mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-15 05:16:49 +00:00
Merge branch 'binary-sensor'
This commit is contained in:
commit
6fd3f9fce9
44
source/_components/binary_sensor.arest.markdown
Normal file
44
source/_components/binary_sensor.arest.markdown
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: component
|
||||
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
|
||||
---
|
||||
|
||||
|
||||
The arest binary 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 binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
platform: arest
|
||||
resource: http://IP_ADDRESS
|
||||
name: Office Switch
|
||||
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.
|
||||
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
|
||||
- **pin** (*Required*): Number of the pin to monitor.
|
||||
|
||||
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://10.100.0.157/digital/9
|
||||
{"return_value": 0, "id": "office1", "name": "Office", "connected": true}
|
||||
|
||||
```
|
||||
|
||||
<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>
|
15
source/_components/binary_sensor.markdown
Normal file
15
source/_components/binary_sensor.markdown
Normal file
@ -0,0 +1,15 @@
|
||||
---
|
||||
layout: component
|
||||
title: "Binary Sensor"
|
||||
description: "Instructions how to setup your binary sensors with Home Assistant."
|
||||
date: 2015-11-20 14:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
---
|
||||
|
||||
Binary sensors are gathering information about state of switches, contacts, pins, and alike. The return value of those sensors is usually digital (1/0). This means that those sensors knows only two states: **off/low/open*** and ***on/high/closed**.
|
||||
|
||||
For analog sensors please check the [component overview](https://home-assistant.io/components/#sensor).
|
||||
|
44
source/_components/binary_sensor.mqtt.markdown
Normal file
44
source/_components/binary_sensor.mqtt.markdown
Normal file
@ -0,0 +1,44 @@
|
||||
---
|
||||
layout: component
|
||||
title: "MQTT binary sensor"
|
||||
description: "Instructions how to integrate MQTT binary sensors within Home Assistant."
|
||||
date: 2015-05-30 23:21
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: mqtt.png
|
||||
ha_category: Binary Sensor
|
||||
---
|
||||
|
||||
|
||||
This MQTT binary sensor implementation uses the MQTT message payload as the sensor value. If messages in this state_topic are published with *RETAIN* flag, the sensor will receive an instant update with the last known value. Otherwise, the initial state will be off.
|
||||
|
||||
To use your MQTT binary sensor in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yml entry
|
||||
binary_sensor:
|
||||
platform: mqtt
|
||||
state_topic: "home-assistant/window/contact"
|
||||
name: "MQTT Sensor"
|
||||
qos: 0
|
||||
payload_on: "ON"
|
||||
payload_of: "OFF"
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **state_topic** (*Required*): The MQTT topic subscribed to receive sensor values.
|
||||
- **name** (*Optional*): The name of the sensor. Default is 'MQTT Sensor'.
|
||||
- **qos** (*Optional*): The maximum QoS level of the state topic. Default is 0.
|
||||
- **payload_on** (*Optional*): The payload that represents on state. Default is "ON".
|
||||
- **payload_off** (*Optional*): The payload that represents state. Default is "OFF".
|
||||
|
||||
|
||||
For a quick check you can use the commandline tools shipped with `mosquitto` to send MQTT messages. Set the state of your sensor manually:
|
||||
|
||||
```bash
|
||||
$ mosquitto_pub -h 127.0.0.1 -t home-assistant/window/contact -m "OFF"
|
||||
```
|
||||
|
Loading…
x
Reference in New Issue
Block a user