esp wifi loggerダウンロード - esp wifi loggerソースコードのダウンロード

esp wifi logger

その他のカテゴリー

1.0.0

ダウンロード

WiFi ロガーコンポーネント

ESP32 WiFi ロガー - TCP、UDP、または Websocket のいずれかを使用して、WiFi 経由でメッセージをログに記録します

ESP-IDF Logging API と同じ形式でログメッセージを生成します。
ESP_LOGX() によって生成されたログをルーティングでき、Wi-Fi 経由でメッセージをログに記録するためのカスタム関数を提供します。
さまざまなログレベルの ESP-IDF ログカラーパターンに従います。
ネットワークプロトコルとして UDP を使用すると、遅延が最小限に抑えられます。
- 最小のテスト条件 - 最小空きヒープ = 220388バイト。
TCP パフォーマンスは中程度です。
- 最小のテスト条件 - 最小空きヒープ = 216537バイト。
Websocket を使用すると、レイテンシが最悪になります。
- 最小のテスト条件 - 最小空きヒープ = 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

menuconfig で構成されている場合ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGVによって生成されたログを送信できます
使用パターンはESP_LOGX()と同じ
wifi_log()_x関数を使用して Wi-Fi 経由でログを出力します
例: wifi_log(TAG, "%s", "logger test");
ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGVログも、menuconfig で設定されている場合、Wi-Fi 経由で送信されます。
void app_main()でstart_wifi_logger()呼び出してロガーを開始します。ロギング関数wifi_log_x() (x = e,w,i,d,v)呼び出してメッセージをログに記録することも、 menuconfigで設定されている場合はESP_LOGWなどの通常の ESP-IDF ロギング API 関数を使用することもできます。
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 を設定します。

サーバーの IP アドレスは、Linux マシンでifconfig実行することで確認できます。

構成

 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 形式のログメッセージの生成に使用される char 配列のバッファサイズを設定します

例

詳細なサンプルアプリ:

 #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
    }
}