How to integrate Tektelic Network Server with TagoIO

How to integrate Tektelic Network Server with TagoIO

This tutorial provides a step-by-step guide to integrate Tektelic with the TagoIO Platform. By following these instructions, you will enable uplink and downlink operations, allowing data exchange between your LoRaWAN devices and the TagoIO application.

Prerequisites

Before you begin, ensure you have the following:
  • Tektelic Account
  • LoRaWAN Device: Ensure your device is connect to Tektelic and transmitting data.

Step 1: Create Authorization in TagoIO

  1. Access Authorizations:
    1. Go to Devices.
    2. Click on Authorizations at the top of the page.
  2. Create a New Authorization:
    1. Click the Create Authorization button.
    2. Provide a meaningful name for the authorization (e.g., Tektelic-Integration).
    3. Click Save.
  3. Copy the Authorization Token:
    1. After creation, copy the authorization token. You will need this in later steps.

Step 2: Set Up Data Converter in Tektelic

Tektelic provides built-in data converters, but if you prefer using TagoIO's converter or if Tektelic lacks a specific converter for your device, follow these steps:
  1. Log in to your Tektelic Administrator Console.
  2. Navigate to Data Converters:
    1. Go to Data Converter section.
    2. Click the + button to create a new converter.
  3. Fill Converter Details:
FieldDescription
NameEnter a unique identifier (e.g., tagoio-decoder).
TypeSelect CUSTOM from the dropdown menu.
DecoderCopy the provided decoder script below
Encoder
Copy the provided encoder script below

Encoder:

  1. // Do not decode anything, just put it into AS as is 
  2. var arr = [];
  3. for (var i = 0; i < bytes.length; ++i) {
  4.     arr.push(bytes[i]);
  5. }
  6. return {"bytes": JSON.stringify(arr), "port": port, "payload length": bytes.length};​

Decoder:

  1. // Encode downlink messages sent in 
  2. // Base64 format as an array or buffer of bytes.
  3. function atob(input) {
  4.     var chars = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
  5.     var str = String(input).replace(/[=]+$/, ''); // #31: ExtendScript bad parse of /=
  6.     if (str.length % 4 === 1) {
  7.         throw new InvalidCharacterError("'atob' failed: The string to be decoded is not correctly encoded.");
  8.     }
  9.     for (
  10.         var bc = 0, bs, buffer, idx = 0, output = '';
  11.         buffer = str.charAt(idx++);
  12.         ~buffer && (bs = bc % 4 ? bs * 64 + buffer : buffer, bc++ % 4) ? output += String.fromCharCode(255 & bs >> (-2 * bc & 6)) : 0
  13.     ) {
  14.         buffer = chars.indexOf(buffer);
  15.     }
  16.     return output;
  17. }

  19. function base64ToArray(base64) {
  20.     var binary_string = atob(base64);
  21.     var len = binary_string.length;
  22.     var result = [];
  23.     for (var i = 0; i < len; i++) {
  24.         result.push(binary_string.charCodeAt(i));
  25.     }
  26.     return new Int8Array(result);
  27. }

  29. if (data.params) {
  30.     var bytes = base64ToArray(data.params.data);
  31.     return {"port": data.params.port, "bytes": bytes};
  32. }

  34. return {"port": 0, "bytes": [0x00]};

Data Converter


Step 3: Set Up Integration in Tektelic

  1. Navigate to Integrations:
    1. In the Tektelic console, go to Applications > Select Your Application > Integrations.
    2. Click the + button to add a new integration.
  2. Fill Integration Details:
FieldDescription
NameEnter a unique identifier (e.g., tagoio-integration).
TypeSelect TagoIO from the dropdown menu.
Data ConverterSelect the TagoIO converter you created earlier or you preferred converter.
Authorization
Add a header for Authorization and set its value to the authorization token you copied in Step 1.

Notes
After saving the integration, copy the HTTP URL path provided. This URL will be used to link Tektelic with TagoIO.

Step 4: Configure Authorization in TagoIO for Downlink Support (Optional)

  1. Edit Authorization:
    1. Return to your TagoIO Dashboard.
    2. Navigate to Account Settings > Authentication > Authorizations.
    3. Locate the previously created authorization and click the Edit (pencil) icon.
  2. Paste HTTP URL Path:
    1. In the authorization settings, paste the HTTP URL path copied from Tektelic.
    2. Endpoint Format:
      https://lorawan-ns-na.tektelic.com/api/v1/integration/http/xxxx 
      or
      https://lorawan-ns-eu.tektelic.com/api/v1/integration/http/xxxx
  3. Save Changes:
    1. After updating the URL, save the authorization settings.

Integration example


Save the Integration:

  • After filling in all the fields, click Save to create the webhook integration.

Step 5: Add Device in TagoIO

To integrate your device with the TagoIO Platform, follow these guidelines:
  1. Ensure Device EUI Consistency:
    1. When creating the device in TagoIO, use the exact same Device EUI that is configured in Tektelic.
    2. The Device EUI must match exactly to establish a successful connection between Tektelic and TagoIO.
  2. Select the Appropriate Network and Device Type:
    1. Choose the LoRaWAN Tektelic Network during the device setup process.
    2. Select the correct device type from the available options. If your device is not listed, you can add support through connectors.
  3. Add Device Support via Connectors (If Necessary):
    1. If your device type is not available in the default list, enhance its compatibility by utilizing connectors.
    2. For more information on available connectors and how to use them, refer to the Connector Overview.
For detailed instructions on adding devices, visit the Adding Devices page.


Finalizing Setup

  1. Power On Your Devices:
    1. Turn on your LoRaWAN device and gateway to initiate data transmission.
  2. Verify Data Reception:
    1. In TagoIO, navigate to the Device and into the Data tab to confirm that data is being received.
    2. Alternatively, use the Live Inspector within your device settings to monitor incoming data in real-time.

With data successfully flowing into TagoIO, you can start creating Dashboards, Analyses, and Actions to visualize and manage your device data effectively.