diff --git a/components/switch.rest/index.html b/components/switch.rest/index.html
index 241555e9aa..68e3a66e21 100644
--- a/components/switch.rest/index.html
+++ b/components/switch.rest/index.html
@@ -78,9 +78,9 @@
- resource (Required): The resource or endpoint that contains the value.
- name (Optional): Name of the REST switch.
- - body_on (Optional): The body of the POST request that commands the switch to become enabled. Default is “ON”. This value can be a template, which is useful if the POST request needs to depend on the state of the system. For example, to enable remote-temperature-sensor tracking on a radio thermostat, one has to send the current value of the remote temperature sensor. On can achieve this using the template
'{"rem_temp":}'
.
- - body_off (Optional): The body of the POST request that commands the switch to become disabled. Default is “OFF”. This value can also be a template.
- - is_on_template (Optional): A template that determines the state of the switch from the value returned by the GET request on the resource url. This template should compute to a boolean (True or False). If the value is valid JSON, it will be available in the template as the variable value_json. See this example in the template docs. Default is equivalent to
'{{ value_json == body_on }}'
. This means that by default, the state of the switch is on if and only if the response to the GET request matches body_on
.
+ - body_on (Optional): The body of the POST request that commands the switch to become enabled. Default is “ON”. This value can be a template.
+ - body_off (Optional): The body of the POST request that commands the switch to become disabled. Default is “OFF”. This value can also be a template.
+ - is_on_template (Optional): A template that determines the state of the switch from the value returned by the GET request on the resource URL. This template should compute to a boolean (True or False). If the value is valid JSON, it will be available in the template as the variable
value_json
. See this example in the template documentation. Default is equivalent to '{{ value_json == body_on }}'
. This means that by default, the state of the switch is on if and only if the response to the GET request matches .
Make sure that the URL matches exactly your endpoint or resource.
@@ -93,12 +93,13 @@ Make sure that the URL matches exactly your endpoint or resource.
switch:
- platform: rest
- resource: http://<address>/led_endpoint
+ resource: http://IP_ADDRESS/led_endpoint
body_on: '{"active": "true"}'
body_off: '{"active": "false"}'
is_on_template: '{{value_json.is_active}}'
+body_on
and body_off
can also depend on the state of the system. For example, to enable a remote temperature sensor tracking on a radio thermostat, one has to send the current value of the remote temperature sensor. This can be achieved by using the template '{"rem_temp":}'
.