mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-02 09:17:35 +00:00
6224c71c08
* ✅ Various markdown, spelling, and grammar fixes * ✅ Various markdown, spelling, and grammar fixes * ✅ Various markdown, spelling, and grammar fixes
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
---
|
|
layout: page
|
|
title: ZigBee Light
|
|
description: "Instructions on how to set up ZigBee lights within Home Assistant."
|
|
date: 2016-01-28 12:38
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: zigbee.png
|
|
ha_category: Light
|
|
ha_release: 0.12
|
|
ha_iot_class: "Local Polling"
|
|
---
|
|
|
|
A ZigBee light in this context is a light connected to one of the digital output pins on a ZigBee module. It can simply be switched on and off. By default, a light is considered `on` when the ZigBee device's digital output is held `high` and considered `off` when it is held `low`. This behavior can be inverted by setting the `on_state` configuration variable to `low`.
|
|
|
|
To configure a digital output pin as light, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
light:
|
|
- name: Desk Lamp
|
|
platform: zigbee
|
|
pin: 0
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **name** (*Required*): The name you would like to give the light in Home Assistant.
|
|
- **pin** (*Required*): The number identifying which pin to use.
|
|
- **address** (*Optional*): The long 64 bit address of the remote ZigBee device whose digital output pin you would like to switch. Do not include this variable if you want to switch the local ZigBee device's pins.
|
|
- **on_state** (*Optional*): Either `high` (default) or `low`, depicting whether the digital output pin is pulled `high` or `low` when the light is turned on.
|