https://github.com/h2zero/esp-libtelnet
Remote console over telnet for esp32 devices.
https://github.com/h2zero/esp-libtelnet
communication esp-idf-component esp32 telnet
Last synced: about 1 year ago
JSON representation
Remote console over telnet for esp32 devices.
- Host: GitHub
- URL: https://github.com/h2zero/esp-libtelnet
- Owner: h2zero
- Created: 2024-01-10T22:58:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-28T15:38:01.000Z (over 1 year ago)
- Last Synced: 2025-04-20T22:32:41.972Z (about 1 year ago)
- Topics: communication, esp-idf-component, esp32, telnet
- Language: C
- Homepage:
- Size: 44.9 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# esp-libtelnet
A library for providing a remote console over Telnet, and (optionally) UART, for esp32 devices.
## Features
- Remote monitor access from any Telnet client.
- Optional output mirroring to UART.
- Log output from `printf`, `stdout`, `stderr`, and `ets_printf` are all provided.
## Using
Clone this repo to your project/components folder and add `#include ` to your project file.
Alternatively, this can be installed via IDF Component Manager by adding the following to your project idf_component.yml file:
```
h2zero/esp-libtelnet:
git: "https://github.com/h2zero/esp-libtelnet"
```
## API
- `void init_telnet(telnet_rx_cb_t rx_cb)` Initialize the Telnet data structures. Param: `rx_cb` takes a callback function of `typedef void (*telnet_rx_cb_t)(const char *buf, size_t len)`.
- `void start_telnet(void)` Starts the Telnet task which listens for clients, do no call until an IP address has been received.
- `void telnet_mirror_to_uart(bool enable)` Enable (true) or disable (false) mirroring console output to UART.
## Aknowledgements
This library uses [libtelnet @commit 5f5ecee](https://github.com/seanmiddleditch/libtelnet) by Sean Middleditch and contributors