ariston-boiler-control

Name	ariston-boiler-control JSON
Version	0.0.4 JSON
	download
home_page
Summary	Managing ariston wifi boilers
upload_time	2023-02-11 11:41:59
maintainer
docs_url	None
author	Francesco Santini
requires_python	>=3.7
license	Apache License 2.0
keywords	smart home boiler ariston
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            [![Documentation Status](https://readthedocs.org/projects/ariston-boiler-control/badge/?version=latest)](https://ariston-boiler-control.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/ariston-boiler-control.svg)](https://badge.fury.io/py/ariston-boiler-control)
![License - Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-brightgreen)

## ariston_boiler_control

Module for the control of a Wifi-enabled Ariston boiler through the Web API.

At the moment, this module only works with the default boiler specificed in the web interface.

Features:
* read the current temperature
* read and set the target temperature
* read and set the operation mode (Green, Comfort, Fast, Auto, HCHP)
* read the HP state (on/off)
* read and set the boost mode (on/off)

Example:
```python
    >>> from ariston_boiler_control import AristonBoilerControl, OperationMode
    >>> abc = AristonBoilerControl('email@email.com', 'password')
    >>> # executes the login with the username and password provided
    >>> # it is actually optional: it is done automatically when needed
    >>> abc.login()
    >>> # get the current temperature
    >>> temperature = abc.get_current_temperature()
    >>> # set the operation mode to comfort
    >>> abc.set_operation_mode(OperationMode.COMFORT)
    >>> # set the target temperature to 60 degrees
    >>> abc.set_target_temperature(60)
```
Copyright (c) 2023 Francesco Santini <francesco.santini@gmail.com>

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ariston-boiler-control",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "Smart home,boiler,ariston",
    "author": "Francesco Santini",
    "author_email": "francesco.santini@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/e8/e3/d541d0fb487375c8c48711ae3bb57ac979d8fb00efad4c94095f3739145d/ariston_boiler_control-0.0.4.tar.gz",
    "platform": null,
    "description": "[![Documentation Status](https://readthedocs.org/projects/ariston-boiler-control/badge/?version=latest)](https://ariston-boiler-control.readthedocs.io/en/latest/?badge=latest)\n[![PyPI version](https://badge.fury.io/py/ariston-boiler-control.svg)](https://badge.fury.io/py/ariston-boiler-control)\n![License - Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-brightgreen)\n\n## ariston_boiler_control\n\nModule for the control of a Wifi-enabled Ariston boiler through the Web API.\n\nAt the moment, this module only works with the default boiler specificed in the web interface.\n\nFeatures:\n* read the current temperature\n* read and set the target temperature\n* read and set the operation mode (Green, Comfort, Fast, Auto, HCHP)\n* read the HP state (on/off)\n* read and set the boost mode (on/off)\n\nExample:\n```python\n    >>> from ariston_boiler_control import AristonBoilerControl, OperationMode\n    >>> abc = AristonBoilerControl('email@email.com', 'password')\n    >>> # executes the login with the username and password provided\n    >>> # it is actually optional: it is done automatically when needed\n    >>> abc.login()\n    >>> # get the current temperature\n    >>> temperature = abc.get_current_temperature()\n    >>> # set the operation mode to comfort\n    >>> abc.set_operation_mode(OperationMode.COMFORT)\n    >>> # set the target temperature to 60 degrees\n    >>> abc.set_target_temperature(60)\n```\nCopyright (c) 2023 Francesco Santini <francesco.santini@gmail.com>\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Managing ariston wifi boilers",
    "version": "0.0.4",
    "split_keywords": [
        "smart home",
        "boiler",
        "ariston"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f37cb0c2b89b87a1f436361ef7a40814855162dfe48a4bf8185d5a51173f6735",
                "md5": "a8469fd96ff629e4ef28fbd478b02c6c",
                "sha256": "985b6e96cfa6ccf2cf2be40a56644744a3f72805dcc233b9e2dc68ebd27ba20c"
            },
            "downloads": -1,
            "filename": "ariston_boiler_control-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a8469fd96ff629e4ef28fbd478b02c6c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 9494,
            "upload_time": "2023-02-11T11:41:56",
            "upload_time_iso_8601": "2023-02-11T11:41:56.706135Z",
            "url": "https://files.pythonhosted.org/packages/f3/7c/b0c2b89b87a1f436361ef7a40814855162dfe48a4bf8185d5a51173f6735/ariston_boiler_control-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e8e3d541d0fb487375c8c48711ae3bb57ac979d8fb00efad4c94095f3739145d",
                "md5": "e76ed4e068d83814055c46ac072454fe",
                "sha256": "51044338beb1eedc210bc6c3e1d1fed990b6bdbe4c5fe3d73e49d5aec352390d"
            },
            "downloads": -1,
            "filename": "ariston_boiler_control-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "e76ed4e068d83814055c46ac072454fe",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 8394,
            "upload_time": "2023-02-11T11:41:59",
            "upload_time_iso_8601": "2023-02-11T11:41:59.113391Z",
            "url": "https://files.pythonhosted.org/packages/e8/e3/d541d0fb487375c8c48711ae3bb57ac979d8fb00efad4c94095f3739145d/ariston_boiler_control-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-02-11 11:41:59",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "ariston-boiler-control"
}