Overview
This article serves as a reference for all the YAML fields that can be specified in the SIB.
Device Integration Reference
| Field (Key) | Type | Mandatory? | Example Value | Description |
| id | string | yes | RST_TILT | A unique ID for this device integration |
| name | string | yes | RST Tilt Digital | A friendly display name for this device integration |
| manufacturer | string | yes | RST | Manufacturer of this device |
| manufacturerLogoUrl | string | no | http://domain/rst_logo.png | Manufacturer Logo for this device |
| icon | string | no | smicon-device-tilt | Icon to represent this device. For a list of available icons that can be used see here. |
| language | string | yes | PYTHON | Chosen scripting language for this integration. Can currently be either JAVASCRIPT or PYTHON |
| deviceAdapter | map | no | deviceAdapter: syncSensor: |- function syncSensor(sensor) {} |
A map from code hook name to actual code. |
| sensors | list | no | sensors: - id: VOLTAGE_SDE mountType: fixed - id: TEMPERATURE_SDE mountType: fixed |
A list of sensor integration ids associated with this device and their mount type |
| controls | list | no | controls: - id: textInput modelPath: props.MUX_INDEX layout: first-column config: label: Index |
A list of UI controls. See here for more details on UI controls. |
| editOnly | boolean | no | true | if true, this device will not be able to be added to a THREAD using the +Device button |
| editableProps | list | no |
editableProps: [NOTES] |
A list of PropertyTypes that can be bulk edited thru the UI |
| help | container | no | help: | yaml object |
| help.text | string | no | Learn more about configuring devices | tooltip that appears above help icon |
| help.link | string | no | https://support.sensemetrics.com/hc/en-us/articles/204912609-Device-Configuration | url for the help icon for a device |
| adapterPassthru | string | no | GEONET_LOGGER_VW_SDE | Passthru to legacy sensemetrics code for the adapter running on the THREAD |
| remoteAdapterPassthru | string | no | GEONET_LOGGER_VW_SDE | Passthru to legacy sensemetrics code for the remote adapter running in the cloud |
| inputTypes | list | no | VW | Type of input for a device. Example values include FOUR_TO_TWENTY or VW |
| minThreadVersion |
string |
no |
7.25.30 |
Specifies the minimum THREAD version required to add a device of this type. If not specified, defaults to version 6.2.0 for all SDE devices |
Sensor Integration Reference
| Field (Key) | Type | Mandatory? | Example Value | Description |
| id | string | yes | PIEZOMETER_VW_GEOKON_SDE | A unique ID for this sensor integration |
| name | string | yes | Geokon Piezometer | A friendly display name for this sensor integration |
| icon | string | no | smicon-sensor-vibratingwire | Icon to represent this sensor. For a list of available icons that can be used see here. |
| defaultMetrics | list | yes | defaultMetrics: - id: P unit: ft_h20 - id: dP unit: ft |
List of metric and unit pairs that will show up by default when graphed |
| metrics | list | yes | metrics: - f - T |
List of metrics that this sensor tracks observations for. Must match in order with units below. |
| units | list | yes | units: - Hz - C |
List of units for each metric that this sensor tracks observations for. Must match in order with metrics above. |
| sensorPrefix | string | no | vw | Mainly for legacy purposes. Used as the prefix in the sensor id string e.g. d1/device/vw1/sensor |
| controls | list | no | controls: - id: textInput modelPath: props.MUX_INDEX layout: first-column config: label: Index |
A list of UI controls. See here for more details on UI controls. |
| editableProps | list | no |
editableProps: [NOTES] |
A list of PropertyTypes that can be bulk edited thru the UI |
| help | container | no | help: | yaml object |
| help.text | string | no | Learn more about configuring sensors | tooltip that appears above help icon |
| help.link | string | no | https://support.sensemetrics.com/hc/en-us/articles/208104826-Sensor-Configuration | url for the help icon for a sensor |
Node Integration Reference
| Field (Key) | Type | Mandatory? | Example Value | Description |
| id | string | yes | GEONET_SDE | A unique ID for this node integration |
| name | string | yes | Geonet | A friendly display name for this node integration |
| manufacturer | string | yes | Geokon | Manufacturer of this node |
| nodePrefix | string | yes | /ewn | Mainly for legacy purposes. Used as the prefix in the node id string e.g. /ewn/123456/node |
| icon | string | no | smicon-node | Icon to represent this device. For a list of available icons that can be used see here. |
| controls | list | no | controls: - id: textInput modelPath: props.MUX_INDEX layout: first-column config: label: Index |
A list of UI controls. See here for more details on UI controls. |
| editOnly | boolean | no | true | if true, this node will not be able to be added using the +Connection button |
| editableProps | list | no |
editableProps: [NOTES] |
A list of PropertyTypes that can be bulk edited thru the UI |
| help | container | no | help: | yaml object |
| help.text | string | no | Learn more about configuring nodes | tooltip that appears above help icon |
| help.link | string | no | https://support.sensemetrics.com/hc/en-us/articles/204982929-Nodes | url for the help icon for a node |
| adapterPassthru | string | no | GEONET__SDE | Passthru to legacy sensemetrics code for the node adapter running on the cloud |
Comments
0 comments
Please sign in to leave a comment.