Skip to content

Latest commit

 

History

History
214 lines (167 loc) · 7.38 KB

README.md

File metadata and controls

214 lines (167 loc) · 7.38 KB

hometop_HT3

Most everything needed for your heater-system to be shown at your 'hometop' -> pimp your heater.

Table of Contents

Introduction

This project is limited to recording/controlling and presentation of heating and solar informations. Currently only heater-systems from german manufacturer: Junkers/Bosch and system-bus: Heatronic/EMS2 (c) are supported.

This repo can not fulfill all wishes you could have to your 'hometop'. Each has his ideas such as the 'home' can be 'Top'. The presentation of informations from the own 'home' with it's heater-system is what this repo will do. Other projects are working too on this item, example: FHEM

Used Hardware

This repo was started creating some different boards for the RaspberryPi(c).
For the hardware see project: ht_transceiver

The table shows the currently available boards:

Board-name function Comment
ht_pitiny transmit- and receiving Bus - data active ht_transceiver-board for RPi
ht_piduino transmit- and receiving Bus - data active ht_transceiver-board for RPi
HT3_Mini_Adapter receiving Bus - data passive ht_receiver-board for RPi
HT3_Micro_Adapter receiving Bus - data passive ht_receiver-board for USB-interface
ht_motherboard passiv place-holder board for USB-UART and above boards

Modul: ht_pitiny

Modul: ht_piduino

Modul: HT3_Mini_Adapter

Modul: HT3_Micro_Adapter


Modul: ht_motherboard

Software

The software is written in python and designed for detection, decoding and controlling of HT - busdata with following features:

Modul-name function remark
create_databases.py tool for creating databases: sqlite and rrdtool. configureable
HT3_Analyser.py GUI for system-data and raw-hexdump of decoded ht - busdata. configureable, default running as ht_proxy.client
HT3_Systemstatus.py GUI to show system-data only. configureable, default running as ht_proxy.client
ht_collgate.py Running as daemon without GUI starting interfaces for
- ht_data decoding,
- mqtt-IF,
- SPS-IF.
configureable, default running as ht_proxy.client and
- sqlite = Off,
- rrdtool = On,
- mqtt_IF = Off,
- SPS_IF = Off.
ht_proxy.py ht-server to collect data from serial port and supporting connected clients with raw - busdata. configureable, default accepting any client
ht_netclient.py ht-client sending commands to the heater-bus. manual data-input, configureable, default connecting to 'localhost'
ht_binlogclient.py acts as logger for binary ht - busdata. logfile-name selectable, default connecting to 'localhost'
ht_client_example.py ht-client acts as example for your one ht-client. ht_client-example, default connecting to 'localhost'
ht_2hassio.py Running as daemon for MQTT-message translation from ht- to HomeAssistant-mqtt messages. ht_collgate configuration must be set to: mqtt_IF = On

The current software can be found in subfolders: ~/HT3/sw/...
Any hardware informations are in subfolders: ~/HT3/hw/...

The software is still under development, but any official release should be runable 'out of the box' under Linux.
For Windows some improvements are required and will be done in the future.

If you have got any problems with hard- or software, let me know.
Also your support with binary - logfiles is good to have for further development.

Thank's to all supporting me, in the past and future.
We all want to have the right thing in the right time.

Software Installation

The SW-installation is designed for user: pi.
For any other user the startup-scripts have to be modified.
During the installation all required software-parts are installed or updated including the OS-update and -upgrade.
Currently created databases are NOT overwritten.
The previous project-software is saved in folder: ~/.hometop (excluding databases).
It's possible to install this project to any platform with a linux-distribution.

Preconditions:

  • login as user: (all startup-scripts are written for user:pi)
    pi

  • get the project with:
    git clone https://github.com/norberts1/hometop_HT3.git

  • 'sudo' has to be accessible for user 'pi'.

Installation / Update

  • Step into cloned folder:
    cd hometop_HT3/HT3

  • Call the installaton-script:
    ht_project_setup.sh

Postconditions:

  • Check the output on the installation-terminal for any errors.
  • reboot the system with:
    sudo reboot

Documentation

For project - details see the documentation (folder: ~/HT3/docu ), the wiki and the following links:

Importent notes

Importent notes:

The reproduction and the commissioning of the adaptations is at your own risk and the description and software do not claim to be complete. A change of software modules and hardware descriptions at any time is possible without notice. Warranty, liability and claims by malfunction of heating or adaptation are hereby expressly excluded.

Wichtiger Hinweis:

Der Nachbau und die Inbetriebnahme der Adaptionen ist auf eigene Gefahr und die Beschreibung und die Software erheben nicht den Anspruch auf Vollständigkeit. Eine Änderung an Software-Modulen und Hardware-Beschreibungen ist jederzeit ohne Vorankündigung möglich. Gewährleistung, Haftung und Ansprüche durch Fehlfunktionen an Heizung oder Adaption sind hiermit ausdrücklich ausgeschlossen.