No announcement yet.

UPB Plug-in - User Guide

This topic is closed.
This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

    UPB Plug-in - User Guide


    System Requirements:
    This plugin allows HS to communicate and control UPB (Universal Powerline Bus) devices through a serial interface called a PIM (Powerline Interface Module) or the PulseWorx Gateway PGW which is an Ethernet based interface. Here are the only supported interfaces:
    If you need an USB interface go with the PIM-U from PulseWorx. The UMC-DB9 from SA with an additional Serial to USB adapter won't work.

    This plugin is for HS3 or HS3PRO. Both Windows and Linux version are supported. It also can run as a remote plugin, i.e. on a different machine than the one on which HS is running.

    UPB System Configuration:
    Before using this plugin, your UPB system must be configured using the UPStart program that you can download from
    The UPStart application will allow you to program and test your UPB devices. When you have completed programming your devices you will need to export your UPB system description so that the plugin can access information about your system. To export your system description use the File/Export command within the UPStart application, and save the file as a .upe file somewhere on your disk, for example in your HS Config folder.

    Plugin Installation:
    Download and install the plugin called UPBSpud from the updater, or download the package from the Beta Testing thread and follow instructions to install.

    Plugin Configuration
    First, make sure you have closed the UPStart program, otherwise the plugin won't be able to communicate with your UPB network.
    Start the plugin from the "PLUG-INS > Manage" page and go to the config page "PLUG-INS > UPBSpud > Config".
    Choose the interface type you have, i.e. "Serial/USB PIM" or "PulseWorx Gateway", then enter the name of the COM Port for the PIM or the IP address of the PGW.
    Click Edit and select your .upe file, then click on the Import button. If everything is ok, it will import your UPB configuration, create HS devices, and synchronize them with the current status of your actual devices.

    Click image for larger version  Name:	upbconfig.png Views:	1 Size:	28.3 KB ID:	1208930

    By default the plugin polls every device on your network at startup to know their current state, which can take quite some time if you have a large UPB network. Uncheck this setting if you don't want this occur everytime the plugin starts.
    Last edited by spud; November 23, 2018, 05:33 PM.

    FEATURESClick image for larger version

Name:	upbdevices.png
Views:	1
Size:	42.3 KB
ID:	1182943

    All these devices can be used as Triggers in Events using the standard trigger type: "A Device's value is...".
    They can be controlled using the Event Action: "Control Device", and they can also be controlled from scripts using the Device Control API (CAPI)

    There is one specific UPB trigger called "UPB Device transmits Link" which is only fired when a physical UPB device transmits a Link, so for example it can be used to determine when a physical switch is actually pressed.
    Click image for larger version

Name:	upbtrigger.png
Views:	1
Size:	5.6 KB
ID:	1182945

    There is one specific UPB action that lets you poll a specific UPB device or all of them:
    Click image for larger version

Name:	actions.jpg
Views:	2
Size:	38.9 KB
ID:	1182946
    Last edited by spud; January 21, 2016, 05:05 PM.