mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-18 23:06:58 +00:00
Update dynalite.markdown (#28187)
The Dynalite integration is now being set up via the UI and the YAML is deprecated.
This commit is contained in:
Ziv
GitHub
parent
64b6e5381d
commit
e23e5dca2b
@ -35,268 +35,13 @@ Each area can have one or more channels that correspond to the different devices
|
||||
|
||||
Additionally, each area can have one or more presets that determine the behavior of all the channels, and sometimes trigger additional actions. Typically, preset '1' in an area means 'on', and preset '4' means 'off'. Additional presets could be used for scenes and dimming.
|
||||
|
||||
## Configuration
|
||||
{% include integrations/config_flow.md %}
|
||||
|
||||
Since Philips Dynalite has virtually no auto-discover capabilities, it needs to be configured via the `configuration.yaml` file:
|
||||
## Setup
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
dynalite:
|
||||
bridges:
|
||||
- host: DEVICE_IP_ADDRESS
|
||||
```
|
||||
Since Philips Dynalite has virtually no auto-discover capabilities, once it is added via the UI, it needs to be configured via Dynalite panel. Note that the panel is only available to "admin" level users.
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: The IP address of the bridge (e.g., 192.168.1.10).
|
||||
required: true
|
||||
type: string
|
||||
port:
|
||||
description: Port number of the bridge.
|
||||
required: false
|
||||
type: integer
|
||||
default: 12345
|
||||
name:
|
||||
description: Name for the bridge.
|
||||
required: false
|
||||
type: string
|
||||
default: dynalite
|
||||
active:
|
||||
description: "Actively query network. When starting, it will query all devices for their current status, and also will send queries when some changes are in progress (e.g., lights dimming or covers moving). Better experience but creates more load on the Dynalite network. Value can be `on`, `off`, our `init`, where `init` will only send queries during the initial init of Home Assistant."
|
||||
required: false
|
||||
type: [boolean, string]
|
||||
default: false
|
||||
polltimer:
|
||||
description: "Polling interval for devices in transition. Value in seconds. When devices are in transition (e.g., a light fading), it will ask for a new state every X seconds until it is at the target level. Only relevant when active is set to `on`."
|
||||
required: false
|
||||
type: float
|
||||
default: 1.0
|
||||
autodiscover:
|
||||
description: Enable auto-discover. As Dynalite does not support native autodiscovery, this tracks events on your network, so if you turn on a light, it will be added to Home Assistant.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
default:
|
||||
description: Global defaults for the system
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
fade:
|
||||
description: Default fade
|
||||
required: false
|
||||
type: float
|
||||
area:
|
||||
description: Definition for the various Dynalite areas.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
AREA_NUMBER:
|
||||
description: The Dynalite area number, 1-255.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of the area.
|
||||
required: true
|
||||
type: string
|
||||
template:
|
||||
description: "Type of template to use for the area. Supported values are: `room` and `time_cover`. They are described in detail below in the **template** section. If the template parameters are different than defaults, they can be overridden in this section as well."
|
||||
require: false
|
||||
type: string
|
||||
TEMPLATE_PARAMS:
|
||||
description: "This can be any of the settings of the template. For example, for template `room`: `room_on` and `room_off` are possible options."
|
||||
required: false
|
||||
type: [integer, float]
|
||||
default: Value from **template** section or system defaults
|
||||
fade:
|
||||
description: Fade time for the area, in seconds.
|
||||
required: false
|
||||
type: float
|
||||
default: 2.0
|
||||
preset:
|
||||
description: Specific presets for the area.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
PRESET_NUMBER:
|
||||
description: The Dynalite preset number in the area.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of the preset.
|
||||
required: false
|
||||
type: string
|
||||
default: AREA_NAME Preset PRESET_NUMBER
|
||||
fade:
|
||||
description: Fade time for the preset, in seconds.
|
||||
required: false
|
||||
type: float
|
||||
default: 2.0
|
||||
level:
|
||||
description: Level of the channels when the preset is selected, between 0 and 1.
|
||||
required: false
|
||||
type: float
|
||||
nodefault:
|
||||
description: Do not use the default presets defined globally, but only the specific ones defined for this area.
|
||||
required: false
|
||||
type: boolean
|
||||
default: false
|
||||
channel:
|
||||
description: Map of the channels in this area.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
CHANNEL_NUMBER:
|
||||
description: The Dynalite channel number in the area, 1-255.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: Name of the channel.
|
||||
required: false
|
||||
type: string
|
||||
default: AREA_NAME Channel CHANNEL_NUMBER
|
||||
type:
|
||||
description: "Type of entity this channel should appear as. Can be either `light` or if this is a device that is not a light (e.g., water heater), can be `switch`."
|
||||
require: false
|
||||
type: string
|
||||
default: light
|
||||
fade:
|
||||
description: Fade time for the channel, in seconds.
|
||||
required: false
|
||||
type: float
|
||||
default: 2.0
|
||||
preset:
|
||||
description: "Default presets for any area without the `nodefault` option."
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
PRESET_NUMBER:
|
||||
description: The Dynalite preset number in the area.
|
||||
required: true
|
||||
type: map
|
||||
keys:
|
||||
name:
|
||||
description: "Name of the preset. When used in an area, it will be 'AREA_NAME name'. For example, if a room's name is 'Kitchen' and preset 4 is defined with the name `Off`, it will appear in HA as 'Kitchen Off'."
|
||||
required: false
|
||||
type: string
|
||||
default: AREA_NAME Preset PRESET_NUMBER
|
||||
fade:
|
||||
description: Fade time for the preset, in seconds.
|
||||
required: false
|
||||
type: float
|
||||
default: 2.0
|
||||
level:
|
||||
description: Level of the channels when the preset is selected, between 0 and 1.
|
||||
required: false
|
||||
type: float
|
||||
template:
|
||||
description: Set the default parameters for the templates.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
room:
|
||||
description: This is used to define a room that has a preset to turn on all the channels in the area and a preset to turn off.
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
room_on:
|
||||
description: Preset to turn area on.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
room_off:
|
||||
description: Preset to turn area off.
|
||||
required: false
|
||||
type: integer
|
||||
default: 4
|
||||
time_cover:
|
||||
description: "This is used to define a cover that has 3 presets: `open`, `close`, and `stop`. Potentially can also use a channel that some systems (e.g., Control4) use to also send commands to open and close the cover. It uses the duration it takes to open or close to determine position. In addition, many times, these covers include tilt by opening or closing for a short time, so this can be defined as well."
|
||||
required: false
|
||||
type: map
|
||||
keys:
|
||||
open:
|
||||
description: Preset to open the cover.
|
||||
required: false
|
||||
type: integer
|
||||
default: 1
|
||||
close:
|
||||
description: Preset to close the cover.
|
||||
required: false
|
||||
type: integer
|
||||
default: 2
|
||||
stop:
|
||||
description: Preset to stop the cover.
|
||||
required: false
|
||||
type: integer
|
||||
default: 4
|
||||
channel_cover:
|
||||
description: Channel that monitors the cover.
|
||||
required: false
|
||||
type: integer
|
||||
duration:
|
||||
description: Time in seconds it takes to open or close the cover.
|
||||
required: false
|
||||
type: integer
|
||||
default: 60
|
||||
tilt:
|
||||
description: "Time in seconds it takes to open or close the cover tilt. `0` means that the cover does not support tilt."
|
||||
require: false
|
||||
type: integer
|
||||
default: 0
|
||||
class:
|
||||
description: "Type of cover for Home Assistant. Any of the possible [cover classes](/integrations/cover/#device-class) (e.g. `blind`, `garage`, `shutter`) are possible."
|
||||
require: false
|
||||
type: string
|
||||
default: shutter
|
||||
{% endconfiguration %}
|
||||
|
||||
## Examples
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry specifying optional parameters
|
||||
dynalite:
|
||||
bridges:
|
||||
- host: DEVICE_IP_ADDRESS
|
||||
port: 12345
|
||||
autodiscover: true
|
||||
polltimer: 1
|
||||
area:
|
||||
'1':
|
||||
name: Office
|
||||
template: room
|
||||
'2':
|
||||
name: Living Room
|
||||
template: room
|
||||
nodefault: true
|
||||
room_on: 2
|
||||
room_off: 5
|
||||
channel:
|
||||
'2':
|
||||
name: Entrance Spot
|
||||
fade: 10.0
|
||||
'3':
|
||||
name: Dining Table
|
||||
preset:
|
||||
'5':
|
||||
name: Blinking Lights
|
||||
'6':
|
||||
name: All Off
|
||||
fade: 3.0
|
||||
'4':
|
||||
name: Curtain
|
||||
template: time_cover
|
||||
preset:
|
||||
'1':
|
||||
name: "On"
|
||||
'4':
|
||||
name: "Off"
|
||||
template:
|
||||
room:
|
||||
room_on: 1
|
||||
room_off: 4
|
||||
```
|
||||
There are global setup parameters and advanced parameters that should normally be left as is. The most important part is defining the areas. Each area normally corresponds to a room or function. They have to be added manually via the UI and match the setup of the existing dynalite installation.
|
||||
|
||||
## Initial Configuration and Discovery
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user