| | |
| Make/Model | Device Version | Connection Type |
| UPB/PIM | N/A | Serial |
This driver provides basic controls for UPB based products. Universal Powerline Bus (UPB) a highly reliable, cost effective, 2-way communications technology which enables control products to utilize existing powerlines for residential applications.
This driver provides the following functionality:
- Bidirectional direct communication to UPB modules with Fade Rate
- One-way LED control on Keypads
- Supports sending Link (scenes) commands with Fade Rate and Level
- Creates read/write driver fields for each device, LED and Link defined in the configuration file supporting both dimmable (0-100%) and non-dimmable true/false)
- Automatic module status poll when Link traffic is received from a defined Link
This driver has only been tested with Lighting and Keypad Modules. It has not been tested with other UPB Based modules.
This driver does not do any form of device discovery. All modules and Links to be controlled must be configured through the configuration files (see the section below on configuration files).
The driver uses an RS-232 serial connection to a UPB PIM running at 4800bps, 8 data bits, no parity, one stop bit, which is the default hardware settings at the device. It has currently been tested with PIM manufactured by PCS and Simply Automated.
The Configuration file is in CSV format and must be named UPB.csv. For the UPB Driver to find the configuration file it must be located in the CQC installation directory under CQCData\MacroFileRoot\Drivers\UPB. Content is a series of records of "Type, Device address, Channel number, Device name, Additional info". A optional converter that will read a UPStart export file (.upe) and create the csv file can be downloaded from Kanak Solutions.
Each line starts with the type of record it is. These are:
NETWORK
TOGGLE
DIMMER
LED
LINK
EOFBelow are the contents of each row record with a comma separated field. The records can be in any order except the NETWORK which must be the first record and EOF which must be the last record.
NETWORK - This record must be the first record and defines the overall network settings.
Network ID of your UPB Network.
Number of Records not including NETWORK and EOF records.
Extended delay in the Status Request for Links above the defined delay in the LINK record.
TOGGLE This record defines any devices that are capable of handling ON/OFF commands only.
Device ID of the UPB device.
Channel number of the device. A device with multiple channels must have a separate record for each channel. If the device only has only one channel then use a 0 here.
Field Name of the device as it will appear in CQC.DIMMER This record defines any devices that are capable of handling ON/OFF and Dimming commands.
Device ID of the UPB device.
Channel number of the device. A device with multiple channels must have a separate record for each channel. If the device only has one channel then use a 0 here.
Field Name of the device as it will appear in CQC.LED This record defines any devices that have controllable LED indicators.
Device ID of the UPB device.
LED number on the device. This is usually 1 for the first LED and so on. A device with multiple LEDs must have a separate record for each LED indicator.
Field Name of the device as it will appear in CQC.LINK This record defines the links with in the network.
Link ID of the link
Place holder of 0 on all link records. This is to keep uniformity of other records.
Field Name of the link as it will appear in CQC.
This last field needs to have the highest Default Fade Rate for all the devices that are part of the link (See the Fade Rate Chart below for values) as the first number and followed by a ; and then a list of all the devices that are in the link each separated by a ;.EOF This must be the last line in the file and has no other values in the record.
NOTE: All Field names and must only use the following characters: A-Z, a-z, 0-9, - or _
Default Fade Rate Chart Fade Rate Fade Time 0 Snap 1 0.8 Seconds 2 1.6 Seconds 3 3.3 Seconds 4 5 Seconds 5 6.6 Seconds 6 10 Seconds 7 20 Seconds 8 30 Seconds 9 1 Minute 10 2 Minutes 11 5 Minutes 12 10 Minutes 13 15 Minutes 14 30 Minutes 15 1 Hour Configuration File Sample:
NETWORK,231,11,2,,
DIMMER,72,0,DEV-UpstairsHallway_BackLight,,
DIMMER,53,0,DEV-Outside_BalconyLight,,
DIMMER,83,0,DEV-LivingRoom_Bar,,
TOGGLE,112,0,DEV-Kitchen_CounterLightL,,
TOGGLE,113,0,DEV-Kitchen_CounterLightR,,
TOGGLE,120,0,DEV-PowderRoom_Fan,,
LED,4,3,LED-MasterBedroom_TabletopControl-A,,
LED,4,4,LED-MasterBedroom_TabletopControl-B,,
LINK,1,0,LNK-NightTime-1,72;112;113;120;56;69;99;97;95;61;64;75;116;119;111;57;86;79;82;70;106;107;114;102;84;51;54;109;115;101;110;,
LINK,2,0,LNK-PoolFilter-2,49;,
LINK,3,0,LNK-LivingLamp-3,114;84;115;,
EOF,,,,,
The driver polls very slowly (One field every minute). On startup it will poll all pollable fields at one per 1&1/2 second. After a link command is issued, the link participants will be polled at one per 1&1/2 seconds. The poll start is delayed by the amount of time set in the FadeRate field plus the additional delay specified on the network configuration line with a maximum delay of one minute.
The driver raises an event of Activate with a value of nnn when it sees an incoming link activate event. Similarly, the driver raises an event of Deactivate with a value of nnn for an incoming deactivate event. The nnn is a 3 digit device id in decimal.
This section lists the fields that the driver makes available, their types, minimum and maximum values, etc... Most of the fields are drive by the loads defined. In the Name column below, a generic description is given for those instead of an actual fieldname.
Name Type R/W Description/Limits TOGGLE/DIMMER RECORD Card or Bool R/W The driver will create a field for each record listed in the UPB.csv file for TOGGLE and DIMMER records. This field will show the current device level in percent (0 - 100) for DIMMER records and True/False for TOGGLE records. Changes to the field will be immediately sent as level change commands to the appropriate device. The value will also be automatically updated during polling cycles. LED RECORD Bool R/W The driver will create a fields for each record listed in the UPB.csv file for LED records. Changes to the field will be immediately sent to the appropriate device LED. This field does not get polled for LED status at the device. LINK RECORD ACTIVATE Bool W The driver will create a fields for each record listed in the UPB.csv file for LINK records. Changes to the field will be immediately sent to the appropriate device LED. Sending a True Activates the Link and False Deactivates the Link. LINK RECORD FADE Card R/W The driver will create a fields for each record listed in the UPB.csv file for LINK records. This field defines what Fade Rate the Link will be Activated or Deactivated with. You need to set this field before Changing the LINK ACTIVATE field to take effect. Allowed values are between 0 and 15 (See "Default Fade Rate Chart" above). LINKE RECORD GOTO Card R/W The driver will create a fields for each record listed in the UPB.csv file for LINK records. This field defines what Level the Link will be Activated or Deactivated to. Any TOGGLE Devices part of the Link will not be effected. You need to set this field before Changing the LINK ACTIVATE field to take effect. UPB-FadeRate String R/W This field defines what Fade Rate the TOGGLE/DIMMER device will be set with. You need to set this field before Changing the device field to take effect. This field needs to be set back to Default unless you want to use the same setting on the next device change. Allowed values Snap, 0.8s, 1.6s, 3.3s, 5s, 6.6s, 10s, 20s, 30s, 1m, 2m, 5m, 10m, 15m, 30m, 1h, Default (Setting on device)