The device API is built according to the REST scheme, but is significantly simplified.
\nGET requests are used to get any information.
\nPOST requests are used to save or change data.
\nPOST requests are not available for all data, as some fields are immutable.
\nPOST requests should be sent as JSON in the body of the message.
\nRequests must be interpreted regardless of the closing slash “/”. When interpreted, all request URIs are lowercase.
\nWhen checking the parameter keys to match them, both the internal name and the name passed to the API must be lowercase.
\nFor example, requests seems like \"/Device/\" or \"/device/\" during parsing will be converted to the following form: \"/device\".
\nRequest with this form
\nPOST /Device» { \"Name\" : «Kitchen light»}\nWill be interpret as:
\nPOST /device» { \"name\" : Kitchen light\" }\nAll fields of the first-level object, in this case “name”, are additionally transferred to the requests inside the device as parameters, along with the parameters of the GET request, separated by &. This leads to the fact that for the device the list of parameters of the following queries is equivalent:
\nGET /device?name=Торшер\nPOST /Device» { «Name» : «Торшер»}\nUsed query types:
\nGET - get information from endpoint or made simple action \nPOST - update or set information \nDELETE - remove object or parameter\nAnswer codes:
\n200 - OK \n400 - Some mistake in query \n500 - Inner device error\nAll requests must be sent with Content-Type: Charset = UTF-8!
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"11774062","collectionId":"0ca63d64-4c32-4403-b33f-dd16081f0d71","publishedId":"SzzkddLg","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-06-18T12:33:04.000Z"},"item":[{"name":"UDP protocol","item":[{"name":"Alive!","id":"0ed2ca38-ff4d-4ee6-9f87-1816cc8d9e5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","description":"This packet is broadcasted every time the device receives power and starts up, or when it goes to the Wi-Fi network. Also, this packet is sent in a situation when the IP address of the device changes.
\nThe request should be sent after the device is ready to process incoming http (s) requests to it on the IP and port from which the request came.
\nDatagram of the message:
\nLOOKin:Alive! {device id}: {type code}: {power type}: {device IP}: {automation version}: {memory version}
or:
\nLOOKin:Alive!AA45B78C:03:01:192.154.11.8:0000F234:2000
This packet is sent broadcast every time one of the devices needs to get information about the others in the network.
\nThe device can either initiate this request or receive it.
\nIf a request is received without a parameter, each device that receives it responds to it.
\nIf the request is received with a parameter, then the response must be sent only by the device whose ID is specified in the datagram.
\nThe request should be sent after the device is ready to process incoming http (s) requests to it on the IP and port from which the request came.
\nRequest datagram:
\nLOOKin:Discover!
Datagram of the response:LOOKin:Alive!AA45B78C:03:01:192.154.11.8:0000F234:2000
This request can also contain the ID of the searched device in the datagram:
\nLOOKin:Discover!AA45B78C
Datagram of a response to a request with a parameter:
\nLOOKin:Alive! {device id}: {type code}: {device IP}
This packet is sent broadcast every time when the sensor state of one of the devices changes. This request serves the purpose of updating the state of the sensor for one or more control devices in the network.
\nDatagram of the message:
\nLOOKin:Updated! {device id}: {sensor id}:{event id}:{optional value}
or
\nLOOK.in:Updated! {device id}: {service name}:{value}:{optional value2}
For example:
\nLOOKin:Updated!AA45B78C:81:0:1
Please keep in mind that there 2 different Updated! datagram semantics: one for sensors, second one for services.
\nLOOKin:Updated! {device id}: {sensor id}:{event id}:{value}
Sent while one of device sensors are changed.
\nExamples:
\nIf IR signal recognized as NECx (protocol ID = 0x04) protocol with command 00012345
\nLOOKin:Updated!XXXXXXXX:87:04:00012345
If IR signal didnt recognized
\nLOOKin:Updated!XXXXXXXX:87:FF
LOOKin:Updated!XXXXXXXX:FF:00:01000154
For a meteorological sensor (ID 0xFE), the value contains the value of temperature and humidity.
\nThe resulting value 01000154 contains the temperature in hexadecimal * 10, humidity - similarly.
\nTemperature: 0x0100 = 256 = 25.6 degrees
\nHumidity: 0x0154 = 340 = 34%
\nThe sensor ID can also be a string, in which case it should be interpreted as the name of the device service.
\nLOOKin:Updated!AA45B78C:MQTT:2
means that local mqtt client was successeful connected.
MQTT statuses:
Unactive = 0
Connecting = 1
Connected = 2
Error = 3
Data service sended in 2 cases:
\nLOOKin:Updated!AA45B78C:Data:
This means that local remote with given UUID was changed. For example changed name of the local remote
\n2. PUT/POST query to /data// was made
\nLOOKin:Updated!AA45B78C:Data::
This means function with given ID was replaced/modified in local remote with given UUID. For example changed/added function with id 01 for local remote with UUID = ABC1
\nLOOKin:Updated!AA45B78C:Data:ABC1:01
This packet is sent broadcast every time a device plans to dispose of a BLE device in order to initiate a scenario on its behalf. This request informs other devices that the script has been accepted for execution and no longer needs to be executed.
\nDatagram of the message:LOOKin:Updated! {device id}: {scenario id}
Every parameter from answer can be get in plain\\text, for example:\n http://00000001.local/device/name
\n","urlObject":{"protocol":"http","path":["device"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"3c31b2c9-2703-4d74-ac0a-64cb3719d24a","name":"/device/id","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/device"},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"296"}],"cookie":[],"responseTime":null,"body":"00000001"},{"id":"40aea0b7-1510-407e-8ea3-b1cb560693a9","name":"/device","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/device"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"218"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Remote\",\n \"Status\": \"Running\",\n \"ID\": \"00000002\",\n \"Name\": \"\",\n \"Time\": \"1592501407\",\n \"Timezone\": \"+5\",\n \"PowerMode\": \"5v\",\n \"CurrentVoltage\": \"5889\",\n \"Firmware\": \"1.37\",\n \"Temperature\": \"65\",\n \"BluetoothMode\": \"public\",\n \"SensorMode\": \"0\"\n}"}],"_postman_id":"c2f75b44-56d3-463b-a91a-004427263f22"},{"name":"Update device information","id":"4cc96afa-1359-4c40-aeed-224ed1de8ce3","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"content-type":true,"host":true,"user-agent":true}},"request":{"method":"POST","header":[{"key":"Content-Type","type":"text","value":"text/plain; charset=utf-8"}],"body":{"mode":"raw","raw":"{\n\t\"name\"\t\t\t: \"Kitchen device\",\n\t\"time\"\t\t\t: \"1592501407\",\n\t\"timezone\"\t\t: \"+5\",\n\t\"sensormode\"\t: \"0\",\n\t\"bluetoothmode\"\t: \"private\"\n\t\"firmware\"\t\t: \"1.37\"\n}"},"url":"http://00000001.local/device/name","description":"All parameters in JSON is optional
\nname - device name to set\ntime - UTC timestamp\ntimezone - current device timezone\nsensormode - set if sensor mode is on or not\nbluetoothmode - set BLE mode, can be private or public\nfirmware - firmware to set, can be version string like \"1.37\" or full http address to firmware\nGet network information
\nEvery parameter from answer can be get in plain\\text, for example:\n http://00000001.local/network/mode
\nmode - wi-fi mode, can \"Client\" or \"AP\"\nIP - current device IP address\nCurrentSSID - current hotspot SSID if connected\nSavedSSID - array of saved hotspot credentials (displayed SSID only)\nMap - LOOK.in devices in this network that founded by this device\nEach map item consist:\n ID - founded device ID\n IP - founded device IP\n IsActive - is this device online or not.\n Type - string device type, for example \"Remote\" or \"Duo\"\nAt the time of launch, the device scans and searches for Wi-Fi networks nearby.\nThis request allows you to see founded wi-fi networks
\n","urlObject":{"protocol":"http","path":["network","scannedssidlist"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"ecbfa18d-902d-40f1-8eb1-0f9ff7380b55","name":"Get nearby hotspots list","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/network/scannedssidlist"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"280"}],"cookie":[],"responseTime":null,"body":"[\n \"SomeAP1\",\n \"SomeAP2\",\n \"SomeAP3\",\n \"SomeAP4\",\n \"SomeAP5\"\n]"}],"_postman_id":"1f5a019b-edfa-4d6c-b034-3af3bbddd8e7"},{"name":"Get all saved hotspots list","id":"4268ecf9-8154-42ec-83dc-09973f462d07","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"content-type":true,"host":true,"user-agent":true}},"request":{"method":"GET","header":[],"url":"http://00000001.local/network/SavedSSID","urlObject":{"protocol":"http","path":["network","SavedSSID"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"dd9bedc7-4734-4572-9341-d46f20c6bae5","name":"Get all saved hotspots list","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"text/plain; charset=utf-8","disabled":true}],"url":"http://00000001.local/network/SavedSSID"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"16"}],"cookie":[],"responseTime":null,"body":"[\n \"ssid1\",\n \"ssid2\"\n]"}],"_postman_id":"4268ecf9-8154-42ec-83dc-09973f462d07"},{"name":"Save or update Wi-Fi credentials","id":"01a5565b-1d86-496a-a764-44bb07cfbc73","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-length":true,"host":true,"user-agent":true,"accept":true,"connection":true,"accept-encoding":true,"content-type":true}},"request":{"method":"POST","header":[{"key":"Content-Type","value":"text/plain; charset=utf-8","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"WiFiSSID\":\"ssid\",\n\t\"WiFiPassword\":\"password\"\n}"},"url":"http://00000001.local/network","description":"Add new Wi-Fi hotspot credentials to array of access points to which device can be connected
\n","urlObject":{"protocol":"http","path":["network"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"0006e8e3-e906-4cab-8720-e4215187d94f","name":"Save Wi-Fi credentials","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n\t\"WiFiSSID\":\"ssid\",\n\t\"WiFiPassword\":\"password\"\n}"},"url":"http://00000001.local/network"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\": \"true\"\n}"}],"_postman_id":"01a5565b-1d86-496a-a764-44bb07cfbc73"},{"name":"Delete saved hotspot from saved","id":"d233a62d-d4ef-4eff-acec-4645dee31bc4","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"content-type":true,"host":true,"user-agent":true}},"request":{"method":"DELETE","header":[],"url":"http://00000001.local/network/savedssid/ssid1","urlObject":{"protocol":"http","path":["network","savedssid","ssid1"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"fb7cb010-2b78-4530-b6f5-0f0a4eebe3ed","name":"Delete hotspot with SSID \"ssid1\"","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","type":"text","value":"text/plain; charset=utf-8","disabled":true}],"url":"http://00000001.local/network/savedssid/ssid1"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"21"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"true\"\n}"}],"_postman_id":"d233a62d-d4ef-4eff-acec-4645dee31bc4"},{"name":"Connect to Wi-Fi hotspot","id":"005eb719-3714-472f-a5d8-1544f4bdd5ad","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"content-type":true,"host":true,"user-agent":true}},"request":{"method":"GET","header":[],"url":"http://00000001.local/network/connect","description":"The device compares the list of saved data of Wi-Fi access points and scanned access points. If matches are found, the device connects to the access point with the highest signal strength.
\nIn this request, you can also specify the SSID of the access point to which you want to connect device (see sample request)
\nIn examples also you can find example how to conenct to hotspot with hidden SSID
\n","urlObject":{"protocol":"http","path":["network","connect"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"c107b305-dcd4-48ae-aebc-46eab5c3af40","name":"Connect to hidden SSID","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"text/plain; charset=utf-8","disabled":true}],"url":{"raw":"http://00000001.local/network/connect/This function can be used with devices in which sensor mode is on.\nIn that case device periodicaly switch on wifi for a little time (exact time based on different conditions)\nThis enpoint allows to keep wi-fi on during heave operations
\nShould be invoked before operations batch.
\n","urlObject":{"protocol":"http","path":["network","keepwifi"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"2437b108-0d5f-4987-9c17-532fde4f1ea7","name":"Keep Wi-Fi on","originalRequest":{"method":"GET","header":[{"key":"Content-Type","type":"text","value":"text/plain; charset=utf-8","disabled":true}],"url":"http://00000001.local/network/keepwifi"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"true\"\n}"}],"_postman_id":"5fa4acd4-b5f2-4939-a8db-162298eb98e6"},{"name":"\"Remote control\" function management","id":"8dea2ab1-5acf-43ac-ae87-b28f133b6ece","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"accept":true,"accept-encoding":true,"connection":true,"content-length":true,"content-type":true,"host":true,"user-agent":true}},"request":{"method":"GET","header":[],"url":"http://00000001.local/network/remotecontrol/","description":"This endpoint helps to manage RemoteControl state
\nThere are 2 functions: stop and reconnect
\n","urlObject":{"protocol":"http","path":["network","remotecontrol",""],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"788447e5-4f03-4abc-bc11-ab0e4bac728c","name":"Reconnect to remote server","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/network/remotecontrol/reconnect"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\n \"success\": \"true\"\n}"},{"id":"d2aa5d9d-8af5-44bc-b1d5-6de451b0f852","name":"Stop remote control function","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/network/remotecontrol/stop"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8dea2ab1-5acf-43ac-ae87-b28f133b6ece"}],"id":"1987902e-9ef0-40f9-ad64-1ec873fec288","description":"Network section designed to store, receive and display network information of the device.
\n","_postman_id":"1987902e-9ef0-40f9-ad64-1ec873fec288"},{"name":"/automation","item":[],"id":"5bf7c4be-c3ea-498a-af54-31bc21f68273","description":"Documentation not ready yet
\n","_postman_id":"5bf7c4be-c3ea-498a-af54-31bc21f68273"},{"name":"/storage","item":[],"id":"595c8e64-286d-46ac-b2ee-4d97567cf81b","description":"Documentation not ready yet
\n","_postman_id":"595c8e64-286d-46ac-b2ee-4d97567cf81b"},{"name":"/sensors","item":[{"name":"Get sensors list","id":"a6370ed2-5b97-4777-b59b-28c660522edd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/sensors","urlObject":{"protocol":"http","path":["sensors"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"ab4c2eab-9f27-479c-b795-c64e90de75ae","name":"Sensors list for Remote2 device with connected temp sensor","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/sensors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6"}],"cookie":[],"responseTime":null,"body":"[\n \"IR\",\n \"Meteo\"\n]"},{"id":"fd73b5cc-7870-49f2-a4b5-f622cc620eae","name":"Sensors list for Remote device","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/sensors"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"6"}],"cookie":[],"responseTime":null,"body":"[\n \"IR\"\n]"}],"_postman_id":"a6370ed2-5b97-4777-b59b-28c660522edd"},{"name":"Get sensor value","id":"db5d685b-f67e-4386-a737-dca0bb1ff2f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/sensors/Sensors provide information on the status of the device.
\nEach device may correspond to several sensors or none at all.
\nThe sensor identifier after the 1st bit matches the identifier of the executing command. This is for easier correspondence between classes. Also, a corresponding sensor must correspond to any class of the command.
\nGet information about sensors supported by the device. For example, for Plug:
\nGET /sensors \n\nAnswer:\n[\"Switch\", \"Dimmer\"]\nFor example, getting information about whether or not Plug is enabled:
\nGET /sensors/switch \n\nAnswer:\n{ \n \"Value\" : \"1\", \n \"Updated\": \"1540987362\", \n}\nA sensor can have both primary and secondary values. Consider the more sophisticated IR sensor:
\nThe main value is the IR protocol code of the signal received by the device. 0x01 - IR protocol NEC1
\nThe Signal object contains the signal value in the context of the detected protocol
\nThe Frequency object contains information about the frequency of the received signal
\nRaw object contains raw timings of the received signal
\nGET /sensors/IR
\n Answer:\n {
\"Value\" : \"1\",
\"Updated\": \"1540987362\",
\"Signal\" : {
\"Value\" : \"00082000\",
\"Updated\": \"1540987362\",
},
\"Frequency\" : {
\"Value\" : \"38200\",
\"Updated\": \"1540987362\",
},
\"Raw\" : {
\"Value\" : \"+9024 -4512 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -1692 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -564 +564 -1692 +564 -564 +564 -1692 +564 -564 +564 -564 +564 -564 +564 -1692 +564 -1692 +564 -564 +564 -1692 +564 -564 +564 -1692 +564 -1692 +564 -1692 +564 -47652 +9024 -2256 +564 -96156\",
\"Updated\": \"1540987362\",
}
}
Each of the values can be obtained in Plain-Text form, for example:
\nGET /sensors/IR/signal/value \n\nAnswer:\n00082000\nWhen integrating devices into an existing system, it may be necessary to receive real-time notification of sensors
\nThis feature is provided by the fact that when the sensor state changes, the device sends a UDP broadcast packet with information about the change:
\nLOOK.in:Updated!C85611AF:87:01;\nUDP packet decomposition:
\n* \"LOOK.in:\" - packet prefix\n* \"Updated!\" - event description\n* 87 - sensor ID, 0x87 means - IR\n* 01 - sensor event - received NEC1 IR signal\nUsing UDP port is 61201
\n| Event ID | \nDescription | \nPossible operands | \n
| 0x00 | \nSwitch state | \nno operand | \n
| 0x01 | \nSwitch on | \nno operand | \n
| 0x02 | \nSwitch off | \nno operand | \n
| Event ID | \nDescription | \nPossible operands | \n
| 0x00 | \nMultiSwitch state (0 if all off or 1 if all on) | \nno operand | \n
| 0x10 | \nChannel 1 off | \nno operand | \n
| 0x11 | \nChannel 1 on | \nno operand | \n
...
\n| 0xN0 | \nChannel N off | \nno operand | \n
| 0xN1 | \nChannel N on | \nno operand | \n
| Event ID | \nDescription | \nPossible operands | \n
| 0x00 | \nMotion detection state | \nno operand | \n
| 0x01 | \nMotion detected | \nno operand | \n
| Event ID | \nDescription | \nPossible operands | \n
| 0x00 | \nIR state | \nno operand | \n
| 0xEE | \nReceived command, saved in Storage | \nCommand storage ID | \n
| 0xFF | \nReceived IR command | \nno operand | \n
Send command of predefined protocol, for example Nec1\nOperand must be 8 HEX symbol length
\n","urlObject":{"protocol":"http","path":["commands","ir","nec1","00820000"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"153a5020-b237-4e18-ab62-66b8bb4336db","name":"Send Nec1 IR protocol command with 00820000 operand","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/nec1/00820000"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\" : \"true\"\n}"}],"_postman_id":"b0dd8e48-163d-4bcc-85b5-7fe014280a7f"},{"name":"Send raw signal with default frequency","id":"1241f19b-68b2-45ff-b40b-bbc719d8634d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/raw/9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156","description":"Example of sending command in raw timings with the default frequency in 38 kHz
\n","urlObject":{"protocol":"http","path":["commands","ir","raw","9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"0eb8e507-0793-402d-a533-e0d7e93e0afc","name":"Send raw signal with default frequency","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/raw/9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\" : \"true\"\n}"}],"_postman_id":"1241f19b-68b2-45ff-b40b-bbc719d8634d"},{"name":"Send raw signal with setted frequency","id":"9cd9d09d-112c-49d2-b528-20cd9914f705","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/raw/40000;9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156","description":"Example of sending command in raw timings with the 40000 Hz frequency
\n","urlObject":{"protocol":"http","path":["commands","ir","raw","40000;9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"b0295e77-425c-4a56-be23-b5b2c1ed32cf","name":"Send raw signal with default frequency","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/raw/40000;9024 -4512 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -564 564 -564 564 -564 564 -1692 564 -564 564 -1692 564 -564 564 -564 564 -564 564 -1692 564 -1692 564 -564 564 -1692 564 -564 564 -1692 564 -1692 564 -1692 564 -47652 9024 -2256 564 -96156"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\" : \"true\"\n}"}],"_postman_id":"9cd9d09d-112c-49d2-b528-20cd9914f705"},{"name":"Send command in ProntoHEX format","id":"d3f3cb5b-fdd5-4252-b359-5f905a436259","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/prontohex/0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0622 015B 0057 0016 0E6C","description":"Example of sending command in ProntoHEX format\nSpaces might be missed
\n","urlObject":{"protocol":"http","path":["commands","ir","prontohex","0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0622 015B 0057 0016 0E6C"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"8a07f75b-d5c7-466a-979e-2ec16f58c510","name":"Send raw signal with default frequency","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/prontohex/0000 006C 0022 0002 015B 00AD 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0016 0016 0041 0016 0016 0016 0041 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0016 0041 0016 0016 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0041 0016 0622 015B 0057 0016 0E6C"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"success\" : \"true\"\n}"}],"_postman_id":"d3f3cb5b-fdd5-4252-b359-5f905a436259"},{"name":"Send NECx command","id":"df8b73c7-7e76-427b-857e-ee757c2d8870","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/necx/E0E040BF","urlObject":{"protocol":"http","path":["commands","ir","necx","E0E040BF"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[],"_postman_id":"df8b73c7-7e76-427b-857e-ee757c2d8870"},{"name":"Send command from saved IR device","id":"ca472130-23bf-4fbd-b3ae-0d57c2be7182","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/localremote/7D3601FF","description":"Operand is 8-hex digits string\nFirst 4 is local remote UUID\nFollowing 2 hex symbols is function code\nLast 2 hex symbols is function signal ID, generally - FF
\nFor example, \n7D3601FF
\n7D36 - UUID saved remote\n01 - power toggle signal ID\nFF - send best suitable signal
\n","urlObject":{"protocol":"http","path":["commands","ir","localremote","7D3601FF"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[],"_postman_id":"ca472130-23bf-4fbd-b3ae-0d57c2be7182"},{"name":"Send command from saved IR signal (Integrations->IR Signal in the App)","id":"f130d2c8-abdd-4fa1-b0b4-52fade69f38e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/saved/10","description":"If you saved IR signal in the App (through Integrations->IR Signals page) you can simply send it using this query.
\nGET http://IP/commands/ir/saved/ID
Where ID is uniq IR signal number that you can see in the App signals list.
\n","urlObject":{"protocol":"http","path":["commands","ir","saved","10"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[],"_postman_id":"f130d2c8-abdd-4fa1-b0b4-52fade69f38e"},{"name":"Send command to control AC unit","id":"b264ee38-14b9-45f6-a2fe-ca5dd0757c9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/ac/90142800","description":"To control your AC unit you can use simplified AC API.
\nTo use this API it is enought to use following enpoint: /commands/ir/ac/operand \nWhere operand consist of 8 HEX digits with this pattern CCCCMTFS
\nCCCC - AC unit codeset
\nM - AC unit mode:
\nT, Temperature. Required temperature in ℃ - 16℃. If T = 0 this means 16 ℃, if T = A this means 26℃
\nF. Fan value
\nS. Swing
\nFor example /commands/ir/ac/90142801\nmeans \"Setup my AC unit with codeset 9014 for cool mode 24℃. Fan auto, Swing move\"
\n","urlObject":{"protocol":"http","path":["commands","ir","ac","90142800"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"b58096f8-5b87-42cc-acc0-8bd0a7396dd1","name":"Send command to control AC unit","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/commands/ir/ac/90142800"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b264ee38-14b9-45f6-a2fe-ca5dd0757c9e"}],"id":"cfc591cd-5cee-470e-a58b-79a9e05845f5","_postman_id":"cfc591cd-5cee-470e-a58b-79a9e05845f5","description":""},{"name":"BLE Commands","item":[{"name":"Send BLE command","id":"8e6199f4-36de-4d43-a142-101b910a3fc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/commands/ble/kbd_key/Allow execute BLE remote command
\nBLE Command may take the following values:
\nMedia commands:
\nConsumer control:
\nKeyboard:
\nKeyboard keys:
\nAny ASCII char
\n","urlObject":{"protocol":"http","path":["commands","ble","kbd_key","Commands perform certain actions related to the device.
\nThere are several commands can be associated with device.
\nGetting information about the classes of commands supported by the device.
\nFor example, for Plug device:
\nGET /commands\nAnswer:\n[\"switch\", \"dimmer\"]\nGetting possible events for a command:
\nGET /commands/switch \nAnswer:\n[\"on\", \"off\"] \n\nGET /commands/dimmer \nAnswer:\n[\"set\", \"on\", \"off\"]\nTo control the device through commands, you must use the following parameters:
\nDevice state management is possible both with POST and GET requests.\nThe following requests are identical and lead to the switching on Plug device. \nThese requests use the \"Switch\" command with the \"On\" action:
\nGET /commands/switch/on\nGET /commands?command=switch&action=on \nGET /commands?command=1&action=1 \nPOST /commands/switch/on\nPOST /commands \n{ \n \"command\": \"switch\", \n \"action\" : \"on\" \n}\nIn addition to the server’s response, a message about the execution or error when executing the command may be in the response to the request in the form of the following JSON on successful execution:
\n{ \"success\" : \"true\" }\nOr in case of fail:
\n{ \"success\" : \"false\" }\n| Event name | \nEvent ID | \nDescription | \nPossible operands | \n
| on | \n0x01 | \nSwitch on | \nno operand | \n
| off | \n0x02 | \nSwitch off | \nno operand | \n
| Event name | \nEvent ID | \nDescription | \nPossible operands | \n
| all | \n0xFF | \nSwitch all on | \nstate | \n
| channel1 | \n0x01 | \nSet state for channel 1 | \nstate | \n
| channel2 | \n0x02 | \nSet state for channel 2 | \nstate | \n
...
\n| channelN | \n0x0N | \nSet state for channel N | \nstate | \n
| Event name | \nEvent ID | \nDescription | \nPossible operands | \n
| nec1 | \n0x01 | \nSend NEC1 command on 38 kHz | \ncommand | \n
| sony | \n0x03 | \nSend Sony command on 38 kHz | \ncommand | \n
| necx | \n0x04 | \nSend NecX command on 38 kHz | \ncommand | \n
| panasonic | \n0x05 | \nSend panasonic command on 38 kHz | \ncommand | \n
| samsung36 | \n0x06 | \nSend Samsung36 command on 38 kHz | \ncommand | \n
| aiwa | \n0x14 | \nSend aiwa command on 38 kHz | \nAiwa command | \n
| repeat | \n0xED | \nSend repeat command for previos sended signal | \nno operand | \n
| saved | \n0xEE | \nSend command from device memory | \nStorage item ID | \n
| ac | \n0xEF | \nSend command for the AC unit | \nAC Operand in XXXXMTFS, where XXXX - codeset, M - AC Mode, T - temperature offset over 16 degrees, F - fan mode, S - swing mode | \n
| localremote | \n0xFE | \nSend command for saved remote | \nOperand with Remote UUID, function and param | \n
HTTP only commands (ignored by decentralized protocol)
\n| Event name | \nEvent ID | \nDescription | \nPossible operands | \n
| prontohex | \n0xF0 | \nSend command in ProntoHEX format | \nCommand in ProntoHEX | \n
| raw | \n0xFF | \nSend command in raw timinigs format | \nstring with following format: \"XX;[YY]\",\n Where: \n XX Frequency in Hz, \n YY raw signal timings\n | \n
Documentation not ready yet
\n","_postman_id":"76150ca2-a562-4330-be13-bac24c3970de"},{"name":"/log","item":[],"id":"7c194e4b-9ad1-44df-bd62-cb6a1a4bb30e","description":"Documentation not ready yet
\n","_postman_id":"7c194e4b-9ad1-44df-bd62-cb6a1a4bb30e"},{"name":"/data","item":[{"name":"Remote","item":[{"name":"Get saved IR remotes","id":"74cc7dc8-1b80-48c4-99db-c6ea511458dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/data/6F36","description":"Get all IR remotes, saved on device
\nEach device presented as object with 3 fields: Type, UUID, Updated
\n","urlObject":{"protocol":"http","path":["data","6F36"],"host":["00000001.local"],"query":[],"variable":[]}},"response":[{"id":"03d8d68f-ffcc-4c6e-b279-0083d4ff2796","name":"Get saved IR remotes","originalRequest":{"method":"GET","header":[],"url":"http://00000001.local/data/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"205"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"07\",\n \"UUID\": \"6D1B\",\n \"Updated\": \"1596103418\"\n },\n {\n \"Type\": \"01\",\n \"UUID\": \"685E\",\n \"Updated\": \"1599130475\"\n },\n {\n \"Type\": \"EF\",\n \"UUID\": \"6F36\",\n \"Updated\": \"1599748069\"\n },\n {\n \"Type\": \"05\",\n \"UUID\": \"85EA\",\n \"Updated\": \"1597838823\"\n }\n]"}],"_postman_id":"74cc7dc8-1b80-48c4-99db-c6ea511458dd"},{"name":"Get saved IR device information","id":"1e717aa2-66d9-445b-bc61-51008d3ef367","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"http://00000001.local/data/6F36","description":"Fields:
\nThis endpoint allows you to receive, store and update IR remotes that are stored on each device
\nGet all IR remotes, saved on device.
\nRemotes divides by remotes types and defined functions for each device type.
\nList of used device types:
\nTV\nType: 0x01\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
| mode | \n0x04 | \nInput mode list | \n
| mute | \n0x05 | \nAudio mute toggle | \n
| volup | \n0x06 | \nVolume Up | \n
| voldown | \n0x07 | \nVolume Down | \n
| chup | \n0x08 | \nChannel Up | \n
| chdown | \n0x09 | \nChannel Down | \n
| cursor | \n0x0C | \nCursor control | \n
| menu | \n0x0D | \nMenu button | \n
Media\nType: 0x02\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
| mute | \n0x05 | \nAudio mute toggle | \n
| volup | \n0x06 | \nVolume Up | \n
| voldown | \n0x07 | \nVolume Down | \n
Light\nType: 0x03\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
Humifier / Dehumidifier\nType: 0x04\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
| mode | \n0x04 | \nMode select | \n
Air Purifier\nType: 0x05\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
| mode | \n0x04 | \nMode select | \n
| speed | \n0x0B | \nSpeed mode | \n
Robo vacuum cleaner\nType: 0x06\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
Data Device Fan\nType: 0x07\nAvaliable Functions:
\n| Short name | \nID | \nMeaning | \n
| power | \n0x01 | \nPower toggle | \n
| poweron | \n0x02 | \nPower On | \n
| poweroff | \n0x03 | \nPower Off | \n
| swing | \n0x0A | \nSwing mode | \n
| speed | \n0x0B | \nFan speed mode | \n
This endpoints allows to manage information stored on the device. \nWorking with these endpoints differs from device to device and depends on its type
\n","event":[{"listen":"prerequest","script":{"id":"11199368-f16c-46bf-b171-66f1068a6516","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"edd11513-c86e-431b-bb95-e69d31cbe14b","type":"text/javascript","exec":[""]}}],"_postman_id":"edaace0b-e871-4520-8d4c-e19dc7f1bff6"}],"id":"95a93fea-dcda-4863-b1fa-bb9fb825b5d0","_postman_id":"95a93fea-dcda-4863-b1fa-bb9fb825b5d0","description":""}],"event":[{"listen":"prerequest","script":{"id":"9b7312e8-8287-4dc6-86a6-7969e96ba7a2","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"82ac5eb1-a2e2-435e-b3a6-79f0cc5d50e7","type":"text/javascript","exec":[""]}}],"variable":[{"key":"IP","value":"00000001.local"}]}