Skip to content

schroedan/homebridge-my-gekko

Repository files navigation

homebridge-my-gekko

NPM Version NPM Downloads Continuous Integration Coverage

myGEKKO Platform Plugin for Homebridge

This plugin exposes:

  • Blinds as window coverings
  • Meteo brightnesses as light sensors
  • Meteo temperature as temperature sensor

Installation

Follow the Homebridge installation instructions here.

Install this plugin globally:

npm install -g homebridge-my-gekko

Add platform to config.json, for configuration see below.

Configuration

The plugin can connect either locally or via myGEKKO Plus.

Local QueryAPI

{
  "platforms": [
    {
      "name": "myGEKKO",
      "host": "<host>",
      "username": "<username>",
      "password": "<password>",
      "platform": "mygekko",
      "blinds": true,
      "meteo": true,
      "meteoCacheSize": 10,
      "ttl": 1,
      "retries": 1,
      "interval": 3,
      "deferance": 10,
      "delay": 500
    }
  ]
}

Either the IP or the hostname of your myGEKKO can be configured as host. Please ensure that the local QueryAPI is enabled. The username and password must be defined in the local QueryAPI settings of your myGEKKO.

Plus Query API

{
  "platforms": [
    {
      "name": "myGEKKO",
      "plus": true,
      "username": "<username>",
      "key": "<key>",
      "gekkoid": "<gekkoid>",
      "platform": "mygekko",
      "blinds": true,
      "meteo": true,
      "meteoCacheSize": 10,
      "ttl": 1,
      "retries": 1,
      "interval": 3,
      "deferance": 10,
      "delay": 500
    }
  ]
}

The username here is the myGEKKO Plus user name and the key is generated via "Advanced settings" in the myGEKKO Plus menu. The gekkoid is displayed in the System info menu (Gear > System info > myGEKKO ID).

Advanced Settings

The discovery of blind and/or meteo accessories can be disabled by setting the blinds and/or meteo options to false.

There is a cache to normalise the meteo values. The number of values for normalisation can be configured via meteoCacheSize.

Feel free to adjust the options for client cache TTL (ttl in seconds), number of retries (retries), update interval (interval in seconds), allocation deferance (deferance in seconds) and allocation delay (delay in milliseconds).

Debugging

If you experience problems with this plugin please provide a Homebridge logfile by running Homebridge with debugging enabled:

homebridge -D

Acknowledgements

About

myGEKKO Platform Plugin for Homebridge

Resources

License

Security policy

Stars

Watchers

Forks