Fetch Huawei ONT (Optical Network Terminator, i.e. GPON "media converter" to Ethernet) statistics using telnet and sends the data to a MQTT broker. I've created this script to integrate my Huawei HG8010H (ISP provided) into HomeAssistant through MQTT. HomeAssistant presents the data using an MQTT sensor for each value. The script can run anywhere, as long as the ONT management interface and the MQTT are reachable. I've crontab'ed it to run every 10 minutes.
- Connects to Huawei ONT using telnet
- Sends several commands to get wanted values (
cmds[]array) - Disconnects telnet session
- Connects to MQTT broker
- Filters wanted values (
fields[]array) - Disconnects from MQTT broker
Script produces the following terminal output. It may vary depending on the parameters monitored.
user@host:~ $ ./ont.py
Connection establised
LinkStatus ok
Voltage 3317
Temperature 53
RxPower -19.07
TxPower 2.10
CpuUsed 5
MemUsed 67
user@host:~ $
The statistics are sent to the MQTT broker.
- MQTT broker (not covered here)
- ONT configuration
- IP access to ONT management interface (not covered here, see note1 below)
- Enable telnet remote access
- Python3 environnment requirement
- HomeAssistant Sensor
ONT Admin credentials. Defaults are root/admin or telecomadmin/admintelecom.
user='root'
password='admin'
ONT management IP address. The default is 192.168.100.1 but it may vary depending on the ISP.
host='<your_ont_management_ip>'
MQTT configuration.
mqttBroker='<your_mqtt_broker>'
mqttUser='<your_mqtt_broker_user>'
mqttPassword='<your_mqtt_broker_password>'
mqttTopic='<your_mqtt_topic>'
Commands to use do get required values. There are more commands available using the ? command. The last command I use is quit to close properly the telnet session as the ONT only accepts one telnet session. There are more commands like display pon statistics to use along with clear pon statisctics to show more info on the GPON transport layer.
cmds=["display optic","display sysinfo","quit"]
Fields to look for displayed by the commands before. The following list is the one I used, but there are more values available. Fields containing spaces should replace these with -. Ex: Bip err should be listed as Bip-err in the fields[] array.
fields=["LinkStatus","Voltage","Temperature","RxPower","TxPower","CpuUsed","MemUsed"]
There are other statistics of interest. However the script splits the line into elements, element 0 being the field name and 2 the value. For names with multiple words, the script should be modified.
WAP>display optic
LinkStatus : ok
Voltage : 3317 (mV)
Bias : 7 (mA)
Temperature : 53 (C)
RxPower : -19.07 (dBm)
TxPower : 2.16 (dBm)
RfRxPower : -- (dBm)
RfOutputPower: -- (dBmV)
VendorName : HUAWEI
VendorSN : xxx
VendorRev :
VendorPN : xxx
DateCode : xxx
success!
WAP>display sysinfo
*************** system infomation ***************
CpuUsed = 4 Percent(s)
MemUsed = 70 Percent(s)
CurTime = 2023-xx-xx xx:xx:xx
*************************************************
success!
WAP>display pon statistics
GPON statistic as follow:
Rx unicast packets : 15450712
Tx unicast packets : 4902623
Rx broadcast packets : 0
Tx broadcast packets : 135
Rx multicast packets : 488687744
Tx multicast packets : 0
Dropped packets : 0
Tx ploam : 88605
Tx omci : 20499
Tx gem : 19992371
Bip err : 0
Rx ploam right : 233109
Rx ploam wrong : 0
Rx ploam drop : 0
Rx omci : 20236
Rx gem : 504158692
Rx mc gem : 488687744
Ds key switch : 0
Rx omci overflow : 0
Tx octets : 2222947148
Tx packets : 4902758
Rx oversize : 5757080
Rx octets : 2079797555
Rx packets : 504138456
Rx undersize : 0
Rx 64 octets : 354816
Rx 65 to 127 octets : 1097083
Rx 128 to 255 octets : 410591
Rx 256 to 511 octets : 108356
Rx 512 to 1023 octets : 145463
Rx 1024 to 1518 octets: 496265067
success!
The goal is to enable telnet for remote access. Open the admin interface using http://192.168.100.1 or the IP matching the ISP configuration. Use ONT credentials.
Save the configuration file. Remote management can only be enabled using the configuration file hw_ctree.xml.
Edit hw_ctree.xml as follows. There are two lines to change to enable telnet.
before
<X_HW_CLITelnetAccess Access="0" EquipAdminAccess="0" TelnetPort="23"/>
<AclServices HTTPLanEnable="1" HTTPWanEnable="0" FTPLanEnable="0" FTPWanEnable="0" TELNETLanEnable="0" TELNETWanEnable="0" SSHLanEnable="0" SSHWanEnable="0" HTTPPORT="80" FTPPORT="21" TELNETPORT="23" SSHPORT="22"/>
after
<X_HW_CLITelnetAccess Access="1" EquipAdminAccess="1" TelnetPort="23"/>
<AclServices HTTPLanEnable="1" HTTPWanEnable="0" FTPLanEnable="0" FTPWanEnable="0" TELNETLanEnable="1" TELNETWanEnable="0" SSHLanEnable="0" SSHWanEnable="0" HTTPPORT="80" FTPPORT="21" TELNETPORT="23" SSHPORT="22"/>
Upload the saved configuration file to the ONT.
Login using telnet on port 23.
There are several commands for statistics available. Use command ? to display all commands. display pon statistics may also be of interest. Each statistics item has a name, the same name is used for statistics filtering in the fields[] in the script.
ONT is now configured.
The script relies on pexpect, paho-mqtt. They can be installed using command:
pip3 install pexpect, paho-mqtt
As telnetlib is now deprecated, the script uses the system telnet client.
The following configuration.yaml mqtt section matches the default script cmds[] and fields[] configuration. The MQTT integration shall already be set up.
mqtt:
sensor:
- name: "ONT Linkstatus"
state_topic: "ont/LinkStatus"
- name: "ONT Voltage"
state_topic: "ont/Voltage"
device_class: voltage
unit_of_measurement: "mV"
- name: "ONT Temperature"
state_topic: "ont/Temperature"
device_class: temperature
unit_of_measurement: "C"
- name: "ONT RxPower"
state_topic: "ont/RxPower"
device_class: signal_strength
unit_of_measurement: "dBm"
- name: "ONT TxPower"
state_topic: "ont/TxPower"
device_class: signal_strength
unit_of_measurement: "dBm"
- name: "ONT CPU"
state_topic: "ont/CpuUsed"
unit_of_measurement: "%"
- name: "ONT Memory"
state_topic: "ont/MemUsed"
unit_of_measurement: "%"
Shown as a card.
Footnotes
-
IP access to ONT management is necessary. There are tutorials to do configure routing and interface configuration if necessary. In my own case, I do have the ONT and my own firewall, the ISP box is absent. My ISP requires a PPPoE session on the firewall WAN Ethernet interface. A VLAN interface (id depends on the ISP) attached to Ethernet interface with an IP in the same subnet as the ONT does the trick. ↩