From bf52ca4af4ef1fdecbf56521a7138bf309cca7d3 Mon Sep 17 00:00:00 2001 From: Glenn Waters Date: Tue, 12 May 2020 03:11:15 -0400 Subject: [PATCH] Universal Powerline Bus -- Link Event (#13404) --- source/_integrations/upb.markdown | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/source/_integrations/upb.markdown b/source/_integrations/upb.markdown index b3bf05df0f0..44fe3390599 100644 --- a/source/_integrations/upb.markdown +++ b/source/_integrations/upb.markdown @@ -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)**. 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.