Pin is now optional (#1204)

This commit is contained in:
Fabian Affolter 2016-10-10 16:53:34 +02:00 committed by GitHub
parent e2987b9414
commit 3a1c599f6e
2 changed files with 15 additions and 18 deletions

View File

@ -34,9 +34,9 @@ Configuration variables:
- **name** (*Required*): The name you would like to give the sensor in Home Assistant.
- **type** (*Required*): Set to `analog` or `temperature`.
- **pin** (*Required*): The number identifying which pin to sample
- **pin** (*Optional*): The number identifying which pin to sample.
- **address** (*Optional*): The long 64 bit address of the remote ZigBee device whose pin you would like to sample. Do not include this variable if you want to sample the local ZigBee device's pins.
- **max_volts** (*Optional*): The maximum voltage which the input pin is able to read. Defaults to `1.2`
- **max_volts** (*Optional*): The maximum voltage which the input pin is able to read. Defaults to `1.2`.
## {% linkable_title Examples %}

View File

@ -24,28 +24,16 @@ There is currently support for the following device types within Home Assistant:
The local ZigBee device (assuming XBee) must have an up to date Router or Coordinator API firmware installed.
## Configuration
A `zigbee` section must be present in the `configuration.yaml` file and contain the following options as required:
- **device**: The serial port to which the local ZigBee device is connected. Default: `/dev/ttyUSB0`
- **baud**: The baud rate at which to communicate with the local ZigBee device. Default: `9600`
#### Example
```yaml
zigbee:
device: /dev/ttyUSB0
baud: 115200
```
Or to simply use the defaults:
```yaml
# Example configuration.yaml entry
zigbee:
```
- **device** (*Optional*): The serial port to which the local ZigBee device is connected. Defaults to `/dev/ttyUSB0`
- **baud** (*Optional*): The baud rate at which to communicate with the local ZigBee device. Defaults to `9600`
To find the possible serial port names of your device, run:
```bash
@ -55,3 +43,12 @@ $ ls /dev/ttyUSB*
<p class='note'>
The port may also appear as /dev/ttyACM* if you're communicating with the ZigBee device through an Arduino.
</p>
### {% linkable_title Example %}
```yaml
# Example configuration.yaml entry
zigbee:
device: /dev/ttyACM1
baud: 115200
```