Skip to content

SUPLA Server commands

Wojciech Frącz edited this page Jan 7, 2021 · 6 revisions
Command Example When?
USER-RECONNECT:USER_ID USER-RECONNECT:1
  • Access ID deleted
  • Access ID changed
  • Channel settings edited
  • Channel group added
  • Channel group edited
  • Channel group deleted
  • IO Device edited
  • IO Device deleted
  • Location edited
  • Location deleted
  • User account deleted
CLIENT-RECONNECT:USER_ID CLIENT-RECONNECT:1
  • Client app's Access ID canged
  • Client app enabled/disabled
  • Client app deleted
  • Demo client app disabled
IS-CLIENT-CONNECTED:USER_ID,CLIENT_APP_ID IS-CLIENT-CONNECTED:1,2
  • When fetching Client's app's state for the list
IS-IODEV-CONNECTED:USER_ID,DEV_ID IS-IODEV-CONNECTED:1,2
  • Checking IO Device connected state
IS-CHANNEL-CONNECTED:USER_ID,DEV_ID,CHANNEL_ID IS-CHANNEL-CONNECTED:1,2,3
  • Checking channel connected state
  • Checking channel group connected state
GET-X-VALUE:USER_ID,DEV_ID,CHANNEL_ID GET-CHAR-VALUE:1,2,3 GET-RGBW-VALUE:1,2,3
  • Checking Channel's state
USER-ALEXA-CREDENTIALS-CHANGED:USER_ID USER-ALEXA-CREDENTIALS-CHANGED:1
  • Amazon Alexa hook settings updated
  • OAuth client removed
USER-GOOGLE-HOME-CREDENTIALS-CHANGED:USER_ID USER-GOOGLE-HOME-CREDENTIALS-CHANGED:1
  • Google Home hook settings updated
USER-GOOGLE-HOME-CREDENTIALS-CHANGED:USER_ID USER-GOOGLE-HOME-CREDENTIALS-CHANGED:1
  • Google Home hook settings updated
USER-STATE-WEBHOOK-CHANGED:USER_ID USER-STATE-WEBHOOK-CHANGED-CHANGED:1
  • State webhook settings updated
  • State webhook settings deleted
USER-MQTT-SETTINGS-CHANGED:USER_ID USER-MQTT-SETTINGS-CHANGED:1
  • MQTT Broker support enabled/disabled
  • MQTT Auth password changed
USER-ON-DEVICE-SETTINGS-CHANGED:USER_ID,DEV_ID USER-ON-DEVICE-SETTINGS-CHANGED:1,2
  • Channel settings changed
  • IO Device settings changed
USER-BEFORE-CHANNEL-FUNCTION-CHANGE:USER_ID,CHANNEL_ID USER-BEFORE-CHANNEL-FUNCTION-CHANGE:1,3
  • Before changing the channel's function
USER-BEFORE-DEVICE-DELETE:USER_ID,DEV_ID USER-BEFORE-DEVICE-DELETE:1,2
  • Before deleting the IO Device
USER-ON-DEVICE-DELETED:USER_ID,DEV_ID USER-ON-DEVICE-DELETED:1,2
  • After deleting the IO Device