Скачать esp wifi logger - скачать исходный код esp wifi logger

esp wifi logger

Другие категории

1.0.0

Скачать

Компонент Wi-Fi Logger

Регистратор ESP32 WiFi — регистрируйте сообщения через Wi-Fi, используя TCP, UDP или веб-сокеты.

Генерирует сообщения журнала в том же формате, что и API ведения журнала ESP-IDF.
Может маршрутизировать журналы, сгенерированные ESP_LOGX(), предоставляет специальную функцию для регистрации сообщений через Wi-Fi.
Соответствует цветовому шаблону журнала 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>
Получать журналы, когда веб-сокет используется в качестве сетевого протокола
websocat -s $(ip -o route get to 8.8.8.8 | sed -n 's/.*src ([0-9.]+).*/1/p'):1234
получать журналы, когда веб-сокет используется в качестве сетевого протокола, автоматически заполняет 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 , если это настроено через менюconfig.
Шаблон использования такой же, как у ESP_LOGX()
Используйте функцию wifi_log()_x для печати журналов через Wi-Fi.
Пример: wifi_log(TAG, "%s", "logger test");
Журналы ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV также будут отправляться через Wi-Fi, если это настроено в меню конфигурации.
Вызовите start_wifi_logger() в void app_main() чтобы запустить регистратор. Функцию ведения журнала wifi_log_x() (x = e,w,i,d,v) можно вызвать для регистрации сообщений или можно использовать обычные функции API ведения журнала ESP-IDF, такие как ESP_LOGW если они настроены через menuconfig .
Настроить menuconfig
- Example Connection Configuration Установите SSID и пароль Wi-Fi.
- 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 . Установите IP-адрес сервера, который будет получать сообщения журнала, отправленные ESP32.
    - Port — установите порт сервера.
  - WEBSOCKET Network Protocol
    - Websocket Server URI — устанавливает URI сервера Websocket, куда должны отправляться журналы.

IP-адрес сервера можно узнать, запустив ifconfig на компьютере с Linux.

Конфигурация

 idf.py menuconfig

Example Connection Configuration
- WiFi SSID — установите SSID Wi-Fi для подключения.
- WiFi Password — установка пароля Wi-Fi
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 . Установите IP-адрес сервера, который будет получать сообщения журнала, отправленные ESP32.
    - Port — установите порт сервера.
  - WEBSOCKET Network Protocol
    - Websocket Server URI — устанавливает URI сервера Websocket, куда должны отправляться журналы.
  - 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
    }
}