https://github.com/home-assistant-ecosystem/python-connect-box

Interact with a Compal CH7465LG cable modem/router
https://github.com/home-assistant-ecosystem/python-connect-box

cable-modem ch7465lg compal connect-box home-assistant iot router smart-home upc

Last synced: 6 days ago
JSON representation

Interact with a Compal CH7465LG cable modem/router

• Host: GitHub
• URL: https://github.com/home-assistant-ecosystem/python-connect-box
• Owner: home-assistant-ecosystem
• License: mit
• Created: 2018-12-10T20:52:57.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-19T10:45:56.000Z (10 months ago)
• Last Synced: 2025-01-11T06:05:52.228Z (13 days ago)
• Topics: cable-modem, ch7465lg, compal, connect-box, home-assistant, iot, router, smart-home, upc
• Language: Python
• Homepage:
• Size: 95.7 KB
• Stars: 53
• Watchers: 7
• Forks: 17
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
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

    

    

       

          

             Ethernet 2

             192.168.0.160/24

             0

             2

             GW-B072BF27A983

             B0:72:BF:27:A9:83

             1

             00:00:34:53

    ...

``connect_box`` is handling the retrieval of the data and the parsing. The 

primary use case is the `Home Assistant `_

``upc_connect`` device tracker but one could use it in other projects as well.

Installation

------------

The module is available from the `Python Package Index `_.

.. 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 `_

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.