jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Osram Lightify documentation to reflect the latest changes (#8621)

Browse Source 
* Update Osram Lightify documentation to reflect latest changes to the component

* Update information about switches and sensors

* Update source/_components/light.osramlightify.markdown

Co-Authored-By: OleksandrBerchenko <OleksandrBerchenko@users.noreply.github.com>

* Improve true/false descriptions

* Hide functionality to be released later

* Mention all new Osram Lightify functionality
This commit is contained in:
OleksandrBerchenko 2019-04-02 22:49:46 +02:00 committed by Klaas Schoute
parent 5bb805e9e4
commit a3dfb7926c
1 changed files with 48 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
source/_components/light.osramlightify.markdown
View File

@ -12,13 +12,13 @@ ha_category: Light
ha_release: 0.21
---
The `osramlightify` platform allows you to integrate your [Osram Lightify](http://www.osram.com/osram_com/products/led-technology/lightify/index.jsp) into Home Assistant.
The `osramlightify` platform allows you to integrate your [Osram Lightify](https://www.osram.com/cb/lightify/index.jsp) into Home Assistant.
```yaml
# Example configuration.yaml entry
light:
- platform: osramlightify
host: 192.168.0.50
host: IP_ADDRESS
```
{% configuration %}
@ -27,13 +27,57 @@ host:
required: true
type: string
allow_lightify_nodes:
description: (true/false) Edit this to stop homeassistant from importing the lightify lights.
description: (true/false) If `true` then import individual lights, if `false` then skip them.
required: false
default: true
type: boolean
allow_lightify_sensors:
description: (true/false) If `true` then import contact and motion sensors, if `false` then skip them. Takes effect only if `allow_lightify_nodes` is `true`.
required: false
default: true
type: boolean
allow_lightify_switches:
description: (true/false) If `true` then import switches, if `false` then skip them. Takes effect only if `allow_lightify_nodes` is `true`.
required: false
default: true
type: boolean
allow_lightify_groups:
description: (true/false) Edit this to stop homeassistant from importing the lightify groups.
description: (true/false) If `true` then import groups, if `false` then skip them.
required: false
default: true
type: boolean
interval_lightify_status:
description: Minimum interval in seconds between querying light status (for both individual lights and groups).
required: false
default: 5
type: integer
interval_lightify_conf:
description: Minimum interval in seconds between querying groups and scenes configuration.
required: false
default: 3600
type: integer
{% endconfiguration %}
At the moment there is not much functionality for Osram Lightify switches and sensors.
The only thing that you can do out of the box is to track whether they are available or not.
Also for sensors a list of raw values is exposed as `sensor_values` attribute, and you can use them
in automations, if you know what particular values mean for your sensor.
It is suggested to make [scan_interval](https://www.home-assistant.io/docs/configuration/platform_options/#scan-interval)
(30 seconds by default) less or equal to `interval_lightify_status`, oherwise the latter won't work
as expected. Shorter `scan_interval` may improve synchronization speed between individual lights and
groups. For example, if you turn on a group, all its lights may be updated to `on` immediately,
without querying the bridge.
Please note that to update all light statuses, only one query to the bridge is actually needed.
If a group has associated scenes, they will be imported as light effects and visible in `Effect`
dropdown on UI. You can apply a scene by clicking an item from the dropdown or by calling
`light.turn_on` service:
```yaml
- service: light.turn_on
entity_id: light.bedroom
data:
effect: Romance
```