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-19 23:36:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Universal Powerline Bus -- Link Event (#13404)

Browse Source
This commit is contained in:
Glenn Waters 2020-05-12 03:11:15 -04:00 committed by GitHub
parent bf8a68a99b
commit bf52ca4af4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
source/_integrations/upb.markdown
View File

@ -20,3 +20,30 @@ The UPB integration allows Home Assistant to connect to a Universal Powerline Bu
To add UPB to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Universal Powerline Bus (UPB)**. To add UPB to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Universal Powerline Bus (UPB)**.
The UPB integration requires that an export from the `UPStart` UPB configuration program. To create an export, in `UPStart`, click the UPB button in the top left and select **Export to File**. This will create a file with the `.upe` extension. The file must be placed somewhere in your Home Assistant installation, for example, in the configuration directory. The UPB integration requires that an export from the `UPStart` UPB configuration program. To create an export, in `UPStart`, click the UPB button in the top left and select **Export to File**. This will create a file with the `.upe` extension. The file must be placed somewhere in your Home Assistant installation, for example, in the configuration directory.
## Events
An event is generated whenever a UPB Link is:
- activated
- deactivated
- goes to a new level
- fade is started
- fade is stopped
- blink is started
The event is `upb.link_changed`.
The `event_data` contains the following:
- `command`: One of `activated`, `blink`, `deactivated`, `fade_started`,
`fade_stopped`, or `goto`.
- `address`: The address of the link reporting the event. The `address`
is comprised of the UPB network number and the UPB Link number.
For example for UPB Network number 42 and UPB Link number 24 the
`address` would be 42_24.
- `brightness_pct`: The brightness level as a percentage. `brightness_pct` is
reported as -1 if the brightness is a default level or brightness is not
applicable to the link change.
- `rate`: The rate for link to transition to the new level. `rate` is
-1 for the default transiton rate.