Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oxan/esphome-stream-server
Stream server (serial-to-wifi bridge) for ESPHome
https://github.com/oxan/esphome-stream-server
esphome esphome-component serial serial-bridge wifi-serial-bridge
Last synced: about 4 hours ago
JSON representation
Stream server (serial-to-wifi bridge) for ESPHome
- Host: GitHub
- URL: https://github.com/oxan/esphome-stream-server
- Owner: oxan
- License: other
- Created: 2021-05-19T17:16:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-05T08:46:49.000Z (10 months ago)
- Last Synced: 2024-12-27T03:07:09.633Z (7 days ago)
- Topics: esphome, esphome-component, serial, serial-bridge, wifi-serial-bridge
- Language: C++
- Homepage:
- Size: 21.5 KB
- Stars: 204
- Watchers: 19
- Forks: 88
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
Stream server for ESPHome
=========================
Custom component for ESPHome to expose a UART stream over WiFi or Ethernet. Provides a serial-to-wifi bridge as known
from ESPLink or ser2net, 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.
Usage
-----
Requires ESPHome v2022.3.0 or newer.
```yaml
external_components:
- source: github://oxan/esphome-stream-server
stream_server:
```
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
```
Sensors
-------
The server provides a binary sensor that signals whether there currently is a client connected:
```yaml
binary_sensor:
- platform: stream_server
connected:
name: Connected
```
It also provides a numeric sensor that indicates the number of connected clients:
```yaml
sensor:
- platform: stream_server
connection_count:
name: Number of connections
```
Advanced
--------
It is possible to define multiple stream servers for multiple UARTs simultaneously:
```yaml
uart:
- id: uart1
# ...
- id: uart2
# ...
stream_server:
- uart_id: uart1
port: 1234
- uart_id: uart2
port: 1235
```
The stream server has an internal buffer into which UART data is read before it is transmitted over TCP. The size of
this buffer can be changed using the `buffer_size` option, and must be a power of two. Increasing the buffer size above
the default of 128 bytes can help to achieve optimal throughput, and is especially helpful when using high baudrates. It
can also be necessary to increase the [`rx_buffer_size`][uart-config] option of the UART itself.
```yaml
stream_server:
buffer_size: 2048
```
[uart-config]: https://esphome.io/components/uart.html#configuration-variables