editor, translator
36
edits
Changes
changes for actual websocket api
<li>"request" - Type of request:
<li>"request" - Type of request:
<ul>
<ul>
<li>“getDevices” – request for getting the list of all devices;</li>
<li>“get-devices” – request for getting the list of all devices;</li>
<li>“getDeviceStatus” – request for getting device status;</li>
<li>“status-get” – request for getting device status;</li>
<li>“setDeviceStatus” – request for setting device status;</li>
<li>“status-set” – request for setting device status;</li>
<li>“status-subscribe” – request for subscribe events (WebSocket only)</li>
</ul>
</ul>
<syntaxhighlight lang="json" line>
<syntaxhighlight lang="json" line>
request:
request:
{"requestType":"getDevicesList","key":"ENTER_API_KEY"}
{"request":"get-devices", "status":"detailed"}
response:
response:
{
{
"response":"get-devices",
"devices":[
{
"addr":"158:21",
"type":"ir-receiver",
"name":"IR receiver",
"area":"Setup",
"status":{
"state":"undefined"
}
},
{
"addr":"158:40",
"type":"com-port",
"name":"RS232",
"area":"Setup",
"status":{
"state":"undefined"
}
}
],
"found":2
}
}
request:
request:
{"requestType":"getDeviceStatus","addr":"310:1","key":"ENTER_API_KEY"}
{"request":"status-get","addr":"158:240", "status":"detailed"}
response:
response:
{
{
"response":"status-get",
"devices":[
{
"addr":"158:240",
"type":"valve-heating",
"status":{
"state":"off"
}
}
],
"found":1
}
}
request:
request:
{"requestType":"setDeviceStatus","addr":"310:1","key":"ENTER_API_KEY","status":{"state": "on"}}
{"request":"status-set","addr":"999:250", "status":{"state":"off"}}
response:
response:
{
{
"response":"status-set",
"devices":[
{
"addr":"999:250",
"success":true
}
]
}
}
request:
request:
{"requestType":"getAllDevicesStatus","key":"ENTER_API_KEY"}
{"request":"status-subscribe","addr":"999:250"}
response:
response:
{
{
"response":"status-subscribe",
"devices":[
{
"addr":"999:250",
"status":"0x08"
}
],
"found":1,
"subscribed":1
}
}
request:
request:
{"requestType":"setDeviceStatusRaw","addr":"310:1","key":"0","status":{"state":"ff00"}}
{"request":"status-set","addr":"999:250", "status":"0x01"}
response:
response:
{
{
"response":"status-set",
"devices":[
"999:250"
]
}
}
</syntaxhighlight>
</syntaxhighlight>