Here is latest info about release V1.33.2.4 of the PLCBUS Connector Plugin for HomeSeer 2
Note:
The plugin has been tested with HomeSeer 2.4.0.1 and PLCBUS interface #1141.
Plugin Features:
- Web Configuration Interface for all features,
- Scripting API for all features,
- Add and Remove PLCBUS Lamp modules,
- Add and Remove PLCBUS Appliance modules,
- Add and Remove PLCBUS Scenes,
- ON / OFF / Direct DIM / HomeSeer status request support for all PLCBUS modules,
- Standard X10 command support (A1 ON, All lights ON, All units OFF... etc),
- HomeSeer Module Polling support,
- PLCBUS Automatic UserCode discovery,
- PLCBUS Fast polling support. The plugin can poll the ON/OFF status for an entire HouseCode (16 modules) in less than one second.
- PLCBUS 3-Phase support (Commands are sent to the 3-phase coupler),
- PLCBUS Command acknowledgment (warning in the HS log in case a module didn't acknowledge a command)
- Default Dim Rate and On behavior for Lamp Devices.
- PLCBUS Tools
* get inuse addresses
* get only on addresses
* change module address
* get signal strength and noise level...
* Erase all scene addresses from a module
- PLCBUS Scene Management (several PLCBUS modules respond simultaneously with their own settings (dim level and ramp rate) to the same Scene address)
* Scene definition (Module on/off/preset-dim DimLevel, RampRate)
* Scene Address programming (easily program modules for scenes)
* Scene Address erasing (easily delete a scene)
* Scene module status (when HS receives or sends a scene command, all module status are updated)
hs.ExecX10 support
The plugin supports this HomeSeer command, and sends PLCBUS commands instead of X10.
The ramp rate is the fourth parameter of the method, right after brightness
Ramp Rate 0 = use the default ramp rate configured for the Lamp Device
Ramp Rate 1 to 100 = very fast to very slow
Ramp Rate > 100 = instant action.
Examples from the HomeSeer Immediate Control Window:
To instantaneously switch ON the A2 light to 80%
&hs.ExecX10 "A2", "DIM", 80, 256
To ramp the light from current dim level to 50% at a fast rate:
&hs.ExecX10 "A2", "DIM", 50, 3
To ramp the light from current dim level to 20% at a slow rate:
&hs.ExecX10 "A2", "DIM", 20, 10
You can also use X10 group commands such as the following:
&hs.ExecX10 "A2+3", "DIM", 60, 0
hs.PollDevice support
This HomeSeer API sends a status query to an individual module, and then adjusts HomeSeer status (ON / OFF and Dim Level).
If you need exact dim level status report for a few modules, you may schedule an event every minute with the following code for each of the devices you want to track:
&hs.PollDevice "A1"
If you don't need dim level status report, it's better to use the fast polling feature of the plugin, because ON/OFF status for an entire house code (16 modules) is updated using only one PLCBUS query. You may also use the Lamp device default On Behavior to minimize the number of PlcBus queries.
Default behavior for lamp devices
PlcBus Lamp devices have capabilities that X10 devices do not have. These PlcBus settings are found in the plugin web configuration interface.
You can find the default ramp rate for dim commands sent from HomeSeer, and the default On Behavior:
- Send On and Set HomeSeer status to On. Use this option when you want to restore the lamp device to last known dim level. This level is unknown to the plugin as it may have been changed localy on the device, and the HomeSeer device status is set to On. This is the default mode, and this works very well with FastPolling if you don't want to accurately track each lamp device dim level.
- Send On and Send PlcBus Status-Requests to update HomeSeer dim level. Use this option when you want to restore the lamp device to last known dim level, and you want the plugin to send additional PlcBus Status-Request messages to update the HomeSeer device dim level. If you use this mode with too many devices, you may use a lot of the total PlcBus bandwidth, and start to experience collisions.
- Preset Dim to xx% within yy seconds. Use this option when you want the on command to be translated to a PlcBus Preset-Dim command (force a specific dim level and ramp rate). Use this option when you don't want to restore the lamp device to last known dim level, and prefer to force your own settings (like 100%, instant). When a PlcBus On command is received by the plugin, the HomeSeer device dim level is set to the default value. This value may be wrong if the dim level has been changed locally at the device.
Plugin Scripting API:
http://board.homeseer.com/showthread.php?t=124339
Please send me feedback
Note:
The plugin has been tested with HomeSeer 2.4.0.1 and PLCBUS interface #1141.
Plugin Features:
- Web Configuration Interface for all features,
- Scripting API for all features,
- Add and Remove PLCBUS Lamp modules,
- Add and Remove PLCBUS Appliance modules,
- Add and Remove PLCBUS Scenes,
- ON / OFF / Direct DIM / HomeSeer status request support for all PLCBUS modules,
- Standard X10 command support (A1 ON, All lights ON, All units OFF... etc),
- HomeSeer Module Polling support,
- PLCBUS Automatic UserCode discovery,
- PLCBUS Fast polling support. The plugin can poll the ON/OFF status for an entire HouseCode (16 modules) in less than one second.
- PLCBUS 3-Phase support (Commands are sent to the 3-phase coupler),
- PLCBUS Command acknowledgment (warning in the HS log in case a module didn't acknowledge a command)
- Default Dim Rate and On behavior for Lamp Devices.
- PLCBUS Tools
* get inuse addresses
* get only on addresses
* change module address
* get signal strength and noise level...
* Erase all scene addresses from a module
- PLCBUS Scene Management (several PLCBUS modules respond simultaneously with their own settings (dim level and ramp rate) to the same Scene address)
* Scene definition (Module on/off/preset-dim DimLevel, RampRate)
* Scene Address programming (easily program modules for scenes)
* Scene Address erasing (easily delete a scene)
* Scene module status (when HS receives or sends a scene command, all module status are updated)
hs.ExecX10 support
The plugin supports this HomeSeer command, and sends PLCBUS commands instead of X10.
The ramp rate is the fourth parameter of the method, right after brightness
Ramp Rate 0 = use the default ramp rate configured for the Lamp Device
Ramp Rate 1 to 100 = very fast to very slow
Ramp Rate > 100 = instant action.
Examples from the HomeSeer Immediate Control Window:
To instantaneously switch ON the A2 light to 80%
&hs.ExecX10 "A2", "DIM", 80, 256
To ramp the light from current dim level to 50% at a fast rate:
&hs.ExecX10 "A2", "DIM", 50, 3
To ramp the light from current dim level to 20% at a slow rate:
&hs.ExecX10 "A2", "DIM", 20, 10
You can also use X10 group commands such as the following:
&hs.ExecX10 "A2+3", "DIM", 60, 0
hs.PollDevice support
This HomeSeer API sends a status query to an individual module, and then adjusts HomeSeer status (ON / OFF and Dim Level).
If you need exact dim level status report for a few modules, you may schedule an event every minute with the following code for each of the devices you want to track:
&hs.PollDevice "A1"
If you don't need dim level status report, it's better to use the fast polling feature of the plugin, because ON/OFF status for an entire house code (16 modules) is updated using only one PLCBUS query. You may also use the Lamp device default On Behavior to minimize the number of PlcBus queries.
Default behavior for lamp devices
PlcBus Lamp devices have capabilities that X10 devices do not have. These PlcBus settings are found in the plugin web configuration interface.
You can find the default ramp rate for dim commands sent from HomeSeer, and the default On Behavior:
- Send On and Set HomeSeer status to On. Use this option when you want to restore the lamp device to last known dim level. This level is unknown to the plugin as it may have been changed localy on the device, and the HomeSeer device status is set to On. This is the default mode, and this works very well with FastPolling if you don't want to accurately track each lamp device dim level.
- Send On and Send PlcBus Status-Requests to update HomeSeer dim level. Use this option when you want to restore the lamp device to last known dim level, and you want the plugin to send additional PlcBus Status-Request messages to update the HomeSeer device dim level. If you use this mode with too many devices, you may use a lot of the total PlcBus bandwidth, and start to experience collisions.
- Preset Dim to xx% within yy seconds. Use this option when you want the on command to be translated to a PlcBus Preset-Dim command (force a specific dim level and ramp rate). Use this option when you don't want to restore the lamp device to last known dim level, and prefer to force your own settings (like 100%, instant). When a PlcBus On command is received by the plugin, the HomeSeer device dim level is set to the default value. This value may be wrong if the dim level has been changed locally at the device.
Plugin Scripting API:
http://board.homeseer.com/showthread.php?t=124339
Please send me feedback
Comment