You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
zhongjin f3c152e76b
Initial commit
6 years ago
.github/ISSUE_TEMPLATE Initial commit 6 years ago
.vscode Initial commit 6 years ago
admin Initial commit 6 years ago
docs Initial commit 6 years ago
img Initial commit 6 years ago
lib Initial commit 6 years ago
test Initial commit 6 years ago
.gitignore Initial commit 6 years ago
.npmignore Initial commit 6 years ago
.travis.yml Initial commit 6 years ago
LICENSE Initial commit 6 years ago
README.md Initial commit 6 years ago
appveyor.yml Initial commit 6 years ago
gulpfile.js Initial commit 6 years ago
io-package.json Initial commit 6 years ago
main.js Initial commit 6 years ago
package-lock.json Initial commit 6 years ago
package.json Initial commit 6 years ago

README.md

Logo

yunkong2.klf200

Travis CI Build status GitHub issues GitHub license

NPM version Downloads

NPM

This adapter is for controlling a VELUX® KLF-200 interface. This adapter is neither an official VELUX product nor is it supported by the company that owns the VELUX products.

The main intention of this adapter is to control electric roof windows and/or electric blinds or roller shutters. Though the KLF-200 interface is able to connect to further devices like lights, switches, canvas blinds etc. I haven't developed the adapter for use with these kind of devices. Thus, it could be possible, that these devices could be controlled by this adapter, too.

The adapter works with the internal REST API of the KLF-200 interface and you don't need to wire the inputs and outputs of the box.

User documentation

You can find the user documentation in several languages:

English flag English documentation

German flag Deutsche Dokumentation

France flag Documentation française

Italien flag Documentazione italiana

Netherlands flag Nederlandse documentatie

Poland flag Polska dokumentacja

Portuguese flag Documentação portuguesa

Russian flag Российская документация

Spanish flag Documentación española

Known restrictions

  • The interface is restricted by storing a maximum of 32 scenes in total.
  • The REST API doesn't provide any feedback of a scene to be finished, therefore each scene is supposed to run at least 30 seconds.
  • Currently, only single product scenes are supported to control from the product side. Thus, it is always possible to create scenes with several products and control them from the scenes part.
  • The REST API doesn't let me read the current status of a product. Therefore the current level of a product is always what was set last and defaults to 0% on initialization of the adapter. This also means, that further logic implemented in other adapters won't work if you e.g. open or close your window with the original remote control.

Documentation of the data points

Devices

There are two devices: "products" and "scenes". The products device lists all registered products wether they are used in a scene or not. The scenes device lists all scenes that you have created in the interface.

Products

  • productsFound - number of products registered in the interface
  • 0...n - channel for each registered product
    • category - name of the category, e.g. Window Opener, Roller Shutter
    • scenesCount - number of scenes the product is used in
    • level - This data point is only available when the product can be controlled from a scene. You can set a value to run a scene that will drive the product to that specific value.

Scenes

  • scenesFound - number of scenes found in the interface
  • 0..n - channel for each scene
    • productsCount - number of products that are controlled through this scene
    • silent - true/false if the scene will run in silent mode (only, if the product supports it). Currently, you can only read this information.
    • run - true/false set to true to run the scene. Will change to false again after the scene has finished

Changelog

0.9.5

  • (Michael Schroeder) Bug fixes

0.9.4

  • (Michael Schroeder) Compatible to Admin 3, add documentation

0.9.0

  • (Michael Schroeder) Initial public beta release

0.0.1

  • (Michael Schroeder) Initial developer release

License

The MIT License (MIT)

Copyright (c) 2018 Michael Schroeder klf200@gmx.de

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


VELUX and the VELUX logo are registered trademarks of VKR Holding A/S.