{
    "info": {
        "author": "rikky",
        "author_email": "rikky@web.de",
        "bugtrack_url": null,
        "classifiers": [],
        "description": "# Boiler Logger for Remeha Tzerra\n\n## Features\n\nThis logger is meant to read data from a Remeha Boiler and distribute it to different backends.\nCurrently it only supports reading from a ***Remeha Tzerra*** and writing to a ***MQTT broker***, a\n***CSV file***, and/or ***MySQL/MariaDB***. It should be easy to add support for other Remeha Boilers.\n\nThere is an additional Python Script (plotlytest.py) which can read the csv file written by the\nlogger and render some nice diagrams. As the name suggests it uses Plotly to do interactive\ndiagrams and dash to distribute it with a simple webservice.\n\n## Installing\n\nYou need ***Python 3*** installed. There is a setup.py provided, which you could call directly or\neven better use \"pip\" to install:\n\nFor the latest released version:\n\n```\npip install remeha-tz\n```\n\nor for the latest version on github:\n\n```\npip install git+https://github.com/TheRikke/remeha_tz.git@master\n```\n\nIf you want to log to a mysql/mariadb, please copy config/remeha.conf to ~/remeha.conf, ~/.remeha.conf or /etc/remeha/remeha.conf\nand change the database parameter in there.\n\nIf you don't need the plotly diagrams, You can remove the 'dash' and 'plotly' dependencies from\nsetup.py.\n\n## Config\n\nThe tool reads the config from '/etc/remeha/remeha.conf', ~/.remeha.conf or a config specified in the environment variable REMEHA_CONF. For an example see \nconfig/remeha.conf\n\n```\n{\n  \"database_logger\": {\n    \"enabled\": false,\n    \"host\": \"testserver.local\",\n    \"user_name\": \"database_user\",\n    \"password\": \"secret_passwort\"\n  },\n  \"mqtt_logger\": {\n    \"enabled\": true,\n    \"host\": \"localhost\",\n    \"port\": 1883,\n    \"tls_enabled\": false,\n    \"comment-topic\": \"specify the topic every value will be published to.\",\n    \"topic\": \"boiler/\",\n    \"log_values\": [\"outside_temp\", \"flow_temp\", \"return_temp\", \"calorifier_temp\", \"airflow_actual\"],\n    \"log_values_with_timestamp\": [ \"status\", \"substatus\", \"locking\", \"blocking\", \"airflow_actual\"],\n    \"Comment-Log_values_with_duration\": \"Log how long a specific value has been active. Useful to log something like 'How long did the boiler burn to heat the domestic hot water supply'\",\n    \"log_values_with_duration\": [\n      {\n        \"value_name\": \"status\",\n        \"expected_value\": \"burning_dhw\"\n      }\n    ],\n    \"scale_to_percent\": [\n      {\n        \"value_name\": \"airflow_actual\",\n        \"lower_limit\": 0,\n        \"upper_limit\": 2900\n      }\n    ]\n  }\n}\n```\n\n## Usage\n\n```\nremeha.py -d /dev/ttyUSB0 --output test.csv\n```\n\nThis will start logging to the local mqtt broker with the topic 'boiler/' and the specified csv\nfile. See ```--help``` for more options and config/remeha.conf for the values logged per default.\n\n## Other useful information\n\nThe csv file contains the raw frame received from the boiler and not the decoded values. This\nis done because I'm not sure about the meaning of some values. By saving the raw frame\nwe don't lose any data and are able to decode them later. Also it makes supporting other\nboiler types more easy.\n\nTo convert the csv with raw values to csv with readable values use the convert script:\n\n```\nremeha_convert.py --input-file test.csv > converted.csv\n```\n\n## Hardware\n\nMost Remeha boiler use a simple serial connection with 5V TTL. If you have a Raspberry Pi, Arduino or similar, \nit can most likely be directly connected to the boiler. To connect it to 3.3V like a PC you need a TTL converter or \na TTL-USB converter. \nThe remeha tzerra uses a RJ10 aka. 4P4C connector. I've used an old phone cord to connect my Raspberry Pi clone to the\nboiler.\n\nhttps://en.wikipedia.org/wiki/Modular_connector#4P4C\n\nConnect the number pins of the 4P4C connector to the following pins of your board or TTL-USB converter:\n\n* pin 1 - GND\n* pin 2 - TX\n* pin 3 - RX\n* pin 4 - VCC 5 (I did not connect this one. Just for reference.)\n\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/TheRikke/remeha_tz",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "remeha-tz",
        "package_url": "https://pypi.org/project/remeha-tz/",
        "platform": null,
        "project_url": "https://pypi.org/project/remeha-tz/",
        "project_urls": {
            "Homepage": "https://github.com/TheRikke/remeha_tz"
        },
        "release_url": "https://pypi.org/project/remeha-tz/0.12/",
        "requires_dist": null,
        "requires_python": ">=3.6",
        "summary": "",
        "version": "0.12",
        "yanked": false,
        "yanked_reason": null
    },
    "last_serial": 13337912,
    "releases": {
        "0.11": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8f7d7d768b8013b4660d272b8062e57e",
                    "sha256": "ea6dce25474a74886ac7d587e142b86fe50e244581f2e6233a6e120617c280ee"
                },
                "downloads": -1,
                "filename": "remeha_tz-0.11.tar.gz",
                "has_sig": false,
                "md5_digest": "8f7d7d768b8013b4660d272b8062e57e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3",
                "size": 16529,
                "upload_time": "2019-10-23T18:57:51",
                "upload_time_iso_8601": "2019-10-23T18:57:51.627889Z",
                "url": "https://files.pythonhosted.org/packages/f7/3c/46329ec2174b586218f7611d8091de9d5fb0ec239f635538cf68d5a07171/remeha_tz-0.11.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ],
        "0.12": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "52cfb5581136a0a9ae24bbd04219ff22",
                    "sha256": "13fe687bfce6d805789b2412202850bd33a59d9982c627f77d875843a99f073e"
                },
                "downloads": -1,
                "filename": "remeha_tz-0.12.tar.gz",
                "has_sig": false,
                "md5_digest": "52cfb5581136a0a9ae24bbd04219ff22",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": ">=3.6",
                "size": 26104,
                "upload_time": "2022-03-29T20:07:20",
                "upload_time_iso_8601": "2022-03-29T20:07:20.888886Z",
                "url": "https://files.pythonhosted.org/packages/9a/61/e0b90a09fbef2ffdf3cb11aef28da82bdf765b63ba1911e0333c7027df09/remeha_tz-0.12.tar.gz",
                "yanked": false,
                "yanked_reason": null
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "52cfb5581136a0a9ae24bbd04219ff22",
                "sha256": "13fe687bfce6d805789b2412202850bd33a59d9982c627f77d875843a99f073e"
            },
            "downloads": -1,
            "filename": "remeha_tz-0.12.tar.gz",
            "has_sig": false,
            "md5_digest": "52cfb5581136a0a9ae24bbd04219ff22",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 26104,
            "upload_time": "2022-03-29T20:07:20",
            "upload_time_iso_8601": "2022-03-29T20:07:20.888886Z",
            "url": "https://files.pythonhosted.org/packages/9a/61/e0b90a09fbef2ffdf3cb11aef28da82bdf765b63ba1911e0333c7027df09/remeha_tz-0.12.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "vulnerabilities": []
}