ESPHome Stream Server 项目教程

1. 项目的目录结构及介绍

esphome-stream-server/
├── components/
│   └── stream_server/
│       ├── __init__.py
│       ├── stream_server.cpp
│       └── stream_server.h
├── LICENSE
├── README.md
└── example_config.yaml

目录结构介绍

• components/stream_server/: 该目录包含了 stream_server 组件的核心代码，包括 C++ 源文件和头文件。

  • __init__.py: Python 初始化文件，用于标识该目录为一个 Python 包。
  • stream_server.cpp: 组件的主要实现代码，负责处理串口数据与 TCP 数据之间的转换。
  • stream_server.h: 组件的头文件，定义了组件的接口和数据结构。

• LICENSE: 项目的开源许可证文件，通常为 MIT 许可证。

• README.md: 项目的说明文件，包含了项目的概述、使用方法和配置说明。

• example_config.yaml: 示例配置文件，展示了如何配置 stream_server 组件。

2. 项目的启动文件介绍

项目的启动文件主要是 stream_server.cpp，该文件实现了 stream_server 组件的核心功能。以下是该文件的主要功能介绍：

• 初始化串口: 在启动时，stream_server 组件会初始化指定的串口，并设置相应的波特率、数据位、停止位等参数。

• 创建 TCP 服务器: 组件会创建一个 TCP 服务器，监听指定的端口（默认端口为 6638）。当有客户端连接时，组件会将串口数据转发给客户端，并将客户端发送的数据写入串口。

• 数据缓冲区管理: 组件内部维护了一个数据缓冲区，用于存储从串口读取的数据。缓冲区的大小可以通过配置文件进行调整。

• 连接状态管理: 组件提供了一个二进制传感器，用于指示当前是否有客户端连接。此外，还提供了一个数值传感器，用于显示当前连接的客户端数量。

3. 项目的配置文件介绍

项目的配置文件通常是一个 YAML 文件，用于配置 stream_server 组件的各项参数。以下是一个示例配置文件的内容：

external_components:
  - source: github://oxan/esphome-stream-server

uart:
  id: uart_bus
  baud_rate: 115200
  data_bits: 8
  parity: NONE
  stop_bits: 1

stream_server:
  uart_id: uart_bus
  port: 1234
  buffer_size: 2048

binary_sensor:
  - platform: stream_server
    connected:
      name: "Connected"

sensor:
  - platform: stream_server
    connection_count:
      name: "Number of Connections"

配置文件说明

• external_components: 指定外部组件的来源，这里是 esphome-stream-server 组件的 GitHub 仓库。

• uart: 配置串口参数，包括串口 ID、波特率、数据位、校验位和停止位。

• stream_server: 配置 stream_server 组件的参数，包括串口 ID、监听端口和缓冲区大小。

• binary_sensor: 配置一个二进制传感器，用于指示当前是否有客户端连接。

• sensor: 配置一个数值传感器，用于显示当前连接的客户端数量。

通过以上配置，stream_server 组件可以实现串口数据与 TCP 数据之间的双向传输，并提供连接状态的监控功能。