Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vedantparanjape/esp-wifi-logger

ESP32 WiFi Logger component
https://github.com/vedantparanjape/esp-wifi-logger

c esp-idf esp32 freertos hacktoberfest logger networking tcp udp websockets wifi

Last synced: about 20 hours ago
JSON representation

ESP32 WiFi Logger component

Host: GitHub
URL: https://github.com/vedantparanjape/esp-wifi-logger
Owner: VedantParanjape
License: mit
Created: 2020-04-11T20:14:50.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2020-11-12T10:08:06.000Z (about 4 years ago)
Last Synced: 2023-03-04T12:00:05.909Z (over 1 year ago)
Topics: c, esp-idf, esp32, freertos, hacktoberfest, logger, networking, tcp, udp, websockets, wifi
Language: C
Homepage: https://ve0x10.in/esp-wifi-logger/
Size: 1.41 MB
Stars: 67
Watchers: 3
Forks: 10
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

WiFi Logger component
====================
ESP32 WiFi logger - Log messages over WiFi, using either TCP, UDP or Websockets
* Generates log messages with same format as ESP-IDF Logging API.
* Can route logs generated by ESP_LOGX(), provides a custom function to log messages over wifi.
* Follows ESP-IDF log color pattern for different log levels.
* Using UDP as network protocol provides lowest latency:
* Minimal test condition - minimum free heap = *220388* bytes.
* TCP performance is mid-way:
* Minimal test condition - minimum free heap = *216537* bytes.
* Using Websockets provides the worst latency:
* Minimal test condition - minimum free heap = *205416* bytes.

Example App: ![https://github.com/VedantParanjape/esp-component-examples/tree/master/esp_wifi_logger_example](https://github.com/VedantParanjape/esp-component-examples/tree/master/esp_wifi_logger_example)

## Requirements

* `protocol_examples_common (esp-idf/examples/common_components/)`

## Installation

```
cd
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
```

Change CMakeList.txt to add the line given below:

`set(EXTRA_COMPONENT_DIRS )`

component folder must contain `protocol_examples_common` and `wifi_logger` component
## Usage

### How to receive logs

* `sudo apt-get install netcat`
Netcat is required to receive logs
* `nc -lu `
Receive logs when ***udp*** is used as network protocol
* `nc -l `
Receive logs when ***tcp*** is used as network protocol
* `websocat -s :`
Receive logs when ***websocket*** is used as network protocol
* `websocat -s $(ip -o route get to 8.8.8.8 | sed -n 's/.*src $[0-9.]\+$.*/\1/p'):1234`
receive logs when ***websocket*** is used as network protocol, auto fills the ip address
* **Example**: Assume, *port* is **1212** over TCP, command will be: `nc -l 1212`

### How to use in ESP-IDF Projects
```
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
```
* Can send logs generated by `ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV`, if configured so through menuconfig

* Usage pattern same as, `ESP_LOGX()`
* Use `wifi_log()_x` function to print logs over wifi
* Example: `wifi_log(TAG, "%s", "logger test");`
* `ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV` logs will also be sent over wifi, if configured in menuconfig.
* Call `start_wifi_logger()` in `void app_main()` to start the logger. Logging function `wifi_log_x() (x = e,w,i,d,v)` can be called to log messages or normal ESP-IDF Logging API functions like `ESP_LOGW` can be used if configured through `menuconfig`.

* Configure `menuconfig`
* `Example Connection Configuration` *Set WiFi SSID and password*
* `Component config`
* `WiFi Logger configuration`
* `Route logs generated by ESP_LOGX to the wifi logger` - Select if the logs written by system API are routed to be sent to the remote logger
* `Network Protocol (TCP/UDP/WEBSOCKET)` - Set network protocol to be used
* `UDP/TCP Network Protocol`
* `Server IP Address` - Set the IP Address of the server which will receive log messages sent by ESP32
* `Port` - Set the Port of the server
* `WEBSOCKET Network Protocol`
* `Websocket Server URI` - Sets the URI of Websocket server, where logs are to be sent

*IP Address of the server can be found out by running `ifconfig` on a linux machine*

## Configuration

```
idf.py menuconfig
```
* `Example Connection Configuration`
* `WiFi SSID` - Set WiFi SSID to connect
* `WiFi Password` - Set WiFi Password

* `Component config`
* `WiFi Logger configuration`
* `Network Protocol (TCP/UDP/WEBSOCKET)` - Set network protocol to be used
* `Route logs generated by ESP_LOGX to the wifi logger` - Select if the logs written by system API are routed to be sent to the remote logger
* `UDP/TCP Network Protocol`
* `Server IP Address` - Set the IP Address of the server which will receive log messages sent by ESP32
* `Port` - Set the Port of the server
* `WEBSOCKET Network Protocol`
* `Websocket Server URI` - Sets the URI of Websocket server, where logs are to be sent
* `Queue Size` - ***Advanced Config, change at your own risk*** Set the freeRTOS Queue size used to pass log messages to logger task.
* `logger buffer size` - ***Advanced Config, change at your own risk*** Set the buffer size of char array used to generate log messages in ESP format

## Example
* Detailed Example App: ![https://github.com/VedantParanjape/esp-component-examples/tree/master/esp_wifi_logger_example](https://github.com/VedantParanjape/esp-component-examples/tree/master/esp_wifi_logger_example)

```C
#include
#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
}
}
```

## Detailed Documentation

* https://vedantparanjape.github.io/esp-wifi-logger/