{
    "info": {
        "author": "Daniel Strigl",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Intended Audience :: Developers",
            "Intended Audience :: Information Technology",
            "Intended Audience :: Manufacturing",
            "Intended Audience :: Science/Research",
            "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
            "Natural Language :: English",
            "Operating System :: POSIX",
            "Operating System :: POSIX :: Linux",
            "Programming Language :: Python",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Communications",
            "Topic :: Home Automation",
            "Topic :: Scientific/Engineering",
            "Topic :: Software Development :: Libraries",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: System :: Hardware :: Hardware Drivers",
            "Topic :: Terminals :: Serial"
        ],
        "description": "HtHeatpump\n==========\n\n\n.. image:: https://img.shields.io/pypi/v/htheatpump.svg\n        :target: https://pypi.python.org/pypi/htheatpump\n\n.. image:: https://img.shields.io/travis/dstrigl/htheatpump.svg\n        :target: https://travis-ci.org/dstrigl/htheatpump\n\n.. image:: https://readthedocs.org/projects/htheatpump/badge/?version=latest\n        :target: https://htheatpump.readthedocs.io/en/latest/?badge=latest\n        :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/dstrigl/htheatpump/shield.svg\n     :target: https://pyup.io/repos/github/dstrigl/htheatpump/\n     :alt: Updates\n\n\nEasy-to-use Python communication module for `Heliotherm <http://www.heliotherm.com/>`_ heat pumps.\n\n\n* GitHub repo: https://github.com/dstrigl/htheatpump\n* Documentation: https://htheatpump.readthedocs.io\n* Free software: `GNU General Public License v3 <https://www.gnu.org/licenses/gpl-3.0.en.html>`_\n\n\nIntroduction\n------------\n\nThis library provides a pure Python interface to access `Heliotherm <http://www.heliotherm.com/>`_ heat pumps\nover a serial connection. It's compatible with Python version 3.5, 3.6 and 3.7.\n\n\nFeatures\n~~~~~~~~\n\n* read the manufacturer's serial number of the heat pump\n* read the software version of the heat pump\n* read and write the current date and time of the heat pump\n* read the fault list of the heat pump\n* query whether the heat pump is malfunctioning\n* query for several parameters of the heat pump\n* change parameter values of the heat pump\n* fast query of MP data points / parameters (\"Web-Online\")\n* read and write the time programs of the heat pump\n\n\nTested with [*]_\n~~~~~~~~~~~~~~~~\n\n* Heliotherm HP08S10W-WEB, SW 3.0.20\n* Heliotherm HP10S12W-WEB, SW 3.0.8\n* Heliotherm HP08E-K-BC, SW 3.0.7B\n* Heliotherm HP05S07W-WEB, SW 3.0.17 and SW 3.0.37\n* Heliotherm HP12L-M-BC, SW 3.0.21\n\n  .. [*] thanks to Kilian, Hans, Alois and Simon for contribution\n\n\nInstalling\n----------\n\nYou can install or upgrade ``htheatpump`` with:\n\n.. code-block:: console\n\n    $ pip install htheatpump --upgrade\n\nOr you can install from source with:\n\n.. code-block:: console\n\n    $ git clone https://github.com/dstrigl/htheatpump.git\n    $ cd htheatpump\n    $ python setup.py install\n\n\nGetting started\n---------------\n\nTo use ``htheatpump`` in a project take a look on the following example. After establishing a connection\nwith the Heliotherm heat pump one can interact with it by different functions like reading or writing\nparameters.\n\n.. code:: python\n\n    from htheatpump.htheatpump import HtHeatpump\n\n    hp = HtHeatpump(\"/dev/ttyUSB0\", baudrate=9600)\n    try:\n        hp.open_connection()\n        hp.login()\n        # query for the outdoor temperature\n        temp = hp.get_param(\"Temp. Aussen\")\n        print(temp)\n        # ...\n    finally:\n        hp.logout()  # try to logout for an ordinary cancellation (if possible)\n        hp.close_connection()\n\nA full list of supported functions can be found in the ``htheatpump`` documentation at\n`readthedocs.io <https://htheatpump.readthedocs.io/en/latest/?badge=latest>`_.\n\n\nLogging\n~~~~~~~\n\nThis library uses the ``logging`` module. To set up logging to standard output, put\n\n.. code:: python\n\n    import logging\n    logging.basicConfig(level=logging.DEBUG)\n\nat the beginning of your script.\n\n\nDisclaimer\n----------\n\n.. warning::\n\n   Please note that any incorrect or careless usage of this module as well as\n   errors in the implementation can damage your heat pump!\n\n   Therefore, the author does not provide any guarantee or warranty concerning\n   to correctness, functionality or performance and does not accept any liability\n   for damage caused by this module, examples or mentioned information.\n\n   **Thus, use it on your own risk!**\n\n\nContributing\n------------\n\nContributions are always welcome. Please review the\n`contribution guidelines <https://github.com/dstrigl/htheatpump/blob/master/CONTRIBUTING.rst>`_\nto get started.\nYou can also help by `reporting bugs <https://github.com/dstrigl/htheatpump/issues/new>`_.\n\n\nCredits\n-------\n\nThis package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n\n\nHistory\n=======\n\n1.2.0 (2019-06-10)\n------------------\n\n* added support for Python's \"with\" statement for the ``HtHeatpump`` class\n* added some more unit-tests (especially for the time program functions)\n* extended the sample scripts ``hthttp.py`` to query for time programs of the heat pump\n* added new sample ``samples/httimeprog.py`` to read the time programs of the heat pump\n* added new functions to write/change time program entries of the heat pump (see ``HtHeatpump.set_time_prog...``)\n* added new functions to read the time program of the heat pump (see ``HtHeatpump.get_time_prog...``)\n* added type annotations and hints for static type checking (using ``mypy``)\n* splitted up property ``HtHeatpump.verify_param`` to ``HtHeatpump.verify_param_action``\n  and ``HtHeatpump.verify_param_error``\n* renamed exception ``ParamVerificationException`` to ``VerificationException``\n* added support for Python 3.7\n* dropped support for Python 3.4\n* added some more heat pump parameters (data points) in ``htparams.csv``\n\n1.1.0 (2019-02-23)\n------------------\n\n* added some more heat pump parameters (data points) in ``htparams.csv``\n* extended sample script ``htfaultlist.py`` by the possibility to write a JSON/CSV file\n* added new sample scripts ``hthttp.py`` and ``htfastquery.py``\n* fixed some formatting (flake8) errors\n* some improvement for the reconnect in the ``login()`` method of class ``HtHeatpump``\n* changed return type of ``HtHeatpump.get_fault_list()`` from ``dict`` to ``list``\n* added support for Python 3.6\n* added support for a user specific parameter definition file under ``~/.htheatpump/htparams.csv``\n* extended sample ``htbackup.py`` to store also the limits (MIN and MAX) of each data point\n* added method to verify the parameter definitions in ``htparams.csv`` during a ``HtHeatpump.get_param()``,\n  ``HtHeatpump.set_param()`` or ``HtHeatpump.query()``; this is just for safety to be sure that the\n  parameter definitions in ``HtParams`` are correct (deactivated by default, but can be activated by\n  setting the property ``HtHeatpump.verify_param`` to ``True``)\n* added new method ``HtHeatpump.fast_query()`` to retrieve \"MP\" data point values in a faster way (\"Web-Online\")\n* extended the ``HtHeatpump.login()`` method to perform an update of the parameter limits if desired\n\n1.0.0 (2018-01-12)\n------------------\n\n* First release on PyPI.",
        "description_content_type": "text/x-rst",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/dstrigl/htheatpump",
        "keywords": "python python3 heatpump serial protocol Heliotherm",
        "license": "GNU General Public License v3",
        "maintainer": "",
        "maintainer_email": "",
        "name": "htheatpump",
        "package_url": "https://pypi.org/project/htheatpump/",
        "platform": "Linux",
        "project_url": "https://pypi.org/project/htheatpump/",
        "project_urls": {
            "Homepage": "https://github.com/dstrigl/htheatpump"
        },
        "release_url": "https://pypi.org/project/htheatpump/1.2.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Easy-to-use Python communication module for Heliotherm heat pumps",
        "version": "1.2.0"
    },
    "last_serial": 5383173,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ee70b708a9f7c4b4f86438577ca38de5",
                    "sha256": "09c5425db15c5b44ad978fc81618cbc700e879904ea66fa74c43461bac26866a"
                },
                "downloads": -1,
                "filename": "htheatpump-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "ee70b708a9f7c4b4f86438577ca38de5",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 43811,
                "upload_time": "2018-01-12T19:23:12",
                "url": "https://files.pythonhosted.org/packages/f9/b9/abff5080cdef6f11040066400967027eaa9be4bb8f8898165a9c11e141b6/htheatpump-1.0.0.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b23db559214d74e6cc5980bc2ac144a3",
                    "sha256": "9056d23aea2290a70397f4de07c64260aacecd437f8f1ea4b04c9150bdef0e20"
                },
                "downloads": -1,
                "filename": "htheatpump-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b23db559214d74e6cc5980bc2ac144a3",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 56465,
                "upload_time": "2019-02-23T14:58:25",
                "url": "https://files.pythonhosted.org/packages/f7/9d/20e2f4408517cd8992dd5735801bfe6925410156e630abdce3a2c9874644/htheatpump-1.1.0.tar.gz"
            }
        ],
        "1.2.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "b5211f38dacabc4d88db782cf7b9f80d",
                    "sha256": "b42c876eb5d75a53ece4150d81ede59de8c8ac1b226ac67e7dac770431800d17"
                },
                "downloads": -1,
                "filename": "htheatpump-1.2.0.tar.gz",
                "has_sig": false,
                "md5_digest": "b5211f38dacabc4d88db782cf7b9f80d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 69013,
                "upload_time": "2019-06-10T19:29:20",
                "url": "https://files.pythonhosted.org/packages/86/65/c5ac18cd5c0f44fcb4b6d62271db8cbe7656ee917451a4b799a6780682ed/htheatpump-1.2.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "b5211f38dacabc4d88db782cf7b9f80d",
                "sha256": "b42c876eb5d75a53ece4150d81ede59de8c8ac1b226ac67e7dac770431800d17"
            },
            "downloads": -1,
            "filename": "htheatpump-1.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b5211f38dacabc4d88db782cf7b9f80d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 69013,
            "upload_time": "2019-06-10T19:29:20",
            "url": "https://files.pythonhosted.org/packages/86/65/c5ac18cd5c0f44fcb4b6d62271db8cbe7656ee917451a4b799a6780682ed/htheatpump-1.2.0.tar.gz"
        }
    ]
}