esp wifi logger Download - esp wifi logger Download do código-fonte

esp wifi logger

Outras categorias

1.0.0

Baixar

Componente WiFi Logger

ESP32 WiFi logger - Registra mensagens por WiFi, usando TCP, UDP ou Websockets

Gera mensagens de log com o mesmo formato da API de registro ESP-IDF.
Pode rotear logs gerados por ESP_LOGX(), fornece uma função personalizada para registrar mensagens por wifi.
Segue o padrão de cores de log ESP-IDF para diferentes níveis de log.
Usar UDP como protocolo de rede fornece menor latência:
- Condição de teste mínima - heap livre mínimo = 220388 bytes.
O desempenho do TCP está no meio do caminho:
- Condição de teste mínima - heap livre mínimo = 216.537 bytes.
O uso de Websockets fornece a pior latência:
- Condição de teste mínima - heap livre mínimo = 205.416 bytes.

Aplicativo de exemplo:

Requisitos

protocol_examples_common (esp-idf/examples/common_components/)

Instalação

 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

Altere CMakeList.txt para adicionar a linha abaixo:

set(EXTRA_COMPONENT_DIRS <relative_path_to_component_folder>)

a pasta do componente deve conter os componentes protocol_examples_common e wifi_logger

Uso

Como receber registros

sudo apt-get install netcat
Netcat é necessário para receber logs
nc -lu <PORT>
Receba logs quando o udp for usado como protocolo de rede
nc -l <PORT>
Receba logs quando o tcp for usado como protocolo de rede
websocat -s <IP_ADDRESS_OF_YOUR_MACHINE>:<PORT>
Receba logs quando o websocket for usado como protocolo de rede
websocat -s $(ip -o route get to 8.8.8.8 | sed -n 's/.*src ([0-9.]+).*/1/p'):1234
recebe logs quando o websocket é usado como protocolo de rede, preenche automaticamente o endereço IP
Exemplo : suponha que a porta seja 1212 sobre TCP, o comando será: nc -l 1212

Como usar em projetos 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

Pode enviar logs gerados por ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV , se configurado assim através do menuconfig
Padrão de uso igual ESP_LOGX()
Use a função wifi_log()_x para imprimir logs via wifi
Exemplo: wifi_log(TAG, "%s", "logger test");
Os logs ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV também serão enviados por wifi, se configurados no menuconfig.
Chame start_wifi_logger() em void app_main() para iniciar o logger. A função de registro wifi_log_x() (x = e,w,i,d,v) pode ser chamada para registrar mensagens ou funções normais da API de registro do ESP-IDF, como ESP_LOGW podem ser usadas se configuradas por meio de menuconfig .
Configurar menuconfig
- Example Connection Configuration Definir WiFi SSID e senha
- Component config
- WiFi Logger configuration
  - Route logs generated by ESP_LOGX to the wifi logger - Selecione se os logs gravados pela API do sistema são roteados para serem enviados ao registrador remoto
  - Network Protocol (TCP/UDP/WEBSOCKET) - Defina o protocolo de rede a ser usado
  - UDP/TCP Network Protocol
    - Server IP Address - Defina o endereço IP do servidor que receberá as mensagens de log enviadas pelo ESP32
    - Port - Defina a porta do servidor
  - WEBSOCKET Network Protocol
    - Websocket Server URI - Define o URI do servidor Websocket, para onde os logs devem ser enviados

O endereço IP do servidor pode ser descoberto executando ifconfig em uma máquina Linux

Configuração

 idf.py menuconfig

Example Connection Configuration
- WiFi SSID - Defina o WiFi SSID para conectar
- WiFi Password - Definir senha WiFi
Component config
- WiFi Logger configuration
  - Network Protocol (TCP/UDP/WEBSOCKET) - Defina o protocolo de rede a ser usado
  - Route logs generated by ESP_LOGX to the wifi logger - Selecione se os logs gravados pela API do sistema são roteados para serem enviados ao registrador remoto
  - UDP/TCP Network Protocol
    - Server IP Address - Defina o endereço IP do servidor que receberá as mensagens de log enviadas pelo ESP32
    - Port - Defina a porta do servidor
  - WEBSOCKET Network Protocol
    - Websocket Server URI - Define o URI do servidor Websocket, para onde os logs devem ser enviados
  - Queue Size - Configuração avançada, altere por sua conta e risco Defina o tamanho da fila do freeRTOS usado para passar mensagens de log para a tarefa do criador de logs.
  - logger buffer size - Configuração avançada, altere por sua conta e risco Defina o tamanho do buffer da matriz char usada para gerar mensagens de log no formato ESP

Exemplo

Aplicativo de exemplo detalhado:

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