diff --git a/source/_components/light.osramlightify.markdown b/source/_components/light.osramlightify.markdown index ac80e46d08a..20ddec022c0 100644 --- a/source/_components/light.osramlightify.markdown +++ b/source/_components/light.osramlightify.markdown @@ -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 +```