Permalink
90e6f86 Jun 13, 2017
2 contributors

Users who have contributed to this file

@bmeriwether-mydevices @jsiderman-mydevices
2246 lines (1428 sloc) 148 KB

LoRa®

Overview

LoRa is a wireless technology developed to create the low-power, wide-area networks (LPWANs) required for machine-to-machine (M2M) and Internet of Things (IoT) applications. The technology offers a very compelling mix of long range, low power consumption and secure data transmission and is gaining significant traction in IoT networks being deployed by wireless network operators.

A network based on LoRa wireless technology can provide coverage that is greater in range compared to that of existing cellular networks. In fact, many mobile network operators have chosen to complement their existing cellular/wireless networks with a LPWAN based on LoRa technology because it is easy to plug into their existing infrastructure and also allows them to offer their customers a solution to serve more IoT battery-operated applications.

LoRa technology originally developed by Semtech is now utilized by the over 400 members of the LoRa Alliance, a non-profit organization focused on standardizing LoRa Technology for IoT/M2M and creating a strong ecosystem to scale the technology. To date, the alliance has developed a global LPWAN specification, known as LoRaWAN™, to help standardize LPWANs and foster the adoption of these networks to enable IoT, M2M, smart city, and industrial applications.

How LoRaWAN™ works

LoRaWAN™ is a protocol specification based on the LoRa technology developed by the LoRa Alliance. LoRaWAN targets the basic needs of LoRa usage for IoT by providing Addressing, Routing and Security.

Topology of a LoRaWAN network consists of several elements.

  • End Nodes: End nodes are elements such as sensors, which are usually remotely located.
  • Concentrator / Gateway: Gateways are access points for for end nodes (e.g. sensors), aggregating data and communicating that data to a central network server via standard IP connections. Several gateways can be co-located in an area and can transparently share a single connection to the network server.
  • Network Server: The LoRa Network Server acts to eliminate duplicate packets, manages security and data rates.
  • Application Server: Application Servers manage payload security and performs analysis to utilize sensor data. Cayenne operates as an Application Server.

About DevEUIs

LoRa devices have a unique identifier (DevEUI) that is assigned to the device by the chip manufacturer. This identifier is used to uniquely identify the device on the network. Cayenne will need to know the DevEUI for your device, regardless of whether it is already registered, or if the device needs to be activated for the first time.

Cayenne Low Power Payload

Overview

The Cayenne Low Power Payload (LPP) provides a convenient and easy way to send data over LPWAN networks such as LoRaWAN. The Cayenne LPP is compliant with the payload size restriction, which can be lowered down to 11 bytes, and allows the device to send multiple sensor data at one time.

Additionally, the Cayenne LPP allows the device to send different sensor data in different frames. In order to do that, each sensor data must be prefixed with two bytes:

  • Data Channel: Uniquely identifies each sensor in the device across frames, eg. “indoor sensor”
  • Data Type: Identifies the data type in the frame, eg. “temperature”.

Payload structure

1 Byte 1 Byte N Bytes 1 Byte 1 Byte M Bytes ...
Data1 Ch. Data1 Type Data1 Data2 Ch. Data2 Type Data2 ...

Data Types

Data Types conform to the IPSO Alliance Smart Objects Guidelines, which identifies each data type with an “Object ID”. However, as shown below, a conversion is made to fit the Object ID into a single byte.

LPP_DATA_TYPE = IPSO_OBJECT_ID - 3200

Each data type can use 1 or more bytes to send the data according to the following table.

Type IPSO LPP Hex Data Size Data Resolution per bit
Digital Input 3200 0 0 1 1
Digital Output 3201 1 1 1 1
Analog Input 3202 2 2 2 0.01 Signed
Analog Output 3203 3 3 2 0.01 Signed
Illuminance Sensor 3301 101 65 2 1 Lux Unsigned MSB
Presence Sensor 3302 102 66 1 1
Temperature Sensor 3303 103 67 2 0.1 °C Signed MSB
Humidity Sensor 3304 104 68 1 0.5 % Unsigned
Accelerometer 3313 113 71 6 0.001 G Signed MSB per axis
Barometer 3315 115 73 2 0.1 hPa Unsigned MSB
Gyrometer 3334 134 86 6 0.01 °/s Signed MSB per axis
GPS Location 3336 136 88 9 Latitude : 0.0001 ° Signed MSB
Longitude : 0.0001 ° Signed MSB
Altitude : 0.01 meter Signed MSB

Examples

Device with 2 temperature sensors

Payload (Hex) 03 67 01 10 05 67 00 FF
Data Channel Type Value
03 ⇒ 3 67 ⇒ Temperature 0110 = 272 ⇒ 27.2°C
05 ⇒ 5 67 ⇒ Temperature 00FF = 255 ⇒ 25.5°C

Device with temperature and acceleration sensors

Frame N

Payload (Hex) 01 67 FF D7
Data Channel Type Value
01 ⇒ 1 67 ⇒ Temperature FFD7 = -41 ⇒ -4.1°C

Frame N+1

Payload (Hex) 06 71 04 D2 FB 2E 00 00
Data Channel Type Value
06 ⇒ 6 71 ⇒ Accelerometer X: 04D2 = +1234 ⇒ +1.234G
Y: FB2E = -1234 ⇒ -1.234G
Z: 0000 = 0 ⇒ 0G

Device with GPS

Payload (Hex) 01 88 06 76 5f f2 96 0a 00 03 e8
Data Channel Type Value
01 ⇒ 1 88 ⇒ GPS Latitude: 06765f ⇒ 42.3519
Longitude: F2960a ⇒ -87.9094
Altitude: 0003E8 ⇒ 10 meters

IPSO Smart Objects Reference

For full information about IPSO Smart Objects, see http://www.ipso-alliance.org/.

IPSO Smart Objects are based on the object model specified in OMA LightWeight M2M [1] Chapter 6, 
Identifiers and Resources.
					
An IPSO Smart Object is a specified collection of reusable resources (See Table 2, Reusable Resources) 
that has a well-known object ID (See Table 1, Smart Objects) and which represents a particular type of 
physical sensor, actuator, connected object or other data source. The reusable resources,which make up 
the Smart Object, represent static and dynamic properties of the connected physical object and the 
embedded software contained therein.
					
This document defines a set of IPSO Smart Objects, which conform to the OMA LWM2MObject Model, and 
which can be used as data objects, or web objects, to represent common sensors, actuators, and data 
sources.
					
Although OMA LWM2M is based on the IETF CoAP [2] protocol, these objects may be used with other 
transport protocols (e.g. HTTP [3] with REST [4]) by supporting the Content-Types and access methods 
defined in [1]. 

IPSO Smart Objects Guideline - Starter Pack - Version 1.0 ©2014 IPSO Alliance

The following section provides information extracted from the IPSO Smart Objects specifications. It includes all of the Data Types (object ID) that can be used with Cayenne LPP. Therefore, the current implementation is limited to the data types listed in the Data Types section.

Starter Pack Data Types

For full specification, see http://www.ipso-alliance.org/so-starter-pack/.


IPSO Starter Pack Data Types

Expansion Pack Data Types

For full specification, see http://www.ipso-alliance.org/so-expansion-pack/.


IPSO Expansion Pack Data Types

Reference Implementation

Cayenne LPP C/C++ constants definitions

#define LPP_DIGITAL_INPUT       0       // 1 byte
#define LPP_DIGITAL_OUTPUT      1       // 1 byte
#define LPP_ANALOG_INPUT        2       // 2 bytes, 0.01 signed
#define LPP_ANALOG_OUTPUT       3       // 2 bytes, 0.01 signed
#define LPP_LUMINOSITY          101     // 2 bytes, 1 lux unsigned
#define LPP_PRESENCE            102     // 1 byte, 1
#define LPP_TEMPERATURE         103     // 2 bytes, 0.1°C signed
#define LPP_RELATIVE_HUMIDITY   104     // 1 byte, 0.5% unsigned
#define LPP_ACCELEROMETER       113     // 2 bytes per axis, 0.001G
#define LPP_BAROMETRIC_PRESSURE 115     // 2 bytes 0.1 hPa Unsigned
#define LPP_GYROMETER           134     // 2 bytes per axis, 0.01 °/s
#define LPP_GPS                 136     // 3 byte lon/lat 0.0001 °, 3 bytes alt 0.01m


// Data ID + Data Type + Data Size
#define LPP_DIGITAL_INPUT_SIZE       3
#define LPP_DIGITAL_OUTPUT_SIZE      3
#define LPP_ANALOG_INPUT_SIZE        4
#define LPP_ANALOG_OUTPUT_SIZE       4
#define LPP_LUMINOSITY_SIZE          4
#define LPP_PRESENCE_SIZE            3
#define LPP_TEMPERATURE_SIZE         4
#define LPP_RELATIVE_HUMIDITY_SIZE   3
#define LPP_ACCELEROMETER_SIZE       8
#define LPP_BAROMETRIC_PRESSURE_SIZE 4
#define LPP_GYROMETER_SIZE           8
#define LPP_GPS_SIZE                 11

Cayenne LPP C++ payload builder

This chapter describes the C++ class definition of the reference myDevices implementation, followed with by the implementation details.

class CayenneLPP {
    public:
        CayenneLPP(uint8_t size);
        ~CayenneLPP();
        
        void reset(void);
        uint8_t getSize(void);
        uint8_t* getBuffer(void);
        uint8_t copy(uint8_t* buffer);
        
        uint8_t addDigitalInput(uint8_t channel, uint8_t value);
        uint8_t addDigitalOutput(uint8_t channel, uint8_t value);

        uint8_t addAnalogInput(uint8_t channel, float value);
        uint8_t addAnalogOutput(uint8_t channel, float value);

        uint8_t addLuminosity(uint8_t channel, uint16_t lux);
        uint8_t addPresence(uint8_t channel, uint8_t value);
        uint8_t addTemperature(uint8_t channel, float celsius);
        uint8_t addRelativeHumidity(uint8_t channel, float rh);
        uint8_t addAccelerometer(uint8_t channel, float x, float y, float z);
        uint8_t addBarometricPressure(uint8_t channel, float hpa);
        uint8_t addGyrometer(uint8_t channel, float x, float y, float z);
        uint8_t addGPS(uint8_t channel, float latitude, float longitude, float meters);
    
    private:
        uint8_t *buffer;
        uint8_t maxsize;
        uint8_t cursor;
        
        
};

CayenneLPP::CayenneLPP(uint8_t size) : maxsize(size)

Initialize the payload buffer with the given maximum size.
{
    buffer = (uint8_t*) malloc(size);
    cursor = 0;
}

CayenneLPP::~CayenneLPP(void)

{
    free(buffer);
}

void CayenneLPP::reset(void)

Reset the payload, to call before building a frame payload
{
    cursor = 0;
}

uint8_t CayenneLPP::getSize(void)

Returns the current size of the payload
{
    return cursor;
}

uint8_t CayenneLPP::getBuffer(void)*

Return the payload buffer
{
    return buffer;
}

uint8_t CayenneLPP::copy(uint8_t dst)*

{
    memcpy(dst, buffer, cursor);
    return cursor;
}

uint8_t CayenneLPP::addDigitalInput(uint8_t channel, uint8_t value)

{
    if ((cursor + LPP_DIGITAL_INPUT_SIZE) > maxsize) {
        return 0;
    }
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_DIGITAL_INPUT; 
    buffer[cursor++] = value; 
    return cursor;
}

uint8_t CayenneLPP::addDigitalOutput(uint8_t channel, uint8_t value)

{
    if ((cursor + LPP_DIGITAL_OUTPUT_SIZE) > maxsize) {
        return 0;
    }
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_DIGITAL_OUTPUT; 
    buffer[cursor++] = value; 

    return cursor;
}

uint8_t CayenneLPP::addAnalogInput(uint8_t channel, float value)

{
    if ((cursor + LPP_ANALOG_INPUT_SIZE) > maxsize) {
        return 0;
    }
    
    int16_t val = value * 100;
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_ANALOG_INPUT; 
    buffer[cursor++] = val >> 8; 
    buffer[cursor++] = val; 

    return cursor;
}

uint8_t CayenneLPP::addAnalogOutput(uint8_t channel, float value)

{
    if ((cursor + LPP_ANALOG_OUTPUT_SIZE) > maxsize) {
        return 0;
    }
    int16_t val = value * 100;
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_ANALOG_OUTPUT;
    buffer[cursor++] = val >> 8; 
    buffer[cursor++] = val; 

    return cursor;
}

uint8_t CayenneLPP::addLuminosity(uint8_t channel, uint16_t lux)

{
    if ((cursor + LPP_LUMINOSITY_SIZE) > maxsize) {
        return 0;
    }
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_LUMINOSITY; 
    buffer[cursor++] = lux >> 8; 
    buffer[cursor++] = lux; 

    return cursor;
}

uint8_t CayenneLPP::addPresence(uint8_t channel, uint8_t value)

{
    if ((cursor + LPP_PRESENCE_SIZE) > maxsize) {
        return 0;
    }
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_PRESENCE; 
    buffer[cursor++] = value; 

    return cursor;
}

uint8_t CayenneLPP::addTemperature(uint8_t channel, float celsius)

{
    if ((cursor + LPP_TEMPERATURE_SIZE) > maxsize) {
        return 0;
    }
    int16_t val = celsius * 10;
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_TEMPERATURE; 
    buffer[cursor++] = val >> 8; 
    buffer[cursor++] = val; 

    return cursor;
}

uint8_t CayenneLPP::addRelativeHumidity(uint8_t channel, float rh)

{
    if ((cursor + LPP_RELATIVE_HUMIDITY_SIZE) > maxsize) {
        return 0;
    }
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_RELATIVE_HUMIDITY; 
    buffer[cursor++] = rh * 2; 

    return cursor;
}

uint8_t CayenneLPP::addAccelerometer(uint8_t channel, float x, float y, float z)

{
    if ((cursor + LPP_ACCELEROMETER_SIZE) > maxsize) {
        return 0;
    }
    int16_t vx = x * 1000;
    int16_t vy = y * 1000;
    int16_t vz = z * 1000;
    
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_ACCELEROMETER; 
    buffer[cursor++] = vx >> 8; 
    buffer[cursor++] = vx; 
    buffer[cursor++] = vy >> 8; 
    buffer[cursor++] = vy; 
    buffer[cursor++] = vz >> 8; 
    buffer[cursor++] = vz; 

    return cursor;
}

uint8_t CayenneLPP::addBarometricPressure(uint8_t channel, float hpa)

{
    if ((cursor + LPP_BAROMETRIC_PRESSURE_SIZE) > maxsize) {
        return 0;
    }
    int16_t val = hpa * 10;
    
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_BAROMETRIC_PRESSURE; 
    buffer[cursor++] = val >> 8; 
    buffer[cursor++] = val; 

    return cursor;
}

uint8_t CayenneLPP::addGyrometer(uint8_t channel, float x, float y, float z)

{
    if ((cursor + LPP_GYROMETER_SIZE) > maxsize) {
        return 0;
    }
    int16_t vx = x * 100;
    int16_t vy = y * 100;
    int16_t vz = z * 100;
    
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_GYROMETER; 
    buffer[cursor++] = vx >> 8; 
    buffer[cursor++] = vx; 
    buffer[cursor++] = vy >> 8; 
    buffer[cursor++] = vy; 
    buffer[cursor++] = vz >> 8; 
    buffer[cursor++] = vz; 

    return cursor;
}

uint8_t CayenneLPP::addGPS(uint8_t channel, float latitude, float longitude, float meters)

{
    if ((cursor + LPP_GPS_SIZE) > maxsize) {
        return 0;
    }
    int32_t lat = latitude * 10000;
    int32_t lon = longitude * 10000;
    int32_t alt = meters * 100;
    
    buffer[cursor++] = channel; 
    buffer[cursor++] = LPP_GPS; 

    buffer[cursor++] = lat >> 16; 
    buffer[cursor++] = lat >> 8; 
    buffer[cursor++] = lat; 
    buffer[cursor++] = lon >> 16; 
    buffer[cursor++] = lon >> 8; 
    buffer[cursor++] = lon; 
    buffer[cursor++] = alt >> 16; 
    buffer[cursor++] = alt >> 8;
    buffer[cursor++] = alt;

    return cursor;
}

Using a public network

Using a public LoRa network is the easiest way to get started using LoRa. In order to get started using a public LoRa network, you will want to first verify that yours sensors will be covered by an appropriate Network Operator. Once you know which network operator you will connect with, you can purchase devices that work on that network. You will then need an account with that operator so that you can add your devices to the network.

In order to activate a LoRa device on a network, you will need to have an account with that network. Using Cayenne, you will not need your account information if the device has already been registered on the network. If you wish to use Cayenne to help activate the device on the network, however, you will need your account information handy so that you can provide this information in order to authenticate with the network and activate the device.

Cayenne currently supports the following LoRa networks. The list of networks that work with Cayenne will keep growing.

Actility

About Actility

Actility is an industry leader in Machine to Machine (M2M) large scale infrastructure with ThingPark®, the new generation standard-based M2M communication platform. Actility is a winner of the French Ministry of Research competition, has obtained the Grand Prix of the Tremplin Entreprise and has been rewarded by Innov’ Eco and CleanTech République for its particularly innovative approach in its Internet Of Things (IoT) solutions.

Using Actility with Cayenne

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

  1. Create / Log into your account on Actility's ThingPark portal
  2. Setup gateway device
  3. Create Cayenne Routing Profile
  4. Register your device on the ThingPark portal
  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 create your ThingPark account, visit the Actility ThingPark Partner's Portal and click on Try or the Create free account button to begin the process of creating your account.


ThingPark create account link

Once your account has been created, you can log into your account from the Partner portal.


ThingPark account login link

After logging into your account you will see the ThingPark Partner dashboard page. You will primarily use the Device Manager screen for the remainder of the documentation when configuring your account and devices to communicate with Cayenne. To access this screen, open the side menu and select the Device Manager link.


ThingPark dashboard with menu highlight


Menu with device link highlght

After selecting the Device Manager link, your Device Manager screen will open.

Tip: Take note of which server your account is using. For most people this will probably be dev1.thingpark.com. You will need to know which server you are using later when adding a device to Cayenne.


ThingPark device dashboard

Setup gateway device

In order for your LoRa devices to connect to the Actility network, you must have purchased and configured a gateway device. When using the Actility network, we recommend that you purchase and configure one of the following gateway devices:

Be sure that you have an appropriate Actility gateway configured and working before continuing. Your devices will not be able to properly function without your gateway device in place.

Create Cayenne Routing Profile

<iframe width="480" height="270" src="https://www.youtube.com/embed/rpZo-GKd7mY" frameborder="0" allowfullscreen></iframe>

In order for data from your device to reach Cayenne, you must create an Application Server that points to Cayenne in the Actility portal. You will also need to add an AS Routing Profile that uses this server. You only need to perform this step once. Any devices that you wish to add to Cayenne will then need to be configured to use the routing profile or Cayenne will not receive their data.

Begin by creating the Application Server. From the device manager, select the Application Servers entry and from the screen that appears, click on the Create button to begin creating a new server.


Create new app server highlight

Give the new entry an appropriate name that you can refer to later, such as "Cayenne". After proceeding, you will see the Application Server screen where you can enter in information for the application server. From this screen, click on the Add button located in the Add a route section.


Add new route button highlight

In the Route section that gets added to the screen, click on the Add button to start adding a destination.


Destintation Add button highlight

In the Add Destination dialog that appears, enter in the Cayenne Actility URL and then click on the Add button to save your changes.

https://lora.mydevices.com/v1/networks/actility/uplink


Paste in Cayenne destination url

Now that the Application Server has been setup, we need to create the AS Routing Profile. To create this profile select the AS routing profiles entry on the portal. From the screen that appears, click on the Create button to begin creating a new profile.


Create new profile highlight

Give your profile an appropriate name, such as "Cayenne" so that you can refer to it later when you configure your devices. After giving your profile a name, you will see the AS Routing Profile screen. Click on the Add button located in the Destinations section.


Add destination button highlight

From the Add Destinations dialog that appears, be sure that the Type dropdown is set to Application Server. In the Destinations dropdown, be sure to select the Application Server you created earlier for Cayenne.


Select app server in profile

After saving your changes, you will be returned to the previous screen. Be sure to click on the Save button to save the changes to your profile. You may now continue with creating a device that uses this profile.

Manually register device

Before you can use your LoRa device on the Actility network, it must be registered on the network. The following information will help guide you through this process using Actility's ThingPark portal and the Device Manager screen.

Create new device

<iframe width="480" height="270" src="https://www.youtube.com/embed/hxhRwEalGvk" frameborder="0" allowfullscreen></iframe>

To get started with a new device, right-click on the Devices entry in the portal and select Create device from the menu that appears.


Actility

The New device dialog will appear. To create a new device using the Actility portal, you will need to enter in all required information for completing the device creation. The process begins by selecting an appropriate activation mode from the Device activation field.

Actility supports two activation modes (OTAA, APB). In most cases, you will want to select Over the Air Activation (OTAA). Let's cover the information needed for both methods.

Over the Air Activation (OTAA)

After selecting the OTAA activation mode, the list of fields will update to show you required fields. You will need to fill in all require fields to register & activate your device with Actility. Below you will find notes on the fields seen for OTAA and specific notes as they relate to what needs to be selected in order to work with Cayenne.


Actility

  • Device identification
    • 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.

    • Device Address: Skip – When selecting OTAA activation, the device address will automatically be generated based on the DevEUI.

    • Device Profile: Actility uses this profile to correctly decode the payload, based on the device type, and display it on their dashboard. Be sure to select the correct profile for your device and which network it will be using.

      TIP: You can refer to the Actility Device Profiles section where we have more details on which Device Profile to select for devices.

  • Application layer
    • 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 do not have an Applicate EUI, you can create one yourself. It must be a unique string composed of 16 alphanumeric characters.

    • Application key: Enter the Appkey. The AppKey is a key specific for the end-device that is assigned by the application owner to the end-device and most likely derived from an application-specific root key exclusively known to and under the control of the application provider.

      TIP: If you do not have an Applicate key, you can create one yourself. It must be a unique string composed of 32 alphanumeric characters.

    • Thingpark cloud config: Skip – Cayenne does not require this optional field.

  • Network
    • Connectivity plan: Select an appropriate Actility plan here for activating your device under.
    • AS routing profile: Select the Cayenne route that you created earlier from the dropdown here. This will forward the information from your device to Cayenne so that once your device is online, Cayenne will receive its information.
  • Administrative data
    • Device name: Used by Actility. Cayenne does not use this information.
    • Marker: Used by Actility. Cayenne does not use this information.
    • Administrative info: Used by Actility. Cayenne does not use this information.
    • Administrative location: Used by Actility. Cayenne does not use this information.
  • Complete the device creation by clicking the Create button to create the device.

Once added, you will see your new device listed in the device list on the portal.


Actility

Once your device has been created, continue by making sure that your device has been programmed/flashed.

Activation By Personalization (APB)

After selecting the APB activation mode, the list of fields will update to show you required fields. You will need to fill in all require fields to register & activate your device with Actility. Below you will find notes on the fields seen for APB and specific notes as they relate to what needs to be selected in order to work with Cayenne.


Actility

  • Device identification
    • 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.

    • Device Address: When using APB, you will need to manually enter the hardware address here.

    • Device Profile: Actility uses this profile to correctly decode the payload, based on the device type, and display it on their dashboard. Be sure to select the correct profile for your device and which network it will be using.

      TIP: You can refer to the Actility Device Profiles section where we have more details on which Device Profile to select for devices.

    • Application session key: Enter the AppSKey. The AppSKey is an application session key specific for the end-device. It is used by both the network server and the end-device to encrypt and decrypt the payload field of application-specific data messages.

    • Network session key: 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.

  • Application layer
    • 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 do not have an Applicate EUI, you can create one yourself. It must be a unique string composed of 16 alphanumeric characters.

    • Application key: Enter the Appkey. The AppKey is a key specific for the end-device that is assigned by the application owner to the end-device and most likely derived from an application-specific root key exclusively known to and under the control of the application provider.

      TIP: If you do not have an Applicate key, you can create one yourself. It must be a unique string composed of 32 alphanumeric characters.

    • Thingpark cloud config: Skip – Cayenne does not require this optional field.

  • Network
    • Connectivity plan: Select an appropriate Actility plan here for activating your device under.
    • AS routing profile: Select the Cayenne route that you created earlier from the dropdown here. This will forward the information from your device to Cayenne so that once your device is online, Cayenne will receive its information.
  • Administrative data
    • Device name: Used by Actility. Cayenne does not use this information.
    • Marker: Used by Actility. Cayenne does not use this information.
    • Administrative info: Used by Actility. Cayenne does not use this information.
    • Administrative location: Used by Actility. Cayenne does not use this information.
  • Complete the device creation by clicking the Create button to create the device.

Once added, you will see your new device listed in the device list on the portal.


Actility

Once your device has been created, continue by making sure that your device has been programmed/flashed.

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.

Add device to Cayenne

<iframe width="480" height="270" src="https://www.youtube.com/embed/u6QuVJCUTo4" frameborder="0" allowfullscreen></iframe>

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Actility

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


Actility

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

If your device has been previously registered on the Actility 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 technology 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 a network.
  3. What is the unique DevEUI for the device being added?
  4. Which Actility ThingPark Server are you using?
  5. Your Actility ThingPark Email and ThingPark Password.

To see how easy it is, let’s walk through an example of connecting an Adeunis LoRa Pulse which was previously registered under an Actility account.

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


Actility

2. Select the Device
Select your device from among the list supported Actility devices. In this case, we’ll select the Adeunis Pulse.


Actility

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 a name. In our case, we’ll enter “LoRa Pulse” in the Name field.

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

  3. Our device has been previously manually registered with Actility. Select “Already Registered” in the Activation Mode field.

  4. From the ThingPark Server field, be sure to select the correct environment that you are using.

    TIP: If you don't find your ThingPark environment in the dropdown, please ask Actility for your ThingPark DX Profile, and manually enter it. It should be suffixed with -api such as mycompany-api.

  5. Enter your ThingPark Email and ThingPark Password into the corresponding fields.

  6. Click Add device.


Actility

The Pulse 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 water, gas, electricity & heat sensors on the device.


Actility

Actility Device Profiles

When setting up your device on Actility's ThingPark portal, you must select the correct Device Profile for your device. Below are some guidelines on which profile to select.

  • For devices used in European Union:
    • Select the Profile LoRaWAN 1.0 class A - Rx2-SF12
  • For devices use in United States of America:
    • Select the Profile LoRaWAN 1.0 class A -US- Rx2-SF12
  • Exceptions to the above:
    • If you are using the NKE Watteco SmartPlug, use the class C version of above configs depending on which region you are in.

      For example, with the SmartPlug being used in the US, select LoRaWAN 1.0 class C (-US-) Rx2-SF12 And in the EU, select LoRaWAN 1.0 class C - Rx2-SF12

Kerlink Network

About Kerlink

Kerlink specialises in network solutions for the Internet of Things (IoT). Its mission is to provide its clients – telecom carriers, businesses and public authorities – with network solutions (equipment, software and services) dedicated to the Internet of Things.

Using Kerlink with Cayenne

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

  1. Setup gateway device
  2. Setup traffic forwarding to Cayenne
  3. Manually register device
  4. Program/Flash your device
  5. Add your device to your Cayenne dashboard

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

Setup gateway device

In order for your LoRa technology devices to connect to the Kerlink network, you must have purchased and configured a gateway device. Kerlink supports several different gateway devices.

Be sure that you have your gateway configured and working before continuing. Your devices will not be able to properly function without your gateway device in place.

Connect to your gateway device

Adding LoRa devices and forwarding their data to Cayenne must be configured on the Kerlink gateway device. You can do so using the gateway's web interface.

Log into the gateway device.

Connect with your browser to the URL / IP Address of your gateway device.

TIP: If needed you can use a network scanner, such as the Fing app to identify devices on your network.


Example enter IP address in browser

Possible security warning seen on connection

When connecting to your gateway device, you may find that your web browser complains about the connection not being secure. Depending upon which browser you are using and its security settings, you may need to take actions to proceed and access the gateway content.


Example security warning from Chrome

Connected to gateway device

As soon as you are connected to the gateway device, you will see the landing screen for your device. You can proceed with configuring the gateway to forward data to Cayenne.


Kerlink SPN landing screen

Setup traffic forwarding to Cayenne

In order for data from your devices to reach Cayenne, you must configure your gateway device to forward data to Cayenne. You will need to perform this step on each Kerlink gateway device. Once logged into your Kerlink gateway interface, click on the HTTP transmitter option located in the Configuration section.


device routing feed screen

In the HTTP transmitter screen that appears, enter in the following information:

  1. Click on the Enable checkbox to enable the fields shown here.

  2. In the Address field enter in the uplink URL for the Kerlink network.

    https://lora.mydevices.com/v1/networks/kerlink/uplink/
    
  3. Click Save to save the changes.


HTTP Transmitter configured for Cayenne

Your gateway is now configured to forward data to Cayenne. You can now proceed with adding devices.

Manually register device

Before you can use your device on the Kerlink network, it must be registered on the network. To accomplish this, devices can be added to the gateway under what Kerlink calls "Fleet devices". The following information will help guide you through this process.

Click on the Fleet option located near the top of the gateway menu. The Fleet screen appears and from here you can add devices.


Landing screen with fleet option highlighted


Fleet devices default screen

Kerlink supports two activation modes (OTAA, ABP). In most cases, you will want to select Over the Air Activation (OTAA). Let’s cover the information needed for both methods.

Over the Air Activation (OTAA)

Below you will find notes on the fields seen for OTAA and specific notes as they relate to what needs to be selected in order to work with Cayenne.


Kerlink OTAA activation options

  • Dev 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.

  • App 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 do not have an Applicate EUI, you can create one yourself. It must be a unique string composed of 16 alphanumeric characters.

  • App key: Enter the Appkey. The AppKey is a key specific for the end-device that is assigned by the application owner to the end-device and most likely derived from an application-specific root key exclusively known to and under the control of the application provider.

    TIP: If you do not have an Applicate key, you can create one yourself. It must be a unique string composed of 32 alphanumeric characters.

  • Class C: Select whether or not your device operates in continuous listening mode. If not, leave this option unselected.

    TIP: Class C is a continuous listening mode making sense for devices that are connected to the electrical network. In this mode the network can at anytime transmit downlink message to the device. An example of such a device is the NKE Watteco SmartPlug.

After filling in the fields for you device, click on the Add button to add the device. Once added, you will see your new device listed on the Fleet screen.


Kerlink fleet device added

Once your device has been created, continue by making sure that your device has been programmed/flashed.

Activation By Personalization (ABP)

Below you will find notes on the fields seen for ABP and specific notes as they relate to what needs to be selected in order to work with Cayenne.


Kerlink ABP activation options

  • Dev Addr: When using ABP, you will need to manually enter the hardware address here.

    NOTE: Kerlink's ABP fields does not ask you to enter the Dev EUI for the device. In order to properly add a device using ABP in Cayenne, an extra step is needed. Be sure to refer to the Add your device to your Cayenne dashboard section in order to make sure that your device is properly added to Cayenne.

  • NwkSKey: Enter the Network Session Key. 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.

  • AppSKey: Enter the Application Session Key. The AppSKey is an application session key specific for the end-device. It is used by both the network server and the end-device to encrypt and decrypt the payload field of application-specific data messages.

  • Class C: Select whether or not your device operates in continuous listening mode. If not, leave this option unselected.

    TIP: Class C is a continuous listening mode making sense for devices that are connected to the electrical network. In this mode the network can at anytime transmit downlink message to the device. An example of such a device is the NKE Watteco SmartPlug.

After filling in the fields for you device, click on the Add button to add the device. Once added, you will see your new device listed on the Fleet screen.


Kerlink fleet device added

Once your device has been created, continue by making sure that your device has been programmed/flashed.

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.

Add device to Cayenne

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Cayenne Add New menu

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


Cayenne showing supported Kerlink 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

If your device has been previously registered on the Kerlink 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 technology 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 a network.
  3. What is the unique DevEUI for the device being added?

To see how easy it is, let’s walk through an example of connecting an Adeunis Pulse which was previously registered on our Kerlink gateway device.

1. Choose the Network

Make sure the Kerlink network is selected in the list of LoRaWAN Networks.


Cayenne showing supported Kerlink devices

2. Select the Device

Select your device from among the list supported the Kerlink network devices. In this case, we’ll select the Adeunis Pulse.


Kerlink with Pulse device highlight

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 a name. In our case, we’ll enter “LoRa Pulse” in the Name field.

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

    NOTE: If your device was configured for Activation By Personalization (ABP), you will need to take a special step here - Cayenne asks for the DevEUI but this information is not currently provided with Kerlink and ABP. To work around this issue, enter in 8 zeros (00000000) followed by the Dev Addr used during the register device with ABP step on the gateway. Without performing this step, your ABP device will not work with Cayenne. This step is not necessary when using OTAA.


    Preceed Dev Addr with 8 zeros in Cayenne

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

  4. Click Add device.


Stream Pulse settings

The Pulse 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 water, gas, electricity & heat sensors on the device.


LoRa dashboard

Loriot Network

About Loriot

LORIOT AG is a Swiss start-up in the field of Internet of Things, founded in 2015. Loriot offers a complete end-to-end solution for real-world IoT applications, including gateway and sensor hardware. Typical customers are small and medium enterprises in the Internet of Things business, cities, municipalities and wireless network operators.

Using Loriot with Cayenne

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

  1. Create / Log into your account on Loriot's portal
  2. Setup gateway device
  3. Create Cayenne Data Output
  4. Register your device on the Loriot portal
  5. Program/Flash your device
  6. Add your device to your Cayenne dashboard

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

Note: For the examples and information shown in this section we will assume that you are using the US server. You will find the same information on whatever server you choose, just note that some of the URLs linked in this section will be different based on the server you use.

Create account

Log into the Loriot portal

To create your Loriot account, visit the Loriot Account Registration page. From here you can enter in all the required details for creating your account, including which server you will be using.

NOTE: Loriot has many servers that you can use, but you will need an account on each of them in order to use that server.


Loriot account registration

Setup gateway device

In order for your LoRa technology devices to connect to the Loriot network, you must have purchased and configured a gateway device. Loriot has a Gateway page with costs and recommendations. Once you have purchased the gateway you want to use, Loriot offers guides for how to set it up for use. When logged into your account, refer to the Documentation > Gateways section on the Loriot portal for information.


Loriot setup gateway

Be sure that you have an appropriate Loriot gateway configured and working before continuing. Your devices will not be able to properly function without your gateway device in place.

Create Cayenne Data Output

<iframe width="480" height="270" src="https://www.youtube.com/embed/euB4Axp1e2M" frameborder="0" allowfullscreen></iframe>

In order for data from your device to reach Cayenne, you must configure your devices in the Loriot portal to forward data to Cayenne. The Loriot portal groups devices in what they call Applications. If you want to use a group of devices with Cayenne, you will need to perform some configuration on the portal. You only need to perform this step once for each Application that you want to use. To set this up, click on the Applications button in the portal. The Network Applications screen appears.


applications button highlighted

From the Network Applications screen, click on the name of the Application that you want to configure. This will open the dashboard for your Application.


Network Applications screen


application dashboard

From the Application screen for your device, find the Data Output option and click on the Edit Output button to change it. The Application Output screen will appear.


myDevices app dash with data output highlight

On the Application Output screen, next to the Data Output option select the Change button and a list of output types will appear. From the list of types, select the myDevices Cayenne option and then click on the Confirm change button to save the change.


Select Cayenne from output list


Confirm data output change

Manually register device

Before you can use your device on the Loriot network, it must be registered on the network. If you need to regsiter your device with Loriot, the following information will help guide you through this process using Loriot's portal.

<iframe width="480" height="270" src="https://www.youtube.com/embed/q6o1AzSuo9c" frameborder="0" allowfullscreen></iframe>

Devices must be added into an Application in the Loriot portal. To enroll a new device, click on Applications and then select which Application your device will be added to. This will open your application's dashboard.


application dashboard

From the application dashboard screen, click on Managed devices and the Devices screen appears. From the Devices screen, you can enroll new devices or you can import existing devices.


Devices screen

Enroll new device

Loriot makes enrolling a new device easy, all you need is the DevEUI for your device.

If you know your DevEUI

If you know the DevEUI for your device, select Enroll new device. In the Enroll screen that appears, enter in your DevEUI into the Device EUI field and click the Enroll button. Loriot will take care of assigning all other keys (APPKEY, APPSKEY, NWKSKEY) and identifiers (DevAddr) for your device automatically.


enroll new device

If you don't know your DevEUI

If you don't know your DevEUI, click on Generate new device. Loriot will generate your device's DevEUI and all other keys and identifiers needed and then add a device entry into your list of devices.


Devices screen generate highlight

Import existing device

If you have existing devices, select either the Import existing OTAA or Import existing ABP button, depending upon whether your devices use Over the Air Activation or Activation by Personalization. You will then need to enter in all of the required information for your device.

Note: You will only use this feature if you have an existing device deployed in the field and are not able to re-personalize the device. In all other cases, you will want to use the new device enrollement process.


Loriot OTAA


Loriot ABP

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.

Add device to Cayenne

<iframe width="480" height="270" src="https://www.youtube.com/embed/AwFwQ4cVpIg" frameborder="0" allowfullscreen></iframe>

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Loriot

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


Add devie with loriot selected

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

If your device has been previously registered on the Loriot 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 technology 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 a network.

  3. What is the unique DevEUI for the device being added?

  4. What is your Loriot Application ID? You can obtain your App ID from your Application's dashboard on the Loriot portal.


    app dashboard App ID highlight

  5. What is your Loriot Security Token? Yuu can obtain your Token by clicking on Security tokens from your Application's dashboard on the Loriot portal.


    App dashboard Security token highlight


    Security token

To see how easy it is, let’s walk through an example of connecting an Adeunis Pulse which was previously registered under an Loriot account.

1. Choose the Network

Make sure the Loriot network is selected in the list of Networks.


Loriot network selected

2. Select the Device

Select your device from among the list supported Loriot devices. In this case, we’ll select the Adeunis Pulse.


Loriot device highlight

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 a name. In our case, we’ll enter “LoRa Pulse” in the Name field.
  2. Enter the DevEUI for this device into the DevEUI field.
  3. Our device has been previously manually registered with Loriot. Make sure “Already Registered” is selected in the Activation Mode field.
  4. Select which server your device uses from the Loriot Server dropdown.
  5. Enter in the Loriot App ID for the Application this device uses on the Loriot portal.
  6. Enter in the Loriot Token for the Application this device uses on the Loriot portal.
  7. Click Add device.


Loriot Pulse settings

The Pulse 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 water, gas, electricity & heat sensors on the device.


LoRa dashboard

Objenious Network

About Objenious

Objenious, a Bouygues Telecom subsidiary, has selected LoRaWAN® technology, a global standard, in order to provide the best support to these businesses through every step of their transformation. Objenious also provides a network, an IoT platform called SPOT (stands for Smart Portal of Things) and tailored services to meet businesses needs.

Using Objenious with Cayenne

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

  1. Create / Log into your account on the Objenious SPOT portal
  2. Register your device on the SPOT portal
  3. Setup traffic forwarding to Cayenne
  4. Add your device to your Cayenne dashboard

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

Note: At present the Objenious SPOT portal is currently shown in French only. The documentation shown in this section will reference the SPOT portal in French, but the steps should be easy enough to follow along.

Create account

To get an account with Objenious, you will need to work directly with Objenious. Although there is an account creation link on the SPOT portal, it requires an Activation Code that you must first obtain from Objenious.

Log into the SPOT portal

Once you have your account, you can proceed with the logging into the SPOT portal. After logging in, you will see your Dashboard and from there you can proceed with setting things up to connect with Cayenne.


Objenious SPOT portal login


SPOT portal dashboard

Manually register device

Before you can use your LoRa device on the Objenious network, it must be registered on the network. The following information will help guide you through this process using Objenious's SPOT portal and the CAPTEURS screen.

Import Devices

To get started with adding new devices, click on the CAPTEURS link in the side menu shown on the SPOT dashboard. From the screen that appears, click on the IMPORTER DES CAPTEURS button.


Capteurs button highlight


Import button highlight

In order to import devices into Objenious, you will need to download and fill in a template file. Download the template by clicking on the Téléchargez le template button. Fill in the required information for the devices that you wish to import and save the template.

Note: Take note of which Groupe (code) you specify your devices get imported to. Later when you setup data forwarding to Cayenne, you will need to do so for each group of devices you want to forward data.

Note: If you need more information on this step, or run into trouble importing your devices, you may wish to refer to Objenious' FAQ document (FRENCH) that contains a wealth of helpful information.


Import screen with template button highlighted

To complete importing your devices, click on CHOISIR UN FICHIER and browse to the template file that contains the devices you wish to importn. Click on the IMPORTER button and then the ACCEPTER button.


Import screen with template ready to import


Import screen popup

Note: You will see the status of your device import and any errors down below in the history section on the Import screen. If you run into any errors, you can expand the details for that import attempt and then try again.


Import screen with import history showing error expanded

Once your devices have been imported, they should appear on the GESTION DES CAPTEURS screen.

Note: that it can take up to 48 hours for newly imported devices to be activated on Objenious. In the meantime, you will see your device shown in the list of devices, but you will see an activation error shown in the status (STATUT) field. Once your device is ready to be used, you will see a green EN ACTIVITÉ status shown next to your device.


Devices screen with activated device highlight

Once your device has been imported and is ready to be used, you can proceed with setting up data forwarding to Cayenne.

Setup device forwarding to Cayenne

In order for Cayenne to be able to able to receive your device’s information, you will need to setup forwarding. When devices are imported into Objenious, they are imported into a group (Groupe). This setup will need to be performed once for each group of devices in your account.

To perform this step, expand the CONFIGURATION option in the side menu and select Scénarios et alertes. On the SCÉNARIOS ALERTES screen that appears, click on the CRÉER UN SCÉNARIO button to begin creating a new scenario.


Scenarios screen with create highlight

On the CHOIX DU SCÉNARIO page that appears, scroll down and select the HTTP Push Route (ROUTAGE) option. Then click on the SUIVANT button to continue to the next step.


HTTP Push Routage option highlight

On the Parameters screen (PARAMÉTRAGE DU SCÉNARIO), make the following choices:

  • Enter a name for the route in the name (NOM DU SCENARIO) field, such as Cayenne Forward.

  • From the group (GROUPE) field, select which group of devices you want this rule to apply. In the example shown here, our group is named MyDevices. Yours will be named differently.

  • From the list of device types (TYPE DE CAPTEUR) select All (TOUS).


    Parameters entered so far

  • In the destination URL field (ENVOI D'UNE REQUÊTE HTTP) enter in Cayenne's Objenious uplink URL.

    https://lora.mydevices.com/v1/networks/objenious/uplink
    
  • Under CONTENU be sure to select the MESSAGE option. This is required so that Cayenne receives the entire payload data and not just decoded values.

  • Finally, click on the create scenario (Créer le scénario) button to complete the creation.


    Parameters showing last options and create highlight

You will then see your completed route shown on the SCÉNARIOS ALERTES screen. Your group is now configured to forward data to Cayenne. You can now proceed with adding your devices in Cayenne.


Scenarios screen with Cayenne Forward created

Add device to Cayenne

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Cayenne Add New menu

From the list of devices & widgets that appears, select the LoRa category and then Objenious option to view a list of supported devices.


Cayenne showing list of Objenious 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

If your device has been previously registered on Objenious, 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 technology 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?

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

1. Choose the Network

Make sure Objenious is selected in the list of Networks.


Cayenne showing list of Objenious devices

2. Select the Device

Select your device from among the list supported Objenious devices. In this case, we’ll select the Adeunis Pulse.


Cayenne showing Objenious and Adeunis Pulse highlighted

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 a name. In our case, we’ll enter "LoRa Pulse" in the Name field.
  2. Enter the DevEUI for this device into the DevEUI field.
  3. Our device has been previously manually registered with Objenious. Make sure “Already Registered” is selected in the Activation Mode field.
  4. Click Add device.


Cayenne showing Objenious Pulse settings

The Pulse 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 water, gas, electricity & heat sensors on the device.


LoRa dashboard

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 are not 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.

Register new 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.


OrbiWise gateway screen and menu

To register a new 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.


OrbiWise add gateway dialog

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 a new device. From the My Devices menu, select List of Devices and the My Devices screen appears.


Orbiwise add device menu

From the My Devices screen, click on the Add Device button to begin the process of adding a new 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.


Orbiwise OTA

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 find notes 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 may not 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 device name, 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.


Orbiwise OTA

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 find notes 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 do not 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 device name, 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.


Orbiwise ABP

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.


Orbiwise Push menu

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 is not used by Cayenne.
  5. Host Password: Enter anything you want here. OribiWise requires this field, but it is not used by Cayenne.
  6. Click on the Start button to start the forwarding service.


Orbiwise Cayenne push configuration

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 do not, double check the values entered for your device and consider programming/flashing the device again.


Orbiwise data activity

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.


Orbiwise

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


Cayenne dashboard showing Orbiwse network

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.


Cayenne dashboard showing Orbiwse network

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


Cayenne dashboard with mDotBox device selected

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 a name. 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 the name 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.


Cayenne dashboard with mDotBox device settings filled in

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.


Actility

Senet Network

About Senet

Senet, a contributing member of the LoRa® Alliance, is the first and only public provider in North America of low-power wide-area networks (LPWANs) with its class-leading LoRa® modulation for IoT and M2M applications.

Using Senet with Cayenne

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

  1. Create / Log into your account on the Senet portal
  2. Setup gateway device
  3. Register your device on the Senet 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 create your Senet account, visit the Senet Portal. Click on the Create New Account to get started.


Senet portal with create new user highlight


Senet create user dialog

Setup gateway device

In order for your LoRa technology devices to connect to the Senet network, you should purchase and configure a gateway device. When using the Senet network, it is recommended that you use a MultiConnect Conduit gateway device. You can find links to an appropriate version of this device on the Multitech MultiConnect Conduit page.

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

Register new gateway device

If you need to register a new gateway device, the Senet portal has instructions and the software for doing so. To begin this process, log into your Senet account and click on the Register Devices button. Select Gateway from the dialog that appears to begin the process of adding your gateway device.

Note: Currently only the MultiTech Conduit gateway can be registered through the Senet Portal.


senet portal with register device button highlight


register gateway link highlighted

The Register Gateway dialog that appears will walk you through the process of adding your gateway device. You can refer to Senet's own gateway documentation if you need help with this step.


Register gateway information

Manual register device

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

Log into the Senet portal

Start by going to the Senet portal and logging into your account. Once logged in, you can proceed with registering a new device.

Register new device

<iframe width="480" height="270" src="https://www.youtube.com/embed/CrY-wAw58Ts" frameborder="0" allowfullscreen></iframe>

To get started with a new device, click on the Register Devices button. From the dialog that appears, select the Device option.


senet portal with register device button highlight


Register new device highlight

From the Register Device dialog that appears, enter in the Device EUI (or allocate one from here) and a description for the device. Click Register New Device to complete registering the device.


Register new device dialog

Your device will now appear in the list of devices shown on your dashboard. You can now setup device forwarding to Cayenne.


Senet dashboard showing devices

Setup device forwarding to Cayenne

<iframe width="480" height="270" src="https://www.youtube.com/embed/k7V0FzuFf-I" frameborder="0" allowfullscreen></iframe>

In order for Cayenne to be able to able to receive your device’s information, you will need to setup packet forwarding. To do so, expand the settings for the device and click on the cogwheel icon. The Edit Device screen appears.

TIP: Alternatively you can click on the device tile itself and then select the cogwheel icon that also appears on the Device screen.


Accessing device settings


Edit device dialog

From the Edit Device dialog we can setup the device so that it forwards data to Cayenne. To do so, perform the following:

  1. Select the NOTIFICATION TARGET tab. This will expose the fields needed for forwarding.


    Edit device dialog with highlight for Notification target

  2. Open the Forward To dropdown and select the myDevices Cayenne profile.


    Notification target tab with Forward To highlight

  3. Before data will begin forwarding, be sure that the Status slider is set to Enabled.

  4. Make sure that the RF Data checkbox is selected to see signal strength data for your device in Cayenne.


    Notification target tab with all selections made

  5. Click Save to save the changes.

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 Senet portal's device list for your device. If you do not, double check the values entered for your device and consider programming/flashing the device again.


Senet dashboard showing traffic from device

Add device to Cayenne

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Senet

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


Senet

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 Senet 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 technology 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. What is your unique Senet account API Key?

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

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


Senet

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


Senet

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 a name. 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 Senet. Make sure “Already Registered” is selected in the Activation Mode field.

  4. Enter your unique Senet Account API Key for your Senet account. This will allow Cayenne to send downlink commands to your device.

    TIP: If you have not generated your API Key it can be found on the Senet Portal under your Account Information.

    Note: Once generated on the Senet Portal, your API key is not shown to you again. Be sure to copy & save off your API key for later reference! Failing to do so may cause you to need to regenerate your key. If you do so, remember that you will need to update the settings for all previously added devices in Cayenne as well.


    Senet access Account Info


    Senet portal showing API key section

  5. Click Add device.


Cayenne Add Device with all Senet fields shown

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.


Actility

Stream Network

About Stream

Stream Technologies is the company behind IoT-X, a Connectivity Enablement, Management & Billing platform.

Designed for all operators of Cellular, Satellite & Low Power Wide Area networks, IoT-X is offered as a Platform as a Service (PaaS) and is fast being adopted by established network operators and new entrants into the M2M/IOT sector.

Using Stream with Cayenne

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

  1. Create / Log into your account on Stream's IoT-X portal
  2. Setup gateway device
  3. Setup traffic forwarding to Cayenne
  4. Create Application
  5. Register your device on the IoT-X portal
  6. Program/Flash your device
  7. Add your device to your Cayenne dashboard

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

Create account

To register and configure your devices to work with Stream, you will need to use Stream's IoT-X portal. To get an account with Stream and to use the IoT-X portal, you will need to work directly with Stream. Accounts are not created manually through any sign up process.

TIP: If you need help logging into your Stream IoT-X account, you can refer to Stream's Quick-Start Guide which includes information on logging in and what to do if you need help.


iotx login screen


iotx landing screen after login

Setup gateway device

In order for your LoRa technology devices to connect to the Stream network, you must have purchased and configured a gateway device. The Stream network supports a few different gateway devices. Refer to the Add a LoRa Gateway process on the IoT-X portal and to Stream's Adding a Gateway documentation for more information.

Be sure that you have an appropriate gateway configured and working before continuing. Your devices will not be able to properly function without your gateway device in place.

Register new gateway device

If you need to register a new gateway device, you can do so from the IoT-X portal. To begin this process, log into your account and expand the LoRa side menu. Select the Gateways option to open the LoRa Gateways screen. From here, click on the Add Gateway button to begin the process of adding a new gateway.


iotx dashboard with LoRa menu expanded


lora gateways screen

On the Add a LoRa Gateway screen that appears, select the gateway device that you are adding and enter in the required information.

TIP: Stream has in-depth documentation on registering your gateway available if you should need help with this process.


Add a LoRa Gateway screen

Setup traffic forwarding to Cayenne

In order for data from your devices to reach Cayenne, you must configure the IoT-X portal to forward data to Cayenne. You only need to perform this step once globally for your account. To perform this step, expand the Services menu and select the Data Routing option. On the Device Routing Feeds screen that appears, click on the Create button to create a new device routing feed.


iotx dashboard with Services menu expanded


device routing feed screen with highlight

In the Add Data Routing Destination dialog that appears, enter in the following information:

  1. Give the feed a Name such as "Cayenne".

  2. Expand the Output Type dropdown and select the HTTPS POST option.

  3. In the URL field enter in Cayenne's Stream uplink URL.

    https://lora.mydevices.com/v1/networks/stream/uplink
    


    device routing feed screen

  4. Click Add to complete creation of your routing feed.


device routing feed screen

Your account is now configured to forward device data to Cayenne. You can now proceed with creating an application and adding devices to it.

Create Application

The IoT-X portal groups devices in what they call Applications. Before you can add devices you must have an application.

TIP: Setting up Data forwarding to Cayenne is done globally to your account in Stream. If you already have an Application that you want to use for your devices, you do not need to create an additional application. You can skip to adding devices in that case.

To create an application, log into the IoT-X portal and expand the LoRa side menu. Select the Applications option to open the LoRa Applications screen. Click on the Create an Application button to begin the process of adding an application.


iotx dashboard with LoRa menu expanded


lora applications screen

On the Add a LoRa Application screen that appears, enter in the required information for creating a new application.

TIP: Stream has in-depth documentation on creating a LoRa Application available if you should need help with this process.


Add a LoRa Application screen

Once you have an application that you want to use, you can then add your devices to it.

Manually register device

Before you can use your device on the Stream network, it must be registered on the network. To accomplish this, devices must be added into an Application in IoT-X portal. The following information will help guide you through this process.

  1. Expand the LoRa side menu. Select the Applications option to open the LoRa Applications screen.


    iotx dashboard with LoRa menu expanded


    lora applications screen

  2. Click on the name of the application you want to add the device to. The screen that appears will show you the details of your application, any existing registered devices and an Add a Device panel from which you can add new devices.


    list of applications with highlight


    App details screen shown for demo app

  3. Refer to the Add a Device panel on the application screen. You can enter in all the required details for adding your device directly here. The Stream network supports both OTAA and APB activation.

    TIP: If you need help with this part of the process you can refer to Stream's Adding devices to LoRa Applications documentation.


    Add a device panel

  4. Click Add to complete adding your device.

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.

Add device to Cayenne

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Cayenne Add New menu

From the list of devices & widgets that appears, select the LoRaWAN category and then the Stream Network option to view a list of supported devices.


Cayenne showing supported Stream 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

If your device has been previously registered on the Stream 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 technology 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 a network.
  3. What is the unique DevEUI for the device being added?

To see how easy it is, let’s walk through an example of connecting an Adeunis Pulse which was previously registered under a the Stream network account.

1. Choose the Network

Make sure the Stream network is selected in the list of LoRaWAN Networks.


Cayenne showing supported Stream devices

2. Select the Device

Select your device from among the list of supported Stream network devices. In this case, we’ll select the Adeunis Pulse.


Stream with Pulse device highlight

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 a name. In our case, we’ll enter “LoRa Pulse” in the Name field.
  2. Enter the DevEUI for this device into the DevEUI field.
  3. Our device has been previously manually registered with the Stream network. Make sure “Already Registered” is selected in the Activation Mode field.
  4. Click Add device.


Stream Pulse settings

The Pulse 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 sensors on the device.


LoRa dashboard

The Things Network

About The Things Network

The Things Network is building a global, open, crowd-sourced Internet of Things data network which is owned and operated by its users. It is based on the technology called LoRaWAN which is perfect for the Internet of Things as it is low energy, long range and low bandwidth. The entire city of Amsterdam was covered with this network in less than 6 weeks and inspired hundreds of cities around the world to do the same.

Using The Things Network with Cayenne

Cayenne makes it easy to use your LoRa device and The Things Network. You will need to:

  1. Create / Log into your account on The Things Network portal
  2. Setup gateway device
  3. Create Application and configure Integration
  4. Register your device on The Things Network portal
  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 create your account, visit The Things Network Sign Up page. From here you can enter in all the required details for creating your account.


Account Sign Up

Open The Things Network Console

Once you have your account and have signed in, you will want to access the Console which is where you can configure your Applications and Gateway devices. To access the console, expand your user menu and select the CONSOLE option. This will open the Console page.


User menu expanded


Console landing screen

Setup gateway device

In order for your LoRa technology devices to connect to The Things Network, you must have purchased and configured a gateway device. The Things Network has a Gateway page with information on hardware supported, including their own Gateway device (Coming Soon) that you can use.

Be sure that you have an appropriate gateway configured and working before continuing. Your devices will not be able to properly function without your gateway device in place.

Register gateway device

If you need to register a new gateway device, you can do so from The Things Network console. To begin this process, log into your account and open the Console page. Select the Gateways link to open the Gateways screen. From here, select the register gateway link to begin the process of registering a new gateway.


Console screen with gateways highlight


Console screen with gateways highlight

You will then be guided through setting up your gateway device.

TIP: The Things Network has in-depth documentation on registering your gateway available if you should need help with this process.


Register gateway screen

Create Application

In order for data from your device to reach Cayenne, you must configure your devices in The Things Network portal to forward data to Cayenne. The Things Network portal groups devices in what they call Applications. If you want to use a group of devices with Cayenne, you will need to configure your Application to use the Cayenne. You only need to perform this step once for each Application that you want to use.

To create an application, click add application in the console. The Add Application screen appears.


Add Application screen


Add Application screen

On the Add Application, fill in the required information to create your new Application.

Tip: If you need help with this part of the process, you can refer to The Things Network documentation on this step.


Add Application screen

Once you have an application that you want to use, you can then proceed with configuring it to work with Cayenne.

Add Cayenne Integration

To configure your Application to forward data to Cayenne you will need to add an Integration. To add the Cayenne integration, perform the following steps:

TIP: If you need additional help with this step you can also refer to The Things Network Add an Integration documentation for generic help on adding integrations.

  1. Open your existing Application in the console.


    Application Overview

  2. Select Integrations from the top-right menu.


    Application screen with Integrations highlight

  3. Click the add integration link.


    Integrations screen with add link highlight

  4. Click to select the Cayenne integration option shown in the list. A list of options for the Cayenne Integration will then be shown.


    Add integration screen with Cayenne option

  5. Configure the Cayenne integration by entering in a Process ID. This can be any string of text that you want, such as "cayenne-ID".

  6. Complete the Cayenne integration by selecting the Access Key to be used for downlink commands. In most cases you will simply need to select the default key for your application.


    Cayenne integration screen with filled in values

  7. Click Add Integration to complete the setup.


Integrations screen with Cayenne shown as configured

Your application is now configured to forward data to Cayenne. You can now proceed with adding devices that use the application.

Manually register device

Before you can use your device on The Things Network, it must be registered on the network. To accomplish this, devices must be added into an Application in The Things Network console. The following information will help guide you through this process.

  1. In the Console, from the Application or an application’s Devices screen, click register device.


    Device screen with register link highlight

  2. Fill in the required information for registering your device.

    TIP: If you need help with this part of the process you can refer to The Things Network device registration documentation.


    Register Device screen

  3. Click Register to complete adding your device.

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.

Add device to Cayenne

Once your device has been registered, programmed, configured to forward data to Cayenne and is online, 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.


Cayenne Add New menu

From the list of devices & widgets that appears, select the LoRa category and then The Things Network option to view a list of supported devices.


Cayenne showing supported TTN 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

If your device has been previously registered on The Things 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 technology 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 a network.
  3. What is the unique DevEUI for the device being added?

To see how easy it is, let’s walk through an example of connecting an Adeunis Pulse which was previously registered under a The Things Network account.

1. Choose the Network

Make sure The Things Network is selected in the list of Networks.


Cayenne showing supported TTN devices

2. Select the Device

Select your device from among the list supported The Things Network devices. In this case, we’ll select the Adeunis Pulse.


TTN with Pulse device highlight

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 a name. In our case, we’ll enter “LoRa Pulse” in the Name field.
  2. Enter the DevEUI for this device into the DevEUI field.
  3. Our device has been previously manually registered with The Things Network. Make sure “Already Registered” is selected in the Activation Mode field.
  4. Click Add device.


TTN Pulse settings

The Pulse 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 water, gas, electricity & heat sensors on the device.


LoRa dashboard