mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Update var description (#1834)
* Update var description * Update description
This commit is contained in:
parent
6c3df542ae
commit
fa0ca7f802
@ -10,6 +10,7 @@ footer: true
|
||||
logo: arest.png
|
||||
ha_category: Sensor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: pre 0.7
|
||||
---
|
||||
|
||||
|
||||
@ -19,8 +20,9 @@ To use your aREST enabled device in your installation, add the following to your
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: arest
|
||||
resource: http://10.100.0.117
|
||||
resource: http://IP_ADDRESS
|
||||
monitored_variables:
|
||||
temperature:
|
||||
name: temperature
|
||||
@ -34,11 +36,13 @@ 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.
|
||||
- **monitored_variables** array (*Optional*): List of exposed variables.
|
||||
- **name** (*Required*): The name of the variable you wish to monitor.
|
||||
- **[variable]** (*Required*): Name of the variable to monitor.
|
||||
- **name** (*Optional*): The name to use for the frontend.
|
||||
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
|
||||
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
- **pins** array (*Optional*): List of pins to monitor. Analog pins need a leading **A** for the pin number.
|
||||
- **name** (*Optional*): The name of the variable you wish to monitor.
|
||||
- **[pin]** (*Required*): Pin number to use.
|
||||
- **name** (*Required*): The name of the variable you wish to monitor.
|
||||
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
|
||||
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
|
||||
|
||||
|
@ -25,8 +25,6 @@ switch:
|
||||
pins:
|
||||
11:
|
||||
name: Fan
|
||||
12:
|
||||
name: Light Desk
|
||||
```
|
||||
|
||||
If you want to use custom functions, then add the following to your `configuration.yaml` file:
|
||||
@ -39,8 +37,6 @@ switch:
|
||||
name: Office
|
||||
functions:
|
||||
function1:
|
||||
name:
|
||||
function2:
|
||||
name: Light Desk
|
||||
```
|
||||
|
||||
@ -48,12 +44,12 @@ 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 the name of the device. By default *name* from the device is used.
|
||||
- **pins** array (*Required*): An array with all used pins.
|
||||
- **pins** array (*Optional*): An array with all used pins.
|
||||
- **name** (*Required*): The name of the pin to use in the frontend.
|
||||
|
||||
or
|
||||
|
||||
- **functions** array (*Required*): An array with all used functions.
|
||||
- **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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user