Plugin API:
hs.Plugin("PLCBUS Connector").Version As String
Get the plugin version
hs.Plugin("PLCBUS Connector").Debug As Boolean
Get or Set the plugin debug mode
hs.Plugin("PLCBUS Connector").ReloadConfig() As Boolean
Reloads the hspi_plcbus.ini INI settings. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateLampDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Lamp device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteLampDevice( deviceCode As String ) As Boolean
Deletes a PLCBUS Lamp device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateApplianceDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Appliance device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteApplianceDevice( deviceCode As String ) As Boolean
Deletes a PLCBUS Appliance device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateSceneDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Scene device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteSceneDevice( deviceCode As String ) As Boolean
Deletes a Scene device and removes Scene programming from PLCBUS modules. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").AddSceneEntry( sceneDeviceCode As String, deviceCode As String, function As String, dimLevel As Integer, fadeRate As Integer) As Boolean
Adds a new Scene entry to a Scene. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
- Function must be "OFF", "ON" (for Appliance devices only) or "PRESETDIM" (for Lamp devices only).
- DimLevel must be 1-100
- FadeRate must be 0 (instant) to 100 (very slow). I think this is the number of seconds.
hs.Plugin("PLCBUS Connector").DeleteSceneEntry( sceneDeviceCode As String, deviceCode As String) As Boolean
Removes a device from a Scene. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").ProgramScene( sceneDeviceCode As String ) As Boolean
Programs PLCBUS modules for a previously defined Scene and save Scene settings to the plugin configuration file. Returns a boolean indicating success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").Version As String
Get the plugin version
hs.Plugin("PLCBUS Connector").Debug As Boolean
Get or Set the plugin debug mode
hs.Plugin("PLCBUS Connector").ReloadConfig() As Boolean
Reloads the hspi_plcbus.ini INI settings. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateLampDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Lamp device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteLampDevice( deviceCode As String ) As Boolean
Deletes a PLCBUS Lamp device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateApplianceDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Appliance device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteApplianceDevice( deviceCode As String ) As Boolean
Deletes a PLCBUS Appliance device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").CreateSceneDevice( deviceCode As String, deviceName As String ) As Boolean
Creates a new PLCBUS Scene device. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").DeleteSceneDevice( deviceCode As String ) As Boolean
Deletes a Scene device and removes Scene programming from PLCBUS modules. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").AddSceneEntry( sceneDeviceCode As String, deviceCode As String, function As String, dimLevel As Integer, fadeRate As Integer) As Boolean
Adds a new Scene entry to a Scene. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
- Function must be "OFF", "ON" (for Appliance devices only) or "PRESETDIM" (for Lamp devices only).
- DimLevel must be 1-100
- FadeRate must be 0 (instant) to 100 (very slow). I think this is the number of seconds.
hs.Plugin("PLCBUS Connector").DeleteSceneEntry( sceneDeviceCode As String, deviceCode As String) As Boolean
Removes a device from a Scene. The API returns a boolean meaning success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
hs.Plugin("PLCBUS Connector").ProgramScene( sceneDeviceCode As String ) As Boolean
Programs PLCBUS modules for a previously defined Scene and save Scene settings to the plugin configuration file. Returns a boolean indicating success or failure. In case of failure, the Error message is printed to the HomeSeer event log.
Comment