mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-03 17:48:59 +00:00
1aca7b08cf
* e.g. to e.g., and proper case for Home Assistant * Instructions how to -> Instructions on how to
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
---
|
|
layout: page
|
|
title: "aREST Switch"
|
|
description: "Instructions on how to integrate aREST switches within Home Assistant."
|
|
date: 2015-09-11 23:15
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: arest.png
|
|
ha_category: Switch
|
|
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.
|
|
|
|
To use your aREST enabled device with pins in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# 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:
|
|
|
|
```yaml
|
|
# 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.
|
|
|
|
```json
|
|
{"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true}
|
|
```
|
|
|