This table provides details on the custom properties created for the MultiTech gateway.

You must add definitions and decoder files to import if they do not display in the Files folder on the station. First follow the steps to add the files to either a JACE or a Windows/Linux system.

JACE installation

1. Open the Platform of the JACE.
2. Click File Transfer Client.
3. Transfer files from your computer to the Files folder on the JACE.

   

Windows/Linux installation

1. Go to the Files folder on the station.

   

2. Right-click in the blank area and choose Copy From. This opens a window for you to copy sensor definition files from your computer to the Station > Files folder.

   

Import a sensor definition

1. Click Import on the Sensor Definition Manager view to open the Import Sensor Definition window.

   

2. Enter the Manufacturer and Sensor Type details.

   

3. The Manufacturer field validates the following:
   1. Name must start with a letter
   2. Name may only contain alpha-numeric, hyphen, and underscore characters
   3. A maximum of 15 characters is allowed
4. The Sensor Type field validates the following:
   1. Sensor type must start with a letter
   2. Sensor type may only contain alpha-numeric, hyphen, and underscore characters
   3. A maximum of 32 characters is allowed
5. Click the folder icon to open a browser window to select the definition and decoder files. Add these files to the station Files folder before the import, as the scope of the file picker is only to this folder. It is your responsibility to select the correct files to add the sensor definition without errors.

   

6. Verify a new sensor definition appears both in Niagara and on the gateway. The Sensor Definition Manager view loads.
7. Review the import notification that appears when the sensor definition uploads. You will either see a success or a failure message.
   1. Import success:

      

   2. Import failure:

      

8. Verify a new sensor definition component appears under Sensor Definitions after successful import. It should contain the following properties:

   Property name	Purpose
   Manufacturer	Stores the manufacturer name. (Read Only)
   Sensor Type	Stores the sensor type information. (Read Only)
   Sensor Definition Information	Stores the sensor definition file contents. (Read Only)
   Sensor Description	Stores the description from the sensor definition file. (Read Only)

   

1. Click the delete icon under Options for a row to delete a sensor definition.

   

2. Click OK in the verification window to remove the sensor definition from both Niagara and the gateway. Click Cancel to return to the Sensor Definition Manager view.

   

3. Review the deletion notification that appears when you delete a sensor definition. You will either see a success or a failure message.
   1. Delete success

      

   2. Delete failure

      

4. Verify the sensor definition component no longer contains the deleted sensor definition.

1. Click Add on the Sensor Definition Manager view to launch the Template view.

   

2. Wait for the Template view to load.

   

3. Review the Template view, which has three sections:
   1. General Configuration - This section has a Name field and a Sensor Definition field.
      1. Name – A text field with a max length of 256 characters.
      2. Sensor Definition – A drop-down list of sensor definitions in Niagara.
   2. LoRaWAN Device Details - This section has three drop-down list fields for Class, Device Profile, and Network Profile.
      1. Class – A drop-down list of three pre-defined options of A, B, and C.
      2. Device Profile – A drop-down list of the pre-defined device options:"", “LW102-OTA-US915", "LW102-OTA-AU915", "LW102-OTA-EU868", "LW102-OTA-AS923", "LW102-OTA-KR920", "LW102-OTA-IN865”.
      3. Network Profile – A drop-down list of the pre-defined options: "", "DEFAULT-CLASS-A", "DEFAULT-CLASS-B", "DEFAULT-CLASS-C”.
   3. BACnet Objects - This section contains a table of BACnet objects defined from sensor definitions. The table contains filters for BACnet object types and text filters and allows users to add BACnet objects pre-populated from the selected sensor definition. The table contains 3 columns: Property, Object, and Options. The sensor definition JSON contains the desired BACnet properties to show.
4. Enter the desired template name in the Name field, which validates for the following:
   1. Empty, null, or not allowed
   2. Maximum of 256 characters allowed
5. Select from the drop-down lists for all remaining fields.
6. Click Add Object to add BACnet properties to the view. A window displays to select a property and type and enter a name for the BACnet object.

   

7. Select an available property from the Property drop-down list, then select an associated type for the selected property from the Type drop-down list. Enter a name for the BACnet object in the Name field and click OK to add the BACnet object to the list.

   

8. Click the edit icon under Options for a row to edit a BACnet object. A window displays to edit the property type and name.

   

9. Select a new associated type for the property from the Type drop-down list and edit the property name, if needed. Click OK to save your edits.

   

10. Click the delete icon under Options for a row to delete a single BACnet property. Click Delete All to delete all BACnet objects in the list. A confirmation message appears.

    

11. Click OK to confirm removal of all BACnet objects or click Cancel to return to the Template view.

    

12. Click Submit to create the template or click Cancel to return to the Sensor Definition Manager view.
13. Review the template notification that appears after you submit the new template. You will either see a success or a failure message.
    1. Add success:

       

    2. Add failure:

       

1. Double-click the Sensor Templates component under the gateway. The Template Manager view loads and displays all the templates available on Niagara.
2. Click the edit icon under Options for a row to edit a template created through Niagara.
3. Modify one or more of the following fields to edit a template for sensor definitions available in Niagara:
   1. Name
   2. Sensor Definition
   3. Class
   4. Device Profile
   5. Network Profile
   6. Add, edit, or delete BACnet objects
   7. Delete all BACnet objects

   

4. Review template details for sensor definitions not available in Niagara. The following actions are disabled for these sensor definitions:
   1. Add, edit, or delete BACnet objects
   2. Delete all BACnet objects

1. Double-click the Sensor Templates component under the gateway. The Template Manager view loads and displays all the templates available on Niagara.
2. Click the delete icon under Options for a row to delete a template created through Niagara. The delete action is disabled for sensor definitions and their templates not available in Niagara.

   

3. Click OK to confirm template deletion or click Cancel to return to the Template Manager view.

   

4. Review the delete notification that appears after you delete a template. You will either see a success or a failure message.
   1. Delete successful:

      

   2. Delete failure:

      

1. Click Download on the Sensor Manager view to export sensor details to a JSON file and download it locally.

   

2. Select where you want to save the JSON file in Niagara’s File Chooser window. The file name defaults to sensor-mappings.json, but you can edit this as needed. Click Save to save the file.

   

3. Review the JSON format of the downloaded file, if needed.

   

You must add the sensor JSON files to import if they do not display in the Files folder on the station.

Verify the sensor JSON file format consists of a JSONArray. Each sensor you add to a gateway must have a JSONObject in that array with a device eui, src, and manufacturer/type included.

[
  {
    "id": "00-11-12-11-11-11-11-11",
    "sensor": "mClimate/viki",
    "src": "lora"
  },
  {
    "id": "00-11-12-08-13-14-15-16",
    "sensor": "mClimate/viki",
    "src": "lora"
  }
]

JACE installation

1. Open the Platform of the JACE.
2. Click File Transfer Client.
3. Transfer files from your computer to the Files folder on the JACE.

   

Windows/Linux Station installation

1. Go to the Files folder on the station.

   

2. Right-click in the blank area and choose Copy From. This opens a window for you to copy sensor files from your computer to the Station > Files folder.

   

Import a sensor

1. Click Import on the Sensor Manager view to open the Import Sensor window.

   

2. Click the folder icon to open a browser window to select the sensor JSON files. Remember to add these files to the station Files folder before the import, as the scope of the file picker is only to this folder.

   

3. Select the JSON files in the File Chooser window. It is your responsibility to select the correct files to add the sensor definition without errors. Click OK to return to the Import Sensor window.

   

4. Click Import to start uploading the sensors to the gateway and Niagara. The new sensors load in the Sensor Manager view.
5. Review the import notification that appears when the sensor definition uploads. You will either see a success or a failure message.

   

1. Click Apply Template to create new sensors by applying a specific template. The Apply Template window appears.

   

2. Select a template type from the Sensor Type Template drop-down list to apply it to the sensors created in this view. The list includes all templates available in Niagara.

   

3. Enter an integer value in the BACnet Object Identifier Start Value field. The value must be between 0 and 4194302.
4. You can create sensors in two ways:
   1. Click Add and enter the following details:

      

      1. Device EUI: Must be an 8-byte hexadecimal value (pairs).
      2. APP EUI: Must be an 8-byte hexadecimal value (pairs).
      3. APP KEY: Must be a 16-byte hexadecimal value (pairs).

         

   2. Click Add in the window and verify the new sensor appears in the Apply Template view. Repeat for each sensor you want to add.

      

   3. Click the edit icon for a row under Options to edit a sensor or click the delete icon for a row under Options to delete a sensor.
   4. Click Import to import a JSON file containing sensor details (Device EUI, APP EUI, and APP KEY) instead of manually adding it in the Apply Template view.

      

   5. You must add the sensor JSON files to import if they do not display in the Files folder on the station.
      1. JACE installation:
         1. Open the Platform of the JACE.
         2. Open the File Transfer Client.
         3. Transfer files from your computer to the Files folder on the JACE.

            

      2. Windows/Linux Station installation:
         1. Go to the Files folder on the station.

            

         2. Right-click in the blank area and choose Copy From. This opens a window for you to copy sensor files from your computer to the Station > Files folder.

            

5. Click Import and select the sensor JSON files, then click OK.

   

6. Verify the selected sensors appear in the Apply Template list and are ready to submit.

   

7. Click Submit to create the sensors with the applied template. For each sensor on the gateway, a corresponding component is created under the sensors component and automatically loads in the view.
8. Review the apply template notification that appears when the submission completes. You will either see a success or a failure message.
   1. Apply template success

      

   2. Apply template failure

      

1. Click Add Sensor to create a new sensor in the Sensor Manager view. The Add Sensor window appears.

   

2. Verify the correct source appears in the Source drop-down list or select a new one, then enter a unique 8-byte hexadecimal value (pairs) separated by hyphens in the Device EUI field.

   

3. Verify the correct manufacturer appears in the Manufacturer drop-down list or select a new one. This value populates from the sensor definitions available in Niagara.
4. Verify the correct type appears in the Type drop-down list or select a new one.
5. Click Add in the window to create the new sensor and verify it appears in the Sensor Manager view.
6. Verify a corresponding component appears under the sensors component and automatically loads in the view.
7. Review the add sensor notification that appears when the creation completes. You will either see a success or a failure message.
   1. Add sensor success

      

   2. Add sensor failure

      

1. Click the delete icon for a row under Options to delete a sensor.

   

2. Click OK to confirm template deletion or click Cancel to return to the Sensor Manager view.

   

3. Review the delete notification that appears after you delete a sensor. You will either see a success or a failure message.
   1. Delete successful

      

   2. Delete failure

      

1. Click the edit icon for a sensor row under Options to add, edit, or delete sensor BACnet properties.

   

2. The Edit Sensor view contains the following fields and controls:
   1. Device EUI: A drop-down list for selecting a sensor by device EUI, which automatically updates the Type and BACnet properties for the sensor
   2. Source: A read-only field indicating the sensor source
   3. Type: A read-only field indicating the sensor manufacturer and type
   4. Add Object: Click to add a new BACnet object
   5. Delete All: Click to delete all BACnet properties
   6. BACnet Objects table: A table listing all BACnet properties for the sensor, including pagination, text filtering, and filtering by type
   7. Edit or Delete: Click the edit or delete icon for a row under Options to edit or delete properties

   

3. Click Add Object to add a new BACnet property to a sensor.

   

4. The Add Object window contains the following fields:
   1. Property: A drop-down list of available properties for the sensor type
   2. Type: A drop-down list of BACnet properties based on the Property field, which updates whenever the property selection changes
   3. Identifier: Enter the OID for the BACnet property, which is a unique combination of identifier and type made up of integers between 0 and 4194302
   4. Name: Enter the name of the property, not to exceed 128 characters or be left blank
   5. Description: Enter the description of the property, not to exceed 128 characters or be left blank
5. Click OK to create the BACnet property on Niagara and the gateway and add it to the corresponding sensor. Review the object addition notification that appears when the submission completes and the property automatically loads in the table. You will either see a success or a failure message.
   1. Add object success

      

   2. Add object failure

      

6. Click Delete All to delete all BACnet properties for a sensor.

   

   1. Click OK to confirm you want to delete all BACnet objects for the sensor on Niagara and the gateway.

      

   2. Verify the Sensor Manager view updates to reflect the deletions. Review the delete notification that appears after you delete all. You will either see a success or a failure message.

      

7. Click the edit icon for a row under Options to edit a BACnet property.

   

   1. The Edit Object view contains the following fields and controls:
      1. Property: A read-only field showing the property for the selected BACnet object
      2. Type: A drop-down list of BACnet property types based on the Property field, which defaults to the current property's type
      3. Identifier: Edit the OID for the BACnet property, which is a unique combination of identifier and type made up of integers between 0 and 4194302
      4. Name: Edit the name of the property, not to exceed 128 characters or be left blank
      5. Description: Edit the description of the property, not to exceed 128 characters or be left blank

      

   2. Click OK to confirm your property updates or click Cancel to return to the Sensor Manager view.
   3. Review the update notification that appears when the refresh completes and the property updates automatically load in the table. You will either see a success or a failure message.
      1. Update success

         

      2. Update failure

         

8. Click the delete icon for a row under Options to delete a BACnet property.

   

   1. Click OK to confirm the property deletion on Niagara and the gateway or click Cancel to return to the Sensor Manager view.

      

   2. Review the delete notification that appears after you delete a property. You will either see a success or a failure message.