Skip to content

Latest commit

 

History

History
108 lines (73 loc) · 3.5 KB

README.md

File metadata and controls

108 lines (73 loc) · 3.5 KB
Raw

logo

Kizcool

A CLI and go package to control devices from Velux, Somfy and other vendors using the Overkiz platform.

Build Status

Components

  • Executable kizcool/exe/kizcmd is a command-line utility to control devices.
  • Package kizcool provides a high-level client with structs for events and devices. Documentation.
  • Package kizcool/api provides a lower-level api client that returns the raw responses from the server without parsing. Documentation.

Command line tool

Download and install kizcmd

go get -u github.com/sgrimee/kizcool/cmd/kizcmd
go install github.com/sgrimee/kizcool/cmd/kizcmd

Create a configuration file

kizcmd configure

Get all devices names

kizcmd get labels

Send a command to a device

kizcmd on "my light"
kizcmd off "my light"
kizcmd instensity "my light" 50

kizcmd open "my window"
kizcmd close "my window"

kizcmd open "my blind"
kizcmd close "my blind"
kizcmd closure "my blind" 75

Get all devices data

kizcmd get devices

Get one device in json format. Hint: jq is a nice json formatter

kizcmd get device "parents window" -ojson | jq

Continuously poll for events from the installation and display them on the console

kizcmd listen

Environment variables

As an alternative to the config file, configuration items can be given as environment variables:

  • KIZ_USERNAME
  • KIZ_PASSWORD
  • KIZ_BASE_URL

Requirements

Go version

Golang >= 1.13

Supported gateways

This packages interacts with the Overkiz API, as used by Somfy's Tahoma devices. It should work with other controllers but only Tahoma was tested.

Supported devices

Support is provided for the following devices:

  • Velux Integra electric window: GGL-GGU
  • Velux Integra electric roller shutter: SML
  • Velux Integra spotlight: KRA-100 (hard to find)

However, the Overkiz system supports many more devices from several vendors. Some may work out of the box. Support for others should be easy to add. Please file an issue to report other working devices or request the addition of new devices.

Supported platforms

This should work wherever go works. Tested on mac and linux. Efforts were made to support windows but it is not tested.

Roadmap

Upcoming features include:

  • KNX bridge to control velux devices from a KNX system (the main goal for this project).

Notice of Non-affiliation and Disclaimer

We are not affiliated, associated, authorized, endorsed by, or in any way officially connected with Overkiz, Velux, Somfy, any other trademark mentioned in this project, or any of its subsidiaries or its affiliates. We are grateful for the great products and services they provide.

Please see the License and Disclaimer notice.