Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 37 additions & 13 deletions source/_components/switch.arest.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ha_iot_class: "Local Polling"
ha_release: 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](http://arest.io/) RESTful framework.
The `arest` switch platform allows you to toggle pins of your devices (like Arduino boards with an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.

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

Expand All @@ -25,6 +25,9 @@ switch:
pins:
11:
name: Fan
13:
name: Switch
invert: True
```

If you want to use custom functions, then add the following to your `configuration.yaml` file:
Expand All @@ -39,18 +42,39 @@ switch:
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.
{% configuration %}
resource:
description: IP address and schema of the device that is exposing an aREST API, e.g., http://192.168.1.10 (no-trailing slash)
required: true
type: string
name:
description: Let you overwrite the name of the device. By default *name* from the device is used.
required: optional
type: string
pins:
description: An array with all used pins.
required: false
type: map
keys:
name:
description: The name of the pin to use in the frontend.
required: true
type: string
invert:
description: If the logic for on/off should be inverted.
required: false
type: boolean
default: false
functions:
description: An array with all used functions.
required: false
type: map
keys:
name:
description: The name to use in the frontend.
required: true
type: string
{% endconfiguration %}

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.

Expand Down