www.homeseer.com    
 

Go Back   HomeSeer Message Board > Lighting & Primary Technology Plug-ins > Lighting & Primary Technology Discussion > UPB plugin by Spud (3P)

UPB plugin by Spud (3P) Spud UPB plugin discussions.

Closed Thread
 
Thread Tools Display Modes
  #1  
Old November 27th, 2013, 04:22 PM
spud's Avatar
spud spud is offline
Moderator
 
Join Date: Jan 2012
Location: Canada
Posts: 4,617
UPB Plug-in - User Guide

INSTALLATION / CONFIGURATION

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.
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 http://www.simply-automated.com/prod...t_download.php
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.

Name:  upbconfig.png
Views: 633
Size:  28.3 KB

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; January 21st, 2016 at 05:24 PM.
  #2  
Old December 3rd, 2013, 04:57 PM
spud's Avatar
spud spud is offline
Moderator
 
Join Date: Jan 2012
Location: Canada
Posts: 4,617
FEATURES

Each time the plug-in starts (or each time you click the import button in the config page) it reads the UPStart export file and check for any new devices or links.
Each UPB device is represented in HS as one or more HS devices (the number depends on the number of channels and number of input/ouputs used by this UPB device). The names and locations of these devices are imported from UPStart so properly filling out these fields in UPStart will make your HS experience more friendly. These devices have standard On / Off and Dim capabilities (if the device supports it), and their status reflect in real time the state of your UPB network.
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 from the config page if you don't want this to occur everytime the plugin starts.

UPB Links are a conceptual combination of scenes and groups. Devices can be programmed with UPStart to respond to link commands.
Each UPB Link is represented in HS as one device. The “Activate” button will cause associated devices to go to their link preset level, again programmed in UPStart. The “Deactivate” button will cause the associated devices to turn off. On, Off, and Dim commands can also be sent to devices associated with the link.

Name:  upbdevices.png
Views: 637
Size:  42.3 KB

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)

Triggers
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.
Name:  upbtrigger.png
Views: 630
Size:  5.6 KB

Actions
There is one specific UPB action that lets you poll a specific UPB device or all of them:
Name:  actions.jpg
Views: 637
Size:  38.9 KB

Last edited by spud; January 21st, 2016 at 06:05 PM.
Closed Thread

Bookmarks

Tags
interface module, universal powerline bus, upstart, user guide

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
Kodi/XBMC Plug-in - User Guide spud Kodi/XBMC Plug-In (3P) 3 April 15th, 2015 03:37 PM
RFXCOM plug-in User & Programmers Guide b_weijenberg RFXCOM Plug-In (3P) 1 February 9th, 2014 07:13 AM
Kinect Plug-in - User Guide spud Kinect (3P) 4 December 21st, 2013 12:10 PM
DirecTV Plug-in - User Guide spud DirecTV for HS3 (3P) 1 October 1st, 2013 08:09 AM
BC4 Plug-In User's Guide BitWise_Mark Bitwise Controls BC4 2 October 16th, 2010 06:23 PM


All times are GMT -4. The time now is 08:03 AM.


Copyright HomeSeer Technologies, LLC