search

dib0 / elro_connects

The ELRO Connects uses a propriety protocol on the local network over UDP. This is the reversed engineered python implementation of the protocol.
MIT License
16 stars 7 forks source link

readme

NOTE

ELRO Connects probably will also function on the BASE smart home gateway SWM188A and the SITERWELL GS198. Both have not been tested.

ELRO Connects

The ELRO Connects uses a propriety protocol on the local network over UDP. This is the reversed engineered python implementation of the protocol.

The ERLO K1 connects SF40GA system allows you to connect fire alarms, heat alarms, CO alarms, water alarms and door/window sensors through a hub. The app uses an internet connection, but on the local network it is possible to communicate with the hub through a propriety UDP protocol.

The ELRO connects hub allows only one 'connection' at a time. So running this will discontinue sending data to the app and vice versa.

Features to expect:

Setup

Simply install via pip

$ pip install .

Usage

usage: elro [-h] -k HOSTNAME -m MQTT_BROKER [-b BASE_TOPIC] [-i ID] [-a]

required arguments:
    -k HOSTNAME, --hostname HOSTNAME
                            The hostname or ip of the K1 connector.
    -m MQTT_BROKER, --mqtt-broker MQTT_BROKER
                            The IP of the MQTT broker.
    -b BASE_TOPIC, --base-topic BASE_TOPIC
                            The base topic of the MQTT topic.

optional arguments:
    -i ID, --id ID        The ID of the K1 connector (format is ST_xxxxxxxxxxxx).
    -a, --ha-autodiscover
                            Send the devices automatically to Home Assistant.

MQTT

Broker

The MQTT_BROKER uses the MQTT URL scheme.

{mqtt,ws}[s]://[username][:password]@host.domain[:port]

Topics

You can set the base topic of all MQTT messages with the -b flag. Then this application will publish on

[base_topic]/elro/[device_id]

The following message will be available on the topic above as soon as the devices are synced.

{
    "name": "fire_alarm_living_room", 
    "device_name": "fire_alarm_living_room", 
    "id": 8, 
    "type": "0013", 
    "type_name": "FIRE_ALARM", 
    "state": "Normal", 
    "battery": 95, 
    "signal": 4
}

When the device has an alarm the payload is the same as above, but the state is set to Alarm or Test Alarm.

The signal has a scale from 0 to 4, where 4 is the best strength.

To initiate an action through MQTT, use the following topic

[base_topic]/elro/[device_id]/set

The following actions can be set.

Permit join

Enable or disable the hub to allow devices to join. This payload can only be sent to [device_id] 0. Send false as the value for "permit_join" when the device will not be joined.

{
  "permit_join": true|false
}

Remove

Remove a device from the network. The [device_id] is the device that will be removed. Use this payload

{
  "remove": true
}

Replace

Replace a device from the network. The [device_id] is the device that will be replaced. When the device will not be replaced, cancel the replacement by using false as the value for "replace". Use this payload

{
  "replace": true|false
}

State

Change the state of the device

Test alarm

Use this payload

{
  "state": "test alarm"
}
Silence

To silence an alarm, a payload can only be sent to [device_id] 0, and it will only silence the hub. Use this payload

{
  "state": "silence"
}

Name

Change the name of your device. This can be a maximum of 15 characters and consist of the following characters (the , is not allowed): a-z,A-Z, 0-9, ,-,_

Use this payload

{
  "name": "Kitchen"
}

Supported Devices by ERLO K1 connects SF40GA

Fire alarms