Network Server Configuration

Overview

Purpose: The Network Server Configuration section guides you through setting up the LoRaWAN Network Server (NS) to integrate with the Locus platform. This includes configuring a data converter to ensure compatibility between the NS and Locus, as well as setting up the integration to enable data transmission.

Access: These configurations are performed directly on the LoRaWAN Network Server’s management interface, typically through its web dashboard or API, depending on the NS provider.

Intended Users: Admins or network engineers responsible for managing the Network Server and integrating it with external platforms like Locus.

Overview

Purpose: A data converter is required to transform incoming and outgoing data between the Network Server and Locus, ensuring that the data format is compatible with Locus’ requirements. The converter includes a decoder (for uplink data) and an encoder (for downlink data).

Conditions: You need administrative access to the Network Server to configure the data converter. Ensure that your NS supports custom data converters (e.g., via JavaScript or another scripting language).

Steps:

1. Access the Network Server Dashboard:

   • Log in to your LoRaWAN Network Server’s management interface.
   • Navigate to the section for managing applications or integrations (e.g., “Applications” or “Data Converters”).

2. Create a New Data Converter:

   • Find the option to add a new data converter (e.g., “Add Data Converter” or “Create Function”).
   • Name the converter (e.g., “LocusDataConverter”).
   • Select the scripting language supported by your NS (e.g., JavaScript).

3. Implement the Decoder:

   • In the decoder section, input the following JavaScript code to handle uplink data from devices:

     // Decoder for uplink data
     // Input object structure:
     // - bytes - int[]
     // - fPort - int
     // - recvTime - Date (needs type check)
     // - tektelicMetadata - Object
     function decodeUplink(input) {
         if (input.recvTime instanceof Date) {
             // Date operations can be performed if needed
         }
     // Output object structure:
     // - data - Object
     // - errors - string[]
     // - warnings - string[]
     // - tektelicMetadata - Object
     return {
         "data": {"bytes": input.bytes},
         "errors": [],
         "warnings": [],
         "tektelicMetadata": input.tektelicMetadata
     };
     

This decoder processes the incoming data, preserves the tektelicMetadata, and returns the data in a format compatible with Locus.

4. Implement the Encoder:

   • In the encoder section, input the following JavaScript code to handle downlink data to devices:

     // Encoder for downlink data
     // Input object structure:
     // - data - Object (customer-defined)
     
     function encodeDownlink(input) {
         // Output object structure:
         // - fPort - int
         // - bytes - int[]
         // - errors - string[]
         // - warnings - string[]
         return {
             "fPort": input.data.fPort,
             "bytes": input.data.bytes,
             "errors": [],
             "warnings": []
         };
     }
     

5. Save the Data Converter:

   • Save the data converter configuration on the Network Server.
   • Verify that the converter is active and associated with your application on the NS.

Expectations: The data converter is configured on the Network Server, ensuring that uplink and downlink data are correctly formatted for Locus integration.

Overview

Purpose: The integration setup on the Network Server enables data to be sent to Locus via an HTTPv2 endpoint. This ensures that device data (e.g., location, status) is transmitted to Locus for processing and tracking.

Conditions: You need administrative access to the Network Server to configure integrations. The data converter (configured in the previous section) must be active.

Steps:

1. Access the Network Server Dashboard:

   • Log in to your LoRaWAN Network Server’s management interface.
   • Navigate to the section for managing integrations (e.g., “Integrations” or “Application Integrations”).

2. Add a New Integration:

   • Find the option to add a new integration (e.g., “Add Integration”).
   • Select the integration type as HTTPv2.

3. Configure Integration Settings:

   • Name: Provide a name for the integration (e.g., “LocusIntegration”).

   • Type: Ensure the type is set to HTTPv2.

   • Data Converter: Select the data converter created earlier (e.g., “LocusDataConverter”).

   • Application Address: Specify the application address for Locus. This URL depends on the client’s tenant. Contact the development team to obtain the correct URL (e.g., https://tenant-specific.locus.tektelic.com).

   • Port: Set the port to 443.

   • Base Path: Set the base path to /v2/integration.

   • HTTPS: Enable HTTPS to ensure secure communication.

   • Request Headers:

     • Add the following header: ApiKey: ApiKey.
     • Note: Replace ApiKey with the actual API key provided by the Locus development team.

4. Save and Test the Integration:

   • Save the integration configuration on the Network Server.
   • Test the integration by sending a sample message from a device to verify that data is successfully transmitted to Locus (e.g., check the Locus dashboard for incoming data).

Expectations: The Network Server is now integrated with Locus, and device data is transmitted to the Locus platform via the configured HTTPv2 endpoint.