OrbiWise Network

OrbiWise Network

About OrbiWise

OrbiWise is a leading solution provider for Low-Power Wide–Area wireless Networks optimized for connected objects based on LoRa(TM) technology.

Using OrbiWise with Cayenne

Cayenne makes it easy to use your LoRa device and the OrbiWise network. You will need to:

1. Create / Log into your account on the OrbiWise portal
2. Setup gateway device
3. Register your device on the Orbiwise portal
4. Setup traffic forwarding to Cayenne
5. Program/Flash your device
6. Add your device to your Cayenne dashboard

We will walk you through these steps in the following sections.

Create account

To get an account with OrbiWise, you will need to work directly with OrbiWise. Accounts areot created manually through any sign up process.

Setup gateway device

In order for your LoRa technology devices to connect to the OrbiWise network, you should purchase and configure a gateway device. Currently, you will obtain and use a Tektelic gateway that has been configured for OrbiWise and Cayenne. OrbiWise will perform this configuration for you. Since your gateway will be preconfigured to work with Cayenne, you will not need to configure any Cayenne-specific data forwarding for each device connected to that gateway.

Be sure that your devices are covered by an appropriate OrbiWise gateway, including having the gateway configured and working for Cayenne, before continuing. Your devices will not be able to properly function without your gateway device in place.

Registerew gateway device

If you obtain your gateway from OrbiWise, your gateway may already be configured and registered. In such instances, you probably do not need to register your device prior to using it. If, however, you need to register your device you can do so using your OrbiWise portal.

To view the gateways under your account, log into your customer-specific OrbiWise portal and select My Gateways > List Of Gateways. You will then see the current list of gateways for your account.

To register aew gateway, click on the Add Gateway button and the Add Gateway dialog appears. The only information you'll need is the Gateway ID for the gateway you'll be adding. Enter this ID into the Gateway ID field and click Add Gateway to add your gateway.

Manual register device

Before you can use your device on the OrbiWise network, it must be registered on the network using the OrbiWise portal. The following information will help guide you through this process.

Register new device

Start by going to your customer-specific OrbiWise portal and logging into your account. Once logged in, you can proceed with registering aew device. From the My Devices menu, select List of Devices and the My Devices screen appears.

From the My Devices screen, click on the Add Device button to begin the process of adding aew device. The Add New Device dialog appears, allowing you to enter in the required information to add and activate your device. Depending upon the Registration type that you will be using (Join Procedure or Presonalized), the information you need to provide will be slightly different.

Join Procedure

After selecting the Registration type > Join Procedure option, the list of fields will update to show you required fields needed for Join Procedure registration. This registration process is similar to Over the Air Activation that may see with other LoRa networks. You will need to fill in all require fields to register & activate your device with OrbiWise. Below you will findotes on the fields seen for Join Procedure registration and specific notes as they relate to what needs to be selected in order to work with Cayenne.

• Device EUI: Enter the DevEUI for your device. This ID should come with the information included with your device, or can be found in the device configuration.

• Application EUI: Enter the AppEUI. The AppEUI is a global application ID that uniquely identifies the application provider (i.e., owner) of the device.

  NOTE: The OrbiWise portal is currently under active development. Currently there is a bug in the OrbiWise portal wherein although the AppEUI field is required for Join Procedure registration, this field mayot be present on the dialog. To work around this, perform the following steps:

  1. First select the Registration type > Personalized option to temporarily display the fields for the Personalized registration mode.
  2. Enter in the AppEUI information into the field that does appear there. You only need to enter in the AppEUI here.
  3. Then return to the Join Precedure tab by clicking back on Join Procedure.
  4. You can then continue with registering using the Join Procedure registration fields.

• Comment: Optional. We recommend you enter in the deviceame, or a description so that you can easily refer to it on the OrbiWise dashboard.

• Complete the device registration by clicking the Add Device button.

Personalized

After selecting the Registration type > Personalized option, the list of fields will update to show you required fields needed for Personalized registraiton. This registration process is similar to Activation by Personalization that may see with other LoRa networks. You will need to fill in all require fields to register & activate your device with OrbiWise. Below you will findotes on the fields seen for Personalized registration and specific notes as they relate to what needs to be selected in order to work with Cayenne.

• Device EUI: Enter the DevEUI for your device. This ID should come with the information included with your device, or can be found in the device configuration.

• Application EUI: Enter the AppEUI. The AppEUI is a global application ID that uniquely identifies the application provider (i.e., owner) of the device.

  TIP: If you doot have an Applicate EUI, you can create one yourself. It must be a unique string composed of 16 alphanumeric characters.

• Comment: Optional. We recommend you enter in the deviceame, or a description so that you can easily refer to it on the OrbiWise dashboard.

• DevAddr: When using Personalized registration, you will need to manually enter the 4 byte hardware address here.

• NwkSKey: Enter the NwkSKey. The NwkSKey is a network session key specific for the end-device. It is used by both the network server and the end-device to calculate and verify the MIC (message integrity code) of all data messages to ensure data integrity. It is further used to encrypt and decrypt the payload field of a MAC only data messages.

• Complete the device creation by clicking the Add Device button.

Setup device forwarding to Cayenne

In order for data from your device to reach Cayenne, you must configure forwarding from within the settings found in your user-specific OrbiWise portal. You only need to perform this step once from the portal. To set this up, open the Applications menu and select HTTP Push configuration.

From the HTTP Push configuration screen we find the settings needed to forward data to Cayenne. To set this up, enter the following information:

1. Hostname: https://lora.mydevices.com
2. Port: 443
3. Path prefix: /v1/networks/ubiq/uplink
4. Host Username: Enter anything you want here. OribiWise requires this field, but it isot used by Cayenne.
5. Host Password: Enter anything you want here. OribiWise requires this field, but it isot used by Cayenne.
6. Click on the Start button to start the forwarding service.

Programming the device

Some devices will come from your device supplier preprogrammed and ready to be used immediately. Other devices will require you to program the device manually. If your device is preprogrammed, it can now be deployed and connected to the network for usage.

If your device needs to be programmed, you should now proceed with programming/flashing the device. Because this process is different for each device, you should refer to the instructions for your device for any specific information you need to perform this step. If you need help, you can refer to the Supported devices section where you will find Product page, Datasheet and User Guides for your device.

NOTE: Be sure that your device is programmed and properly connected to the network at this time. Only after your device is programmed, online and properly forwarding data should you proceed with adding your device to Cayenne.

TIP: You should see data being reported on the OrbiWise portal's Data > Show Packets page. If you doot, double check the values entered for your device and consider programming/flashing the device again.

Add device to Cayenne

Once your device has been registered, programmed, and connected to a gateway that is forwarding data to Cayenne, you can proceed with adding the device in Cayenne so that it appears in your dashboard.

From the Cayenne dashboard, click Add New > Device / Widget.

From the list of devices & widgets that appears, click LoRa and select the OrbiWise Network option to view a list of OrbiWise supported devices.

After selecting the device that you wish to add, settings for that device will appear. In the following section, we’ll walk you through the settings needed for adding a previously registered device.

Already Registered

Once your device has been previously registered on the OrbiWise network, it can be quickly & easily added to Cayenne. Once added, your device and all of its sensors will appear in your dashboard.

Items you will need:

1. Which LoRa device is being added?
2. Your device will need to have been previously registered on the network. Refer to Manual device registration if you need help with manually registering your device on the network.
3. What is the unique DevEUI for the device being added?
4. If you wish to use downlink commands, you will need to know your user-specific OrbiWise Server address as well as your Login and Password.

To see how easy it is, let’s walk through an example of connecting an Multitech mDotBox which was previously registered under a OrbiWise account.

1. Choose the Network Make sure the OrbiWise network is selected in the list of Networks.

2. Select the Device Select your device from among the list supported OrbiWise devices. In this case, we’ll select the Multitech mDotBox.

3. Enter Settings & Add device In order to add the device, Cayenne needs to know some information about the device and how it will be shown on the dashboard.

1. Give the device aame. In our case, we’ll enter “mDotBox” in the Name field.

2. Enter the DevEUI for this device into the DevEUI field.

3. Our device has been previously manually registered with OrbiWise. Make sure “Already Registered” is selected in the Activation Mode field.

4. (Optional) Enter in your OrbiWise account information to take advantage of downlink commands.

   • Enter theame of your customer-specific OrbiWise portal (e.g. us.xyz.orbiwise.com) into the OrbiWise Server field.
   • Enter your OrbiWise Login and OrbiWise Password into the corresponding fields.

5. Click Add LoRa device.

The Multitech mDotBox device has been added to your dashboard and Cayenne will automatically add widgets for the sensors on the device. You can now track the location of your device as well as examine the current status of the various sensors on the device.