Changes

Jump to navigation Jump to search
469 bytes removed ,  12:01, 23 June 2025
changes for actual websocket api
Line 24: Line 24:  
  <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>“setDeviceStatusRaw” – request for setting device status (status in hex format);</li>
+
<li>“status-subscribe” – request for subscribe events (WebSocket only)</li>
−
<li>“getAllDevicesStatus” – request for getting all devices status.</li>
   
        
 
        
 
</ul>
 
</ul>
Line 41: Line 40:  
<syntaxhighlight lang="json" line>
 
<syntaxhighlight lang="json" line>
 
request:
 
request:
−
{"requestType":"getDevicesList","key":"ENTER_API_KEY"}
+
{"request":"get-devices", "status":"detailed"}
 
   
 
   
 
response:
 
response:
 
{
 
{
−
    "requestType":"devicesList",
+
"response":"get-devices",
−
    "devices": [
+
"devices":[
−
        {
+
{
−
            "type": "lamp",
+
"addr":"158:21",
−
            "name": "Ceiling",
+
"type":"ir-receiver",
−
            "addr":"401:1"
+
"name":"IR receiver",
−
        },
+
"area":"Setup",
−
                     
+
"status":{
−
        {
+
"state":"undefined"
−
            "type": "conditioner",
+
}
−
            "name": "AC",
+
},
−
            "addr":"158:200",
+
{
−
            "t-min":"16",
+
"addr":"158:40",
−
            "t-delta":"16"
+
"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:
 
{
 
{
−
  "requestType" : "deviceStatus",
+
"response":"status-get",
−
  "status" : {
+
"devices":[
−
      "addr" : "310:1",
+
{
−
      "state" : "middle",
+
"addr":"158:240",
−
      "type" : "jalousie"
+
"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:
 
{
 
{
−
  "requestType":"setDeviceStatus",
+
"response":"status-set",
−
  "addr":"410:1",
+
"devices":[
−
  "status":{
+
{
−
    "state": "on"
+
"addr":"999:250",
−
  }
+
"success":true
−
 
+
}
 +
]
 
}
 
}
 
   
 
   
 
request:
 
request:
−
{"requestType":"getAllDevicesStatus","key":"ENTER_API_KEY"}
+
{"request":"status-subscribe","addr":"999:250"}
 
   
 
   
 
response:
 
response:
 
{
 
{
−
    "requestType":"allDevicesStatus",
+
"response":"status-subscribe",
−
    "statuses": [
+
"devices":[
−
      {
+
{
−
        "addr":"401:1",
+
"addr":"999:250",
−
        "state": "off",
+
"status":"0x08"
−
      },
+
}
−
     
+
],
−
      {
+
"found":1,
−
        "addr":"158:200",
+
"subscribed":1
−
        "state": "on",
  −
        "temp":"25",
  −
        "mode":"cool",
  −
        "fan":"low",
  −
        "vane-ver":"1",
  −
        "vane-hor":"4"
  −
      } 
  −
        ]
   
}
 
}
 
   
 
   
 
request:
 
request:
−
{"requestType":"setDeviceStatusRaw","addr":"310:1","key":"0","status":{"state":"ff00"}}
+
{"request":"status-set","addr":"999:250", "status":"0x01"}
 
   
 
   
 
response:
 
response:
 
{
 
{
−
  "addr" : "310:1",
+
"response":"status-set",
−
  "key" : "0",
+
"devices":[
−
  "requestType" : "setDeviceStatusRaw",
+
"999:250"
−
  "status" : {
+
]
−
      "state" : "ff00"
   
}
 
}
 
</syntaxhighlight>
 
</syntaxhighlight>
editor, translator
55

edits

Navigation menu