Skip to content

Commit fa0ca7f

Browse files
authored
Update var description (home-assistant#1834)
* Update var description * Update description
1 parent 6c3df54 commit fa0ca7f

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

source/_components/sensor.arest.markdown

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ footer: true
1010
logo: arest.png
1111
ha_category: Sensor
1212
ha_iot_class: "Local Polling"
13+
ha_release: pre 0.7
1314
---
1415

1516

@@ -19,8 +20,9 @@ To use your aREST enabled device in your installation, add the following to your
1920

2021
```yaml
2122
# Example configuration.yaml entry
23+
sensor:
2224
- platform: arest
23-
resource: http://10.100.0.117
25+
resource: http://IP_ADDRESS
2426
monitored_variables:
2527
temperature:
2628
name: temperature
@@ -34,13 +36,15 @@ Configuration variables:
3436
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, e.g. http://192.168.1.10.
3537
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
3638
- **monitored_variables** array (*Optional*): List of exposed variables.
37-
- **name** (*Required*): The name of the variable you wish to monitor.
38-
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
39-
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
39+
- **[variable]** (*Required*): Name of the variable to monitor.
40+
- **name** (*Optional*): The name to use for the frontend.
41+
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
42+
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
4043
- **pins** array (*Optional*): List of pins to monitor. Analog pins need a leading **A** for the pin number.
41-
- **name** (*Optional*): The name of the variable you wish to monitor.
42-
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
43-
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
44+
- **[pin]** (*Required*): Pin number to use.
45+
- **name** (*Required*): The name of the variable you wish to monitor.
46+
- **unit_of_measurement** (*Optional*): Defines the unit of measurement of the sensor, if any.
47+
- **value_template** (*Optional*): Defines a [template](/topics/templating/) to extract a value from the payload.
4448
4549
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.
4650

source/_components/switch.arest.markdown

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ switch:
2525
pins:
2626
11:
2727
name: Fan
28-
12:
29-
name: Light Desk
3028
```
3129
3230
If you want to use custom functions, then add the following to your `configuration.yaml` file:
@@ -39,21 +37,19 @@ switch:
3937
name: Office
4038
functions:
4139
function1:
42-
name:
43-
function2:
4440
name: Light Desk
4541
```
4642

4743
Configuration variables:
4844

4945
- **resource** (*Required*): IP address and schema of the device that is exposing an aREST API, eg. http://192.168.1.10 (no-trailing slash)
5046
- **name** (*Optional*): Let you overwrite the the name of the device. By default *name* from the device is used.
51-
- **pins** array (*Required*): An array with all used pins.
47+
- **pins** array (*Optional*): An array with all used pins.
5248
- **name** (*Required*): The name of the pin to use in the frontend.
5349

5450
or
5551

56-
- **functions** array (*Required*): An array with all used functions.
52+
- **functions** array (*Optional*): An array with all used functions.
5753
- **name** (*Required*): The name to use in the frontend.
5854

5955
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.

0 commit comments

Comments
 (0)