https://github.com/grimmpp/esphome-wifi-serial-bridge
https://github.com/grimmpp/esphome-wifi-serial-bridge
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/grimmpp/esphome-wifi-serial-bridge
- Owner: grimmpp
- License: mit
- Created: 2024-11-19T13:51:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-19T13:59:52.000Z (over 1 year ago)
- Last Synced: 2025-01-25T09:42:03.662Z (over 1 year ago)
- Language: C++
- Size: 7.81 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Serial to Wifi Bridge for ESPHome
=========================
Custom component for ESPHome to expose a UART stream over WiFi or Ethernet. Can be used as a serial-to-wifi bridge as
known from ESPLink or ser2net by using ESPHome.
This component creates a TCP server listening on port 6638 (by default), and relays all data between the connected
clients and the serial port. It doesn't support any control sequences, telnet options or RFC 2217, just raw data.
This is original component from https://github.com/oxan/esphome-stream-server extend by ayufan to define a set of additional options
to better handle for high baud rate UART modes and define a way how clients are handled.
Usage
-----
Requires ESPHome v1.10.0 or higher.
```yaml
external_components:
- source: github://grimmpp/esphome-wifi-serial-bridge
stream_server:
# default 6638
port: 2323
# 0: unlimited
# positive: keep only N latest connected clients
# negative: reject over N clients
max_clients: 4
```
You can set the UART ID and port to be used under the `stream_server` component.
```yaml
uart:
id: uart_bus
# add further configuration for the UART here
stream_server:
uart_id: uart_bus
port: 1234
```
How to build and push code locally
======
Create virtual python environment
`python -m venv .venv`
Install esphome
`pip install esphome`
Install libraries
`?`
Create secrets.yaml in project folder file:
```
wifi_ssid: "**********"
wifi_password: "**********"
api_password: "**********"
ota_password: "**********"
```
Compile und upload via USB
`esphome run project.yaml`