Dingz offers a REST API (REST = representational State Transfer).
\nThe interface allows you to access/control your dingz device directly from your local network independently from the dingz cloud.\nWith those rules you can integrate your dingz in almost any environment.
\nFor some calls you will get success back. This should almost always be true. If it is false however, it means that your dingz has experienced an internal error.
Often in these request you will see a number like this 200AD4074I68. This is the MAC address of the device without any delimiers.
To discover a dingz in your network, you have to listen on udp port 7979. Each dingz device will broadcast a message. The first 6 bytes contain the mac address of the device and the following two bytes are a number that corresponds to the device type. Currently all dingz devices have the type number \"108\".
\nThe interface is transparent and has no authentication. If someone has access to your local network, they will be able to control your dingz.\nPlease apply strong security mechanisms to protect your network.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"REST API","slug":"rest-api"}],"owner":"11123877","collectionId":"8ba5cfba-35ab-4126-91e5-2c6df89d0c85","publishedId":"Szf55A3X","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2020-04-18T10:49:19.000Z"},"item":[{"name":"dingz Information ","item":[{"name":"Get Puck version number","id":"2e1e5a76-8843-4732-a6de-011667600783","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/puck","description":"Returns a JSON object with two fields namely fw for firmware and hw for hardware.
In the fw object the field version denotes the current puck firmware version.\nIn the hw object the field version denotes the current bootloader version of the puck.
Gets general information about your dingz device. Will return a JSON object with:
\nversion: Current firmware versionmac: MAC address, without any delimitersssid: SSID of the currently connected networkip: Current ip addressmask: Mask of the current networkgateway: Gateway of the current networkdns: DNS of the curent networkstatic: Wether or not the ip address is staticconnected: Wether or not the device is connected to the internetReturns a JSON object with two fields:
\nsuccess: Wether or not the request succeededtemperature: The current (room) temperatureReturns JSON object with 2 fiels:
\nsuccess: Wether or not the request has succeededmotion: Wether or noth the motion sensor has recognized motion (for dingz one it will always be false)Returns a json object which has one field namely the mac address of the dingz device without any delimiters. In this field there is the following information:
\ntype: Device typebattery: Wether or not the devices is using batteriesreachable: Wether or not the device is reachable from the dingz cloud.meshroot: Wether or not the dingz device is part of a meshfw_version: The current firmware version of the frontfw_version_puck: The current firmware version of the circular backbl_version_puck: The current bootloader version of the circular backdip_config: Value corresponding to dip switch configuration of puckhas_pir: Wether or not the device has a pirhk_activation_code: The homekit activation codeGets a log of everything that has happened. Returned as a raw string.
\n","urlObject":{"path":["log"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[{"id":"9deae169-c782-4197-beb2-a8bdbca13608","name":"Get log","originalRequest":{"method":"GET","header":[],"url":"{{ip}}/log"},"status":"OK","code":200,"_postman_previewlanguage":"plain","header":[{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache"},{"key":"Content-Type","value":"text/plain"},{"key":"Content-Length","value":"1174"},{"key":"Connection","value":"close"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"\r\nTIMESTAMP\tMODULE\tLEVEL\tCODE\tVALUE\r\n5C1276D4\t1\t4\t19\r\n5C1276D4\t1\t4\t18\t3\r\n5C1276D4\t1\t4\t18\t2\r\n5C1276D4\t1\t4\t18\t13\r\n5C1276DB\t1\t3\t11\r\n5C1276DB\t1\t4\t8\r\n5C1276DB\t1\t4\t18\t3\r\n5C1276DB\t1\t4\t18\t14\r\n5C1276DB\t1\t3\t15\r\n5C1276DB\t1\t4\t28\r\n5C1276DB\t1\t4\t18\t2\r\n5C1276DB\t1\t4\t10\r\n5C127753\t1\t4\t18\t11\r\n5C127754\t1\t3\t5\r\n5C127754\t1\t3\t7\r\n5C127754\t1\t4\t18\t3\r\n5C127754\t1\t4\t18\t2\r\n5C127754\t1\t4\t18\t13\r\n5C127812\t1\t4\t18\t15\r\n5C12781B\t1\t4\t18\t17\r\n5C1278B6\t1\t3\t11\r\n5C1278B6\t1\t4\t8\r\n5C1278B6\t1\t4\t18\t3\r\n5C1278B6\t1\t4\t18\t16\r\n5C1278B6\t1\t4\t18\t14\r\n5C1278B6\t1\t3\t15\r\n5C1278B6\t1\t4\t28\r\n5C1278B6\t1\t4\t18\t2\r\n5C1278B6\t1\t4\t10\r\n5C1278C9\t1\t4\t18\t5\r\n5C1278CA\t1\t4\t18\t9\r\n5C1278CA\t1\t4\t16\r\n5C1278CB\t1\t4\t11\r\n5C1278CB\t1\t4\t3\r\n5C1278CB\t1\t4\t18\t3\r\n5C1278CB\t1\t3\t13\r\n5C1278CB\t1\t4\t26\r\n5C1278CB\t1\t4\t18\t2\r\n5C1278CC\t1\t4\t18\t4\r\n5C1278CC\t1\t4\t18\t7\r\n5C1278CC\t1\t4\t12\r\n5C1278CD\t1\t4\t18\t19\r\n5C1278CD\t1\t4\t14\r\n5C1278CD\t1\t4\t1\r\n5C1278CD\t2\t4\t34\r\n5C1278E2\t1\t4\t18\t19\r\n5C1278E5\t2\t4\t27\r\n5C1278E5\t2\t4\t28\r\n5C1278E5\t2\t4\t30\r\n5C1278E5\t2\t4\t31\r\n5C1278E6\t2\t4\t32\r\n5C1278E6\t2\t4\t22\r\n5C1278E6\t2\t4\t23\r\n5C1278E6\t2\t4\t24\r\n5C1278E6\t2\t4\t5\r\n5C1278E6\t2\t4\t2\t30\r\n5C1278E6\t2\t4\t1\t60\r\n5C1278E7\t2\t4\t4\r\n5C127904\t2\t4\t4\r\n5C127922\t2\t4\t24\r\n5C127922\t2\t4\t7\r\n5C127922\t2\t4\t4\r\n5C127940\t2\t4\t4\r\n5C12795E\t2\t4\t4\r\n"}],"_postman_id":"3736951b-48b0-4d25-a2dc-e991db87eeb6"}],"id":"f8b83ffa-2d6b-4e68-b55b-1a8c20a85986","description":"Requests used to get general information from dingz.
\n","event":[{"listen":"prerequest","script":{"id":"17fddc35-c00c-4469-8d9e-44637bbf5bb6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"62f2cfd1-2c4d-4952-a210-6361050fbcb3","type":"text/javascript","exec":[""]}}],"_postman_id":"f8b83ffa-2d6b-4e68-b55b-1a8c20a85986"},{"name":"dingz Wifi","item":[{"name":"Scan Wifi","event":[{"listen":"test","script":{"id":"def6437f-2629-46e6-9e60-dba2a5fe7df5","exec":[""],"type":"text/javascript"}}],"id":"629dc5da-c3c5-4350-bf26-a39d0f4a74e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/scan","description":"Scans for nearby wifi networks. Will return a JSON array consisting alternatingly of a wifi name and its signal strength
\n","urlObject":{"path":["api","v1","scan"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[{"id":"ab476431-f2fa-4bdd-9f58-d65fb852881d","name":"Scan wifi","originalRequest":{"method":"GET","header":[],"url":"[dingz IP]/api/v1/scan"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Pragma","value":"no-cache"},{"key":"Cache-Control","value":"no-store, no-cache"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"212"},{"key":"Connection","value":"close"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"[\n \"UPC42A3283\",\n -49,\n \"FRITZ!Box 7490\",\n -77,\n \"UPC3B0283\",\n -63,\n \"UPC9CE144A\",\n -69,\n \"WN-C61328_2GEXT\",\n -77\n]"}],"_postman_id":"629dc5da-c3c5-4350-bf26-a39d0f4a74e1"},{"name":"Scan Wifi (detailed)","id":"29eeaea0-081b-4ef3-beb9-ffafa80c4005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/networks","description":"Scans for nearby wifi networks in a detailed manner. Returns a JSON object where each detected wifi signal is a field. \nFor each detected Wifi it returns
\nname: indicating the name of the wifisignal: indicating signal strengthencryption-on: wether or not the wifi signal is encryptedencryption: The used encryption standardActivates WPS on your dingz.
\n","urlObject":{"path":["api","v1","wps"],"host":["{{setupIP}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"adfc32b1-a08c-4539-955e-59e89e2b9585"},{"name":"Connect to Wifi","id":"ee597793-5933-464a-9b01-c5ee2f44032c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"ssid\": \"ABEO\",\n \"passwd\": \"PASSWORD\"\n}"},"url":"{{setupIP}}/api/v1/connect","description":"Connects the device to wifi
\nPostman somehow has problems with this request so we write it here as you would use it for curl. DISREGARD THE POSTMAN EXAMPLE
\nIn order for this command to work you must first exectue the \"Scan Wifi\" or \"Scan Wifi (detailed)\"
\nThe fields you can enter in the JSON object are:
\nssid: The ssid of the network you want your dingz to connect topasswd: The password of the network you want your dingz to connect toip: The static ip address you whish you dingz to have (optional, only needed when using static ips and not using dhcp)mask: The mask of the network (optional, only needed when using static ips and not using dhcp)gateway: The gateway of the network (optional, only needed when using static ips and not using dhcp)dns: The dns server of you network (optional, only needed when using static ips and not using dhcp)curl -d '{\"ssid\":\"WIFI\", \"passwd\":\"PASSWORD\"}' http://192.168.254.1/api/v1/connect
\n","urlObject":{"path":["api","v1","connect"],"host":["{{setupIP}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ee597793-5933-464a-9b01-c5ee2f44032c"}],"id":"35be3337-1574-4e6d-9ef7-75807b20f30c","description":"Requests for setting or detecting wifi networks.
\n","event":[{"listen":"prerequest","script":{"id":"3446388a-bcb2-4d1a-b684-7937feb3b972","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"11e0f02f-50b3-4432-b969-2c8e009ad554","type":"text/javascript","exec":[""]}}],"_postman_id":"35be3337-1574-4e6d-9ef7-75807b20f30c"},{"name":"dingz Setting","item":[{"name":"Enable/Disable REST API","id":"f7c64fa7-3474-4f52-91bf-00064b0e7ced","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/rest?enable=true","description":"Disables or enables the rest api. Does not return anything.
\nBy disableing the rest api one also disables any kind of interaction with the device besides the standalone mode. Needs to be reset after usage to get the device back in working condition.
\nAlso disables the webui.
\n","urlObject":{"path":["rest"],"host":["{{ip}}"],"query":[{"key":"enable","value":"true"}],"variable":[]}},"response":[],"_postman_id":"f7c64fa7-3474-4f52-91bf-00064b0e7ced"},{"name":"Enable/Disable Web UI","id":"dec477ae-eb26-4af3-aa49-28c46923f956","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/panel?enable=true","description":"Enables or disables the Web interface. Does not return anything
\n","urlObject":{"path":["panel"],"host":["{{ip}}"],"query":[{"key":"enable","value":"true"}],"variable":[]}},"response":[],"_postman_id":"dec477ae-eb26-4af3-aa49-28c46923f956"},{"name":"Get settings information","id":"eb107ad2-e118-4ec0-a117-a51a31903551","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/settings","description":"Returns a json objects listing wether or not some dingz settings are enabled or not. The fields included in this object are:
\nrest: Wether or not the rest api is enabledpanel: Wether or not the web ui is enabledreferer: Wether or not we accept requests that have no referrer or do not originate from myStrom server or the dingz device itself token: API access token (disable by default)hap_disable: Wether or not homekit is enabledUpgrade the firmware of the device to the firmwarefile provided.
\nMake sure that the firmware (.bin file) corresponds to your device type before uploading.
\nReturns an empty body.
\n","urlObject":{"path":["load"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ce0603b8-59d6-45f9-97b7-d86cce225349"}],"id":"ff154415-3f09-43fd-a6e6-ac8c7e613090","description":"Change settings saved on your dingz.
\n","event":[{"listen":"prerequest","script":{"id":"18db8eef-6315-4707-8745-eef0e50070e7","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c6869be2-4f2d-4c80-8ed3-770ca137c2d8","type":"text/javascript","exec":[""]}}],"_postman_id":"ff154415-3f09-43fd-a6e6-ac8c7e613090"},{"name":"dingz Actions","item":[],"id":"15b80356-5dee-419c-bf8d-fec26e33fcc9","description":"Actions allow you to make an HTTP request on a remote host. You can assign an action to the buttons, PIR sensor and input of the device in the form of an HTTP request performed at a specific event. The HTTP client on the device allows you to perform 4 methods of HTTP requests: GET, POST, PUT and DELETE.
\nIn the case of buttons and input, it is possible to assign actions regarding individual press schemes: single, double, long, press, release and generic for all types.
\nIn the case of a motion sensor, it is possible to assign an action of motion detection, end of motion detection, motion detection depending on the intensity of lighting and a generic action performed for all events.
\nBefore assigning a request to a specific action, you need to understand its general format. During the processing of the assigned action, an HTTP request is made. The first thing you need to know when assigning an action is the IP address and port on which the HTTP server receiving the actions is running, instead of the IP address you can also provide this parameter as the hostname. You also need to know the IP address of the device (DINGZ) on which you want to assign the action. Depending on how the receipt of the action is implemented on the server, you will need to define the request method. On the receiving server, you will probably also have the paths for which the request is to be executed and the query parameters defined. Sometimes authentication is needed as well, the device only supports Basic authentication.
\nButtons, input, motion sensor.
\nButton single press, double press, long press, press, release.
\nMotion detected, end of motion, motion and day, motion and night, motion and twilight.
\nGeneral format of the action to be performed:
\nscheme://[user:password@]host[:port][/path][?query]\nWhere the scheme corresponds to the HTTP request method (GET, POST, PUT, DELETE).
\nscheme = {get[s]|post[s]|put[s]|delete[s]|http[s]}\nSpecifying the scheme as http corresponds to the post schema. The optional ending s means whether the query is to be made in an SSL connection.
\nSince it is not possible to define the HTTP header specifying the body content type, it is inferred from the query format in the case of POST and PUT methods. For these queries, it is also not possible to send the query in the path, but only in the body.
\nAn action can also consist of multiple queries executed sequentially, use || to separate these queries.
\nAs an example of the action, we will execute a query to another dingz, which is at the address 192.168.1.120. The request will turn on the dimmer on the first output and set its brightness to 50%, this request should be made using the POST method.
\npost://192.168.1.120/api/v1/dimmer/0/on?value=50\nIn order to read all assigned actions, use the command for all the possibilities of their execution and keeping the LED and other parameters:
\nGET api/v1/action\nit should return JSON:
\n{\n \"generic\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"btn1\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"btn2\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"btn3\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"btn4\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"input\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n },\n \"pir\": {\n \"generic\": \"\",\n \"night\": \"\",\n \"twilight\": \"\",\n \"day\": \"\",\n \"rise\": \"\",\n \"fall\": \"\",\n \"feedback\": {\n \"generic\": true,\n \"night\": true,\n \"twilight\": true,\n \"day\": true,\n \"rise\": true,\n \"fall\": true\n }\n }\n}\nYou can also specify the scope of the request:
\nGET api/v1/action\nGET api/v1/action/pir\nGET api/v1/action/<ENUM generic|btn1|btn2|btn3|btn4|input>\nGET api/v1/action/pir/<ENUM generic|night|twilight|day|rise|fall>\nGET api/v1/action/<ENUM generic|btn1|btn2|btn3|btn4|input>/<ENUM generic|single|double|long>\nSo e.g. if you only want to get the assignment for the first button use:
\nGET api/v1/action/btn1\nit should return JSON:
\n{\n \"btn1\": {\n \"generic\": \"\",\n \"single\": \"\",\n \"double\": \"\",\n \"long\": \"\",\n \"press_release\": false,\n \"feedback\": {\n \"generic\": true,\n \"single\": true,\n \"double\": true,\n \"long\": true\n }\n }\n}\nor even so:
\nGET api/v1/action/btn1/single\nit should return JSON:
\n{\n \"url\": \"\",\n \"feedback\": true\n}\nThe device does not flash if the auction is not assigned, i.e. the character string length is zero.
\nThe description of the object defining the blinking is analogous to the case of buttons.
\nAssigning an action looks similar to reading it, except that you can only make one assignment with one request. The action URL is sent as the body of the POST method with a regular string. Don't send the assignment with a JSON object as it is returned. The general request syntax is provided below:
\nPOST api/v1/action/<ENUM btn1|btn2|btn3|btn4|input>/<ENUM single|double|long>\nPOST api/v1/action/pir/<ENUM night|twilight|day|rise|fall>\nSuppose you want to assign an action to a single press of button 1, then your curl query should look like this:
\ncurl -d '<action_url>' http://<dingz_ip>/api/v1/action/btn1/single\nas action_url substitute a personalized action, example for our action with dimmer:
curl -d 'post://192.168.1.120/api/v1/dimmer/0/on?value=50' http://<dingz_ip>/api/v1/action/btn1/single\nno headers in the action assignment request are needed or interpreted.
\nA generic action is a special case of an action that is performed on all possible events. This action communicates its origin in the parameters, i.e. whether it was generated by a button, input or motion sensor, and the event that triggered it. In addition, the MAC address of the device from which the action comes is also transferred. You will use this action when your HTTP server receiving the actions is able to parse incoming parameters and make decisions based on them. The generic action invalidates the configuration because it sets a global request to execute. Regardless of whether the generic action is set, you can also set dedicated actions for individual events from individual modules.
\nGeneric action parameters are passed as additional query parameters. If you have your request to add, it must be in the format application/x-www-form-urlencoded. The generic action should set the content type of the HTTP request to application/x-www-form-urlencoded.
\nThe rise event from the motion sensor is reported as a press and a fall event from the motion sensor is reported as release.
\nIf you have looked at the object returned while reading the actions, you will notice that there are several levels of generic action nests.
\nThis action is performed for each event from each module.
\napi/v1/action\napi/v1/action/generic/generic\nThe generic action for the module will be performed for each event.
\napi/v1/action/<btn1|btn2|btn3|btn4|pir|input>\nThe generic action for an event is generated for a specific event, regardless of which module it comes from. It is only possible for buttons and inputs.
\napi/v1/action/generic/<ENUM single|double|long>\nThis parameter applies to the button and input module and allows you to define whether a generic action will also be performed for pressing and releasing the button.
\nPOST api/v1/action/<ENUM generic|btn1|btn2|btn3|btn4|input>/press_release/<ENUM disable|enable>\nIt is possible to turn on and off signaling the success of the action with the LED diode, this setting is available for specific actions as well as generics.
\nPOST api/v1/action/pir/<ENUM generic|night|twilight|day|rise|fall>/feedback/<ENUM disable|enable>\nPOST api/v1/action/<ENUM generic|btn1|btn2|btn3|btn4|input>/<ENUM generic|single|double|long>/feedback/<ENUM disable|enable>\nIt is possible to assign multiple actions or HTTP requests to each action, regardless of whether it is a generic or specific action.
\nTo use this functionality, separate the action URLs with ||.
Each action assignment can be up to 767 bytes long, regardless of whether it is multi action.
\nSet assignment to zero characters.
\n","event":[{"listen":"prerequest","script":{"id":"0fb6f00a-9725-4bfc-84a3-5be5e1a5c74e","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"26bf4753-ed1f-4fc7-881f-6a14af50a299","type":"text/javascript","exec":[""]}}],"_postman_id":"15b80356-5dee-419c-bf8d-fec26e33fcc9"},{"name":"dingz Dimmers","item":[{"name":"Set dimmer values","id":"0f7bc943-e1d9-4914-b7d8-cbbb0d101edc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{ip}}/api/v1/dimmer/0/on/?value=33&ramp=0","description":"The URL is of the form /api/v1/dimmer/<UINT 0..3>/<ENUM off|on>
<UINT 0...3> specifies which of the 4 outputs we are changing.
\nIf no post data is specified the corresponding dimmer will be set to either on or off.
\nHowever we can use post data to set value & ramp, in this case the <ENUM off|on> value is disregarded.
Nothing is returned
\n","urlObject":{"path":["api","v1","dimmer","0","on",""],"host":["{{ip}}"],"query":[{"description":{"content":"To which value the corresponding dimmer is set to. Values from [0, 100]
\n","type":"text/plain"},"key":"value","value":"33"},{"description":{"content":"How quickly the values change. Values from [0, 255]
\n","type":"text/plain"},"key":"ramp","value":"0"}],"variable":[]}},"response":[],"_postman_id":"0f7bc943-e1d9-4914-b7d8-cbbb0d101edc"},{"name":"Get dimmer status","id":"4f1e9b7e-713b-4319-8b4d-df18b745ab23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/dimmer","description":"Returns a JSON object consisting of one field per dimmer output which in turn consists of 3 values namely
\non: Wether or not the dimmer output is currently onvalue: To which value the corresponding dimmer is set to. Values from [0, 100]ramp: How quickly the values change. Values from [0, 255]URL is of form /api/v1/dimmer/<UINT 0..3>
Returns a JSON object consisting of one field per dimmer output which in turn consists of 3 values namely
\non: Wether or not the dimmer output is currently onvalue: To which value the corresponding dimmer is set to. Values from [0, 100]ramp: How quickly the values change. Values from [0, 255]Getting or setting the dingz output dimmers.
\n","event":[{"listen":"prerequest","script":{"id":"7bed2afc-90ff-4f18-8f7f-c9234fff80a8","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"afa6292d-e7df-462c-b99f-b532be04ae01","type":"text/javascript","exec":[""]}}],"_postman_id":"a1433d0c-509a-4ba4-b2f5-245257651ad7"},{"name":"dingz Front LED","item":[{"name":"Get current front LED information","id":"f51bb760-28a4-4757-8265-8070e8ca3936","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/led/get","description":"Returns a JSON object with 4 fields, namely:
\non: Wether or not the led is onhsv: Color in hsv mode has format <UINT 0..360>;<UINT 0..100>;<UINT 0..100>rgb: Color in rgb mode format is 6 hex numbersmode: To which mode we are currently set to format <ENUM hsv|rgb>URL has form /api/v1/led/<ENUM red|green|blue> for each channel.\nNothing is returned.
We can the set the values for the specified channeld by posting:
\nvalue: <UINT 0..255>Optionally we can also specify how quickly this we should change the to the new value by using:
\nramp: <UINT 1..4095>Getting or setting the front LED data.
\n","event":[{"listen":"prerequest","script":{"id":"608fd8cd-dc57-49b2-9435-b16fb200b673","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5ecdda43-7154-4229-960a-ca287c47efd2","type":"text/javascript","exec":[""]}}],"_postman_id":"3fa95b33-fdb2-4650-bdf9-a7b38ef26c4e"},{"name":"dingz Shades/Blinds","item":[{"name":"Get shade information","id":"ac5b3086-7f97-41af-ac31-461eb09b22a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/shade","description":"Contains a field for every dingz output that is set to \"blinds\" mode (at most two fields one named 0 and the other 1). To do this, remove the front cover of your dingz and set the DIP/toggle switches accordingly.
target: Target state of the shadescurrent: Current state of the shadesEach of those again have two fields, namely
\nblind: Position of the blind [0..100]lamella: Angle of the lamella [0..90]URL is of form /api/v1/shade/<UINT 0..1>
Get the shade information of the specified shade configuration.
\ntarget: Target state of the shadescurrent: Current state of the shadesEach of those again have two fields, namely
\nblind: Position of the blind [0..100]lamella: Angle of the lamella [0..90]Sets the current shade values.
\nURL is of form /api/v1/shade/<UINT 0..1>
Nothing is returned.
\nAs data we send two field
\nblind: Position of the blind (in percent)lamella: Angle of the lamella (in percent)Control shades/blinds with your dingz.
\n","event":[{"listen":"prerequest","script":{"id":"ebe13d96-eb30-4d68-bdcb-257206d23325","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2d269b03-053b-4719-a766-fd15b4877370","type":"text/javascript","exec":[""]}}],"_postman_id":"816cba98-d6fe-4b7a-83be-53b8b9236b43"},{"name":"Motion Sensor (PIR)","item":[{"name":"Get PIR configuration","id":"891f315e-fb51-4af6-80fe-e2eb69d45ee8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/pir_config","description":"Gets general information about the motion sensor (PIR).
\nWhen not specified otherwise, time is always in seconds [s].
\nWill return a JSON object with:
\npir_output: Which output of your dingz will be toggled when motion is detectedpir_feedback: With which color the front led should light up when motion is detectedfeedback_intensity: Brightness of the feedback blinkingdark_threshold: lux threshold for which pir output will be turn on if motion occurredbright_threshold: lux threshold for which pir output will be turn offtimer: How long the output should be set to on (legacy)on_time: How long the output should be set to on off_time: How long the pir should temporarily be disableddim_value: The target output dimmer value in percentage set if output is turn onbackoff: Time after a pir trigger until we reset the motion state to \"off\",feedback_time: How long the front led will light up once the pir is triggered,fade_in_time: Time in which the output will be set to the target value (unit 0.1s)fade_out_time: Time in which the output will be turned off (unit 0.1s)enabled: wether or not the pir is enabledReturns a JSON object with 3 fields:
\nsuccess: Wether or not the request has succeededintensity: The current brightness value [lux]day: Wether or not the dingz thinks its currently daytime based on the brighness it receivesRequest accepts body as JSON with bellow fields
\npir_output: Which output of your dingz will be toggled when motion is detected. null to disable, or int value of 1..4 to enable. pir_feedback: With which color the front led should light up when motion is detected. null to disable, string value of white|reg|green|blue to enablefeedback_intensity: Brightness of the feedback blinking. int value in range 0..100dark_threshold: lux threshold for which pir output will be turn on if motion occurred. int value > 0, should be smaller than bright_thresholdbright_threshold: lux threshold for which pir output will be turn off. int value > 0, should be bigger than dark_thresholdtimer: How long the output should be set to on (legacy)on_time: How long the output should be set to on. int value > 0off_time: How long the pir should temporarily be disabled. int value > 0dim_value: The target output dimmer value in percentage set if output is turn on, int value in range 0..100backoff: Time after a pir trigger until we reset the motion state to \"off\", int value > 0feedback_time: How long the front led will light up once the pir is triggered, int value > 0fade_in_time: Time in which the output will be set to the target value (unit 0.1s), int value > 0fade_out_time: Time in which the output will be turned off (unit 0.1s), int value > 0enabled: wether or not the pir is enabled, bool valueGetting or setting motion sensor data.
\n","event":[{"listen":"prerequest","script":{"id":"db5116b9-8330-4fc0-850d-0e25d92d9346","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"aaec0a15-2be6-4706-b1d3-5af60f126e1e","type":"text/javascript","exec":[""]}}],"_postman_id":"8574b7f3-21aa-4601-b093-02611293716e"},{"name":"Front LED","item":[{"name":"Set front led","id":"80cf63a8-aa85-4dca-85d2-1bee9dfd2c47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"{{ip}}/api/v1/led/set?action=on&color=0;100;100&mode=hsv&ramp=0","description":"Set the color of the led of the dingz.
\n","urlObject":{"path":["api","v1","led","set"],"host":["{{ip}}"],"query":[{"key":"action","value":"on"},{"key":"color","value":"0;100;100"},{"key":"mode","value":"hsv"},{"key":"ramp","value":"0"}],"variable":[]}},"response":[],"_postman_id":"80cf63a8-aa85-4dca-85d2-1bee9dfd2c47"}],"id":"1d7d2caa-4853-4cd3-90f1-f00f9c92cf50","_postman_id":"1d7d2caa-4853-4cd3-90f1-f00f9c92cf50","description":""},{"name":"Thermostat","item":[{"name":"Get thermostat configuration","id":"bdfd55aa-3986-4d7d-83bd-d16bbd10ae0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/thermostat_config","description":"Will return a JSON object with:
\nactive bool: if the thermostat function is activeoutput uint: output on which thermostat function will be presenton bool: describe current status of thermostat output, true if output is onmin_temp int: temperature below which the output will be turned onmax_temp int: temperature below which the output will be turned offreverse bool: reverse polarity of output, on is off, off is onenable bool: if thermostat output is controledBody should be JSON with fields bellow:
\nactive bool: if the thermostat function is active on given outputoutput uint: output on which thermostat function will be presentmin_temp int: temperature below which the output will be turned onmax_temp int: temperature below which the output will be turned offreverse bool: reverse polarity of output, on is off, off is onenable bool: if thermostat enabled/disabledReturn collection of inputs settings in JSON format:
\noutput: output which will be triggered by input, null if function is disabled, 1..4 if function is enabledfeedback: if input event will be cause LED feedback, null if no, white|reg|green|blue describe LED feedback colorfeedback_intensify: intensity of LED feedback, 0..100active: if input function is enabled, boolean valuerequire JSON as body:
\noutput: output which will be triggered by input, null if function is disabled, 1..4 if function is enabledfeedback: if input event will be cause LED feedback, null if no, white|reg|green|blue describe LED feedback colorfeedback_intensify: intensity of LED feedback, 0..100active: if input function is enabled, boolean valueReturn list of active timers.
\nThis request return array of JSON objects in format as described in POST request.
\nExample of returned object:
\n[{\n \"ref\": \"dimmer\",\n \"index\": 0,\n \"time\": 10,\n \"reverse\": false,\n \"at_night\": false,\n \"value\": 50,\n \"ramp\": 10\n}]\nThis example show one active timer.
\nIf the timer execution was completed timer instance is automaticly deleted.
\n","urlObject":{"path":["api","v1","timer"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[{"id":"de1fb633-01db-4d5c-8470-4e8e0978c979","name":"Get active timmers","originalRequest":{"method":"GET","header":[],"url":"{{ip}}/api/v1/timer"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"8786ed3c-d0dd-4ba7-aedc-a5209965e41c"},{"name":"Create and activate timer","id":"744f4b75-7922-4e31-8048-29c2072f1971","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref\": \"dimmer\",\r\n \"index\": 0,\r\n \"time\": 10,\r\n \"reverse\": false,\r\n \"at_night\": false,\r\n \"value\": 50,\r\n \"ramp\": 10\r\n}"},"url":"{{ip}}/api/v1/timer","description":"Allow create timer.
\nThis request require JSON object with fields described bellow as body:
\nExample of request body:
\n{\n \"ref\": \"dimmer\",\n \"index\": 0,\n \"time\": 10,\n \"reverse\": false,\n \"at_night\": false,\n \"value\": 50,\n \"ramp\": 10\n}\nThis request object set timer for 10s on dimmer 0 (1), dimmer value will be set to 50% with ramp 1s. Dimmer output will be change to required value immediately and back to previous value after required time.
\nref and index firlds range depends on dingz output configuration.
\nCannot create multiple timer instances with same ref and index.
\n","urlObject":{"path":["api","v1","timer"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"744f4b75-7922-4e31-8048-29c2072f1971"},{"name":"Stop timer","id":"62cc6f98-dac3-487c-8c90-367a388f6adc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"ref\": \"dimmer\",\r\n \"index\": 0\r\n}"},"url":"{{ip}}/api/v1/timer/stop","description":"Allow stop/destroy timer previously created.
\nThis request require JSON object with two first fields (ref and index) of timer start request
\nExample:
\n{\n \"ref\": \"dimmer\",\n \"index\": 0\n}\nStop timer for dimmer with index 0
\n","urlObject":{"path":["api","v1","timer","stop"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62cc6f98-dac3-487c-8c90-367a388f6adc"}],"id":"988f15c4-48af-4adb-b7a9-9bd463a304d7","description":"This feature allows control outputs by time. Timers allows set target values on particular module: dimmer, shade and LED indicated by ref field in JSON object. Timers can work in two modes: set target values immediately and after set time back to previous values (before timer activated) or set values after set time (reverse field in JSON object). Timers also allow delay action execution to night (light sensor) event (at_night field in JSON object)
\n","event":[{"listen":"prerequest","script":{"id":"22ce2398-611f-458d-bae5-38df7fd17cc0","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"757a24a4-7eb6-47c8-be28-cb18ea8deea9","type":"text/javascript","exec":[""]}}],"_postman_id":"988f15c4-48af-4adb-b7a9-9bd463a304d7"},{"name":"Scheduler","item":[{"name":"Set schedule","id":"8f5cb3b9-d568-426b-8c3b-0a11ea19ffaf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\r\n {\r\n \"hour\": 13,\r\n \"minute\": 15,\r\n \"days\": 127,\r\n \"dimmers\": 1,\r\n \"value\": 25,\r\n \"ramp\": 50\r\n },\r\n {\r\n \"hour\": 13,\r\n \"minute\": 20,\r\n \"days\": 127,\r\n \"dimmers\": 1,\r\n \"value\": 0,\r\n \"ramp\": 50\r\n }\r\n]"},"url":"{{ip}}/api/v1/schedule","description":"Allow set schedule on dimmers outputs.
\nThis method accepts array of JSON object as request body. The single object are described bellow:
\nLimit of schedule objects is 100.
\nDays field is binary number with selected days converted to decimal format. Least significant bit (0) responds to Sunday most significant bit (6) responds to Saturday.
\nBinary example:
\n01111111 -> 127, item active all days in week,
\n00111110 -> 62, item active from Monday to Friday,
\n01000001 -> 65, item active in Saturday and Sunday.
\nDimmers field is binary number with bit 0 corresponds to dimmer 0 (1) and bit 3 corresponds to dimmer 3 (4).
\nBinary example:
\n1111 -> 15, all dimmers,
\n0001 -> 1, dimmer 0 (1),
\n1000 -> 8, dimmer 3 (4)
\nExample:
\n[\n {\n \"hour\": 13,\n \"minute\": 15,\n \"days\": 127,\n \"dimmers\": 1,\n \"value\": 25,\n \"ramp\": 50\n },\n {\n \"hour\": 13,\n \"minute\": 20,\n \"days\": 127,\n \"dimmers\": 1,\n \"value\": 0,\n \"ramp\": 50\n }\n]\nThis example set schedule on dimmer 0 (1), the dimmer value will be set to 25% with ramp 5s about 13:15 every day and set to 0% with ramp 5s about 13:20.
\n","urlObject":{"path":["api","v1","schedule"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8f5cb3b9-d568-426b-8c3b-0a11ea19ffaf"},{"name":"Get schedule","id":"a803fffe-dbe3-45e6-b8a0-f80267fc0427","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{ip}}/api/v1/schedule","description":"Return defined schedule items.
\nThis method return array of JSON object as response body.
\nExample:
\n[{\n \"hour\": 13,\n \"minute\": 15,\n \"days\": 127,\n \"dimmers\": 1,\n \"value\": 25,\n \"ramp\": 50,\n \"id\": \"\"\n}, {\n \"hour\": 13,\n \"minute\": 20,\n \"days\": 127,\n \"dimmers\": 1,\n \"value\": 0,\n \"ramp\": 50,\n \"id\": \"\"\n}]\nRequire single JSON object same as in set schedule request
\n","urlObject":{"path":["api","v1","schedule","add"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"fc3bfdab-b885-4eca-b69e-c235ba98de09"},{"name":"Remove schedule item","id":"e9ee28ca-145b-4d57-aec7-289c4e6f9cbe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"id\": \"test\"\n}"},"url":"{{ip}}/api/v1/schedule/remove","description":"This method accept JSON object as request body. The object fields are described bellow:
\nThe schedule item can by removed by id or by index, id or index should be given else bad request will be returned.
\n","urlObject":{"path":["api","v1","schedule","remove"],"host":["{{ip}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"e9ee28ca-145b-4d57-aec7-289c4e6f9cbe"}],"id":"ab75cbf5-1b2f-4836-be82-4c7f45b8b1de","_postman_id":"ab75cbf5-1b2f-4836-be82-4c7f45b8b1de","description":""}],"event":[{"listen":"prerequest","script":{"id":"2fce17f7-98d1-46e7-afdf-29c0e1d3f0b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b6861549-6cbc-424e-a702-f1e8f58ae1b8","type":"text/javascript","exec":[""]}}]}