Compal-Wifi-Switch
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/compal-wifi-switch.svg)
![License](https://img.shields.io/github/license/frimtec/compal-wifi-switch.svg)
![Deploy Status](https://github.com/frimtec/compal-wifi-switch/workflows/Deploy%20release/badge.svg)
A command line tool to switch on/off the wifi signal of a Compal-CH7465LG cablemodem.
![Compal-CH7465LG cablemodem back](images/compal_modem_back.png)
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 use the custom component hass-compal-wifi.
This module is not official developed, supported or endorsed by Compal.
Installation
Using pip
- Install python3.7 or higher
- Install compal-wifi-switch with
pip install compal-wifi-switch
. - Run compal-wifi-switch with
compal-wifi-switch --help
.
Without pip (e.g. on Synology DSM)
- Download package from PyPi (tar.gz) to your server.
- Run the following commands:
# Install
user@dsm:~> tar xfv compal-wifi-switch-<version>.tar.gz
user@dsm:~> cd compal-wifi-switch-<version>
user@dsm:~/compal-wifi-switch> python3 setup.py install --user
# Run
user@dsm:~> python3 ~/compal-wifi-switch-<version>/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 <YOUR_PW> --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 <YOUR_PW>
==============================================================
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 <YOUR_PW>
Credits