VELUX KLF200 Plugin for HomeSeer User Guide

KLF200 Plugin for HomeSeer
User Guide

**

**{introduction}

This plugin allows VELUX INTEGRA devices to be controlled through HomeSeer via a VELUX KLF200 gateway.
It potentially also works with other io-homecontrol devices (e.g. Somfy) which are supported by the KLF200, but this has not been tested.
This version has been confirmed working with the following device types:

Other device types should work since in most cases their basic functionality requires a 0 – 100% setting. Only the sub-control for speed is so far implemented.

{concepts}

The plugin creates a HomeSeer device for each corresponding physical device found in the KLF200, which will:

• Reflect the status of its underlying physical device.
• Control the physical device when the HomeSeer device is changed.

A gateway device (VELUX KLF200) is also created to show the status of the connection and allow connection / disconnection from the KLF200.The plugin also has special handling for automation which is covered later in this document.

{setup}

First set up the KLF200 gateway according to its instructions and associate your devices with it.
Set the names of your devices appropriately in the KLF200 web interface, as these will be used to name the corresponding HomeSeer devices.
Also make sure the LAN connection is turned on:And set a fixed IP address, so the plugin can reliably find the KLF200 gateway: (You can also used DHCP if you prefer to manage this through your router, as long as the IP address is fixed).
In HomeSeer in the plugin settings page, set the IP address of the KLF200 gateway and the password (usually the one written on the bottom of the gateway).
The plugin should already have created the VELUX KLF200 device. Click the “Connect” button on this device.
The log should show successful connection to the KLF200 gateway, and a set of HomeSeer devices corresponding to your physical devices should be created.

{operation of devices}

A typical device in HomeSeer looks like this, with buttons for key positions and a slider for free positioning:The plugin listens for notification from the KLF200 gateway of physical device movement, updating the corresponding HomeSeer device position as required.
Changing the position of the HomeSeer device by using the controls or through events or scripts will trigger a command to the KLF200 gateway to move the corresponding physical device.
Devices may be renamed in HomeSeer, the plugin does not use this information and it will not break the link to the KLF200 device. Similarly the group/detail/category settings may be changed freely.
If a device is removed from the KLF200 gateway, stop the plugin, delete the corresponding
HomeSeer device, then restart the plugin. Attempts to control a HomeSeer device whose physical device has been removed could lead to unpredictable behaviour.
The plugin will recreate any missing HomeSeer devices on connection to the KLF200 gateway. {automation}
When automating movements, the user may also want to control the physical device (directly, or via HomeSeer) and not have the automation rapidly override this.
With that in mind, each HomeSeer device has an additional “automation” feature.
Controlling the automation feature will be rejected if the device has been controlled physically or through the main position feature within a definable time (default 60 minutes). Automation events / scripts may use this feature to easily implement manual override.
The automation block time can be configured on the plugin settings page, and defaults to 60 minutes.
The feature also has a button to reset the automation block, effectively setting the device last update time to (now – block period). The VELUX KLF200 device has a button to reset automation for all devices. To aid scripting, a plugin function is provided which will check if automation would be blocked for a device, returning true if automation will be accepted and false if it would be blocked.
A typical use-case being if further actions are dependent on this information, or to reduce logging changes which are later blocked.
Example function which wraps this for use in your own scripts:
Function CanAutomate(ref as Integer)
Return CBool(hs.PluginFunction(“VELUX KLF200”, “”, “CanAutomate”, new Object() {ref})) End Function

{troubleshooting}

Additional logging can be turned on in the plugin settings page.
Debug logging shows messages sent and received from the KLF200 gateway and can therefore be quite a lot of entries.
The plugin tries to connect to the KLF200 gateway a number of times on startup or if the connection is lost. If this fails it will show an error state, and further reconnection attempts will not be made until the plugin is restarted or the Connect button pressed on the VELUX KLF200 HomeSeer device.

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>