mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
🚜 Merges/Redirect Arest component pages (#9121)
* 🚜 Merges/Redirect Arest component pages * ✏️ Tweak * ✏️ Tweak
This commit is contained in:
Klaas Schoute
Fabian Affolter
parent
9fb9f96778
commit
a52b4b3438
@ -1,23 +1,35 @@
|
|||||||
---
|
---
|
||||||
layout: page
|
layout: page
|
||||||
title: "aREST Binary Sensor"
|
title: "aREST"
|
||||||
description: "Instructions on how to integrate aREST binary sensors within Home Assistant."
|
description: "Instructions on how to integrate aREST within Home Assistant."
|
||||||
date: 2015-11-20 18:15
|
date: 2015-11-20 18:15
|
||||||
sidebar: true
|
sidebar: true
|
||||||
comments: false
|
comments: false
|
||||||
sharing: true
|
sharing: true
|
||||||
footer: true
|
footer: true
|
||||||
logo: arest.png
|
logo: arest.png
|
||||||
ha_category: DIY
|
ha_category:
|
||||||
|
- DIY
|
||||||
|
- Binary Sensor
|
||||||
|
- Sensor
|
||||||
|
- Switch
|
||||||
ha_iot_class: Local Polling
|
ha_iot_class: Local Polling
|
||||||
ha_release: 0.9
|
ha_release: 0.9
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /components/binary_sensor.arest/
|
- /components/binary_sensor.arest/
|
||||||
|
- /components/sensor.arest/
|
||||||
|
- /components/switch.arest/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
There is currently support for the following device types within Home Assistant:
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
- [Binary Sensor](#binary-sensor)
|
||||||
|
- [Sensor](#sensor)
|
||||||
|
- [Switch](#switch)
|
||||||
|
|
||||||
|
## {% linkable_title Binary Sensor %}
|
||||||
|
|
||||||
|
The `arest` binary sensor platform allows you to get all data from your devices (like Arduinos with an ethernet/wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
||||||
|
|
||||||
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
|
To use your aREST binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||||
|
|
||||||
@ -65,3 +77,178 @@ binary_sensor:
|
|||||||
<p class='note'>
|
<p class='note'>
|
||||||
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
|
This sensor is not suitable for fast state changes because there is a high possibility that the change took place between two update cycle.
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
## {% linkable_title Sensor %}
|
||||||
|
|
||||||
|
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, 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:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
sensor:
|
||||||
|
- platform: arest
|
||||||
|
resource: https://IP_ADDRESS
|
||||||
|
monitored_variables:
|
||||||
|
temperature:
|
||||||
|
name: temperature
|
||||||
|
pins:
|
||||||
|
A0:
|
||||||
|
name: Pin 0 analog
|
||||||
|
```
|
||||||
|
|
||||||
|
{% configuration %}
|
||||||
|
resource:
|
||||||
|
description: "IP address and schema of the device that is exposing an aREST API, e.g., https://192.168.1.10."
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
name:
|
||||||
|
description: Let you overwrite the name of the device.
|
||||||
|
required: false
|
||||||
|
default: aREST sensor
|
||||||
|
type: string
|
||||||
|
pins:
|
||||||
|
description: List of pins to monitor. Analog pins need a leading **A** for the pin number.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
pin:
|
||||||
|
description: Pin number to use.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
name:
|
||||||
|
description: The name of the variable you wish to monitor.
|
||||||
|
required: true
|
||||||
|
type: string
|
||||||
|
unit_of_measurement:
|
||||||
|
description: Defines the unit of measurement of the sensor, if any.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
value_template:
|
||||||
|
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
||||||
|
required: false
|
||||||
|
type: template
|
||||||
|
monitored_variables:
|
||||||
|
description: List of exposed variables.
|
||||||
|
required: false
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
variable:
|
||||||
|
description: Name of the variable to monitor.
|
||||||
|
required: true
|
||||||
|
type: list
|
||||||
|
keys:
|
||||||
|
name:
|
||||||
|
description: The name to use for the frontend.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
unit_of_measurement:
|
||||||
|
description: Defines the units of measurement of the sensor, if any.
|
||||||
|
required: false
|
||||||
|
type: string
|
||||||
|
value_template:
|
||||||
|
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
||||||
|
required: false
|
||||||
|
type: template
|
||||||
|
{% endconfiguration %}
|
||||||
|
|
||||||
|
The variables in the `monitored_variables` array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. [Ethernet](https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino) for an Arduino with Ethernet shield). In those sketches are two variables (`temperature` and `humidity`) available which will act as endpoints.
|
||||||
|
|
||||||
|
Accessing one of the endpoints (eg. http://192.168.1.10/temperature) will give you the value inside a JSON response.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}
|
||||||
|
```
|
||||||
|
|
||||||
|
The root will give you a JSON response that contains all variables and their current values along with some device details.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"variables" : {
|
||||||
|
"temperature" : 23,
|
||||||
|
"humidity" : 82
|
||||||
|
},
|
||||||
|
"id" : "sensor01",
|
||||||
|
"name" : "livingroom",
|
||||||
|
"connected" : true
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
`return_value` contains the sensor's data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/).
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
|
||||||
|
```
|
||||||
|
|
||||||
|
## {% linkable_title Switch %}
|
||||||
|
|
||||||
|
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:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: arest
|
||||||
|
resource: http://IP_ADDRESS
|
||||||
|
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:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Example configuration.yaml entry
|
||||||
|
switch:
|
||||||
|
- platform: arest
|
||||||
|
resource: http://IP_ADDRESS
|
||||||
|
name: Office
|
||||||
|
functions:
|
||||||
|
function1:
|
||||||
|
name: Light Desk
|
||||||
|
```
|
||||||
|
|
||||||
|
{% 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.
|
||||||
|
|
||||||
|
```json
|
||||||
|
{"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true}
|
||||||
|
```
|
||||||
|
|||||||
@ -1,117 +0,0 @@
|
|||||||
---
|
|
||||||
layout: page
|
|
||||||
title: "aREST Sensor"
|
|
||||||
description: "Instructions on how to integrate aREST sensors within Home Assistant."
|
|
||||||
date: 2015-09-07 18:15
|
|
||||||
sidebar: true
|
|
||||||
comments: false
|
|
||||||
sharing: true
|
|
||||||
footer: true
|
|
||||||
logo: arest.png
|
|
||||||
ha_category: DIY
|
|
||||||
ha_iot_class: Local Polling
|
|
||||||
ha_release: pre 0.7
|
|
||||||
---
|
|
||||||
|
|
||||||
The `arest` sensor platform allows you to get all data from your devices (like Arduinos with a Ethernet/Wifi connection, the ESP8266, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
To use your aREST enabled device in your installation, add the following to your `configuration.yaml` file:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
# Example configuration.yaml entry
|
|
||||||
sensor:
|
|
||||||
- platform: arest
|
|
||||||
resource: https://IP_ADDRESS
|
|
||||||
monitored_variables:
|
|
||||||
temperature:
|
|
||||||
name: temperature
|
|
||||||
pins:
|
|
||||||
A0:
|
|
||||||
name: Pin 0 analog
|
|
||||||
```
|
|
||||||
|
|
||||||
{% configuration %}
|
|
||||||
resource:
|
|
||||||
description: "IP address and schema of the device that is exposing an aREST API, e.g., https://192.168.1.10."
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
name:
|
|
||||||
description: Let you overwrite the name of the device.
|
|
||||||
required: false
|
|
||||||
default: aREST sensor
|
|
||||||
type: string
|
|
||||||
pins:
|
|
||||||
description: List of pins to monitor. Analog pins need a leading **A** for the pin number.
|
|
||||||
required: false
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
pin:
|
|
||||||
description: Pin number to use.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
name:
|
|
||||||
description: The name of the variable you wish to monitor.
|
|
||||||
required: true
|
|
||||||
type: string
|
|
||||||
unit_of_measurement:
|
|
||||||
description: Defines the unit of measurement of the sensor, if any.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
value_template:
|
|
||||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
|
||||||
required: false
|
|
||||||
type: template
|
|
||||||
monitored_variables:
|
|
||||||
description: List of exposed variables.
|
|
||||||
required: false
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
variable:
|
|
||||||
description: Name of the variable to monitor.
|
|
||||||
required: true
|
|
||||||
type: list
|
|
||||||
keys:
|
|
||||||
name:
|
|
||||||
description: The name to use for the frontend.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
unit_of_measurement:
|
|
||||||
description: Defines the units of measurement of the sensor, if any.
|
|
||||||
required: false
|
|
||||||
type: string
|
|
||||||
value_template:
|
|
||||||
description: Defines a [template](/docs/configuration/templating/#processing-incoming-data) to extract a value from the payload.
|
|
||||||
required: false
|
|
||||||
type: template
|
|
||||||
{% endconfiguration %}
|
|
||||||
|
|
||||||
The variables in the `monitored_variables` array must be available in the response of the device. As a starting point you could use the one of the example sketches (eg. [Ethernet](https://raw.githubusercontent.com/marcoschwartz/aREST/master/examples/Ethernet/Ethernet.ino) for an Arduino with Ethernet shield). In those sketches are two variables (`temperature` and `humidity`) available which will act as endpoints.
|
|
||||||
|
|
||||||
Accessing one of the endpoints (eg. http://192.168.1.10/temperature) will give you the value inside a JSON response.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{"temperature": 23, "id": "sensor01", "name": "livingroom", "connected": true}
|
|
||||||
```
|
|
||||||
|
|
||||||
The root will give you a JSON response that contains all variables and their current values along with some device details.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
|
||||||
"variables" : {
|
|
||||||
"temperature" : 23,
|
|
||||||
"humidity" : 82
|
|
||||||
},
|
|
||||||
"id" : "sensor01",
|
|
||||||
"name" : "livingroom",
|
|
||||||
"connected" : true
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
`return_value` contains the sensor's data in a JSON response for a given pin (eg. http://192.168.1.10/analog/2/ or http://192.168.1.10/digital/7/).
|
|
||||||
|
|
||||||
```json
|
|
||||||
{"return_value": 34, "id": "sensor02", "name": "livingroom", "connected": true}
|
|
||||||
```
|
|
||||||
@ -1,86 +0,0 @@
|
|||||||
---
|
|
||||||
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: DIY
|
|
||||||
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 an Ethernet/Wifi connection, ESP8266 based devices, and the Raspberry Pi) running the [aREST](http://arest.io/) RESTful framework.
|
|
||||||
|
|
||||||
## {% linkable_title Configuration %}
|
|
||||||
|
|
||||||
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
|
|
||||||
13:
|
|
||||||
name: Switch
|
|
||||||
invert: true
|
|
||||||
```
|
|
||||||
|
|
||||||
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 %}
|
|
||||||
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.
|
|
||||||
|
|
||||||
```json
|
|
||||||
{"message": "Pin D8 set to 1", "id": "sensor02", "name": "livingroom", "connected": true}
|
|
||||||
```
|
|
||||||
Loading…
x
Reference in New Issue
Block a user