jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-05-01 16:57:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/components/switch.rest.markdown
Fabian Affolter eca5731d4c Add rest switch page
2015-10-23 18:34:13 +02:00

1.1 KiB
Raw Blame History

layout title description date sidebar comments sharing footer
page RESTful switch support Instructions how to integrate REST switches into Home Assistant. 2015-09-14 19:10 false false true true
The rest switch platform allows you to control a given endpoint that supports a [RESTful API](https://en.wikipedia.org/wiki/Representational_state_transfer). The switch can get the state via GET and set the state via POST on a given REST resource.

To enable this switch, add the following lines to your configuration.yaml file:

switch: platform: rest resource: http://IP_ADDRESS/ENDPOINT name: "Bedroom Switch" body_on: "ON" body_off: "OFF"


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".

<p class='note warning'>
Make sure that the URL matches exactly your endpoint or resource.
</p>