esp wifi logger下載 - esp wifi logger原始碼下載

esp wifi logger

其他類別

1.0.0

下載

WiFi記錄器組件

ESP32 WiFi 記錄器 - 使用 TCP、UDP 或 Websockets 透過 WiFi 記錄訊息

產生與 ESP-IDF Logging API 格式相同的日誌訊息。
可以路由 ESP_LOGX() 產生的日誌，提供自訂函數來透過 wifi 記錄訊息。
遵循不同日誌等級的 ESP-IDF 日誌顏色模式。
使用 UDP 作為網路協定可提供最低的延遲：
- 最小測試條件 - 最小可用堆 = 220388位元組。
TCP 效能處於中等水準：
- 最小測試條件 - 最小可用堆 = 216537位元組。
使用 Websockets 會產生最差的延遲：
- 最小測試條件 - 最小可用堆 = 205416位元組。

範例應用程式：

要求

protocol_examples_common (esp-idf/examples/common_components/)

安裝

 cd <your_esp_idf_project>
mkdir components
cd components
cp $IDF_PATH/examples/common_components/protocol_examples_common . -r
git clone https://github.com/VedantParanjape/esp-wifi-logger.git wifi_logger

更改 CMakeList.txt 以新增以下行：

set(EXTRA_COMPONENT_DIRS <relative_path_to_component_folder>)

元件資料夾必須包含protocol_examples_common和wifi_logger元件

用法

如何接收日誌

sudo apt-get install netcat
需要Netcat來接收日誌
nc -lu <PORT>
使用udp作為網路協定時接收日誌
nc -l <PORT>
使用tcp作為網路協定時接收日誌
websocat -s <IP_ADDRESS_OF_YOUR_MACHINE>:<PORT>
使用websocket作為網路協定時接收日誌
websocat -s $(ip -o route get to 8.8.8.8 | sed -n 's/.*src ([0-9.]+).*/1/p'):1234
使用websocket作為網路協定時接收日誌，自動填入ip位址
範例：假設 TCP連接埠為1212 ，指令為： nc -l 1212

如何在 ESP-IDF 專案中使用

 wifi_log_e() - Generate log with log level ERROR
wifi_log_w() - Generate log with log level WARN
wifi_log_i() - Generate log with log level INFO
wifi_log_d() - Generate log with log level DEBUG
wifi_log_v() - Generate log with log level VERBOSE

可以傳送ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV產生的日誌（如果透過 menuconfig 配置）
使用模式與ESP_LOGX()相同
使用wifi_log()_x函數透過 wifi 列印日誌
範例： wifi_log(TAG, "%s", "logger test");
如果在 menuconfig 中配置ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV日誌也會透過 wifi 傳送。
在void app_main()中呼叫start_wifi_logger()來啟動記錄器。可以呼叫日誌函數wifi_log_x() (x = e,w,i,d,v)來記錄訊息，如果透過menuconfig配置，則可以使用普通 ESP-IDF 日誌 API 函數（如ESP_LOGW 。
配置menuconfig配置
- Example Connection Configuration設定 WiFi SSID 和密碼
- Component config
- WiFi Logger configuration
  - Route logs generated by ESP_LOGX to the wifi logger - 選擇是否將系統 API 寫入的日誌路由傳送到遠端記錄器
  - Network Protocol (TCP/UDP/WEBSOCKET) - 設定要使用的網路協定
  - UDP/TCP Network Protocol
    - Server IP Address - 設定將接收 ESP32 發送的日誌訊息的伺服器的 IP 位址
    - 連接Port - 設定伺服器的連接埠
  - WEBSOCKET Network Protocol
    - Websocket Server URI - 設定要傳送日誌的 Websocket 伺服器的 URI

在Linux機器上執行ifconfig可以找到伺服器的IP位址

配置

 idf.py menuconfig

Example Connection Configuration
- WiFi SSID - 設定要連接的 WiFi SSID
- WiFi Password - 設定 WiFi 密碼
Component config
- WiFi Logger configuration
  - Network Protocol (TCP/UDP/WEBSOCKET) - 設定要使用的網路協定
  - Route logs generated by ESP_LOGX to the wifi logger - 選擇是否將系統 API 寫入的日誌路由傳送到遠端記錄器
  - UDP/TCP Network Protocol
    - Server IP Address - 設定將接收 ESP32 發送的日誌訊息的伺服器的 IP 位址
    - 連接Port - 設定伺服器的連接埠
  - WEBSOCKET Network Protocol
    - Websocket Server URI - 設定要傳送日誌的 Websocket 伺服器的 URI
  - Queue Size -進階配置，變更需要您自擔風險設定用於將日誌訊息傳遞到記錄器任務的 freeRTOS 佇列大小。
  - logger buffer size -進階配置，變更需要您自擔風險設定用於產生 ESP 格式日誌訊息的字元陣列的緩衝區大小

例子

詳細範例應用程式：

 #include <stdio.h>
#include "freertos/FreeRTOS.h"
#include "freertos/task.h"
#include "wifi_logger.h"


void app_main ( void )
{
    start_wifi_logger (); // Start wifi logger

    while ( 1 )
    {
        wifi_log_e ( "test" , "%s %d %f" , "hello world wifi logger" , 43 , 45.341223242 ); // write log over wifi with log level -> ERROR
        wifi_log_w ( "test" , "%s %d %f" , "hello world wifi logger" , 43 , 45.341223242 ); // write log over wifi with log level -> WARN
        wifi_log_i ( "test" , "%s %d %f" , "hello world wifi logger" , 43 , 45.341223242 ); // write log over wifi with log level -> INFO
        wifi_log_d ( "test" , "%s %d %f" , "hello world wifi logger" , 43 , 45.341223242 ); // write log over wifi with log level -> DEBUG
        wifi_log_v ( "test" , "%s %d %f" , "hello world wifi logger" , 43 , 45.341223242 ); // write log over wifi with log level -> VERBOSE

        vTaskDelay ( 100 );  // Wait for 100ms, prevent watchdog from triggering a reset
    }
}