Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nopnop2002/esp-idf-net-logging
Redirect esp-idf logging to the network
https://github.com/nopnop2002/esp-idf-net-logging
esp-idf esp32 logger logging redirects
Last synced: 24 days ago
JSON representation
Redirect esp-idf logging to the network
- Host: GitHub
- URL: https://github.com/nopnop2002/esp-idf-net-logging
- Owner: nopnop2002
- License: mit
- Created: 2022-02-01T05:05:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T00:03:10.000Z (30 days ago)
- Last Synced: 2024-10-22T19:13:48.838Z (29 days ago)
- Topics: esp-idf, esp32, logger, logging, redirects
- Language: C
- Homepage:
- Size: 83 KB
- Stars: 43
- Watchers: 3
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# esp-idf-net-logging
Redirect esp-idf logging to the network.
esp-idf has a Logging library.
The Logging library contains the ```esp_log_set_vprintf``` function.
By default, log output goes to UART0.
This function can be used to redirect log output to some other destination, such as file or network.
I made a project that uses 3 UARTs of ESP32.
But I was in trouble because there was no logging output destination.
So I made this.
The following protocols are available for this project.
- UDP
- TCP
- MQTT
- HTTP(POST)
I referred to [this](https://github.com/MalteJ/embedded-esp32-component-udp_logging).
# Software requirements
esp-idf v4.4/v5.x.
# Installation
```Shell
git clone https://github.com/nopnop2002/esp-idf-net-logging
cd esp-idf-net-logging/basic
idf.py menuconfig
idf.py flash
```
# Configuration
## Configuration for UDP Redirect
There are the following four methods for specifying the UDP Address.
- Limited broadcast address
The address represented by 255.255.255.255, or \, cannot cross the router.
Both the sender and receiver must specify a Limited broadcast address.
- Directed broadcast address
It is possible to cross the router with an address that represents only the last octet as 255, such as 192.168.10.255.
Both the sender and receiver must specify the Directed broadcast address.
__Note that it is possible to pass through the router.__
- Multicast address
Data is sent to all PCs belonging to a specific group using a special address (224.0.0.0 to 239.255.255.255) called a multicast address.
I've never used it, so I don't know anything more.
- Unicast address
It is possible to cross the router with an address that specifies all octets, such as 192.168.10.41.
Both the sender and receiver must specify the Unicast address.
## Configuration for TCP Redirect
ESP32 works as a TCP client.
You can use the mDNS hostname of such a TCP server instead of the IP address.
tcp-server.local
## Configuration for MQTT Redirect
## Configuration for HTTP Redirect
ESP32 works as a HTTP client.
You can use mDNS host name for your http server.
## Disable Logging to STDOUT
## Use xRingBuffer as IPC
Both xMessageBuffer and xRingBuffer are interprocess communication (IPC) components provided by ESP-IDF.
Several drivers provided by ESP-IDF use xRingBuffer.
This project uses xMessageBuffer by default.
If you use this project at the same time as a driver that uses xRingBuffer, using xRingBuffer uses less memory.
Memory usage status can be checked with ```idf.py size-files```.
# View logging
You can see the logging using python code or mosqutto client.
- for UDP
You can use ```netcat``` as server.
We can use [this](https://apps.microsoft.com/detail/9nblggh52bt0) as Logging Viewer.
Note that the most recent logging is displayed at the __top__.
We can also use [this](https://apps.microsoft.com/detail/9p4nn1x0mmzr) as Logging Viewer.
Note that the most recent logging is displayed at the __buttom__.
I like this one better.
There are others if you look for them.
- for TCP
You can use ```netcat``` as server.
We can use [this](https://sourceforge.net/projects/sockettest/) as Logging Viewer.
- for MQTT
The wifi logging is output in two parts.
First time:W (7060) wifi:
Second time:Characters after that
In MQTT and HTTP, it is displayed separately in two.
__If you use broker.emqx.io, continuous Logging will drop.__
__Using a local MQTT server is stable.__
You can use [this](https://github.com/nopnop2002/esp-idf-mqtt-broker) as a broker.
- for HTTP
# Disable ANSI Color control
You can disable this if you are unable to display ANSI color codes correctly.
# API
Use one of the following.
Subsequent logging will be redirected.
```
esp_err_t udp_logging_init(char *ipaddr, unsigned long port, int16_t enableStdout);
esp_err_t tcp_logging_init(char *ipaddr, unsigned long port, int16_t enableStdout);
esp_err_t mqtt_logging_init(char *url, char *topic, int16_t enableStdout);
esp_err_t http_logging_init(char *url, int16_t enableStdout);
```