jbouwh / ha-elro-connects Goto Github PK

View Code? Open in Web Editor NEW

9.0 3.0 2.0 97 KB

Elro Connects K1 for Home Assistant via HACS

License: MIT License

Python 98.54% Dockerfile 1.46%

elro fire-alarm fire-alarm-monitoring-system hacs-integration home-assistant smart-home siterwell hacs-default

ha-elro-connects's Introduction

ha-elro-connects

Elro Connects K1

The Elro Connects integration will allow users to integrate their Elro Connects fire, heat, CO, water, or smoke alarms as a siren entity into Home Assistant. The alarms can be tested (and silenced) through the siren turn on (and turn off) services. The integration discovers entities (automatically) through an Elro Connects K1 connector plug. The entity names assigned in the Elro Connects app will be synced with Home Assistant.

There is also a K2 connector available, but this K2 connector will not work with this software.

The integration only supports the Elro Connects K1 connector (SF40GA) mainly sold in Germany, the Netherlands, Belgium and France. The manufactor of this connector is Siterwell, and its products are also sold under the name FamilyWell Smart Security EcoSystem (gateway product GS188A). This integration support the legacy gateway, not the new generation that is working via Tuya using a zigbee gateway. The integration is not tested with the Siterwell branded devices, but some user reports indicate this is working too.

This component will set up the following platforms.

Platform	Description
`sensor`	Adds a `device state` sensor, a `battery level` sensor and a `signal` sensor (disabled by default) for each device.
`siren`	Represents Elro Connects alarms as a siren. Turn the siren `ON` to test it. Turn it `OFF` to silence the (test) alarm.

The device_state sensor can have of the following states:

fault
silence
test_alarm
fire_alarm
alarm
normal
unknown
offline

Note that the sensors are polled about every 15 seconds. So it might take some time before an alarm state will be propagated. If an unknown state is found that is not supported yet, the hexadecimal code will be assigned as state. Please open an issue here if a new state needs to be supported.

If the name of the device is changed in HA, it is also updated in the Elro Connects app. Note the name has a 15 character length limit.

The siren platform (for enabling a test alarm) was tested and is supported for Fire, Heat, CO and Water alarms.

Installation

Using HACS

Install the Home Assistant Community Store (HACS).
Select integration as category and click + to add an integration.
Find and install install Elro Connects via HACS.
When the installation via HACS is done, restart Home Assistant.
In the HA UI go to Configuration -> Integrations click + and search for Elro Connects

Manual

Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
If you do not have a custom_components directory (folder) there, you need to create it.
In the custom_components directory (folder) create a new folder called elro_connects.
Download all the files from the custom_components/elro_connects/ directory (folder) in this repository.
Place the files you downloaded in the new directory (folder) you created.
Restart Home Assistant
In the HA UI go to Configuration -> Integrations click + and search for Elro Connects

Using your HA configuration directory (folder) as a starting point you should now also have something like this:

Configuring the integration

You need the IP-address and your Elro Connects cloud credentials (username and password) to setup the integration. This will get the connector_id and api_key for local access of your connector. After the setup has finished setup, the cloud credentials will not be used during operation.
An alternative is a manual setup. For this you need to fill in the connector_id, leave username and password fields open. which can be obtained from the Elro Connects app. Go to the home tab and click on the settings wheel. Select current connector. A list will be shown with your connectors. The ID starts with ST_xxx....
The API key is probably not needed as long as it is provided by the connector locally. This behavior might change in the future.

custom_components/elro_connects/translations/en.json
custom_components/elro_connects/translations/nl.json
custom_components/elro_connects/__init__.py
custom_components/elro_connects/api.py
custom_components/elro_connects/sensor.py
custom_components/elro_connects/siren.py
custom_components/elro_connects/config_flow.py
custom_components/elro_connects/const.py
custom_components/elro_connects/manifest.json
...

Configuration is done in the UI

ha-elro-connects's People

Contributors

Stargazers

Watchers

Forkers

tom-bon92 ampiorosso

ha-elro-connects's Issues

When testing with real smoke I see something strange.

Hi Jan,
Thank you for this beautiful elro integration and all the time you have invested in it.
I have a k1 and 6 smoke detectors.
Installed the elro integration via hacs without problems v0.1.5-1
When testing with real smoke I see something strange.
The status goes from NORMAL to n/a and only when the smoke alarm is almost gone it go to the FIRE ALARM status

k2

Hi, I know thit is not a issue.
But i don't get it worked with a k2.

If you wan't to try something with a k2, i've got one and if you want I can make a test.

Error integracion

Hello thanks for your amazing integration. When adding the integration it shows me this error:

Reintentando la configuración: Not received the expected result, cannot connect to hub 192.168.1.103 with id ST_xxxxxxxxxx. ('Expecting property name enclosed in double quotes: line 1 column 2 (char 1)',)

port: 1025
version: v0.1.10

port: 1025
version: v0.1.10
elro devices, those manufactured by siterwell, my devices have not been bought from elro but from siterwell.

sorry my english is not very good and i'm translating from google

Unable to connect

When I put in ip address, credentials and even connector ID I get message unable to connect. Also tried without credentials but similar result. Running HA2023.1

I have the Elro connected to guest wifi since this is the only 2.4ghz and the dual band the K1 can't connect to. Might this be the issue? The ip is in similar range as all other local ip's. Any idea how I can connect to the K1 integration?

Cannot seem to get connection

Hi, I have the Elro K1 and tried to get it connected to Home Assistant via the HACS approach.
After installation I not I trying to get it configured, but I cannot get it to work.

I enter the IP address of the K1 connector (found it in my pfSense setup).
It seems to me that the connector ID is created by prefixing "ST_" to the mac address of the K1 connector. This also makes it quite easy to find the device in the router.

The HA is in the same IP range as the K1 connector. both 192.168.10.x . As pfsense is not blocking any LAN traffic, this should not be any issue.

However, I get an error "Maken van de verbinding mislukt" every time I try to setup the Elro Connects integration.

I tried both approaches:

filling in the IP address and the username/password (leaving other fields as-is. e.g. the port is default 1025)
filling in the IP address and the Connector ID (ST_xxxxx), leaving other fields as-is (no username/password)
In both scenario's cases the API key is not populated by me.
After a while a get the mentioned error message.

Because of this issue, i completely removed the Elro package from HACS and reinstalled it, to test it again. Same results.
I observe no issues in the log of HA, only a warning that the custom integration elro_connects has not been tested by Home Assistant (which is pretty normal).

running HA on VMWare (in Unraid)

HA OS 9.4
HA Core 2023.1.2

How can I debug my issue and find a solution?

Version vor K2?

Hi! Since there are no K1 connectors on the market, are there plans to create an integration for the K2?

Cannot start custom integration "elro_connects" after 2023.08.03

This error originated from a custom integration.

Logger: homeassistant.setup
Source: custom_components/elro_connects/device.py:10
Integration: Elro Connects (documentation, issues)
First occurred: 09:29:49 (1 occurrences)
Last logged: 09:29:49

Setup failed for custom integration elro_connects: Unable to import component: cannot import name 'K1' from 'elro.api' (/usr/local/lib/python3.11/site-packages/elro/api.py)
Traceback (most recent call last):
File "/usr/src/homeassistant/homeassistant/setup.py", line 215, in _async_setup_component
component = integration.get_component()
^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/src/homeassistant/homeassistant/loader.py", line 813, in get_component
ComponentProtocol, importlib.import_module(self.pkg_path)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "/usr/local/lib/python3.11/importlib/init.py", line 126, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
File "", line 1204, in _gcd_import
File "", line 1176, in _find_and_load
File "", line 1147, in _find_and_load_unlocked
File "", line 690, in _load_unlocked
File "", line 940, in exec_module
File "", line 241, in _call_with_frames_removed
File "/config/custom_components/elro_connects/init.py", line 12, in
from .device import ElroConnectsK1
File "/config/custom_components/elro_connects/device.py", line 10, in
from elro.api import K1
ImportError: cannot import name 'K1' from 'elro.api' (/usr/local/lib/python3.11/site-packages/elro/api.py)

Had a real fire alarm, but no status update in HA

Had a fire alarm last night at 4:30 am. Luckily it was a false alarm. I checked the Elro app and found one detector which reported a fire alarm.
But this alarm was not reported in Home Assistant. All detectors still report "Device_state NORMAL". None of them have changed, nor in the history log.

I haven't checked this issue yet in detail, will do that this weekend. But I wanted to report this already. This weekend I will run several test runs. As far as I know, that should change the Device_state as well. Is that true?

I will add details of my findings later. So no action is required yet on this issue.

Other sensors and actuators

Hi,

After reading the manual better I succeeded in installing the integration. It works great with a Elro K1 (found a refurbised one with Elro). As far as I understand it is only suitable for Fire/smoke, heat and CO alarm. Are you planning other sensors in the future? Elro has a nice priced set of addons. I'm interested in the temperature/humidity (SF40TH) and the radiator thermostat (SF40RV). The temperature sensor is great for monitoring or temperature regulation.

Regards
Alex

Error while connecting

I have setup Home Automation in a Docker container and added HACS and elro-components.
After configuring, first just with the connector Id, later with username and password which retrieved the same connector id I added manually in the first round and API key (wasn't retrieved when only using the connector id), I keep on getting the following error:

Config entry 'Elro Connects K1 Connector' for elro_connects integration not ready yet: Not received the expected result, cannot connect to hub 192.168.xxx.xxx with id "ST_............". ('Expecting property name enclosed in double quotes: line 1 column 2 (char 1)',); Retrying in background.
The connector id is all lowercase hex, changing this to upper case didn't work neither did enclosing it in double quotes

Port number

Thank you for making this HA integration.
Small question: what port number to choose? / where to find?

Device name limited to 15 characters

Thanks for this integration. Gives options for much better push notifications than the Elro app (and I like having everything in HA).

When setting up some of my devices showed up with generic names like FIRE_ALARM while others gave the names I set in the Elro app. After some searching I found that those devices for which the name exceeded 15 characters had this problem. I guess this is hard or impossible to fix, so perhaps it would be good to metion the 15 character name limit in the readme.md.

Where to get cloud credentials to setup integration?

I have just bought 15 smoke and heat detectors and particularly the K1 connector to get them integrated into HA.
Setting up the controller and pairing up all the detectors went just fine, however I'm stuck setting up the integration now.

In the README there is a mention that I need to input "your Elro Connects cloud credentials", however I cannot find anything related to Elro cloud in the android app. Also googling doesn't give any results.
I must be missing something obvious and feeling a bit dumb ;-). Hopefully you can help me further.