blaubergvento-client


Nameblaubergvento-client JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://github.com/michaelkrog/blaubergvento-python
SummaryA client for communicating with Blauberg vento (and derived) ventilators.
upload_time2025-07-26 10:47:24
maintainerNone
docs_urlNone
authorMichael Krog
requires_python>=3.9
licenseMIT License Copyright (c) 2022 Michael Krog Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords blauberg duka ventilator
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Introduction

This is a Python module for communicating with a Blauberg Vento (and OEMS like Duka One S6w).
The Blauberg Vento is a one room ventilationsystem with a heat exchanger.

This module has roots in the [dukaonesdk](https://github.com/dingusdk/dukaonesdk/blob/master/readme.md) but has been rewritten from scratch in order to better separate 
responsibilities into different classes, while still being able to reuse shared logic.

The primary goal for this module is to create a Python client that makes communicating with Blauberg 
Vento(and its derivatives) a simple task. 

## Installation
```
python3 -m pip install blaubergvento_client
```

The module has the following 2 levels of communication:
1. A low level client that implements the communication protocol specified by Blauberg.
2. A high level client that utilizes the protocol client for easier usage.
 
## Protocol Client Example 

```
async def main():
    resource = Client()

    # 1. List devices (first page, 20 per page)
    devices = await resource.find_all(page=0, size=20)
    print(f"Total devices returned: {len(devices)}")
    for device in devices:

        print(f"Device ID: {device.id}, IP: Do-no, Mode: {device.mode}, Speed: {device.speed}")

    # 2. Find a specific device by ID
    device_id = devices[0].id if devices else None
    if device_id:
        device = await resource.find_by_id(device_id)
        print(f"\nDetails of device {device_id}: Mode={device.mode}, Speed={device.speed}")

        # 3. Modify device properties and save
        device.speed = Speed.HIGH
        updated_device = await resource.save(device)
        print(f"Updated device speed: {updated_device.speed}")

if __name__ == "__main__":
    asyncio.run(main())
```

## High Level Example

```
async def main():
    print("Searching for Blauberg Vento devices on the network...")

    client = ProtocolClient(timeout=2.0)  # Increase timeout if needed
    devices = await client.find_devices()

    if not devices:
        print("No devices found.")
    else:
        print(f"Found {len(devices)} device(s):")
        for idx, device in enumerate(devices, start=1):
            print(f"{idx}. ID: {device.id}, IP: {device.ip}")

if __name__ == "__main__":
    asyncio.run(main())

```

[You can see the documentation from Blauberg here](https://blaubergventilatoren.de/uploads/download/b133_4_1en_01preview.pdf)

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/michaelkrog/blaubergvento-python",
    "name": "blaubergvento-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "blauberg, duka, ventilator",
    "author": "Michael Krog",
    "author_email": "Michael Krog <info@apaq.dk>",
    "download_url": "https://files.pythonhosted.org/packages/e8/7e/feaeb89cfdcead6b8b313e1d05f9dadb99b89d74d9796756e3b7dd20fa36/blaubergvento_client-1.0.0.tar.gz",
    "platform": null,
    "description": "# Introduction\n\nThis is a Python module for communicating with a Blauberg Vento (and OEMS like Duka One S6w).\nThe Blauberg Vento is a one room ventilationsystem with a heat exchanger.\n\nThis module has roots in the [dukaonesdk](https://github.com/dingusdk/dukaonesdk/blob/master/readme.md) but has been rewritten from scratch in order to better separate \nresponsibilities into different classes, while still being able to reuse shared logic.\n\nThe primary goal for this module is to create a Python client that makes communicating with Blauberg \nVento(and its derivatives) a simple task. \n\n## Installation\n```\npython3 -m pip install blaubergvento_client\n```\n\nThe module has the following 2 levels of communication:\n1. A low level client that implements the communication protocol specified by Blauberg.\n2. A high level client that utilizes the protocol client for easier usage.\n \n## Protocol Client Example \n\n```\nasync def main():\n    resource = Client()\n\n    # 1. List devices (first page, 20 per page)\n    devices = await resource.find_all(page=0, size=20)\n    print(f\"Total devices returned: {len(devices)}\")\n    for device in devices:\n\n        print(f\"Device ID: {device.id}, IP: Do-no, Mode: {device.mode}, Speed: {device.speed}\")\n\n    # 2. Find a specific device by ID\n    device_id = devices[0].id if devices else None\n    if device_id:\n        device = await resource.find_by_id(device_id)\n        print(f\"\\nDetails of device {device_id}: Mode={device.mode}, Speed={device.speed}\")\n\n        # 3. Modify device properties and save\n        device.speed = Speed.HIGH\n        updated_device = await resource.save(device)\n        print(f\"Updated device speed: {updated_device.speed}\")\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n```\n\n## High Level Example\n\n```\nasync def main():\n    print(\"Searching for Blauberg Vento devices on the network...\")\n\n    client = ProtocolClient(timeout=2.0)  # Increase timeout if needed\n    devices = await client.find_devices()\n\n    if not devices:\n        print(\"No devices found.\")\n    else:\n        print(f\"Found {len(devices)} device(s):\")\n        for idx, device in enumerate(devices, start=1):\n            print(f\"{idx}. ID: {device.id}, IP: {device.ip}\")\n\nif __name__ == \"__main__\":\n    asyncio.run(main())\n\n```\n\n[You can see the documentation from Blauberg here](https://blaubergventilatoren.de/uploads/download/b133_4_1en_01preview.pdf)\n",
    "bugtrack_url": null,
    "license": "MIT License\n        \n        Copyright (c) 2022 Michael Krog\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy\n        of this software and associated documentation files (the \"Software\"), to deal\n        in the Software without restriction, including without limitation the rights\n        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n        copies of the Software, and to permit persons to whom the Software is\n        furnished to do so, subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n        SOFTWARE.\n        ",
    "summary": "A client for communicating with Blauberg vento (and derived) ventilators.",
    "version": "1.0.0",
    "project_urls": {
        "Homepage": "https://github.com/michaelkrog/blaubergvento-python"
    },
    "split_keywords": [
        "blauberg",
        " duka",
        " ventilator"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "7fb81e6d573f47d96b9030b26d1e95dd2b5eba7b6d752cdb520ee7da1561037c",
                "md5": "918eb9381b75002672b8bbfd237c5999",
                "sha256": "25588e33b160a16ea50f8cc5a2bb83f58ead781c2703cfb08991ebc81b2037c5"
            },
            "downloads": -1,
            "filename": "blaubergvento_client-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "918eb9381b75002672b8bbfd237c5999",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 4150,
            "upload_time": "2025-07-26T10:47:23",
            "upload_time_iso_8601": "2025-07-26T10:47:23.677995Z",
            "url": "https://files.pythonhosted.org/packages/7f/b8/1e6d573f47d96b9030b26d1e95dd2b5eba7b6d752cdb520ee7da1561037c/blaubergvento_client-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "e87efeaeb89cfdcead6b8b313e1d05f9dadb99b89d74d9796756e3b7dd20fa36",
                "md5": "76549bafe33f41202c850e67343bd243",
                "sha256": "889d54e27fe09ed56279715550f4264a0170d937a1fd963a6115346067f42af9"
            },
            "downloads": -1,
            "filename": "blaubergvento_client-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "76549bafe33f41202c850e67343bd243",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 3675,
            "upload_time": "2025-07-26T10:47:24",
            "upload_time_iso_8601": "2025-07-26T10:47:24.737518Z",
            "url": "https://files.pythonhosted.org/packages/e8/7e/feaeb89cfdcead6b8b313e1d05f9dadb99b89d74d9796756e3b7dd20fa36/blaubergvento_client-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-26 10:47:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "michaelkrog",
    "github_project": "blaubergvento-python",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "blaubergvento-client"
}
        
Elapsed time: 0.80241s