#Universal Powerline Bus (UPB)

The Universal Powerline Bus (UPB) integration allows Home Assistant to connect to a Universal Powerline Bus Powerline Interface Module (UPB PIM) to get status and control UPB devices and UPB links. The UPB PIM may be connected either to a serial port or over TCP. The integration implements the following platforms:

• Light
• Scene

#Prerequisites

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 in the configuration directory of your Home Assistant installation.

#Device configuration

Using UPStart, configure each UPB dimmer-switch to report its state when it is manually operated. If you omit this step, manual changes to a dimmer-switch's state (on/off/brightness) will not be reported to Home Assistant.

#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.scene_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 of 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 transition rate.

#Actions

Besides the standard actions provided by the Home Assistant Light and Scene integrations, the following extra actions are provided by the UPB integration:

• upb.light_fade_start
• upb.light_fade_stop
• upb.light_blink
• upb.scene_deactivate
• upb.scene_goto
• upb.scene_fade_start
• upb.scene_fade_stop
• upb.scene_blink

#Rate transition time

Both standard and custom actions that take a transition or a rate for changing brightness levels take time in seconds. The UPB system only offers a discrete set of transition times. As such, the transition time requested is changed to the closest time based on the table below. Note that this table does not apply to blink rates, only to brightness transition times.

#Action: Light fade start

The upb.light_fade_start action starts a transition of a light to the specified level. Lights that are not dimmable ignore the fade start command.

#Action: Light fade stop

The upb.light_fade_stop action stops a light when transitioning from one light level to another. Stops either a fade or a goto (goto occurs when using a light.turn_on or light.turn_off).

#Action: Light blink

The upb.light_blink action starts a light blinking.

#Action: Scene deactivate

The upb.scene_deactivate action deactivates a scene. The term "deactivate" is a general UPB term that usually means to turn to the OFF state, but each individual device manufacturer can define it differently for their device.

#Action: Scene goto

The upb.scene_goto action starts a transition of a scene to the specified level.

#Action: Scene fade start

The upb.scene_fade_start action starts a transition of a scene to the specified level. Lights within the scene that are not dimmable ignore the fade start command.

#Action: Scene fade stop

The upb.scene_fade_stop action stops a scene when transitioning from one light level to another. Stops either a fade or a goto.

#Action: Scene blink

The upb.scene_blink action starts a scene blinking.

#Examples

#automation:

- alias: "Specific scene activated"
  description: "Trigger when scene 9 on network 42 is activated"
  triggers:
    - trigger: event
      event_type: upb.scene_changed
      event_data:
        command: activated
        address: "42_9"
  actions:
    - action: persistent_notification.create
      data:
        title: "Scene Activated"
        message: >
          Activated scene 9 on network 42: {{trigger.event.data.command}}, {{trigger.event.data.address}}

#script:
 
all_lights_on:
  alias: "All Lights On"
  description: "Activate two UPB scenes named interior_lights and exterior_lights"
  sequence:
    - action: scene.turn_on
      target:
        entity_id: 
          - scene.interior_lights
          - scene.exterior_lights

all_lights_off:
  alias: "All Lights Off"
  description: "Deactivate two UPB scenes named interior_lights and exterior_lights"
  sequence:
    - action: upb.scene_deactivate
      target:
        entity_id: 
          - scene.interior_lights
          - scene.exterior_lights

kitchen_fade_on:
  alias: "Kitchen Fade to On"
  description: "Turn on kitchen light to 75% over a period of 10 seconds"
  sequence:
    - action: upb.light_fade_start
      target:
        entity_id: light.kitchen
      data:
        brightness_pct: 75
        rate: 10

#Notes

• A UPB device does not always report its current state. For example, if you call upb.light_fade_start and then, a few seconds later, call upb.light_fade_stop, the selected UPB device will not report its new brightness level. However, if you then call homeassistant.update_entity it will make the UPB device report its current state to Home Assistant.
• Alterations to your UPB configuration with UpStart must be re-exported. The exported UPE file must have the same filename in the Home Assistant config directory.

#Debugging

Debug logs are often required to solve an issue. To enable UPB debug logs add the following to your "configuration.yaml" file in your Home Assistant config directory:

logger:
  logs:
    upb_lib: debug
    homeassistant.components.upb: debug

After updating your configuration file, restart Home Assistant. The debug logs will be in the file homeassistant.log in the config directory.