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/ee/c2/2b7b924e666662d57f29ce0723f33552e15994326cecb5d6cc74ae03ad42/gce_ipx800-0.6.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.6.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": "750ca496c215ba2353c4adc4296aaac86c0b241bf3c52621d5447a8b60297acd",
"md5": "554648f6a4f7569a9cfd73a99b346c17",
"sha256": "3dac837110e1800189ca3dcfe4a8b09383cc9497c7a8433508ff4e233206c302"
},
"downloads": -1,
"filename": "gce_ipx800-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "554648f6a4f7569a9cfd73a99b346c17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 8090,
"upload_time": "2024-04-14T07:05:37",
"upload_time_iso_8601": "2024-04-14T07:05:37.914088Z",
"url": "https://files.pythonhosted.org/packages/75/0c/a496c215ba2353c4adc4296aaac86c0b241bf3c52621d5447a8b60297acd/gce_ipx800-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "eec22b7b924e666662d57f29ce0723f33552e15994326cecb5d6cc74ae03ad42",
"md5": "129c0d4c3744a697e7648159e26e8658",
"sha256": "3cfc4ba142e359027b5a9d90d8dcaef221ce69d3466ead71aea834d5bb9fe31b"
},
"downloads": -1,
"filename": "gce_ipx800-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "129c0d4c3744a697e7648159e26e8658",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 7616,
"upload_time": "2024-04-14T07:05:39",
"upload_time_iso_8601": "2024-04-14T07:05:39.493044Z",
"url": "https://files.pythonhosted.org/packages/ee/c2/2b7b924e666662d57f29ce0723f33552e15994326cecb5d6cc74ae03ad42/gce_ipx800-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 07:05:39",
"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
