# Evonic Fire API Client
## About
This package allows you to control and monitor an Evonic Fire, over a local WebSocket connection. It has been tested
with the Linnea, so other fires may or may not be compatible
## Installation
`pip install pyevonic`
## Usage
```py
import asyncio
from pyevonic import Evonic
ev = Evonic("192.168.1.190")
async def main():
await ev.connect()
await ev.listen(callback=log)
def log(e):
print(e.__dict__)
if __name__ == "__main__":
asyncio.run(main())
```
## Available Methods
### Connect to the WebSocket of an Evonic Fire.
```py
connect()
```
### Listen for events on the Evonic WebSocket.
```py
listen(callback=method)
```
### Disconnect from a WebSocket
```py
disconnect()
```
### Control the main lighting for the Evonic Fire.
```python
light_power(cmd)
```
Valid `cmd` values: `on` `off` `toggle`
### Toggles the feature light of an Evonic Fire
```python
toggle_feature_light()
```
### Sets the brightness of each RGB strip
```python
set_light_brightness(rgb_id, brightness)
```
`rgb_id` values can be found in `Device.info.modules`
`brightness` must be an integer from `0` to `255`
### Sets the animation speed of each RGB strip
```python
set_animation_speed(rgb_id, speed)
```
`rgb_id` values can be found in `Device.info.modules`
`speed` must be an integer from `0` to `255`
### Sets the heater temperature on an Evonic Fire
```python
set_temperature(temp)
```
`temp` must be an integer between `50` and `90` for fahrenheit, and `10` and `33` for celsius
### Controls the Heater for the Evonic Fire.
```python
heater_power(cmd)
```
Valid `cmd` values: `on` `off` `toggle`
Raw data
{
"_id": null,
"home_page": "https://github.com/greghesp/python-evonic",
"name": "pyevonic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Greg Hesp",
"author_email": "greg.hesp+pyevonic@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/51/a2/2689e51c72c9834202aa5546c3a76ed50059b629d0b67da6e87fa92640a4/pyevonic-0.0.14.tar.gz",
"platform": null,
"description": "# Evonic Fire API Client\n\n## About\n\nThis package allows you to control and monitor an Evonic Fire, over a local WebSocket connection. It has been tested \nwith the Linnea, so other fires may or may not be compatible\n\n## Installation\n\n`pip install pyevonic`\n\n## Usage\n\n```py\nimport asyncio\n\nfrom pyevonic import Evonic\n\nev = Evonic(\"192.168.1.190\")\n\nasync def main():\n await ev.connect()\n await ev.listen(callback=log)\n\ndef log(e):\n print(e.__dict__)\n\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n## Available Methods\n\n### Connect to the WebSocket of an Evonic Fire.\n```py\nconnect()\n```\n\n### Listen for events on the Evonic WebSocket.\n```py\nlisten(callback=method)\n```\n\n### Disconnect from a WebSocket\n```py\ndisconnect()\n```\n\n### Control the main lighting for the Evonic Fire.\n```python\nlight_power(cmd) \n```\nValid `cmd` values: `on` `off` `toggle`\n\n### Toggles the feature light of an Evonic Fire\n```python\ntoggle_feature_light()\n```\n\n### Sets the brightness of each RGB strip\n```python\nset_light_brightness(rgb_id, brightness)\n```\n`rgb_id` values can be found in `Device.info.modules`\n\n`brightness` must be an integer from `0` to `255`\n\n### Sets the animation speed of each RGB strip\n```python\nset_animation_speed(rgb_id, speed)\n```\n`rgb_id` values can be found in `Device.info.modules`\n\n`speed` must be an integer from `0` to `255`\n\n### Sets the heater temperature on an Evonic Fire\n```python\nset_temperature(temp)\n```\n`temp` must be an integer between `50` and `90` for fahrenheit, and `10` and `33` for celsius\n\n### Controls the Heater for the Evonic Fire.\n```python\nheater_power(cmd)\n```\nValid `cmd` values: `on` `off` `toggle`\n",
"bugtrack_url": null,
"license": "",
"summary": "A wrapper for the Evoflame API v1",
"version": "0.0.14",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "152ee2f42ac33d667126150a38ea3465",
"sha256": "9372720b9d6da08810d4f1feb9fd86fafb218562f1fa45ac2d3fa76718ececa1"
},
"downloads": -1,
"filename": "pyevonic-0.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "152ee2f42ac33d667126150a38ea3465",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 7570,
"upload_time": "2022-12-16T12:13:17",
"upload_time_iso_8601": "2022-12-16T12:13:17.639752Z",
"url": "https://files.pythonhosted.org/packages/20/b2/af5c42e15a231a399aecf88752b726b3daf94eed76214bdfb5248a88733b/pyevonic-0.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "b0994a689a3c43f5c3e55179d6b74a84",
"sha256": "559c3767d7baa8ce8e0136e1df44a91d3ee1f2962b6f1142740598dfcb3e8b1c"
},
"downloads": -1,
"filename": "pyevonic-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "b0994a689a3c43f5c3e55179d6b74a84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 7429,
"upload_time": "2022-12-16T12:13:18",
"upload_time_iso_8601": "2022-12-16T12:13:18.623194Z",
"url": "https://files.pythonhosted.org/packages/51/a2/2689e51c72c9834202aa5546c3a76ed50059b629d0b67da6e87fa92640a4/pyevonic-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-16 12:13:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "greghesp",
"github_project": "python-evonic",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyevonic"
}
JSON
