python-connect-box
==================
Python Client for interacting with the cable modem/router Compal CH7465LG which
is provided under different names by various ISP in Europe.
- UPC Connect Box (CH)
- Play Connect Box (PL)
- Irish Virgin Media Super Hub 3.0 (IE)
- Ziggo Connectbox (NL)
- Unitymedia Connect Box (DE)
This module is not official, developed, supported or endorsed by UPC,
Unitymedia or Compal.
There is an interface with is providing details about various states like the
DHCP lease table for Ethernet and Wifi.
.. code:: xml
<?xml version="1.0" encoding="UTF-8"?>
<LanUserTable>
<Ethernet>
<clientinfo>
<interface>Ethernet 2</interface>
<IPv4Addr>192.168.0.160/24</IPv4Addr>
<index>0</index>
<interfaceid>2</interfaceid>
<hostname>GW-B072BF27A983</hostname>
<MACAddr>B0:72:BF:27:A9:83</MACAddr>
<method>1</method>
<leaseTime>00:00:34:53</leaseTime>
...
``connect_box`` is handling the retrieval of the data and the parsing. The
primary use case is the `Home Assistant <https://home-assistant.io>`_
``upc_connect`` device tracker but one could use it in other projects as well.
Installation
------------
The module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.
.. code:: bash
$ pip3 install connect_box
On a Fedora-based system or on a CentOS/RHEL 8 machine which has EPEL enabled.
.. code:: bash
$ sudo dnf -y install python3-connect-box
For Nix or NixOS is `pre-packed module <https://search.nixos.org/packages?channel=unstable&query=connect-box>`_
available. The lastest release is usually present in the ``unstable`` channel.
.. code:: bash
$ nix-env -iA nixos.python3Packages.connect-box
Usage
-----
The file ``example.py`` contains an example about how to use this module.
Development
-----------
For development is recommended to use a ``venv``.
.. code:: bash
$ python -m venv .
$ source bin/activate
$ python setup.py develop
License
-------
``connect_box`` is licensed under MIT, for more details check LICENSE.
Raw data
{
"_id": null,
"home_page": "https://github.com/home-assistant-ecosystem/python-connect-box",
"name": "connect-box",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Fabian Affolter",
"author_email": "fabian@affolter-engineering.ch",
"download_url": "https://files.pythonhosted.org/packages/e2/4d/cc66743d0e22435623e8603449c5d6cc0e29e9632a3cb5a64a0486668a6c/connect_box-0.3.1.tar.gz",
"platform": null,
"description": "python-connect-box\n==================\n\nPython Client for interacting with the cable modem/router Compal CH7465LG which\nis provided under different names by various ISP in Europe.\n\n- UPC Connect Box (CH)\n- Play Connect Box (PL)\n- Irish Virgin Media Super Hub 3.0 (IE)\n- Ziggo Connectbox (NL)\n- Unitymedia Connect Box (DE)\n\nThis module is not official, developed, supported or endorsed by UPC, \nUnitymedia or Compal.\n\nThere is an interface with is providing details about various states like the\nDHCP lease table for Ethernet and Wifi.\n\n.. code:: xml\n\n <?xml version=\"1.0\" encoding=\"UTF-8\"?>\n <LanUserTable>\n <Ethernet>\n <clientinfo>\n <interface>Ethernet 2</interface>\n <IPv4Addr>192.168.0.160/24</IPv4Addr>\n <index>0</index>\n <interfaceid>2</interfaceid>\n <hostname>GW-B072BF27A983</hostname>\n <MACAddr>B0:72:BF:27:A9:83</MACAddr>\n <method>1</method>\n <leaseTime>00:00:34:53</leaseTime>\n ...\n\n``connect_box`` is handling the retrieval of the data and the parsing. The \nprimary use case is the `Home Assistant <https://home-assistant.io>`_\n``upc_connect`` device tracker but one could use it in other projects as well.\n\nInstallation\n------------\n\nThe module is available from the `Python Package Index <https://pypi.python.org/pypi>`_.\n\n.. code:: bash\n\n $ pip3 install connect_box\n\nOn a Fedora-based system or on a CentOS/RHEL 8 machine which has EPEL enabled.\n\n.. code:: bash\n\n $ sudo dnf -y install python3-connect-box\n\nFor Nix or NixOS is `pre-packed module <https://search.nixos.org/packages?channel=unstable&query=connect-box>`_\navailable. The lastest release is usually present in the ``unstable`` channel.\n\n.. code:: bash\n\n $ nix-env -iA nixos.python3Packages.connect-box\n\n\nUsage\n-----\n\nThe file ``example.py`` contains an example about how to use this module.\n\nDevelopment\n-----------\n\nFor development is recommended to use a ``venv``.\n\n.. code:: bash\n\n $ python -m venv .\n $ source bin/activate\n $ python setup.py develop\n\nLicense\n-------\n\n``connect_box`` is licensed under MIT, for more details check LICENSE.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python client for interacting with Compal CH7465LG devices.",
"version": "0.3.1",
"project_urls": {
"Download": "https://github.com/home-assistant-ecosystem/python-connect-box/releases",
"Homepage": "https://github.com/home-assistant-ecosystem/python-connect-box"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e24dcc66743d0e22435623e8603449c5d6cc0e29e9632a3cb5a64a0486668a6c",
"md5": "8e86a41b6c0e7164da70710d1f2f2044",
"sha256": "c75a33723dc82fe888fd0b52d76c84b9d0aa3649c29b26f97b0f3c677f7168b0"
},
"downloads": -1,
"filename": "connect_box-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "8e86a41b6c0e7164da70710d1f2f2044",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11265,
"upload_time": "2024-01-09T09:17:49",
"upload_time_iso_8601": "2024-01-09T09:17:49.801798Z",
"url": "https://files.pythonhosted.org/packages/e2/4d/cc66743d0e22435623e8603449c5d6cc0e29e9632a3cb5a64a0486668a6c/connect_box-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 09:17:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "home-assistant-ecosystem",
"github_project": "python-connect-box",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "connect-box"
}
JSON
