Channel Functions states - SUPLA/supla-cloud GitHub Wiki

Function State (example) Description
NONE {} -
CONTROLLINGTHEGATEWAYLOCK {"hi": true} hi is either true or false depending on paired opening sensor state; the hi value is provided only if the channel has param2 set (i.e. has opening sensor chosen)
CONTROLLINGTHEGATE {"hi": true, "partial_hi": false} hi is either true or false depending on paired opening sensor state; the hi value is provided only if the channel has param2 set (i.e. has opening sensor chosen); partial_hi is either true or false depending on paired secondary opening sensor state; the partial_hi value is provided only if the channel has param3 set (i.e. has secondary opening sensor chosen)
CONTROLLINGTHEGARAGEDOOR {"hi": true} see above
THERMOMETER {"temperature": 20.38} temperature contains current value of temperature provided by the sensor (including possibly configured delta adjustment), in Celsius
HUMIDITY {"humidity": 50.4} humidity contains current value of humidity provided by the sensor (including possibly configured delta adjustment), in percent; possible values from 0 to 100
HUMIDITYANDTEMPERATURE {"temperature": 20.38, "humidity": 50.4} see above
OPENINGSENSOR_GATEWAY {"hi": true} hi is either true or false depending on sensor state
OPENINGSENSOR_GATE {"hi": true} see above
OPENINGSENSOR_GARAGEDOOR {"hi": true} see above
NOLIQUIDSENSOR {"hi": true} see above
CONTROLLINGTHEDOORLOCK {"hi": true} see above
OPENINGSENSOR_DOOR {"hi": true} see above
CONTROLLINGTHEROLLERSHUTTER {"hi": true, "is_calibrating": false, "shut": 42} hi is either true or false depending on paired opening sensor state; the hi value is provided only if the channel has param2 set (i.e. has opening sensor chosen); the is_calibrating is true if the roller shutter has calibration in progres or if it hasn't been finished for whatever reason; shut is provided regardles off is_calibrating state and is an integer from 0 to 100, meaning the percantage of rolette being closed
OPENINGSENSOR_ROLLERSHUTTER {"hi": true} hi is either true or false depending on sensor state
POWERSWITCH {"on": true} on is either true or false depending on the switch state
LIGHTSWITCH {"on": true} see above
DIMMER {"brightness": 42} brightness contains current dimmer brightness value in percent, integer from 0 to 100
RGBLIGHTING {"color": "0x7A266B", "color_brightness": 42} color contains the integer (hex) value of a current color, ranging from 0x000001 to 0xFFFFFF; color_brightness is a color brightness in percent, integer from 0 to 100
DIMMERANDRGBLIGHTING {"brightness": 42, "color": "0x7A266B", "color_brightness": 42} see above
DEPTHSENSOR {"depth": 34.3} depth contains current sensor value
DISTANCESENSOR {"distance": 34.3} distance contains current sensor value
OPENINGSENSOR_WINDOW {"hi": true} hi is either true or false depending on sensor state
MAILSENSOR {"hi": true} see above
WINDSENSOR {"value": 34.3} value contains current sensor value
PRESSURESENSOR {"value": 34.3} value contains current sensor value
RAINSENSOR {"value": 34.3} value contains current sensor value
WEIGHTSENSOR {"value": 34.3} value contains current sensor value
WEATHER_STATION {}
STAIRCASETIMER {"on": true} on is either true or false depending on the switch state
ELECTRICITYMETER {"support":4095, "currency":"USD", "pricePerUnit":3.5326, "totalCost":176.1962, "phases":[{"number":1, "frequency":49.78, "voltage":239.22, "current":4.952, "powerActive":59.44942, "powerReactive":90.32455, "powerApparent":41.7422, "powerFactor":3.551, "phaseAngle":242, "totalForwardActiveEnergy":49.87719, "totalReverseActiveEnergy":69.84143, "totalForwardReactiveEnergy":34.21381, "totalReverseReactiveEnergy":82.65749}]} The support is a bitmask indicating which measurements are supported by the electricity meter. See this enumeration for more info. All not supported measurements will not be present in the response. The phases array contains as many objects as there are phases in the meter. The currency and unit might be null if not supplied by the user. Such state is available only when the channel type is ELECTRICITYMETER. If the channel type is IMPULSECOUNTER, then the state will be the same as for other impulse counters, e.g. GASMETER.
GASMETER {"totalCost":947, "pricePerUnit":500, "impulsesPerUnit":1000, "counter":1894, "calculatedValue":1.894, "currency":"USD", "unit":"m³"} The currency and unit might be null if not supplied by the user.
WATERMETER see above see above
THERMOSTAT {}
THERMOSTATHEATPOLHOMEPLUS {}