python-omnilogic-local


Namepython-omnilogic-local JSON
Version 0.14.2 PyPI version JSON
download
home_pagehttps://github.com/cryptk/python-omnilogic-local
SummaryA library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API
upload_time2024-06-11 18:30:57
maintainerNone
docs_urlNone
authorcryptk
requires_python<4.0,>=3.10
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # Pyomnilogic Local

<p align="center">
  <a href="https://pypi.org/project/python-omnilogic-local/">
    <img src="https://img.shields.io/pypi/v/python-omnilogic-local.svg?logo=python&logoColor=fff&style=flat-square" alt="PyPI Version">
  </a>
  <img src="https://img.shields.io/pypi/pyversions/python-omnilogic-local.svg?style=flat-square&logo=python&amp;logoColor=fff" alt="Supported Python versions">
  <img src="https://img.shields.io/pypi/l/python-omnilogic-local.svg?style=flat-square" alt="License">
  <a href="https://www.buymeacoffee.com/cryptk" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 20px !important;" ></a>
</p>

A library implementing the UDP XML Local Control api for Hayward OmniLogic and OmniHub pool controllers

## Installation

This package is published to pypi at https://pypi.org/project/python-omnilogic-local/:

`pip install python-omnilogic-local`

## Functionality

This library is still under development and is not yet able to control every function of a Hayward pool controller.  The implemented functionality is:

- Pulling the MSP Config
- Polling telemetry
- Polling a list of active alarms
- Polling filter/pump diagnostic information
- Polling the logging configuration
- Setting pool heater temperature
- Turning pool heaters on/off
- Turning other pool equipment on/off, including countdown timers
- Setting filter/pump speed
- Controlling ColorLogic lights including brightness, speed, and selected shows, with support for countdown timers

If your controller has functionality outside of this list, please do not hesitate to [Open an Issue](https://github.com/cryptk/python-omnilogic-local/issues)

## Credits

The work on this library would not have been possible without the efforts of [djtimca](https://github.com/djtimca/) and [John Sutherland](garionphx@gmail.com)

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/cryptk/python-omnilogic-local",
    "name": "python-omnilogic-local",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": "cryptk",
    "author_email": "cryptk@users.noreply.github.com",
    "download_url": "https://files.pythonhosted.org/packages/4f/f1/7a89aaa865f989220421b4d9aaf3f5be4017b068c29bcaca075b6cbda13c/python_omnilogic_local-0.14.2.tar.gz",
    "platform": null,
    "description": "# Pyomnilogic Local\n\n<p align=\"center\">\n  <a href=\"https://pypi.org/project/python-omnilogic-local/\">\n    <img src=\"https://img.shields.io/pypi/v/python-omnilogic-local.svg?logo=python&logoColor=fff&style=flat-square\" alt=\"PyPI Version\">\n  </a>\n  <img src=\"https://img.shields.io/pypi/pyversions/python-omnilogic-local.svg?style=flat-square&logo=python&amp;logoColor=fff\" alt=\"Supported Python versions\">\n  <img src=\"https://img.shields.io/pypi/l/python-omnilogic-local.svg?style=flat-square\" alt=\"License\">\n  <a href=\"https://www.buymeacoffee.com/cryptk\" target=\"_blank\"><img src=\"https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png\" alt=\"Buy Me A Coffee\" style=\"height: 20px !important;\" ></a>\n</p>\n\nA library implementing the UDP XML Local Control api for Hayward OmniLogic and OmniHub pool controllers\n\n## Installation\n\nThis package is published to pypi at https://pypi.org/project/python-omnilogic-local/:\n\n`pip install python-omnilogic-local`\n\n## Functionality\n\nThis library is still under development and is not yet able to control every function of a Hayward pool controller.  The implemented functionality is:\n\n- Pulling the MSP Config\n- Polling telemetry\n- Polling a list of active alarms\n- Polling filter/pump diagnostic information\n- Polling the logging configuration\n- Setting pool heater temperature\n- Turning pool heaters on/off\n- Turning other pool equipment on/off, including countdown timers\n- Setting filter/pump speed\n- Controlling ColorLogic lights including brightness, speed, and selected shows, with support for countdown timers\n\nIf your controller has functionality outside of this list, please do not hesitate to [Open an Issue](https://github.com/cryptk/python-omnilogic-local/issues)\n\n## Credits\n\nThe work on this library would not have been possible without the efforts of [djtimca](https://github.com/djtimca/) and [John Sutherland](garionphx@gmail.com)\n\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "A library for local control of Hayward OmniHub/OmniLogic pool controllers using their local API",
    "version": "0.14.2",
    "project_urls": {
        "Homepage": "https://github.com/cryptk/python-omnilogic-local",
        "Repository": "https://github.com/cryptk/python-omnilogic-local"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b12e5cbe8f16963be89a03b5108162e5b3a5ac212a72effc508e31163a373abc",
                "md5": "a0c36d5fadf96fdb4087d606c57f0479",
                "sha256": "febf42ad4247523df610090d64dae36d9d80337c88fa572c13b91960bd8f8294"
            },
            "downloads": -1,
            "filename": "python_omnilogic_local-0.14.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a0c36d5fadf96fdb4087d606c57f0479",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 27029,
            "upload_time": "2024-06-11T18:30:55",
            "upload_time_iso_8601": "2024-06-11T18:30:55.750073Z",
            "url": "https://files.pythonhosted.org/packages/b1/2e/5cbe8f16963be89a03b5108162e5b3a5ac212a72effc508e31163a373abc/python_omnilogic_local-0.14.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4ff17a89aaa865f989220421b4d9aaf3f5be4017b068c29bcaca075b6cbda13c",
                "md5": "65b06d6d6a362635b7baf4ff6d9fd684",
                "sha256": "4188c284019896da11f58a8eeac27163cda7dc0cccee32aaca8d3067521fc1f2"
            },
            "downloads": -1,
            "filename": "python_omnilogic_local-0.14.2.tar.gz",
            "has_sig": false,
            "md5_digest": "65b06d6d6a362635b7baf4ff6d9fd684",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 24325,
            "upload_time": "2024-06-11T18:30:57",
            "upload_time_iso_8601": "2024-06-11T18:30:57.364518Z",
            "url": "https://files.pythonhosted.org/packages/4f/f1/7a89aaa865f989220421b4d9aaf3f5be4017b068c29bcaca075b6cbda13c/python_omnilogic_local-0.14.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-11 18:30:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "cryptk",
    "github_project": "python-omnilogic-local",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "python-omnilogic-local"
}
cryptk
Elapsed time: 0.39359s