From 3a1c599f6ec39908be9ac8e1a47705c91dab5605 Mon Sep 17 00:00:00 2001 From: Fabian Affolter Date: Mon, 10 Oct 2016 16:53:34 +0200 Subject: [PATCH] Pin is now optional (#1204) --- source/_components/sensor.zigbee.markdown | 4 ++-- source/_components/zigbee.markdown | 29 ++++++++++------------- 2 files changed, 15 insertions(+), 18 deletions(-) diff --git a/source/_components/sensor.zigbee.markdown b/source/_components/sensor.zigbee.markdown index 96f66fc0d45..64049c9837f 100644 --- a/source/_components/sensor.zigbee.markdown +++ b/source/_components/sensor.zigbee.markdown @@ -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 %} diff --git a/source/_components/zigbee.markdown b/source/_components/zigbee.markdown index 8b29e11237a..1b3c76b2bd4 100644 --- a/source/_components/zigbee.markdown +++ b/source/_components/zigbee.markdown @@ -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*

The port may also appear as /dev/ttyACM* if you're communicating with the ZigBee device through an Arduino.

+ +### {% linkable_title Example %} + +```yaml +# Example configuration.yaml entry +zigbee: + device: /dev/ttyACM1 + baud: 115200 +```