https://github.com/igrr/rfc2217-server

RFC2217 (remote serial port) server library for ESP-IDF
https://github.com/igrr/rfc2217-server

component esp-idf rfc2217

Last synced: 3 months ago
JSON representation

RFC2217 (remote serial port) server library for ESP-IDF

• Host: GitHub
• URL: https://github.com/igrr/rfc2217-server
• Owner: igrr
• License: apache-2.0
• Created: 2024-08-16T17:47:41.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2025-10-05T07:02:13.000Z (8 months ago)
• Last Synced: 2025-11-29T23:57:41.319Z (6 months ago)
• Topics: component, esp-idf, rfc2217
• Language: C
• Homepage: https://components.espressif.com/components/igrr/rfc2217-server/
• Size: 60.5 KB
• Stars: 13
• Watchers: 1
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# RFC2217 server library for ESP-IDF

[![Component Registry](https://components.espressif.com/components/igrr/rfc2217-server/badge.svg)](https://components.espressif.com/components/igrr/rfc2217-server) [![Example build](https://github.com/igrr/rfc2217-server/actions/workflows/build_examples.yml/badge.svg)](https://github.com/igrr/rfc2217-server/actions/workflows/build_examples.yml)

This library provides an RFC2217 server for ESP-IDF. RFC2217 is one of the protocols for accessing serial ports remotely over network. RFC2217 is based on Telnet, extending it with a few commands related to serial port settings.

With this library, you can build a "remote serial port" type of device using an Espressif chip.

## Examples

- `loopback` example sets up an RFC2217 server and echoes back any data received.

- `uart` is an example of an RFC2217-to-UART bridge.

- `usb_cdc` is an example of an RFC2217-to-USB-CDC bridge.

## Using the component

If you have an existing ESP-IDF project you can run the following command to install the component:

```bash

idf.py add-dependency "igrr/rfc2217-server"

```

## License

This component is provided under Apache 2.0 license, see [LICENSE](LICENSE.md) file for details.