تنزيل esp wifi logger - تنزيل رمز المصدر esp wifi logger

esp wifi logger

فئات أخرى

1.0.0

تنزيل

مكون مسجل WiFi

ESP32 WiFi logger - تسجيل الرسائل عبر شبكة WiFi، باستخدام إما TCP أو UDP أو Websockets

يُنشئ رسائل سجل بنفس تنسيق 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
مثال : لنفترض أن المنفذ هو 1212 عبر TCP، وسيكون الأمر: 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 ، إذا تم تكوينها من خلال القائمة
نمط الاستخدام مماثل لـ ESP_LOGX()
استخدم وظيفة wifi_log()_x لطباعة السجلات عبر شبكة wifi
مثال: wifi_log(TAG, "%s", "logger test");
سيتم أيضًا إرسال سجلات ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV عبر wifi، إذا تم تكوينها في Menuconfig.
اتصل بـ start_wifi_logger() في void app_main() لبدء تشغيل المُسجل. يمكن استدعاء وظيفة التسجيل wifi_log_x() (x = e,w,i,d,v) لتسجيل الرسائل أو يمكن استخدام وظائف ESP-IDF Logging API العادية مثل ESP_LOGW إذا تم تكوينها من خلال menuconfig .
تكوين menuconfig
- Example Connection Configuration قم بتعيين WiFi SSID وكلمة المرور
- Component config
- WiFi Logger configuration
  - Route logs generated by ESP_LOGX to the wifi logger - حدد ما إذا كان يتم توجيه السجلات المكتوبة بواسطة واجهة برمجة تطبيقات النظام لإرسالها إلى المسجل عن بعد
  - Network Protocol (TCP/UDP/WEBSOCKET) - قم بتعيين بروتوكول الشبكة المطلوب استخدامه
  - UDP/TCP Network Protocol
    - Server IP Address - قم بتعيين عنوان IP للخادم الذي سيتلقى رسائل السجل المرسلة بواسطة ESP32
    - Port - قم بتعيين منفذ الخادم
  - WEBSOCKET Network Protocol
    - Websocket Server URI - يضبط URI لخادم Websocket، حيث سيتم إرسال السجلات

يمكن معرفة عنوان IP الخاص بالخادم عن طريق تشغيل ifconfig على جهاز يعمل بنظام التشغيل Linux

إعدادات

 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 - حدد ما إذا كان يتم توجيه السجلات المكتوبة بواسطة واجهة برمجة تطبيقات النظام لإرسالها إلى المسجل عن بعد
  - UDP/TCP Network Protocol
    - Server IP Address - قم بتعيين عنوان IP للخادم الذي سيتلقى رسائل السجل المرسلة بواسطة ESP32
    - Port - قم بتعيين منفذ الخادم
  - WEBSOCKET Network Protocol
    - Websocket Server URI - يضبط URI لخادم Websocket، حيث سيتم إرسال السجلات
  - Queue Size - تكوين متقدم، قم بالتغيير على مسؤوليتك الخاصة قم بتعيين حجم قائمة انتظار freeRTOS المستخدم لتمرير رسائل السجل إلى مهمة المسجل.
  - logger buffer size - التكوين المتقدم، قم بالتغيير على مسؤوليتك الخاصة. قم بتعيين حجم المخزن المؤقت لصفيف char المستخدم لإنشاء رسائل السجل بتنسيق 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
    }
}