{"id":16796005,"url":"https://github.com/oxan/esphome-stream-server","last_synced_at":"2025-04-07T06:06:07.016Z","repository":{"id":38201734,"uuid":"368946393","full_name":"oxan/esphome-stream-server","owner":"oxan","description":" Stream server (serial-to-wifi bridge) for ESPHome ","archived":false,"fork":false,"pushed_at":"2024-03-05T08:46:49.000Z","size":22,"stargazers_count":226,"open_issues_count":16,"forks_count":97,"subscribers_count":19,"default_branch":"master","last_synced_at":"2025-03-31T05:03:15.416Z","etag":null,"topics":["esphome","esphome-component","serial","serial-bridge","wifi-serial-bridge"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oxan.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["oxan"]}},"created_at":"2021-05-19T17:16:16.000Z","updated_at":"2025-03-24T15:15:26.000Z","dependencies_parsed_at":"2024-10-27T00:57:48.904Z","dependency_job_id":null,"html_url":"https://github.com/oxan/esphome-stream-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxan%2Fesphome-stream-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxan%2Fesphome-stream-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxan%2Fesphome-stream-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxan%2Fesphome-stream-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxan","download_url":"https://codeload.github.com/oxan/esphome-stream-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247601447,"owners_count":20964864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esphome","esphome-component","serial","serial-bridge","wifi-serial-bridge"],"created_at":"2024-10-13T09:18:00.771Z","updated_at":"2025-04-07T06:06:06.988Z","avatar_url":"https://github.com/oxan.png","language":"C++","funding_links":["https://github.com/sponsors/oxan"],"categories":[],"sub_categories":[],"readme":"Stream server for ESPHome\n=========================\n\nCustom component for ESPHome to expose a UART stream over WiFi or Ethernet. Provides a serial-to-wifi bridge as known\nfrom ESPLink or ser2net, using ESPHome.\n\nThis component creates a TCP server listening on port 6638 (by default), and relays all data between the connected\nclients and the serial port. It doesn't support any control sequences, telnet options or RFC 2217, just raw data.\n\nUsage\n-----\n\nRequires ESPHome v2022.3.0 or newer.\n\n```yaml\nexternal_components:\n  - source: github://oxan/esphome-stream-server\n\nstream_server:\n```\n\nYou can set the UART ID and port to be used under the `stream_server` component.\n\n```yaml\nuart:\n   id: uart_bus\n   # add further configuration for the UART here\n\nstream_server:\n   uart_id: uart_bus\n   port: 1234\n```\n\nSensors\n-------\nThe server provides a binary sensor that signals whether there currently is a client connected:\n\n```yaml\nbinary_sensor:\n  - platform: stream_server\n    connected:\n      name: Connected\n```\n\nIt also provides a numeric sensor that indicates the number of connected clients:\n\n```yaml\nsensor:\n  - platform: stream_server\n    connection_count:\n      name: Number of connections\n```\n\nAdvanced\n--------\nIt is possible to define multiple stream servers for multiple UARTs simultaneously:\n\n```yaml\nuart:\n  - id: uart1\n    # ...\n  - id: uart2\n    # ...\n\nstream_server:\n  - uart_id: uart1\n    port: 1234\n  - uart_id: uart2\n    port: 1235\n```\n\nThe stream server has an internal buffer into which UART data is read before it is transmitted over TCP. The size of\nthis buffer can be changed using the `buffer_size` option, and must be a power of two. Increasing the buffer size above\nthe default of 128 bytes can help to achieve optimal throughput, and is especially helpful when using high baudrates. It\ncan also be necessary to increase the [`rx_buffer_size`][uart-config] option of the UART itself.\n\n```yaml\nstream_server:\n    buffer_size: 2048\n```\n\n[uart-config]: https://esphome.io/components/uart.html#configuration-variables\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxan%2Fesphome-stream-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxan%2Fesphome-stream-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxan%2Fesphome-stream-server/lists"}