Overkiz (Somfy) - Homebridge-TaHoma

Homebridge plugin supporting Overkiz based platforms :

Installation

1. Install homebridge using: npm install -g homebridge
2. Install this plugin using: npm install -g homebridge-tahoma
3. Update your configuration file. See bellow for a sample.

Configuration

Minimal configuration sample:

{
    "bridge": {
        ...
    },

    "description": "...",

    "accessories": [],

    "platforms":[
        {
            "platform": "Tahoma",
            "name": "My TaHoma Box",

            "service": "somfy_europe",
            "user": "user@me.com",
            "password": "MyPassw0rd",
        }
    ]
}

Configuration parameters:

Configure Local API

Local API service is available on TaHoma and TaHoma switch gateways.

WARNING: Switching to local API will break your HomeKit configuration (automations) as local API device identifiers actually differs.

To use Local API you will have to:

1. Activate developer mode (www.somfy.com > My Account > Activate developer mode)
2. Generate API credentials at https://dev.duboc.pro/homebridge-tahoma
3. Configure the plugin service to Local API: "service":"local"

When using Local API service, please fill user with your gateway PIN number or IPv4 address and password with the token generated at step 2

For more information, browse https://developer.somfy.com/developer-mode

Specific device configuration

This option allows you to apply a specific configuation to device or group of device. One configuration is composed of a key attribute containing device name, widget, uiClass, protocol or unique identifier and as many parameter depending of device type.

{
    "key": "Bedroom door",
    "param1": "value1"
    ...
}

Full configuration example:

{
    "bridge": {
        ...
    },

    "description": "...",

    "accessories": [],

    "platforms":[
        {
            "platform": "Tahoma",
            "name": "My Tahoma Bridge",

            "user": "user@me.com",
            "password": "MyPassw0rd",
            "service": "somfy_europe",
            "exclude": ["hue", "rts", "Main door", "Main door", "PositionableHorizontalAwning"],

            "devicesConfig": [
                {
                    "key": "Alarm",
                    "stayZones": "A,C"
                },
                {
                    "key": "Bedroom blind",
                    "blindMode": true
                },
                {
                    "key": "GarageDoor",
                    "reverse": true
                },
                {
                    "key": "UpDownRollerShutter",
                    "defaultPosition": 50
                }
            ]
        }
    ]
}

Contribute

You are welcome to contribute to this plugin development by opening an issue in case of unexpected behaviour or unsupported device.

I do not expect any reward concerning this plugin, however, some users ask me for a button as sign of contribution. Feel free to use it.