| Name | ngenicpy JSON |
| Version |
0.4.2
JSON |
| download |
| home_page | None |
| Summary | Python package for simple access to Ngenic Tune API. |
| upload_time | 2025-04-18 07:40:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | None |
| keywords |
api
hass
integration
ngenic
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Ngenic Tune Python API Wrapper
This python package simplifies access to the Ngenic Tune API.
It can be used for viewing or edit your Tune configuration.
Both sync and async APIs are provided - async APIs are prefixed with `async_`.
**NOTE**: This API wrapper is not yet finished, and only implements a subset of all the APIs. The interface may very well change.
## Prerequisite
### Obtain an API token
An API token may be obtained here: https://developer.ngenic.se/
## Installation
```
$ pip install ngenicpy
```
## Example
```python
import json
from ngenicpy import Ngenic
# try/finally
try:
ngenic = Ngenic(token="YOUR-API-TOKEN")
except NgenicException as e:
print(str(e))
finally:
ngenic.close()
# as context manager
with Ngenic(token="YOUR-API-TOKEN") as ngenic:
tunes = ngenic.tunes()
for tune in tunes:
print("Tune %s\nName: %s\nTune Name: %s" %
(
tune.uuid(),
tune["name"],
tune["tuneName"]
)
)
tune = ngenic.tune("TUNE-UUID")
rooms = tune.rooms()
for room in rooms:
print("Room %s\nName: %s\nTarget Temperature: %d" %
(
room.uuid(),
room["name"],
room["targetTemperature"]
)
)
# Update a room
room = tune.room(room_uuid="ROOM-UUID")
room["name"] = "Livingroom"
room.update()
nodes = tune.nodes()
for node in nodes:
node_status = node.status()
print("Node %s\nType: %s" %
(
node.uuid(),
node.get_type()
)
)
if node_status:
print("Battery: %s\nRadio Signal: %s" %
(
str(node_status.battery_percentage()),
str(node_status.radio_signal_percentage())
)
)
measurements = node.measurements()
for measurement in measurements:
print("%s: %d" %
(
measurement.get_type(),
measurement["value"]
)
)
```
Async example
```python
import json
from ngenicpy import Ngenic
async with AsyncNgenic(token="YOUR-API-TOKEN") as ngenic:
tunes = await ngenic.async_tunes()
for tune in tunes:
print("Tune %s\nName: %s\nTune Name: %s" %
(
tune.uuid(),
tune["name"],
tune["tuneName"]
)
)
```
## Reference
[Ngenic Tune Public API](https://developer.ngenic.se/)
Raw data
{
"_id": null,
"home_page": null,
"name": "ngenicpy",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Carl Ripa <cj.ripa@gmail.com>",
"keywords": "api, hass, integration, ngenic, sdk",
"author": null,
"author_email": "Carl Ripa <cj.ripa@gmail.com>, Simon Falkman <sfalkman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/48/fc/a6668f0adeac472a0af61e1d77cb8e85e461a69529abecc1b0c52d582e85/ngenicpy-0.4.2.tar.gz",
"platform": null,
"description": "# Ngenic Tune Python API Wrapper\n\nThis python package simplifies access to the Ngenic Tune API.\nIt can be used for viewing or edit your Tune configuration.\n\nBoth sync and async APIs are provided - async APIs are prefixed with `async_`.\n\n**NOTE**: This API wrapper is not yet finished, and only implements a subset of all the APIs. The interface may very well change.\n\n## Prerequisite\n\n### Obtain an API token\n\nAn API token may be obtained here: https://developer.ngenic.se/\n\n## Installation\n\n```\n$ pip install ngenicpy\n```\n\n## Example\n\n```python\nimport json\n\nfrom ngenicpy import Ngenic\n\n# try/finally\ntry:\n ngenic = Ngenic(token=\"YOUR-API-TOKEN\")\nexcept NgenicException as e:\n print(str(e))\nfinally:\n ngenic.close()\n\n# as context manager\nwith Ngenic(token=\"YOUR-API-TOKEN\") as ngenic:\n tunes = ngenic.tunes()\n for tune in tunes:\n print(\"Tune %s\\nName: %s\\nTune Name: %s\" %\n (\n tune.uuid(),\n tune[\"name\"],\n tune[\"tuneName\"]\n )\n )\n\n tune = ngenic.tune(\"TUNE-UUID\")\n\n rooms = tune.rooms()\n for room in rooms:\n print(\"Room %s\\nName: %s\\nTarget Temperature: %d\" %\n (\n room.uuid(),\n room[\"name\"],\n room[\"targetTemperature\"]\n )\n )\n\n # Update a room\n room = tune.room(room_uuid=\"ROOM-UUID\")\n room[\"name\"] = \"Livingroom\"\n room.update()\n\n nodes = tune.nodes()\n for node in nodes:\n node_status = node.status()\n\n print(\"Node %s\\nType: %s\" %\n (\n node.uuid(),\n node.get_type()\n )\n )\n\n if node_status:\n print(\"Battery: %s\\nRadio Signal: %s\" %\n (\n str(node_status.battery_percentage()),\n str(node_status.radio_signal_percentage())\n )\n )\n\n measurements = node.measurements()\n for measurement in measurements:\n print(\"%s: %d\" %\n (\n measurement.get_type(),\n measurement[\"value\"]\n )\n )\n```\n\nAsync example\n\n```python\nimport json\n\nfrom ngenicpy import Ngenic\n\nasync with AsyncNgenic(token=\"YOUR-API-TOKEN\") as ngenic:\n tunes = await ngenic.async_tunes()\n for tune in tunes:\n print(\"Tune %s\\nName: %s\\nTune Name: %s\" %\n (\n tune.uuid(),\n tune[\"name\"],\n tune[\"tuneName\"]\n )\n )\n```\n\n## Reference\n\n[Ngenic Tune Public API](https://developer.ngenic.se/)\n",
"bugtrack_url": null,
"license": null,
"summary": "Python package for simple access to Ngenic Tune API.",
"version": "0.4.2",
"project_urls": {
"Changelog": "https://github.com/dotnetdummy/ngenicpy/releases",
"Documentation": "https://github.com/dotnetdummy/ngenicpy",
"Homepage": "https://github.com/dotnetdummy/ngenicpy",
"Issues": "https://github.com/dotnetdummy/ngenicpy/issues",
"Repository": "https://github.com/dotnetdummy/ngenicpy.git"
},
"split_keywords": [
"api",
" hass",
" integration",
" ngenic",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1312f51599bc520a6312af25a915c4f0c7ca72780792cd3d41afa670c60c77d6",
"md5": "1109b4f08e5b413b6144710493e55d16",
"sha256": "e9137874d59170f5bc24f855b4900ab2c69a1c27f5ed94839929ff614912b03e"
},
"downloads": -1,
"filename": "ngenicpy-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1109b4f08e5b413b6144710493e55d16",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 14802,
"upload_time": "2025-04-18T07:40:56",
"upload_time_iso_8601": "2025-04-18T07:40:56.328133Z",
"url": "https://files.pythonhosted.org/packages/13/12/f51599bc520a6312af25a915c4f0c7ca72780792cd3d41afa670c60c77d6/ngenicpy-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "48fca6668f0adeac472a0af61e1d77cb8e85e461a69529abecc1b0c52d582e85",
"md5": "5d6cec6567848dd784379a9264fcc8a2",
"sha256": "db9077cae22a3473f141420ba0ba360e67c7b2cf1e01153a415d5eaeb8c5524d"
},
"downloads": -1,
"filename": "ngenicpy-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "5d6cec6567848dd784379a9264fcc8a2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 9987,
"upload_time": "2025-04-18T07:40:57",
"upload_time_iso_8601": "2025-04-18T07:40:57.989613Z",
"url": "https://files.pythonhosted.org/packages/48/fc/a6668f0adeac472a0af61e1d77cb8e85e461a69529abecc1b0c52d582e85/ngenicpy-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-04-18 07:40:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dotnetdummy",
"github_project": "ngenicpy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ngenicpy"
}
