Channel Actions - SUPLA/supla-cloud GitHub Wiki

Action name Additional parameters Example parameters
READ (1000)
SET (2000)
EXECUTE (3000)
INTERRUPT (3001)
INTERRUPT_AND_EXECUTE (3002)
OPEN (10)
CLOSE (20)
SHUT (30) percentage an integer from 0 to 100 meaning how much to shut; optional, default 100 {"percentage":40}
REVEAL (40) percentage an integer from 0 to 100 meaning how much to shut; optional, default 100 {"percentage":60}
REVEAL_PARTIALLY (50) percentage an integer from 0 to 100 meaning how much to shut; optional, default 100 {"percentage":60}
SHUT_PARTIALLY (51) percentage an integer from 0 to 100 meaning how much to shut; optional, default 100 {"percentage":40}
TURN_ON (60)
TURN_OFF (70)
SET_RGBW_PARAMETERS (80) new color for the device in one of the described formatsbrightness an integer from 0 to 100 meaning the brightness of the white controller (or dimmer); optional, default 0 {"color":"0x00FF00","brightness":70} {"color":362537,"color_brightness":20,"brightness":70} {"brightness":50} {"color":"random","color_brightness":100}
OPEN_CLOSE (90)
STOP (100)
TOGGLE (110)
OPEN_PARTIALLY (120)
CLOSE_PARTIALLY (130)
UP_OR_STOP (140)
DOWN_OR_STOP (150)
STEP_BY_STEP (160)
COPY (10100) sourceChannelId - the ID of the channel which state should be copied from {"sourceChannelId":123}
Channel Function Possible actions
NONE (0) -
SCENE (2000) EXECUTE (3000), INTERRUPT (3001), INTERRUPT_AND_EXECUTE (3002)
CONTROLLINGTHEGATEWAYLOCK (10) OPEN (10)
CONTROLLINGTHEGATE (20) OPEN (10), CLOSE (20), OPEN_CLOSE (90), COPY (10100)
CONTROLLINGTHEGARAGEDOOR (30) OPEN (10), CLOSE (20), OPEN_CLOSE (90), COPY (10100)
THERMOMETER (40) -
HUMIDITY (42) -
HUMIDITYANDTEMPERATURE (45) -
OPENINGSENSOR_GATEWAY (50) -
OPENINGSENSOR_GATE (60) -
OPENINGSENSOR_GARAGEDOOR (70) -
NOLIQUIDSENSOR (80) -
CONTROLLINGTHEDOORLOCK (90) OPEN (10)
OPENINGSENSOR_DOOR (100) -
CONTROLLINGTHEROLLERSHUTTER (110) SHUT (30), REVEAL (40), REVEAL_PARTIALLY (50), SHUT_PARTIALLY (51), STOP (100), COPY (10100)
CONTROLLINGTHEROOFWINDOW (115) SHUT (30), REVEAL (40), REVEAL_PARTIALLY (50), SHUT_PARTIALLY (51), STOP (100), COPY (10100)
OPENINGSENSOR_ROLLERSHUTTER (120) -
OPENINGSENSOR_ROOFWINDOW (125) -
POWERSWITCH (130) TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
LIGHTSWITCH (140) TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
DIMMER (180) SET_RGBW_PARAMETERS (80), TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
RGBLIGHTING (190) SET_RGBW_PARAMETERS (80), TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
DIMMERANDRGBLIGHTING (200) SET_RGBW_PARAMETERS (80), TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
DEPTHSENSOR (210) -
DISTANCESENSOR (220) -
OPENINGSENSOR_WINDOW (230) -
MAILSENSOR (240) -
WINDSENSOR (250) -
PRESSURESENSOR (260) -
RAINSENSOR (270) -
WEIGHTSENSOR (280) -
WEATHER_STATION (290) -
STAIRCASETIMER (300) TURN_ON (60), TURN_OFF (70), TOGGLE (110), COPY (10100)
ELECTRICITYMETER (310) -
IC_ELECTRICITYMETER (315) -
IC_GASMETER (320) -
IC_WATERMETER (330) -
IC_HEATMETER (340) -
THERMOSTAT (400) TURN_ON (60), TURN_OFF (70), TOGGLE (110)
THERMOSTATHEATPOLHOMEPLUS (410) TURN_ON (60), TURN_OFF (70), TOGGLE (110)
VALVEOPENCLOSE (500) OPEN (10), CLOSE (20)
VALVEPERCENTAGE (510) -
GENERAL_PURPOSE_MEASUREMENT (520) -
ACTION_TRIGGER (700) -
DIGIGLASS_HORIZONTAL (800) SET (2000)
DIGIGLASS_VERTICAL (810) SET (2000)

Time: 50 ms, Memory: 6.00 MB

OK, but incomplete, skipped, or risky tests! Tests: 1, Assertions: 0, Risky: 1. Process finished with exit code 0