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.arest.markdown
Florian Klien dd51ad0df5 fixed double 'the' (#3447) 
* fixed double 'the'

mostly 's/the the /the /', little style changes where 'is' or 'to' was missing

* removed duplicate words

removed duplicate words like 'to to', 'you you' or 'account account' etc.

a batch of pizza-toasts burnt for this.
2017-09-26 20:30:04 +02:00

1.9 KiB
Raw Blame History

layout title description date sidebar comments sharing footer logo ha_category ha_iot_class ha_release
page aREST Switch Instructions how to integrate aREST switches within Home Assistant. 2015-09-11 23:15 true false true true arest.png Switch Local Polling 0.16

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 RESTful framework.

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

# Example configuration.yaml entry
switch:
  - platform: arest
    resource: http://IP_ADDRESS
    pins:
      11:
        name: Fan

If you want to use custom functions, then add the following to your configuration.yaml file:

# Example configuration.yaml entry
switch:
  - platform: arest
    resource: http://IP_ADDRESS
    name: Office
    functions:
      function1:
        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 (no-trailing slash)
  • name (Optional): Let you overwrite the name of the device. By default name from the device is used.
  • pins array (Optional): An array with all used pins.
    • name (Required): The name of the pin to use in the frontend.

or

  • functions array (Optional): An array with all used functions.
    • name (Required): The name to use in the frontend.

You can still switch your pins with a web browser or a command line tool. Use the URL http://192.168.1.10/digital/8/1 to set pin 8 to high/on, the JSON response will give you the feedback.

{"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true}