Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frimtec/compal-wifi-switch
:satellite: CLI tool to switch on/off the wifi signal of a Compal-CH7465LG cablemodem.
https://github.com/frimtec/compal-wifi-switch
ch7465lg compal-wifi-switch switch upc wifi-signal wlan ziggo
Last synced: 5 days ago
JSON representation
:satellite: CLI tool to switch on/off the wifi signal of a Compal-CH7465LG cablemodem.
- Host: GitHub
- URL: https://github.com/frimtec/compal-wifi-switch
- Owner: frimtec
- License: apache-2.0
- Created: 2020-11-27T08:11:48.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-12T10:36:53.000Z (5 months ago)
- Last Synced: 2024-12-16T22:42:57.132Z (18 days ago)
- Topics: ch7465lg, compal-wifi-switch, switch, upc, wifi-signal, wlan, ziggo
- Language: Python
- Homepage:
- Size: 275 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Compal-Wifi-Switch
[![PyPI][pypi-shield]][pypi]
[![PyPI - Python Version][pypi-python-version-shield]][pypi]
![Project Maintenance][maintenance-shield]
[![License][license-shield]][license]
[![Build Status][build-status-shield]][build-status]
[![Deploy Status][deploy-status-shield]][deploy-status]
---
**_Contributions Only:_**
_I no longer have a Compal modem and can therefore not actively work on this project anymore.
So all future development will be from pull requests submitted by the community.
What I will do:_
* _review pull requests_
* _publish new releases upon request_
---
A command line tool to switch on/off the wifi signal of a Compal-CH7465LG cablemodem.
Wifi radiation should be turned off if not used (better for your health and for IT security reasons).
Unfortunattly the Compal-CH7465LG cablemodem does not offer a physical button to switch on/off the wifi signal.
There is also no configuration available to switch the wifi signal on/off based on a time schedule.
The compal-wifi-switch tool can switch the wifi signal on/off via a command line interface.
The tool can be installed on any device where Python3 runtime is available (NAS, Raspberry Pi, etc.).
To schedule compal-wifi-switch you can use any scheduling mechanism (e.g. cron, Synology task scheduler, ...).
For the use within [Home Assistant][home-assistant] use the custom component [hass-compal-wifi][hass-compal-wifi].
This module is not official developed, supported or endorsed by Compal.
## Installation
### Using pip
1. Install python3.7 or higher
1. Install compal-wifi-switch with ```pip install compal-wifi-switch```.
1. Run compal-wifi-switch with ```compal-wifi-switch --help```.
### Without pip (e.g. on Synology DSM)
1. Download package from [PyPi][pypi-files] (tar.gz) to your server.
1. Run the following commands:
```
# Install
user@dsm:~> tar xfv compal-wifi-switch-.tar.gz
user@dsm:~> cd compal-wifi-switch-
user@dsm:~/compal-wifi-switch> python3 setup.py install --user
# Run
user@dsm:~> python3 ~/compal-wifi-switch-/compal_wifi_switch/main.py --help
```
## Usage
### General syntax
```
usage: compal-wifi-switch [-h] [--version] {status,switch,reboot} ...
Compal-Wifi-Switch configuration
optional arguments:
-h, --help show this help message and exit
--version, -v show program's version number and exit
command:
{status,switch}
status shows the current status of the cablemodem
switch switches the wifi state of the cabelmodem
reboot reboots the cabelmodem
```
### Command switch
#### Usage
```
usage: compal-wifi-switch switch [-h] [--band {2g,5g,all}] [--guest]
[--pause PAUSE] [--host HOST] [--password PASSWORD]
[--verbose]
{on,off}
positional arguments:
switch
{on,off}
optional arguments:
-h, --help show this help message and exit
--band {2g,5g,all}, -b {2g,5g,all}
band to switch power state for (default = all)
--guest, -g activate guest network while switching ON wifi
--pause PAUSE, -p PAUSE
number of seconds to pause after wifi state change
(default = 60); when the pause is too short, the
following modem commands may block forever
--host HOST host name or IP of compal cablemodem, or use env
variable COMPAL_WIFI_SWITCH_HOST
--password PASSWORD password of compal cablemodem, or use env variable
COMPAL_WIFI_SWITCH_PASSWORD
--verbose verbose logging
```
#### Example
To enable the wifi signal for the 2GHz band including the activation of the guest network, use the following command:
```
> compal-wifi-switch switch on --host 192.168.0.1 --password --band 2g --guest
Switching wifi ON (band = 2g)
Wait 60s till wifi state is changed ...
Finished.
```
### Command status
#### Usage
```
usage: main.py status [-h] [--format {json,text}] [--host HOST]
[--password PASSWORD] [--verbose]
positional arguments:
status
optional arguments:
-h, --help show this help message and exit
--format {json,text}, -f {json,text}
output format
--host HOST host name or IP of compal cablemodem, or use env
variable COMPAL_WIFI_SWITCH_HOST
--password PASSWORD password of compal cablemodem, or use env variable
COMPAL_WIFI_SWITCH_PASSWORD
--verbose verbose logging
```
#### Example
To show the status of the wifi signal, use the following command:
```
> compal-wifi-switch status --host 192.168.0.1 --password
==============================================================
Modem
==============================================================
Model : CH7465LG
HW Version : 5.01
SW Version : CH7465LG-NCIP-6.15.31p1-NOSH
Serial Number : ************
Modem MAC Address : **:**:**:**:**:**
Operator ID : LIBERTYGLOBAL
Network Mode : IPv4
Uptime : 50day(s)0h:12m:28s
==============================================================
WIFI BANDS
==============================================================
State Band Hidden SSID
----- ---- ------ ----------------
ON 2g OFF FRIMTEC
OFF 5g OFF FRIMTEC
==============================================================
WIFI GUEST NETWORKS
==============================================================
State Band MAC Hidden SSID
----- ---- ----------------- ------ ----------------
ON 2g 92:5C:34:DD:6F:0A OFF FRIMTEC-GUEST
OFF 5g 92:5C:44:DD:6D:CA OFF FRIMTEC-GUEST
```
### Command reboot
#### Usage
```
usage: compal-wifi-switch reboot [-h] [--host HOST] [--password PASSWORD] [--verbose]
positional arguments:
reboot
optional arguments:
-h, --help show this help message and exit
--host HOST host name or IP of compal cablemodem, or use env
variable COMPAL_WIFI_SWITCH_HOST
--password PASSWORD password of compal cablemodem, or use env variable
COMPAL_WIFI_SWITCH_PASSWORD
--verbose verbose logging
```
#### Example
To reboot the cabelmodem, use the following command:
```
> compal-wifi-switch reboot --host 192.168.0.1 --password
```
## Credits
* Using [compal_CH7465LG_py][compal-CH7465LG-py] by [ties][github-ties] to communicate with Compal cablemodem.
[maintenance-shield]: https://img.shields.io/maintenance/no/2023.svg
[license-shield]: https://img.shields.io/github/license/frimtec/compal-wifi-switch.svg
[license]: https://opensource.org/licenses/Apache-2.0
[pypi-shield]: https://img.shields.io/pypi/v/compal-wifi-switch.svg
[pypi-python-version-shield]: https://img.shields.io/pypi/pyversions/compal-wifi-switch.svg
[pypi]: https://pypi.org/project/compal-wifi-switch/
[pypi-files]: https://pypi.org/project/compal-wifi-switch/#files
[build-status-shield]: https://github.com/frimtec/compal-wifi-switch/workflows/Build/badge.svg
[build-status]: https://github.com/frimtec/compal-wifi-switch/actions?query=workflow%3ABuild
[deploy-status-shield]: https://github.com/frimtec/compal-wifi-switch/workflows/Deploy%20release/badge.svg
[deploy-status]: https://github.com/frimtec/compal-wifi-switch/actions?query=workflow%3A%22Deploy+release%22
[home-assistant]: https://www.home-assistant.io/
[hass-compal-wifi]: https://github.com/frimtec/hass-compal-wifi
[compal-CH7465LG-py]: https://github.com/ties/compal_CH7465LG_py
[github-ties]: https://github.com/ties/