mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-04 10:08:57 +00:00
b39bd81c6e
* Spelling fixes * "It's" -> "its" fixes * Fix capitalization of "Pi" in "Raspberry Pi" "Pi", not "PI" or "pi".
56 lines
1.7 KiB
Markdown
56 lines
1.7 KiB
Markdown
---
|
|
layout: page
|
|
title: "aREST Binary Sensor"
|
|
description: "Instructions how to integrate aREST binary sensors within Home Assistant."
|
|
date: 2015-11-20 18:15
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: arest.png
|
|
ha_category: Binary Sensor
|
|
ha_iot_class: "Local Polling"
|
|
ha_release: 0.9
|
|
---
|
|
|
|
|
|
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:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
- platform: arest
|
|
resource: http://IP_ADDRESS
|
|
pin: 8
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
|
|
- **pin** (*Required*): Number of the pin to monitor.
|
|
- **name** (*Optional*): Let you overwrite the name of the device. By default *name* from the device is used.
|
|
|
|
Accessing the URL http://IP_ADDRESS/digital/PIN_NUMBER should give you the state of the pin inside a JSON response as `return_value`.
|
|
|
|
```bash
|
|
$ curl -X GET http://192.168.0.5/digital/9
|
|
{"return_value": 0, "id": "office1", "name": "Office", "connected": true}
|
|
```
|
|
|
|
An example for Pin 9 inspired by the command above could look like this:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
binary_sensor:
|
|
- platform: arest
|
|
resource: http://192.168.0.5/digital/9
|
|
pin: 9
|
|
name: Office
|
|
```
|
|
|
|
<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.
|
|
</p>
|