search

pvyleta / ebusd-brink-hru

Collection of Brink HRU configuration files for ebusd
GNU General Public License v3.0
2 stars 1 forks source link

readme

ebusd-brink-hru

Collection of Brink HRU configuration files for ebusd

The configuration files were created by parsing the Brink Service Tool decompiled through JetBrains DotPeak. The decompiled source code is not distributed in this repo for it likely being a violation of the license agreement, though decompiling SW with the intention of interfacing to it can be considered legal. This is also a reason why parsing the code through independent python script was used, rather than re-using portions of the decompiled source code in a new C# binary.

For few parameters, other sources than the decompiled Brink Service Tool was used, such as datasheets, random internet forums etc. This is always noted in the source code, or even in the produced files.

Supported devices

Currently, the ebusd-configuration for these heat recovery units is present:

repo structure

ebusd-configuration-known-slave-address

If you find your device in this folder, you may consider yourself lucky - there can be used verbatim in ebusd. The files contain parameters for the latest SW version, for the 'Plus' variant of the HRU unit, so not all parameters might be applicable for your device. If you want a .csv file that matches your device perfectly, you need to look into ebusd-configuration-unknown-slave-address

All files are provided with language mutations for English, German, French, Italian, Spanish, Dutch and Polish in the respective subdirectories.

ebusd-configuration-unknown-slave-address

This folder contains all known Brink devices in all known SW versions and basic/plus variants of HW.

All files are provided with language mutations for English, German, French, Italian, Spanish, Dutch and Polish in the respective subdirectories.

The naming format is [device].[first_sw_version].[last_sw_version].[plus].csv (Files for basic devices, or for devices that does not even have a 'plus' variant have no 'plus' suffix)

The use is simple:

  1. Find out your device type and SW version (e.g. from the wall controller) and pick the appropriate file.
  2. Figure out the slave address of your device (can be easily found from ebusd logs - Brink devices respond as manufacturer ENCON to the 0704 id scan message, which might help you to find it)
  3. Rename the file to that address (in hexa, e.g. 3c.csv)
  4. In the file, replace [fill_your_slave_address_here] with slave address of your device, (e.g. '3c')
  5. Now you can use the file in ebusd

ebusd-mqtt

Contains useful adaptation of the mqtt-hassio.cfg file from the ebus repo, that is suitable for controlling Brink HRUs. The original is aimed mostly at water heaters and not ventilation units, so it was extended.

ebusd-scan

This is work-in-progress. The hope is, that we would be able to automate the selection of right file in ebusd through properly scanning various fields in this file, however, after several tries, this looks like way more difficult thing to achieve, than originally thought.

src

Contains the python scripts used to parse the decompiled Brink Service Tool. They are not exactly pretty, but they do the jobs and they contain reasonable number of sanity checks. The scripts are expected to be run from the root repo directory, i.e. python .\src\main.py

BCSServiceTool

This folder is expected to be filled in with the decompiled binary.

The version of tool used and tested with the parsing scripts is 'S1_04_11_0002'

dump

Contains dump of the parsed data in fairly re-usable JSON and CSV formats. if you plan to integrate Brink HRUs in other software than ebusd, this is the place to go.

Future work