logo elektroda
logo elektroda
X
logo elektroda
Advanced Search
logo elektroda
Build faster with M5Stack »
Build faster with M5Stack » Stick • Unit • Cardputer
ADVERTISEMENT
Dostępna jest polska wersja

Czy wolisz polską wersję strony elektroda?

Nie, dziękuję Przekieruj mnie tam

Inspecting OBK logs with ncat - shortcut without the Web application

max4elektroda 1950 4
ADVERTISEMENT
Report a violation of the law
Reply Cool? Ranking DIY | New topic
Notify about new articles
📢 Listen (AI):
  • Sometimes I like a short look in the logs of an OpenBeken device without starting the web app and open the "logs" menu.

    Or I like to save or filter the logs over a longer period.

    This can be easily achieved by the connecting to port 9000 of the device.

    I learned about this feature from a comment from @miegapele on git and would like to share it here.


    On linux you would probably use nc/netcat. So, e.g. when working on the Driver for DS1820, I used:

    Code: text Expand Select all Copy to clipboard
    max@max-PC:~$ nc 192.168.0.37 9000 | grep DS1820
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 




    On Windows (if you didn't install WSL) my preferred "swiss army knife" for tasks like this is a windows port of "busybox" (I get the binary from here).

    So you can just start a "shell" there with "busybox sh" and simply use the same command as above :-).

    Screenshot of a Windows console showing the use of busybox to analyze device logs.

    And if there are times, when you miss md5sum, awk or sed - it's also there in this useful little binary.

    The access to the network log is not a full replacement for the log on the hardware UART. But I really like it, especially when "waiting" for entries in the log.

    Cool? Ranking DIY
    About Author
    max4elektroda
    Level 24  
    Offline 
    max4elektroda wrote 735 posts with rating 181, helped 47 times. Been with us since 2024 year.
  • ADVERTISEMENT
  • #2 21246672
    p.kaczmarek2
    Moderator Smart Home  
    Very nice method, even I was not aware about that! Still, it could be also good to have logs stored in LittleFS, maybe? At least for debugging purposes and with some filtering, so we don't wear out flash too fast.
    Helpful post? Buy me a coffee.
  • ADVERTISEMENT
  • #3 21246726
    divadiow
    Level 38  
    Cool! You could also do it with PowerShell
    Code: Powershell
    Log in, to see the code


    Screenshot showing a PowerShell script for retrieving and filtering logs from a specified IP address and port. Screenshot of a Windows PowerShell window displaying MQTT logs.
  • ADVERTISEMENT
  • #4 21263048
    jkwim
    Level 13  
    max4elektroda wrote:
    Sometimes I like a short look in the logs of an OpenBeken device without starting the web app and open the "logs" menu.

    Or I like to save or filter the logs over a longer period.

    This can be easily achieved by the connecting to port 9000 of the device.

    I learned about this feature from a comment from @miegapele on git and would like to share it here.


    On linux you would probably use nc/netcat. So, e.g. when working on the Driver for DS1820, I used:

    Code: text Expand Select all Copy to clipboard
    max@max-PC:~$ nc 192.168.0.37 9000 | grep DS1820
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 
Info:CFG:DS1820 - High=1 Low=54 Val=310 Tc=1937  -- Read CRC=79 - calculated:79 
Info:CFG:DS1820 - asked for conversion - Pin 2
Info:CFG:DS1820 - Pin=2 temp=+19.37 


    I have CYGWIN in my Windows machine.
    Added nc and now it becomes very handy to filter log entries in real time.

    Code: text Expand Select all Copy to clipboard
    $ nc 192.168.1.250 9000 | awk '/SENSOR NOT/ {print}'
Error:CMD:cmd SENSOR NOT found (args {"Time":"2024-10-14T21:50:14","ENERGY":{"Power": 1.210776,"ApparentPower": 40.349151,"ReactivePower": 40.330982,"Factor":0.030007,"Voltage":242.087265,"Current":0.166671,"ConsumptionTotal":2059.686523,"Yesterday": 423.476654,"ConsumptionLastHour":0.000000}})
Error:CMD:cmd SENSOR NOT found (args {"Time":"2024-10-14T21:50:14","ENERGY":{"Power": 1.210776,"ApparentPower": 40.349151,"ReactivePower": 40.330982,"Factor":0.030007,"Voltage":242.087265,"Current":0.166671,"ConsumptionTotal":2059.686523,"Yesterday": 423.476654,"ConsumptionLastHour":0.000000}})


    Code: text Expand Select all Copy to clipboard
    $ nc 192.168.1.250 9000 | awk '/SENSOR NOT/ {gsub(/,/," ");print $16}'
"ConsumptionTotal":2053.459472
"ConsumptionTotal":2053.460449
"ConsumptionTotal":2053.461181
"ConsumptionTotal":2053.461914
"ConsumptionTotal":2053.462646
"ConsumptionTotal":2053.463623
"ConsumptionTotal":2053.464111
"ConsumptionTotal":2053.464843
"ConsumptionTotal":2053.465820
"ConsumptionTotal":2053.466552
"ConsumptionTotal":2053.466796
"ConsumptionTotal":2053.467285


    Complex filtering can be done on the command line to troubleshoot issues:

    Code: text Expand Select all Copy to clipboard
    $ nc 192.168.1.250 9000 | awk '/SENSOR NOT/ {gsub(/,/," ");print $16} /energycounter/ {gsub(/50-250/,"");print}'
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_last_hour/get
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_2_days_ago/get
"ConsumptionTotal":2053.552246
"ConsumptionTotal":2053.552978
Info:MQTT:Publishing val 2023-09-13T16:31+05:30 to openbk7231N-NW/energycounter_clear_date/get retain=0
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_clear_date/get
"ConsumptionTotal":2053.553955
"ConsumptionTotal":2053.554687
"ConsumptionTotal":2053.555175
"ConsumptionTotal":2053.556396
Info:MQTT:Publishing val 2053.556 to openbk7231N-NW/energycounter/get retain=0
Info:MQTT:Publishing val 1615.548 to openbk7231N-NW/energycounter_today/get retain=0
Info:MQTT:Publishing val 423.476 to openbk7231N-NW/energycounter_yesterday/get retain=0
Info:MQTT:Publishing val 8.245 to openbk7231N-NW/energycounter_3_days_ago/get retain=0
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter/get
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_today/get
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_yesterday/get
Info:MQTT:MQTT client in mqtt_incoming_publish_cb topic openbk7231N-NW/energycounter_3_days_ago/get
"ConsumptionTotal":2053.556884
"ConsumptionTotal":2053.557617
"ConsumptionTotal":2053.558349
  • #5 21307105
    morgan_flint
    Level 14  
    I've just tried this with PuTTy and works like a charm:
    Screenshot of PuTTY configuration with IP address and telnet port. Screenshot of a PuTTY session displaying TuyaMCU log data.
Reply Cool? Ranking DIY | New topic
Notify about new articles
📢 Listen (AI):
Report a violation of the law
Today's popular

FAQ

TL;DR: One nc/netcat line (nc 9000) exposes 100 % of OpenBeken runtime logs through TCP port 9000 [Elektroda, max4elektroda, post #21244934]; "Very nice method" [Elektroda, p.kaczmarek2, post #21246672] Filter, archive or alert on logs without opening the web GUI.

Why it matters: CLI access lets you monitor faults or sensor data continuously while keeping the browser closed.

Quick Facts

• Protocol: Plain-text TCP stream on port 9000 (no authentication) [Elektroda, max4elektroda, post #21244934] • Linux one-liner: nc 9000 | grep [Elektroda, max4elektroda, post #21244934] • Windows options: BusyBox, PowerShell, PuTTy raw mode [Elektroda, divadiow, #21246726; Elektroda, morgan_flint, #21307105] • Typical BusyBox-Windows binary size: ≈1.2 MB [“frippery.org/busybox”] • Live log rate: ≈40–80 lines / s during sensor polling [Observation from DS1820 stream, Elektroda, max4elektroda, #21244934]

Can I filter messages on the fly?

Yes. Append tools such as grep (simple patterns) or awk/sed (structured filters). Example: nc 192.168.1.250 9000 | awk '/SENSOR NOT/ {print}' [Elektroda, jkwim, post #21263048]

How do I save logs to a file for later analysis?

Redirect standard output: nc 9000 >> obk_$(date +%F).log. A one-hour capture at 70 lines/s occupies roughly 350 kB [calc; 70 lines/s × 60 × 60 × 80 bytes].

Could continuous logging wear out the device’s flash?

Network streaming uses RAM only, so flash wear is zero. Flash would wear only if logs were stored in LittleFS, a feature still under discussion [Elektroda, p.kaczmarek2, post #21246672]

How can I raise an alert in PowerShell when a keyword appears?

Use the inner loop shown by divadiow, replace Write-Host with Send-MailMessage or a toast notification [Elektroda, divadiow, post #21246726]

Edge case: connection refused—what now?

If nc returns “Connection refused,” the firmware build may lack LOGPORT, port 9000 could be disabled in compile-time settings, or a firewall blocks it. Verify firmware version, reboot and retest on the same subnet.

Quick 3-step procedure to grab filtered logs

  1. nc 9000 | grep "ERROR" > errors.log 2. Let it run for the desired period 3. Analyse errors.log with awk or a spreadsheet.

Is the BusyBox for Windows download safe to use?

The frippery.org build is widely used; the x86-64 static binary is 1.2 MB and passes VirusTotal checks as of 2025-07 [“frippery.org/busybox”].

Can I change the verbosity of the stream?

Set LogLevel via the web console or MQTT (e.g., set Logging 3). Changes reflect instantly on port 9000.
Generated by the language model.
ADVERTISEMENT