GCE-IPX800
==========
.. image:: https://img.shields.io/pypi/v/gce-ipx800?color=blue
:alt: Pypi version
:target: https://pypi.org/project/gce-ipx800/
.. image:: https://github.com/marcaurele/gce-ipx800/workflows/Build%20status/badge.svg
:alt: Build Status
:target: https://github.com/marcaurele/gce-ipx800/actions
.. image:: https://codecov.io/gh/marcaurele/gce-ipx800/branch/main/graph/badge.svg
:alt: Code coverage
:target: https://codecov.io/gh/marcaurele/gce-ipx800
.. image:: https://img.shields.io/pypi/l/gce-ipx800.svg
:alt: License
:target: https://pypi.org/project/gce-ipx800/
.. image:: https://img.shields.io/pypi/pyversions/gce-ipx800.svg
:alt: Python versions
:target: https://pypi.org/project/gce-ipx800/
A python library to control a GCE-Electronics IPX800 V4 device through its API.
* Python 3.8+ support
* Apache License
IPX800 features implemented
---------------------------
* Analog sensors (``ipx.analogs[]``)
* Control:
- relays (``ipx.relays[]``)
- virtual inputs (``ipx.virtual_inputs[]``)
- virtual outputs (``ipx.virtual_outputs[]``)
* Counters (``ipx.counters[]``)
Installation
------------
.. code-block:: console
> pip install gce-ipx800
Usage
-----
.. note:: The default API key of the device is `apikey`.
.. code-block:: python
from ipx800 import ipx800
ipx = ipx800("http://your-device-ip", "apikey")
r4 = ipx.relays[3]
r4.status # => return a Boolean
r4.on()
r4.off()
r4.toggle()
len(ipx.relays) # => 56
Links
-----
* GCE IPX800 V4 API: https://gce.ovh/wiki/index.php?title=API_V4
Licence
-------
Licensed under Apache License Version 2.0
Raw data
{
"_id": null,
"home_page": "https://github.com/marcaurele/gce-ipx800",
"name": "gce-ipx800",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "ipx800, GCE-Electronics, GCE, home-automation",
"author": "Marc-Aur\u00e8le Brothier",
"author_email": "m@brothier.org",
"download_url": "https://files.pythonhosted.org/packages/a8/6a/84b7adc19a13e1ac396d3c4a317b202fdfb90425cd2d759a7b5d9397cb59/gce_ipx800-0.7.0.tar.gz",
"platform": null,
"description": "GCE-IPX800\n==========\n\n.. image:: https://img.shields.io/pypi/v/gce-ipx800?color=blue\n :alt: Pypi version\n :target: https://pypi.org/project/gce-ipx800/\n\n.. image:: https://github.com/marcaurele/gce-ipx800/workflows/Build%20status/badge.svg\n :alt: Build Status\n :target: https://github.com/marcaurele/gce-ipx800/actions\n\n.. image:: https://codecov.io/gh/marcaurele/gce-ipx800/branch/main/graph/badge.svg\n :alt: Code coverage\n :target: https://codecov.io/gh/marcaurele/gce-ipx800\n\n.. image:: https://img.shields.io/pypi/l/gce-ipx800.svg\n :alt: License\n :target: https://pypi.org/project/gce-ipx800/\n\n.. image:: https://img.shields.io/pypi/pyversions/gce-ipx800.svg\n :alt: Python versions\n :target: https://pypi.org/project/gce-ipx800/\n\nA python library to control a GCE-Electronics IPX800 V4 device through its API.\n\n* Python 3.8+ support\n* Apache License\n\nIPX800 features implemented\n---------------------------\n\n* Analog sensors (``ipx.analogs[]``)\n* Control:\n\n - relays (``ipx.relays[]``)\n - virtual inputs (``ipx.virtual_inputs[]``)\n - virtual outputs (``ipx.virtual_outputs[]``)\n\n* Counters (``ipx.counters[]``)\n\nInstallation\n------------\n\n.. code-block:: console\n\n > pip install gce-ipx800\n\nUsage\n-----\n\n.. note:: The default API key of the device is `apikey`.\n\n.. code-block:: python\n\n from ipx800 import ipx800\n\n ipx = ipx800(\"http://your-device-ip\", \"apikey\")\n\n r4 = ipx.relays[3]\n\n r4.status # => return a Boolean\n\n r4.on()\n\n r4.off()\n\n r4.toggle()\n\n len(ipx.relays) # => 56\n\nLinks\n-----\n\n* GCE IPX800 V4 API: https://gce.ovh/wiki/index.php?title=API_V4\n\nLicence\n-------\n\nLicensed under Apache License Version 2.0\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Library to interact with the GCE Electronics IPX800 device",
"version": "0.7.0",
"project_urls": {
"Bug Tracker": "https://github.com/marcaurele/gce-ipx800/issues",
"Homepage": "https://github.com/marcaurele/gce-ipx800",
"Repository": "https://github.com/marcaurele/gce-ipx800"
},
"split_keywords": [
"ipx800",
" gce-electronics",
" gce",
" home-automation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0026c65ecf21a448ad5f3005bfee7213565aa9d51812098732f996efa6ddfd7f",
"md5": "45235aaa2fb052990cf29545861adfc0",
"sha256": "57904d1e2de6c7682d193e4f67e6e55df42f55d040c2f448eff3535177fd74d3"
},
"downloads": -1,
"filename": "gce_ipx800-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "45235aaa2fb052990cf29545861adfc0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8094,
"upload_time": "2024-12-08T15:07:27",
"upload_time_iso_8601": "2024-12-08T15:07:27.116296Z",
"url": "https://files.pythonhosted.org/packages/00/26/c65ecf21a448ad5f3005bfee7213565aa9d51812098732f996efa6ddfd7f/gce_ipx800-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a86a84b7adc19a13e1ac396d3c4a317b202fdfb90425cd2d759a7b5d9397cb59",
"md5": "75561830567c49dc9a0729f1bf7efcf4",
"sha256": "1f1bf0fca54e8e346e3ffefacbf266a81badca240996924568cf4909ae990995"
},
"downloads": -1,
"filename": "gce_ipx800-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "75561830567c49dc9a0729f1bf7efcf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 7613,
"upload_time": "2024-12-08T15:07:28",
"upload_time_iso_8601": "2024-12-08T15:07:28.668342Z",
"url": "https://files.pythonhosted.org/packages/a8/6a/84b7adc19a13e1ac396d3c4a317b202fdfb90425cd2d759a7b5d9397cb59/gce_ipx800-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-08 15:07:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "marcaurele",
"github_project": "gce-ipx800",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "gce-ipx800"
}
JSON
