Sensor Object
The Sensor object represents a sensor connected to the thermostat. Sensors may not be modified using the API, however some configuration may occur through the web portal.
Properties
Name | Type | Read Only | Required | Description |
---|---|---|---|---|
name | String | yes | no | The sensor name |
manufacturer | String | yes | no | The sensor manufacturer |
model | String | yes | no | The sensor model |
zone | Integer | yes | no | The thermostat zone the sensor is associated with |
sensorId | Integer | yes | no | The unique sensor identifier |
type | String | yes | no | The type of sensor. Values: adc, co2, dryContact, humidity, temperature, unknown. |
usage | String | yes | no | The sensor usage type. Values: dischargeAir, indoor, monitor, outdoor. |
numberOfBits | Integer | yes | no | The number of bits the adc has been configured to use. |
bconstant | Integer | yes | no | Value of the bconstant value used in temperature sensors |
thermistorSize | Integer | yes | no | The sensor thermistor value, ie. 10K thermistor=10000, 2.5K thermistor=2500 |
tempCorrection | Integer | yes | no | The user adjustable temperature compensation applied to the temperature reading. |
gain | Integer | yes | no | The sensor thermistor gain value. |
maxVoltage | Integer | yes | no | The sensor thermistor max voltage in Volts, 5=5V, 10=10V. |
multiplier | Integer | yes | no | The multiplier value used in sensors (1000x value). |
states | State[] | yes | no | A list of SensorState objects |