Appendix¶
Data Message Example¶
Example data message:
{
"ts": 1608416763.9,
"ambient": 25.83,
"current1": 0.16,
"angle": 1.7,
"pitch": -0.9,
"motion": 24,
"wifi_ip": "192.168.1.178",
"deviceid": "BD6AEDJQ2",
"vreg": 8.98,
"vsys": 4.09,
"vbat": 0,
"wifi_rssi": -32,
"light": 1,
"accel_x": 0.02,
"accel_y": -0.03,
"accel_z": -1.01,
"events": [
{
"msg": "Low",
"topic": "pitch",
"lv": 30
}
],
"pressure": 101.26,
"vin": 12.11,
"analog1": 0,
"roll": -1.5,
"can1": [
{
"data": "42C8590803FFD908",
"id": 419371762
},
{
"data": "4DE9BD3404AA7D34",
"id": 419372018
}
]
}
List of Data Keys¶
The following table lists all possible data measurement keys used by Senquip devices. Note: depending on device model and configuration, not all keys may be available.
Key |
Description |
Units |
---|---|---|
vsys |
Internal system voltage |
Volts |
vin |
Input supply voltage |
Volts |
vbat |
AA Battery Voltage |
Volts |
tamper |
Light sensor tamper status (0 or 1) |
|
gps_lat |
GPS Latitude |
|
gps_lon |
GPS Longitude |
|
gps_speed |
GPS Speed |
km/h |
ambient |
Internal Temperature |
°C |
capture1 |
Serial 1 Capture |
|
pitch |
Pitch of device |
degrees |
roll |
Roll of device |
degrees |
angle |
Angle of device |
degrees |
motion |
Motion/Vibration |
millig-g |
analog1 |
Analog Input 1 |
|
analog2 |
Analog Input 2 |
|
analog3 |
Analog Input 3 |
|
analog4 |
Analog Input 4 |
|
analog5 |
Analog Input 5 |
|
digital1 |
Digital Input 1 |
|
digital2 |
Digital Input 2 |
|
digital3 |
Digital Input 3 |
|
digital4 |
Digital Input 4 |
|
digital5 |
Digital Input 5 |
|
tc1 |
Thermocouple Input 1 |
°C |
freq1 |
Frequency Input 1 |
Hz |
duty1 |
Duty Cycle Input 1 |
% |
pulse1 |
Pulse Count Input 1 |
|
current1 |
Current Loop Input 1 |
|
current2 |
Current Loop Input 2 |
|
current3 |
Current Loop Input 3 |
|
current4 |
Current Loop Input 4 |
|
current5 |
Current Loop Input 5 |
|
mod1 |
Modbus Channel 1 |
|
mod2 |
Modbus Channel 2 |
|
mod3 |
Modbus Channel 3 |
|
mod4 |
Modbus Channel 4 |
|
mod5 |
Modbus Channel 5 |
|
mod6 |
Modbus Channel 6 |
|
mod7 |
Modbus Channel 7 |
|
mod8 |
Modbus Channel 8 |
|
mod9 |
Modbus Channel 9 |
|
mod10 |
Modbus Channel 10 |
|
can1 |
CANbus Channel 1 |
|
can2 |
CANbus Channel 2 |
|
state |
Current device state (0 to 6) |
|
state1_hrs |
Number of hours in device state 1 |
hours |
state2_hrs |
Number of hours in device state 2 |
hours |
state3_hrs |
Number of hours in device state 3 |
hours |
state4_hrs |
Number of hours in device state 4 |
hours |
state5_hrs |
Number of hours in device state 5 |
hours |
state6_hrs |
Number of hours in device state 6 |
hours |
motion_hrs |
Number of hours where vibration is above wake threshold |
hours |
vin_hrs |
Number of hours where Vin is above 9 volts |
hours |
movement_hrs |
Number of hours where GPS speed is equal or above 2 km/h |
hours |
gsm_iccid |
ICCID of SIM card |
|
gsm_imei |
IMEI of device |
|
gsm_carrier |
The mobile carrier |
List of Configuration Keys¶
Type |
Key |
Name |
Description |
Range |
Units |
Notes |
---|---|---|---|---|---|---|
string |
device.id |
Device ID |
Unique device serial number. |
readonly |
||
string |
device.model |
Device Model |
The device model number. |
readonly |
||
string |
device.fw |
Firmware Version |
The device firmware revision. |
readonly |
||
string |
device.hw |
Hardware Revision |
The device hardware revision. |
readonly |
||
string |
device.name |
Device Name |
A name for the device that is meaningful to the user. |
|||
integer |
device.base_interval |
Base Interval |
The time after which the device will wakeup to check which measurements need to be taken and if a transmission is scheduled. |
1 to 86400 |
Seconds |
|
integer |
device.transmit_interval |
Transmit Interval |
The number of base intervals after which a transmission is made. |
1 to 1000 |
||
integer |
device.exception_interval |
Exception Interval |
If a warning or alarm is active, this setting overrides the Transmit Interval, allowing an increased rate of transmission. |
1 to 1000 |
||
boolean |
device.always_on |
Device Always On |
If enabled the device will not sleep between Base Intervals and will remain awake. Not recommended for battery powered applications. |
|||
boolean |
device.batch_tx_enable |
Batch Transmit |
If enabled, all measurements at the Base Interval will be stored and transmitted at the Transmit Interval. Useful for low power optimisation. |
|||
boolean |
device.web_always_on |
Web Server |
This setting will keep the device webserver on all the time (while device is awake). Normally the websever is only available in setup mode. |
|||
boolean |
device.vin.alert_enable |
Power Loss Alert |
Sends and alert when voltage on the power input is below a fixed threshold. |
|||
boolean |
device.vin.sleep_enable |
Hibernate on Power Loss |
Puts the device into a low power state, when the power input is below a fixed threshold. The device will run off it’s internal backup battery and report periodically. |
|||
integer |
device.vin.sleep_delay |
Hibernate Delay Intervals |
The number of base intervals to wait after power loss before entering hibernate mode. |
0 to 1000 |
||
boolean |
device.vin.count_hours |
Count Hours |
Counts the number of hours the power input is active. Typically used as an engine hour meter when powered from ignition. |
|||
boolean |
device.batt.alert_enable |
AA Battery Low Alert |
Enable if an alert is to be sent when the AA battery level drops below a specified limit. |
|||
decimal |
device.batt.threshold |
Threshold |
The lower threshold at which an alert is raised. |
Volts |
||
boolean |
wifi.sta.enable |
Wifi |
Connect to existing Wifi connection specified below. |
|||
string |
wifi.sta.ssid |
SSID |
Wifi SSID to connect to. |
|||
password |
wifi.sta.pass |
Password |
Wifi password to use for connection. |
|||
string |
wifi.sta.ip |
Static IP Address |
Leave blank if assigned by DHCP. |
|||
string |
wifi.sta.netmask |
Static Netmask |
Leave blank if assigned by DHCP. |
|||
string |
wifi.sta.gw |
Static Gateway |
Leave blank if assigned by DHCP. |
|||
string |
wifi.sta.nameserver |
DNS Server |
Leave blank if assigned by DHCP. |
|||
boolean |
gsm.enable |
4G LTE |
Enable the 4G LTE connection. |
|||
string |
gsm.apn |
APN |
Access Point Name of mobile operator |
|||
string |
gsm.user |
Username |
Username for data connection. Leave blank if not specified |
|||
string |
gsm.pass |
Password |
Password for data connection. Leave blank if not specified |
|||
string |
tamper.name |
Name |
A name for the light sensor that is meaningful to the user. |
|||
boolean |
tamper.enable |
Tamper Alert |
This parameter determines if an alert is generated when the light sensor detects light or not. |
|||
string |
ambient.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
ambient.interval |
Interval |
The number of base intervals after which the temperature is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
decimal |
ambient.hysteresis |
Hysteresis |
The amount by which the measured value has to drop below the threshold to re-enable the alert after an event. |
0 to 100 |
°C |
|
string |
ambient.warning |
Warning |
Warning thresholds. Refer to user guide. |
-40 to 100 |
°C |
|
string |
ambient.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
-40 to 100 |
°C |
|
string |
accel.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
accel.interval |
Interval |
The number of base intervals after which the accelerometer is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
boolean |
accel.outputxyz |
Output XYZ Vectors |
Send X,Y,Z gravity vectors in data output. |
|||
decimal |
accel.hysteresis |
Hysteresis |
The amount by which the pitch, roll or angle has to exceed a threshold before triggering alarms or warnings. |
0 to 20 |
Degrees |
|
string |
accel.pitch.warning |
Pitch Warning |
Warning thresholds. Refer to user guide. |
-90 to 90 |
Degrees |
|
string |
accel.pitch.alarm |
Pitch Alarm |
Alarm thresholds. Refer to user guide. |
-90 to 90 |
Degrees |
|
string |
accel.roll.warning |
Roll Warning |
Warning thresholds. Refer to user guide. |
-90 to 90 |
Degrees |
|
string |
accel.roll.alarm |
Roll Alarm |
Alarm thresholds. Refer to user guide. |
-90 to 90 |
Degrees |
|
string |
accel.angle.warning |
Angle Warning |
Warning thresholds. Refer to user guide. |
0 to 90 |
Degrees |
|
string |
accel.angle.alarm |
Angle Alarm |
Alarm thresholds. Refer to user guide. |
0 to 90 |
Degrees |
|
string |
accel.motion.warning |
Vibration Warning |
Warning thresholds. Refer to user guide. |
0 to 5000 |
milli-g |
|
string |
accel.motion.alarm |
Vibration Alarm |
Alarm thresholds. Refer to user guide. |
0 to 5000 |
milli-g |
|
boolean |
accel.motion.wake_from_hibernate |
Wake from Hibernate |
The high warning vibration threshold is used to wake the device when hibernating. |
|||
decimal |
accel.motion.wake_threshold |
Vibration Wake Threshold |
The vibration threshold above which the device will wake from hibernation. |
1 to 2000 |
milli-g |
|
boolean |
accel.motion.count_hours |
Count Vibration Hours |
Counts the number of hours the device exceeds the Vibration Wake Threshold. Typically used as an machinery work vs idle hour meter. |
|||
string |
ble.name |
Name |
A name that is meaningful to the user. |
|||
string |
ble.addr |
Address |
The Bluetooth Address of this device. |
readonly |
||
integer |
ble.interval |
Interval |
The number of base intervals at which the Bluetooth module is turned on. Set to 0 to disable. |
0 to 10000 |
||
integer |
ble.scan_time |
Scan Time |
How long to scan for Bluetooth advertisements each interval. |
1 to 300 |
Seconds |
|
string |
ble.id_list |
Address Capture List |
List of addresses to be captured in HEX format, separated by a comma eg: AC233F6925AD. Leave blank to capture all. |
|||
boolean |
ble.send_data |
Send Raw Data |
Send all captured data in the standard data message. If unticked, data is only delivered to the scripting handler. |
|||
string |
gps.name |
Name |
A name for the GPS signal that is meaningful to the user. |
|||
integer |
gps.interval |
Interval |
The number of base intervals after which the gps is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
integer |
gps.maxtime |
Max Time |
Maximum time the device will wait for a valid GPS fix. |
0 to 3600 |
Seconds |
|
boolean |
gps.position.alert.enable |
Position Alert |
Sets whether a change in position generates an alert. |
|||
integer |
gps.position.alert.radius |
Radius |
An alert will be raised if the device moves further than this value from the expected position. |
1 to 10000 |
Meters |
|
integer |
gps.position.alert.hysteresis |
Hysteresis |
Once the alert is active or inactive, the radius must change by this value to change the alert state. |
1 to 10000 |
Meters |
|
decimal |
gps.position.alert.lat |
Expected Latitude |
Latitude at which the device is expected to be. |
-90 to 90 |
Degrees |
|
decimal |
gps.position.alert.lon |
Expected Longitude |
Longitude at which the device is expected to be. |
-180 to 180 |
Degrees |
|
boolean |
gps.speed.count_hours |
Count Movement Hours |
Counts the number of hours the device is moving according to the GPS speed. |
|||
boolean |
gps.speed.alert.enable |
Speed Alert |
Sets whether a change in speed generates an alert. |
|||
integer |
gps.speed.alert.threshold |
Threshold |
An alert will be raised if the device’s speed goes above this threshold. |
1 to 1000 |
km/h |
|
integer |
gps.speed.alert.hysteresis |
Hysteresis |
Once the alert is active or inactive, the speed must change by this value to change the alert state. |
1 to 1000 |
km/h |
|
string |
input1.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
input1.interval |
Interval |
The number of base intervals after which the input is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
preset |
input1.mode |
Mode |
Specifies the function of the IN1 terminal. The calibration, warnings and alarms are applied to this mode. |
Digital,Analog,Frequency,Duty Cycle |
||
decimal |
input1.digital.threshold |
Digital Threshold |
A threshold against which the input is compared to determine if the input state is ON or OFF. |
0 to 30 |
Volts |
|
decimal |
input1.digital.hysteresis |
Digital Hysteresis |
Once the input is in a certain state, hysteresis is the amount by which the input has to change before moving to the other state. |
0 to 20 |
Volts |
|
boolean |
input1.digital.count_hours |
Count Hours |
Counts the number of hours the digtial input is ON (above threshold). |
|||
boolean |
input1.digital.alert.enable |
Digital Change Alert |
Sets whether a change in digital state generates an alert. |
|||
string |
input1.cal |
Analog 1 Calibration |
Calibration parameters for Analog 1. Refer to user guide. |
|||
string |
input1.unit |
Unit |
The unit of measure associated with the calibration. Eg: Litres, RPM |
|||
string |
input1.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
input1.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
decimal |
input1.hysteresis |
Alarm/Warning Hysteresis |
Once the input is in a certain state, hysteresis is the amount by which the input has to change before moving to the other state. |
|||
boolean |
input1.pulse.enable |
Pulse Counting |
Enables counting of pulses in addition to frequency measurement. |
|||
integer |
input1.pulse.reset_value |
Reset Value |
The value at which the number of pulses counted on the input is reset to zero. |
1 to 2000000000 |
Counts |
|
decimal |
input1.pulse.scaling |
Pulse Scaling |
Multiplier to convert the pulse count to a useful unit. |
|||
string |
input1.pulse.unit |
Pulse Unit |
The unit of measure associated with the scaled pulse count. Eg: Litres |
|||
string |
input1.pulse.warning |
Pulse Warning |
Warning thresholds. Refer to user guide. |
|||
string |
input1.pulse.alarm |
Pulse Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
input2.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
input2.interval |
Interval |
The number of base intervals after which the input is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
preset |
input2.mode |
Mode |
Specifies the function of the IN2 terminal. The calibration, warnings and alarms are applied to this mode. |
Digital,Analog |
||
decimal |
input2.digital.threshold |
Digital Threshold |
A threshold against which the input is compared to determine if the input state is ON or OFF. |
0 to 30 |
Volts |
|
decimal |
input2.digital.hysteresis |
Digital Hysteresis |
Once the input is in a certain state, hysteresis is the amount by which the input has to change before moving to the other state. |
0 to 20 |
Volts |
|
boolean |
input2.digital.count_hours |
Count Hours |
Counts the number of hours the digtial input is ON (above threshold). |
|||
boolean |
input2.digital.alert.enable |
Digital Change Alert |
Sets whether a change in digital state generates an alert. |
|||
string |
input2.cal |
Analog 2 Calibration |
Calibration parameters for Analog 2. Refer to user guide. |
|||
string |
input2.unit |
Unit |
The unit of measure associated with the calibration. Eg: Litres, RPM, Volts |
|||
string |
input2.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
input2.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
decimal |
input2.hysteresis |
Alarm/Warning Hysteresis |
Once the input is in a certain state, hysteresis is the amount by which the input has to change before moving to the other state. |
|||
string |
output1.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
output1.interval |
Interval |
Does not affect output mode. The number of base intervals at which the input is sampled. Set to 0 to disable. Set to 1 for every base interval. |
0 to 10000 |
||
preset |
output1.mode |
Mode |
Specifies the function of the OUT1 terminal. |
Output,Digital,Analog |
||
boolean |
output1.warnings |
Warnings |
Determines if the output is turned on when a warning is active. |
|||
boolean |
output1.alarms |
Alarms |
Determines if the output is turned on when an alarm is active. |
|||
boolean |
output1.alerts |
Alerts |
Determines if the output is turned on when an alert is active. |
|||
integer |
output1.hold_time |
Hold Time |
Sets the time in seconds for which the output is held on after it is triggered. If set to zero, the output remains on while any exceptions are active. |
Seconds |
||
boolean |
output1.digital.alert.enable |
Digital Change Alert |
If enabled, a change in digital state will generate an alert. |
|||
string |
output1.cal |
Analog 3 Calibration |
Calibration parameters for Analog 3. Refer to user guide. |
|||
string |
output1.unit |
Unit |
The unit of measure associated with the calibration. Examples: Litres, RPM, Volts |
|||
string |
output1.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
output1.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
decimal |
output1.hysteresis |
Alarm/Warning Hysteresis |
Once the input is in a certain state, hysteresis is the amount by which the input has to change before moving to the other state. |
|||
string |
tc1.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
tc1.interval |
Interval |
The number of base intervals after which the thermocouple is measured and events are checked. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
decimal |
tc1.hysteresis |
Hysteresis |
The amount by which the measured value has to drop below the threshold to re-enable the event. |
-1000 to 1000 |
°C |
|
string |
tc1.type |
Type |
Determines the type of thermocouple connected. Valid values are: K, J, T, N, S, E, B and R |
|||
string |
tc1.warning |
Warning |
Warning thresholds. Refer to user guide. |
-1000 to 1000 |
°C |
|
string |
tc1.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
-1000 to 1000 |
°C |
|
string |
can1.name |
Name |
A name that is meaningful to the user. |
|||
integer |
can1.interval |
Interval |
The number of base intervals after which the CAN module is turned on. Set to 0 to disable. |
0 to 10000 |
||
integer |
can1.nominal_baud |
Nominal Baud Rate |
Baud rate for CAN communication. Supported values are: 125, 250, 500, 1000 |
kbit/s |
||
integer |
can1.capture_time |
Capture Time |
The device will capture matching messages for this length of time. |
Seconds |
||
boolean |
can1.tx_enable |
TX Enable |
Allows the device to transmit and acknowledge messages on the CAN bus. |
|||
string |
can1.id_list |
ID Capture List |
List of IDs to be captured in HEX format, separated by a comma eg: 18FEE60A. Leave blank to capture all. |
|||
boolean |
can1.send_data |
Send Raw Data |
Send all captured data in the standard data message. If unticked, data is only delivered to the scripting handler. |
|||
string |
can2.name |
Name |
A name that is meaningful to the user. |
|||
integer |
can2.interval |
Interval |
The number of base intervals after which the CAN module is turned on. Set to 0 to disable. |
0 to 10000 |
||
integer |
can2.nominal_baud |
Nominal Baud Rate |
Baud rate for CAN communication. Supported values are: 125, 250, 500, 1000 |
kbit/s |
||
integer |
can2.capture_time |
Capture Time |
The device will capture matching messages for this length of time. |
Seconds |
||
boolean |
can2.tx_enable |
TX Enable |
Allows the device to transmit and acknowledge messages on the CAN bus. |
|||
string |
can2.id_list |
ID Capture List |
List of IDs to be captured in HEX format, separated by a comma eg: 18FEE60A. Leave blank to capture all. |
|||
boolean |
can2.send_data |
Send Raw Data |
Send all captured data in the standard data message. If unticked, data is only delivered to the scripting handler. |
|||
string |
current1.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
current1.interval |
Interval |
The number of base intervals after which the input is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
preset |
current1.mode |
Mode |
Specifies the function of the SRC1 terminal. |
Current,Digital |
||
boolean |
current1.always_on |
Always On |
Determines if Switched Power is to be enabled permanently. |
|||
decimal |
current1.start_time |
Start Time |
Time in seconds that the output is turned on before measurements are taken. Allows an external device to stabilise. |
0 to 3600 |
Seconds |
|
boolean |
current1.digital.alert.enable |
Digital Change Alert |
Sets whether a change in digital state generates an alert. (Digital Mode Only) |
|||
string |
current1.cal |
Current 1 Calibration |
Calibration parameters for Current 1. Refer to user guide. |
|||
string |
current1.unit |
Unit |
The unit of measure associated with the calibration. Eg: Percent, Litres |
|||
string |
current1.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
current1.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
decimal |
current1.hysteresis |
Alarm/Warning Hysteresis |
The amount by which the calibrated current value has to drop below the threshold to re-enable the event. |
|||
string |
current2.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
current2.interval |
Interval |
The number of base intervals after which the input is sampled. A value of 1 means that the input is collected every base interval. Set to 0 to disable. |
0 to 10000 |
||
preset |
current2.mode |
Mode |
Specifies the function of the SRC2 terminal. |
Current,Digital |
||
boolean |
current2.always_on |
Always On |
Determines if Switched Power is to be enabled permanently. |
|||
decimal |
current2.start_time |
Start Time |
Time in seconds that the output is turned on before measurements are taken. Allows an external device to stabilise. |
0 to 3600 |
Seconds |
|
boolean |
current2.digital.alert.enable |
Digital Change Alert |
Sets whether a change in digital state generates an alert. (Digital Mode Only) |
|||
string |
current2.cal |
Current 2 Calibration |
Calibration parameters for Current 2. Refer to user guide. |
|||
string |
current2.unit |
Unit |
The unit of measure associated with the calibration. Eg: Percent, Litres |
|||
string |
current2.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
current2.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
decimal |
current2.hysteresis |
Alarm/Warning Hysteresis |
The amount by which the calibrated current value has to drop below the threshold to re-enable the event. |
|||
string |
serial1.name |
Name |
A name for the input that is meaningful to the user. |
|||
integer |
serial1.interval |
Interval |
The number of base intervals after which the serial port is turned on. Set to 0 to disable. |
0 to 10000 |
||
preset |
serial1.type |
Type |
The electrical interface type. |
RS232,RS485 |
||
boolean |
serial1.termination |
Termination Resistor |
This parameter enables the integrated termination resistor. |
|||
preset |
serial1.mode |
Mode |
Describes how the serial port is to be handled. CAPTURE: serial data is captured between start and end characters. MODBUS: serial data is treated according to MODBUS RTU standard |
Capture,Modbus,Scripted |
||
integer |
serial1.baud |
Baud Rate |
Baud rate for serial communication. Common values are: 4800, 9600, 19200, 38400, 57600, 115200 |
|||
string |
serial1.settings |
Settings |
A string describing the number of bytes: 7,8,9. Parity type: N(none), E(even), O(odd). Number of stop bits: 1 or 2. Typically: 8N1 |
|||
string |
serial1.capture.start |
Start String |
The serial port starts reading data when it detects these characters. Example: $GPGGA, serial data will be ignored until $GPGGA is received after which data will be captured. If nothing is specified, the serial port will capture all data until the timeout period is reached. |
|||
integer |
serial1.capture.start_idle_time |
Idle Time Before Start |
For a valid start condition, there must be this amount of idle time before receiving serial data. Additionally, the captured data will restarted if the serial port is idle for this time. Set to 0 to disable. |
0 to 60000 |
Milliseconds |
|
string |
serial1.capture.end |
End String |
Once capturing, if these characters are received, the serial port will stop capturing and will return to sleep. For binary data or escape sequences refer to the User Guide. |
|||
string |
serial1.capture.request |
Request String |
This string will be sent when the serial port is first turned on. Use this function to request data from a remote module. |
|||
integer |
serial1.capture.maxtime |
Max Time |
The device will wait this length of time for a valid capture. |
Seconds |
||
integer |
serial1.capture.maxchars |
Max Chars |
Maximum number of characters to be captured before the serial port goes back to sleep. |
|||
boolean |
serial1.capture.alert |
Alert on Capture |
If checked an alert will be raised on any successful serial capture. |
|||
decimal |
serial1.modbus.timeout |
Slave Timeout |
How long to wait for a response from each slave device. |
0 to 10 |
Seconds |
|
string |
mod1.name |
Modbus 1 Name |
A meaningful name for the measurement. |
|||
string |
mod1.settings |
Modbus 1 Settings |
Settings for Modbus Channel 1. Refer to user guide. |
|||
string |
mod1.cal |
Modbus 1 Calibration |
Calibration paramters for Modbus Channel 1. Refer to user guide. |
|||
string |
mod1.unit |
Modbus 1 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod1.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod1.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod2.name |
Modbus 2 Name |
A meaningful name for the measurement. |
|||
string |
mod2.settings |
Modbus 2 Settings |
Settings for Modbus Channel 2. Refer to user guide. |
|||
string |
mod2.cal |
Modbus 2 Calibration |
Calibration paramters for Modbus Channel 2. Refer to user guide. |
|||
string |
mod2.unit |
Modbus 2 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod2.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod2.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod3.name |
Modbus 3 Name |
A meaningful name for the measurement. |
|||
string |
mod3.settings |
Modbus 3 Settings |
Settings for Modbus Channel 3. Refer to user guide. |
|||
string |
mod3.cal |
Modbus 3 Calibration |
Calibration paramters for Modbus Channel 3. Refer to user guide. |
|||
string |
mod3.unit |
Modbus 3 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod3.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod3.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod4.name |
Modbus 4 Name |
A meaningful name for the measurement. |
|||
string |
mod4.settings |
Modbus 4 Settings |
Settings for Modbus Channel 4. Refer to user guide. |
|||
string |
mod4.cal |
Modbus 4 Calibration |
Calibration paramters for Modbus Channel 4. Refer to user guide. |
|||
string |
mod4.unit |
Modbus 4 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod4.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod4.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod5.name |
Modbus 5 Name |
A meaningful name for the measurement. |
|||
string |
mod5.settings |
Modbus 5 Settings |
Settings for Modbus Channel 5. Refer to user guide. |
|||
string |
mod5.cal |
Modbus 5 Calibration |
Calibration paramters for Modbus Channel 5. Refer to user guide. |
|||
string |
mod5.unit |
Modbus 5 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod5.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod5.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod6.name |
Modbus 6 Name |
A meaningful name for Modbus Channel 6. |
|||
string |
mod6.settings |
Modbus 6 Settings |
Settings for Modbus Channel 6. Refer to user guide. |
|||
string |
mod6.cal |
Modbus 6 Calibration |
Calibration paramters for Modbus Channel 6. Refer to user guide. |
|||
string |
mod6.unit |
Modbus 6 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod6.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod6.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod7.name |
Modbus 7 Name |
A meaningful name for the measurement. |
|||
string |
mod7.settings |
Modbus 7 Settings |
Settings for Modbus Channel 7. Refer to user guide. |
|||
string |
mod7.cal |
Modbus 7 Calibration |
Calibration paramters for Modbus Channel 7. Refer to user guide. |
|||
string |
mod7.unit |
Modbus 7 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod7.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod7.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod8.name |
Modbus 8 Name |
A meaningful name for the measurement. |
|||
string |
mod8.settings |
Modbus 8 Settings |
Settings for Modbus Channel 8. Refer to user guide. |
|||
string |
mod8.cal |
Modbus 8 Calibration |
Calibration paramters for Modbus Channel 8. Refer to user guide. |
|||
string |
mod8.unit |
Modbus 8 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod8.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod8.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod9.name |
Modbus 9 Name |
A meaningful name for the measurement. |
|||
string |
mod9.settings |
Modbus 9 Settings |
Settings for Modbus Channel 9. Refer to user guide. |
|||
string |
mod9.cal |
Modbus 9 Calibration |
Calibration paramters for Modbus Channel 9. Refer to user guide. |
|||
string |
mod9.unit |
Modbus 9 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod9.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod9.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod10.name |
Modbus 10 Name |
A meaningful name for the measurement. |
|||
string |
mod10.settings |
Modbus 10 Settings |
Settings for Modbus Channel 10. Refer to user guide. |
|||
string |
mod10.cal |
Modbus 10 Calibration |
Calibration paramters for Modbus Channel 10. Refer to user guide. |
|||
string |
mod10.unit |
Modbus 10 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod10.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod10.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod11.name |
Modbus 11 Name |
A meaningful name for the measurement. |
|||
string |
mod11.settings |
Modbus 11 Settings |
Settings for Modbus Channel 11. Refer to user guide. |
|||
string |
mod11.cal |
Modbus 11 Calibration |
Calibration paramters for Modbus Channel 11. Refer to user guide. |
|||
string |
mod11.unit |
Modbus 11 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod11.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod11.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod12.name |
Modbus 12 Name |
A meaningful name for the measurement. |
|||
string |
mod12.settings |
Modbus 12 Settings |
Settings for Modbus Channel 12. Refer to user guide. |
|||
string |
mod12.cal |
Modbus 12 Calibration |
Calibration paramters for Modbus Channel 12. Refer to user guide. |
|||
string |
mod12.unit |
Modbus 12 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod12.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod12.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod13.name |
Modbus 13 Name |
A meaningful name for the measurement. |
|||
string |
mod13.settings |
Modbus 13 Settings |
Settings for Modbus Channel 13. Refer to user guide. |
|||
string |
mod13.cal |
Modbus 13 Calibration |
Calibration paramters for Modbus Channel 13. Refer to user guide. |
|||
string |
mod13.unit |
Modbus 13 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod13.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod13.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod14.name |
Modbus 14 Name |
A meaningful name for the measurement. |
|||
string |
mod14.settings |
Modbus 14 Settings |
Settings for Modbus Channel 14. Refer to user guide. |
|||
string |
mod14.cal |
Modbus 14 Calibration |
Calibration paramters for Modbus Channel 14. Refer to user guide. |
|||
string |
mod14.unit |
Modbus 14 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod14.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod14.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod15.name |
Modbus 15 Name |
A meaningful name for the measurement. |
|||
string |
mod15.settings |
Modbus 15 Settings |
Settings for Modbus Channel 15. Refer to user guide. |
|||
string |
mod15.cal |
Modbus 15 Calibration |
Calibration paramters for Modbus Channel 15. Refer to user guide. |
|||
string |
mod15.unit |
Modbus 15 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod15.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod15.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod16.name |
Modbus 16 Name |
A meaningful name for Modbus Channel 16. |
|||
string |
mod16.settings |
Modbus 16 Settings |
Settings for Modbus Channel 16. Refer to user guide. |
|||
string |
mod16.cal |
Modbus 16 Calibration |
Calibration paramters for Modbus Channel 16. Refer to user guide. |
|||
string |
mod16.unit |
Modbus 16 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod16.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod16.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod17.name |
Modbus 17 Name |
A meaningful name for the measurement. |
|||
string |
mod17.settings |
Modbus 17 Settings |
Settings for Modbus Channel 17. Refer to user guide. |
|||
string |
mod17.cal |
Modbus 17 Calibration |
Calibration paramters for Modbus Channel 17. Refer to user guide. |
|||
string |
mod17.unit |
Modbus 17 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod17.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod17.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod18.name |
Modbus 18 Name |
A meaningful name for the measurement. |
|||
string |
mod18.settings |
Modbus 18 Settings |
Settings for Modbus Channel 18. Refer to user guide. |
|||
string |
mod18.cal |
Modbus 18 Calibration |
Calibration paramters for Modbus Channel 18. Refer to user guide. |
|||
string |
mod18.unit |
Modbus 18 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod18.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod18.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod19.name |
Modbus 19 Name |
A meaningful name for the measurement. |
|||
string |
mod19.settings |
Modbus 19 Settings |
Settings for Modbus Channel 19. Refer to user guide. |
|||
string |
mod19.cal |
Modbus 19 Calibration |
Calibration paramters for Modbus Channel 19. Refer to user guide. |
|||
string |
mod19.unit |
Modbus 19 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod19.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod19.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
string |
mod20.name |
Modbus 20 Name |
A meaningful name for the measurement. |
|||
string |
mod20.settings |
Modbus 20 Settings |
Settings for Modbus Channel 120. Refer to user guide. |
|||
string |
mod20.cal |
Modbus 20 Calibration |
Calibration paramters for Modbus Channel 120. Refer to user guide. |
|||
string |
mod20.unit |
Modbus 20 Unit |
The unit of measure associated with the calibration. |
|||
string |
mod20.warning |
Warning |
Warning thresholds. Refer to user guide. |
|||
string |
mod20.alarm |
Alarm |
Alarm thresholds. Refer to user guide. |
|||
boolean |
endpoint.config_to_portal |
Configuration via Senquip Portal |
Enables connection to Senquip Portal for remote configuration. |
|||
boolean |
endpoint.data_to_portal |
Send Data to Senquip Portal |
Enables data from the device to be sent to the Senquip Portal. |
|||
boolean |
endpoint.buffer_enable |
Offline Buffer |
Save data if device is offline, and send when network is available. |
|||
boolean |
endpoint.addtimedate |
Add Formatted Time |
This option adds a human readable time/date format to the data output. |
|||
boolean |
endpoint.network_report |
Report Network Info |
Add network details and signal strength to data output. |
|||
boolean |
endpoint.sq_data_format |
Use Senquip Data Format |
Automatically send the Senquip data message to the endpoints below (does not affect data to Senquip Portal). If unchecked, no data is sent and the device script should create messages. |
|||
boolean |
endpoint.udp.enable |
UDP |
Enables sending data over UDP to specified address below. |
|||
string |
endpoint.udp.address |
UDP Address |
Address and port to send data to. |
|||
boolean |
endpoint.http.enable |
HTTP POST |
Enables sending data via a HTTP POST request to address below. |
|||
string |
endpoint.http.address |
HTTP Address |
Destination address and port for HTTP POST request. |
|||
boolean |
endpoint.mqtt.enable |
MQTT |
Enables sending data to a MQTT broker. |
|||
string |
endpoint.mqtt.server |
Broker Address |
MQTT Broker Address and Port. |
|||
string |
endpoint.mqtt.client_id |
Client ID |
Client ID to send to the broker. Defaults to device.id if left blank. |
|||
string |
endpoint.mqtt.data_topic |
Data Topic |
Topic for Senquip formatted data messages. A single ‘?’ character will be replaced with the Device ID. Leave blank for ‘?/data’. |
|||
string |
endpoint.mqtt.user |
Username |
Username for MQTT authentication with username/password. (Optional) |
|||
string |
endpoint.mqtt.pass |
Password |
Password for MQTT authentication with username/password. (Optional) |