Actility

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 willeed 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 button Create free account to begin the process of creating your account.

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

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.

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.

Setup gateway device#

In order for your LoRa devices to connect to the Actilityetwork, you must have purchased and configured a gateway device. When using the Actilityetwork, 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#

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 theneed 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 aew server.

Give the new entry an appropriateame 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.

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

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

Now that the Application Server has been setup, weeed 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 aew profile.

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

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.

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

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.

alt text

The New device dialog will appear. To create aew device using the Actility portal, you willeed 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 willeed to fill in all require fields to register & activate your device with Actility. Below you will findotes on the fields seen for OTAA and specific notes as they relate to whateeds to be selected in order to work with Cayenne.

alt text

  • 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 whichetwork it will be using.

      TIP: You can refer to the [Actility Device Profiles section(#lora-actility-actility-device-profiles) 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 doot 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 doot 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

    • Deviceame: 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 yourew device listed in the device list on the portal.

alt text

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 willeed to fill in all require fields to register & activate your device with Actility. Below you will findotes on the fields seen for APB and specific notes as they relate to whateeds to be selected in order to work with Cayenne.

alt text

  • 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 willeed 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 whichetwork 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 doot 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 doot 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

    • Deviceame: 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 yourew device listed in the device list on the portal.

alt text

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 canow be deployed and connected to the network for usage.

If your deviceeeds to be programmed, you shouldow 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 youeed to perform this step. If youeed 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.

alt text

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.

alt text

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 willeed to have been previously registered on the network. Refer to Manual device registration if youeed 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.

alt text

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

alt text

3. Enter Settings & Add device

In order to add the device, Cayenneeeds to know some information about the device and how it will be shown on the dashboard.

  1. Give the device aame. In our case, we’ll enter “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.

The Pulse has been added to your dashboard and Cayenne will automatically add widgets for the sensors on the device. You canow track the location of your device as well as examine the current status of the water, gas, electricity & heat sensors on the device.

alt text

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