edilkamin

Name	edilkamin JSON
Version	1.3.0 JSON
	download
home_page	https://github.com/AndreMiras/edilkamin.py
Summary	Edilkamin Stove Python client
upload_time	2023-01-26 10:44:03
maintainer
docs_url	None
author	Andre Miras
requires_python
license
keywords
VCS
bugtrack_url
requirements	None
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Edilkamin.py

[![Tests](https://github.com/AndreMiras/edilkamin.py/workflows/Tests/badge.svg)](https://github.com/AndreMiras/edilkamin.py/actions/workflows/tests.yml)
[![Coverage Status](https://coveralls.io/repos/github/AndreMiras/edilkamin.py/badge.svg?branch=main)](https://coveralls.io/github/AndreMiras/edilkamin.py?branch=main)
[![PyPI version](https://badge.fury.io/py/edilkamin.svg)](https://badge.fury.io/py/edilkamin)
[![Documentation Status](https://readthedocs.org/projects/edilkamin/badge/?version=latest)](https://edilkamin.readthedocs.io/en/latest/?badge=latest)

This is a library for the [Reverse Engineered](https://medium.com/@andre.miras/edilkamin-stove-reverse-engineering-54c8f7af6b54) "The Mind" Edilkamin API.
The Mind offers an app/API to remote control the Edilkamin pellet stoves.

## Install

```sh
pip install edilkamin[ble]
```

## Usage

```python
import edilkamin
token = edilkamin.sign_in(username, password)
mac_address = edilkamin.discover_devices()[0]
edilkamin.device_info(token, mac_address)
edilkamin.set_power_off(token, mac_address)
```
For more advanced usage read the [documentation](https://edilkamin.readthedocs.io/en/latest/).

## Tests

```sh
make test
```

## Motivations

- providing an open source web alternative
  to the [proprietary mobile app](https://play.google.com/store/apps/details?id=com.edilkamin.stufe)
- improving the interoperability (Nest, HomeAssistant...)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/AndreMiras/edilkamin.py",
    "name": "edilkamin",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Andre Miras",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/d7/43/37d170b4a13b6649b8e1f2b2a2cf97b90086e9fc2c411a7758434833df56/edilkamin-1.3.0.tar.gz",
    "platform": null,
    "description": "# Edilkamin.py\n\n[![Tests](https://github.com/AndreMiras/edilkamin.py/workflows/Tests/badge.svg)](https://github.com/AndreMiras/edilkamin.py/actions/workflows/tests.yml)\n[![Coverage Status](https://coveralls.io/repos/github/AndreMiras/edilkamin.py/badge.svg?branch=main)](https://coveralls.io/github/AndreMiras/edilkamin.py?branch=main)\n[![PyPI version](https://badge.fury.io/py/edilkamin.svg)](https://badge.fury.io/py/edilkamin)\n[![Documentation Status](https://readthedocs.org/projects/edilkamin/badge/?version=latest)](https://edilkamin.readthedocs.io/en/latest/?badge=latest)\n\nThis is a library for the [Reverse Engineered](https://medium.com/@andre.miras/edilkamin-stove-reverse-engineering-54c8f7af6b54) \"The Mind\" Edilkamin API.\nThe Mind offers an app/API to remote control the Edilkamin pellet stoves.\n\n## Install\n\n```sh\npip install edilkamin[ble]\n```\n\n## Usage\n\n```python\nimport edilkamin\ntoken = edilkamin.sign_in(username, password)\nmac_address = edilkamin.discover_devices()[0]\nedilkamin.device_info(token, mac_address)\nedilkamin.set_power_off(token, mac_address)\n```\nFor more advanced usage read the [documentation](https://edilkamin.readthedocs.io/en/latest/).\n\n## Tests\n\n```sh\nmake test\n```\n\n## Motivations\n\n- providing an open source web alternative\n  to the [proprietary mobile app](https://play.google.com/store/apps/details?id=com.edilkamin.stufe)\n- improving the interoperability (Nest, HomeAssistant...)\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Edilkamin Stove Python client",
    "version": "1.3.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6734d05bb441c54cf3d58e93d962ccf267526e2f73d23ebbd8650c79debac21f",
                "md5": "9fb8fea281aaacf67763d948932e6bb0",
                "sha256": "60678e8cd6214b1fd65120b3cbae72a5ea487a9d70341b7a61a009ee432b1128"
            },
            "downloads": -1,
            "filename": "edilkamin-1.3.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9fb8fea281aaacf67763d948932e6bb0",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6995,
            "upload_time": "2023-01-26T10:44:01",
            "upload_time_iso_8601": "2023-01-26T10:44:01.803338Z",
            "url": "https://files.pythonhosted.org/packages/67/34/d05bb441c54cf3d58e93d962ccf267526e2f73d23ebbd8650c79debac21f/edilkamin-1.3.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d74337d170b4a13b6649b8e1f2b2a2cf97b90086e9fc2c411a7758434833df56",
                "md5": "bf2989bc2984ebd3338acf61d149c983",
                "sha256": "624b60c91276e835f44416d784d027e6ba7530fd23d3141caa6d0ad75fed8b5f"
            },
            "downloads": -1,
            "filename": "edilkamin-1.3.0.tar.gz",
            "has_sig": false,
            "md5_digest": "bf2989bc2984ebd3338acf61d149c983",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6496,
            "upload_time": "2023-01-26T10:44:03",
            "upload_time_iso_8601": "2023-01-26T10:44:03.374385Z",
            "url": "https://files.pythonhosted.org/packages/d7/43/37d170b4a13b6649b8e1f2b2a2cf97b90086e9fc2c411a7758434833df56/edilkamin-1.3.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-26 10:44:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "AndreMiras",
    "github_project": "edilkamin.py",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": null,
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "edilkamin"
}