Set States
Allows applying a new value to an object-array variable through the URL by index or unique id.
HTTP Request
- Method:
GET
- URL index:
http://screen-address:8080/api/set/{domain}/{variable}/{index}/{value}
- URL unique id:
http://screen-address:8080/api/set/uid/{domain}/{variable}/{unique_id}/{value}
JSON TCP Request
- URL index:
/api/set/{domain}/{variable}/{index}/{value}
- URL unique id:
/api/set/uid/{domain}/{variable}/{unique_id}/{value}
Accessible variables
Domain | Variable |
---|---|
action | state |
alarm | subtext, state |
heat | state, temp, set_point, mode1_state, mode2_state, mode3_state, mode4_state, text_heat, subtext |
home_action | state |
lighting | level, subtext, state |
opening | subtext |
HTTP index exemple
Request :
GET http://screen-address:8080/api/set/lighting/subtext/0/text_value
Response :
{ "code": 200 }
HTTP unique id exemple
Request :
GET http://screen-address:8080/api/set/uid/lighting/subtext/light-uid/text_value
Response :
{ "code": 200 }
JSON TCP index exemple
Request :
{
"request": {
"url":"/api/set/lighting/subtext/0/text_value"
},
"id":"message-id", //Optional
"password":"password" //If defined and only for the first request
}
Response :
{
"request":{
"response": {
"code":200
},
"content_type":"application/json"
},
"id":"message-id" //Returns the received ID if defined.
}
JSON TCP unique id exemple
Request :
{
"request": {
"url":"/api/set/uid/lighting/subtext/light-uid/text_value"
},
"id":"message-id", //Optional
"password":"password" //If defined and only for the first request
}
Response :
{
"request":{
"response": {
"code":200
},
"content_type":"application/json"
},
"id":"message-id" //Returns the received ID if defined.
}