https://github.com/marcaurele/gce-ipx800
Python library to interact with the GCE Electronics IPX800 device
https://github.com/marcaurele/gce-ipx800
gce-electronics home-automation ipx800 python
Last synced: 2 months ago
JSON representation
Python library to interact with the GCE Electronics IPX800 device
- Host: GitHub
- URL: https://github.com/marcaurele/gce-ipx800
- Owner: marcaurele
- License: apache-2.0
- Created: 2019-11-14T17:33:54.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T03:11:42.000Z (8 months ago)
- Last Synced: 2024-11-01T08:33:37.778Z (8 months ago)
- Topics: gce-electronics, home-automation, ipx800, python
- Language: Python
- Size: 253 KB
- Stars: 3
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
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.9+ 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