Sensor Configuration from Scratch

Workflow

The basic work flow consists of four steps.

Detailed Workflow

  1. Create a Component Instance, this is a "child" of the component template and holds individual model information
  2. Create a Site Template, this is derived from the component and holds custom configuration such as the device parameters (e.g. Modbus address, registers), automation rules, calibration or special thresholds. A best practice is to create one site template for each location that has similar hardware sensors/devices/components installed.
  3. Assign the Site Template to the location (remote site)
  4. Customize the Location Site Template for the Location, these settings (e..g specific IP address) override the basics of the site template and are specific to one location.

Create a Component Instance

An existing component is the base of a new instance. You can use the generic Modbus TCP component as a template to create your individual instance that matches the setup of the device, e.g. number of inputs and outputs and the register settings.

Create the instance:

  1. Go to Config/ProvisioningComp. Instances.
  2. Click + Add button and a new view will be opened listing existing components.
  3. Select Generic Modbus TCP I/O Device and set the name, here ADAM-6050, for the New Instance.
  4. Click Add or Add and Edit button that will create new component instance and close the modal window or navigate to instance editor page.

Customize the Component Instance

Model (but not location specific) parameters such as the Modbus register for the inputs and outputs are defined in the component instance. These settings are always the same for this particular model.

Digital Inputs

  1. Go to Config/ProvisioningComp. Instances.
  2. Locate the instance ADAM-6050 and click Edit
  3. Select Toggle S/U Normal Mode to open the editable view as a super user.
  4. Navigate in the left hand component tree to Sensors → Digital_Input_1 

  5. Open in the element tree (right hand) sensor → sensors_gateway → demux → keys → key
  6. Set the register to 101 in the Value row and click

Digital Outputs / Actions

The digital outputs in our example can be switched on/off by writing a 0 (OFF) or a 1 (ON) into the coil register per output. This is a Modbus command (see step number 6).

  1. Go to Config/ProvisioningComp. Instances.
  2. Locate the instance ADAM-6050 and click Edit
  3. Select Toggle S/U Normal Mode to open the editable view as a super user.
  4. Navigate in the left hand component tree to Actions → Switch_Digital_Output_1 
  5. Open in the element tree (right hand)  action → commands → command → value
  6. Change the command and set the appropriate register for Output 1, here it is 301. Command syntax is  as follows: write_single_coil(<Modbus_Register>, <Value>)

  7. Save your changes with a click on


Create a Site Template

The previously created component instance is the base for a new site template.

Create the site template from the component instance:

  1. Go to Config/Provisioning → Site Templates.
  2. Click + Add and when modal window opens set your Name, a good practice is to set this according to your location name, here Berlin-101 and save your changes.
  3. From Site Templates table, find your newly created Site Template and click on the Edit button.
  4. Select Toggle S/U Normal Mode to open the editable view as a super user.
  5. Click + Component button, a new view opens where the base component will be selected
  6. Select the Instances tab and choose ADAM-6050
  7. All included objects, such as sensors or actions, are now listed. Select the ones required and click add for every input (here 12) and output (here 6) of the device.
  8. Select and add the Actions for your digital outputs. There will allow you to remotely switch those outputs later on (e.g. in Admin Live Table)
  9. The new sensors and action are now listed in the tree

Assign the Site Template

After the creation of the site template it needs to be assigned for your location. The assignment won't apply any changes to your locations sensor configuration yet.

To assign a site template:

  1. Go to My Organization and find your location by name
  2. Choose Details from the right, this opens the location parameters view
  3. Go to the Gatways tab
  4. Go to Assign New and select the correct Sensor Config in the drop down menu
  5. Press Save
  6. Click Save

Customize the Location (Site) Template

You can customize the parameters that are individual for particular sites through the Location Template, which is derived from the previously assigned Site Template. Settings like the IP address the Modbus TCP I/O module or sensor thresholds are examples for location specific settings you can configure.

For our example, we have to set the IP address 192.168.0.100 for our location.

To set the right IP address:

  1. Go to My Organization and click on (location template link)
  2. Select Toggle S/U Normal Mode to open the editable view as a super user.
  3. Navigate in the left hand component tree to Devices → dev_Generic_MODBUS_TCP
  4. Open in the element tree (right hand) device → modbus_device → modbus_tcp → address
  5. Edit the address field and enter the IP address 192.168.0.100
  6. Click to save your changes and select Toggle S/U Normal Mode to leave the super user mode.


Deploy the Sensor Configuration

After the configuration is done we need to deploy the configuration to our Berlin-101 location.

To deploy the prepared configuration:

  1. Go to My Organization, navigate to Berlin-101 location and click on right hand side.
  2. Click Actions → schedule which opens the deployment view
  3. Choose Deploy Sensor Config, and select Immediately
  4. Clicking Schedule will schedule an immediate deployment of the sensor configuration
  5. The deployment job will be shown in the bottom job overview

Best Practices

  • Versions: Create new versions for each change if your components or site templates
  • Keep Diversity Low: If possible, try to use the same ip addressing for each individual remote location, this will allow you to use one site template for many locations without any location specific customization
  • Site Templates per Region: If thresholds and rules differ by region: create a new version of your base site template that holds region specific customizations, e.g. higher thresholds for temperature sensors for warmer country regions