Minor update

This commit is contained in:
Fabian Affolter 2015-10-29 09:36:30 +01:00
parent 083825388e
commit b726f0e94b

View File

@ -11,7 +11,6 @@ logo: arest.png
ha_category: Switch ha_category: 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. 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: To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
@ -33,12 +32,12 @@ Configuration variables:
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, eg. http://192.168.1.10. - **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. - **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. - **pins** array (*Required*): An array with all used pins of your board.
- **name** (*Required*): The name of the pin you wish to toggle. - **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. You can still switch your pins with a web browser or a command line tool. Use the http://192.168.1.10/digital/8/1 to set pin 8 to high/on, the JSON response will give you some feedback.
```json ```json
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true} {"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true}
``` ```