Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.11 KB

README.rst

File metadata and controls

81 lines (55 loc) · 2.11 KB
Raw

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.

<?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 upc_connect device tracker but one could use it in other projects as well.

Installation

The module is available from the Python Package Index.

$ pip3 install connect_box

On a Fedora-based system or on a CentOS/RHEL 8 machine which has EPEL enabled.

$ 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.

$ 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.

$ python -m venv .
$ source bin/activate
$ python setup.py develop

License

connect_box is licensed under MIT, for more details check LICENSE.