Generate Generic SDI-12 Script

SDI-12 sensors that are not already listed in the X2 sensor script library can be configured to communicate with the X2 by generating a generic SDI-12 script.

SDI-12 Script Utility

1. Connect the X2 logger to a PC and launch the CONNECT software. Test connection by reading the RTC clock of the logger in the CONFIG tab.
2. On the CONFIG tab, click the drop down arrow to the right of the Create Script button and select Generic SDI-12.

 

3. The Script Utility menu will appear.

 

SDI-12 Script Specifications

The following specifications must be outlined in the Generic SDI-12 script.

1. Manufacturer – By default, this parameter will be Generic. However, a list of common manufacturers and their respective sensors are also available. Specifying the manufacturer and sensor name has the following effects over generic:
   1. The available parameter list is narrowed down to only those that typically apply to the selected sensor (Show All can be checked to remove this filter).
   2. The sensor’s default parameter output is automatically placed in the Selected Parameters column (this list can still be manually edited).
   3. The sensor model name will be sent by the X2 to WQData LIVE instead of being listed as a Generic sensor type.

 

2. Port – Specify the X2 sensor port the device will be connected to (P0, P1, or P2).

 

3. Power – Select the power type required for the sensor.
   1. Switch – turns on power to the listed sensor port at a specified period of time ahead of each scheduled reading. Power is turned off once the data for the reading has been collected by the X2. The Warmup field determines how long the sensor will be powered in advance of each reading.
      • For most sensors, 30 seconds will be sufficient, but check with the manufacturer specifications. Occasionally, longer warmup periods are required for sensors to reach their peak accuracy rating.
      • In general, sensors deployed with internal batteries should not use switch power. In between readings, when the X2 port power is off, the internal sensor batteries will drain and this can lead to communication issues once they are exhausted. Either remove batteries or select the Continuous power option.
   2. Continuous – the specified X2 sensor port will have power applied constantly. This is typically less power efficient, but depending on the sensor type can be a requirement (ex. weather sensors running continuous rain/wind averaging calculations).
   3. None – the listed X2 sensor port will not receive power and internal batteries will power the sensor.

 

4. SDI-12 Address & Measurement Command – Select the SDI-12 address that is assigned to the sensor as well as which measurement command (Meas Cmd) should be sent to it by the X2 each scheduled reading.
   1. If unsure which measurement command to use, consult the manufacturer’s manual for the sensor and note the parameter output response to each.

5. Available Parameters – Construct the appropriate parameter output list for the sensor by assigning parameters to the Selected Parameters column using the Add/Remove/Move Up/Move Down buttons.
   1. The total number and ordering of parameters for the script must match the parameter output for the sensor.
   2. If the sensor outputs a diagnostic or undesirable parameter as a part of its measurement command, it can be omitted from logging to the X2. Substitute the _None parameter into its position on the Selected Parameters list.

 

6. Once the script settings have been outlined, click Generate Script in the bottom right corner of the menu, assign a script number and click OK.
   1. If multiple generic scripts will be created for the X2, assign a unique value to each.
   2. If modifications need to be made to an existing generic script, assign the same script number to overwrite the original.

7. The generic script will be saved in the CONNECT software folder.

 

8. Follow the Configure Sensor Scripts document to:
   1. Transfer the new script to the X2 (demonstrated in the Add/Update Sensor Scripts section).
   2. Read the existing X2 script list (shown in the Show Enabled Sensors section).
   3. Enable the custom script to run during sensor detection (demonstrated in the Modify Sensor Detection List section).
9. Connect all sensors, apply 12V power and run sensor detection in CONNECT (alternatively, by queuing the Sensor (Auto)Detection command from WQData LIVE or through the X2 embedded web).
10. Once the detection command is received, the generic script will be run. As long as the sensor responds to the X2 according to the script settings, it will be identified, and data collection and posting to WQData LIVE will begin.