home-assistant.github.io/source/_components/switch.arest.markdown
Paulus Schoutsen 04f48395d6 Merge branch 'pr/101'
Conflicts:
	source/components/index.markdown
2015-10-24 21:54:58 -07:00

1.5 KiB

layout title description date sidebar comments sharing footer logo ha_category
page aREST switch support Instructions how to integrate aREST switches within Home Assistant. 2015-09-11 23:15 false false true true arest.png Switch
The arest switch platform allows you to toggle pins of your devices (like Arduino boards with a ethernet/wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.

To use your aREST enabled device in your installation, add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  platform: arest
  resource: http://IP_ADDRESS
  name: Office
  pins:
    11:
      name: Fan
    12:
      name: Light Desk

Configuration variables:

  • resource (Required): IP address and schema of the device that is exposing an aREST API, eg. http://192.168.1.10.
  • name (Optional): Let you overwrite the the name of the device. By default name from the device is used.
  • pins (Required): An array with all used pins of your board.
    • name (Required): The name of the pin you wish to toggle.

Accessing one of the endpoints (eg. http://192.168.1.10/analog/2/) will give you a JSON response. The interesting part is return_value which represents the sensor's data.

{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}