From 79352842901aafde1277836ecde0b40d6cb839af Mon Sep 17 00:00:00 2001 From: Abhishek Anand Date: Fri, 28 Oct 2016 06:09:25 -0400 Subject: [PATCH] switch.rest updates (#1030) * updates corresponding to PR#3329 * more explanation * de-jargoned iff --- source/_components/switch.rest.markdown | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/source/_components/switch.rest.markdown b/source/_components/switch.rest.markdown index 43e30200b6e..51c43af6497 100644 --- a/source/_components/switch.rest.markdown +++ b/source/_components/switch.rest.markdown @@ -28,8 +28,10 @@ Configuration variables: - **resource** (*Required*): The resource or endpoint that contains the value. - **name** (*Optional*): Name of the REST switch. -- **body_on** (*Optional*): The body that represents enabled state. Default is "ON". -- **body_off** (*Optional*):The body that represents disabled state. Default is "OFF". +- **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](/topics/templating/), 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":{{states.sensor.bedroom_temp.state}}}'`. +- **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](/topics/templating/) 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). 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`. +

Make sure that the URL matches exactly your endpoint or resource.