Example in Cline

### 硬件编程 firmware可以在项目仓库中下载，目前演示的是Pico的micropython代码案例。另存到Pico开发板运行即可。 ### 从源码快速开始 1. 从源码安装 ```bash # 通过源码安装： git clone https://github.com/mcp2everything/mcp2serial.git cd mcp2serial # 创建虚拟环境 uv venv .venv # 激活虚拟环境 # Windows: .venv\Scripts\activate # Linux/macOS: source .venv/bin/activate # 安装开发依赖 uv pip install --editable . ``` 2. 配置串口和命令：默认不使用真实串口用模拟串口来演示如果你的电脑没有串口或者目前没有串口可用可以将port参数设置为LOOP_BACK，这样就可以在命令行直接发送命令了但同时请修改应答OK的命令的起始符需要和发送的命令一样。比如发送LED_ON 那么应答起始符也是LED_ON ```yaml serial: # 串口配置 port: LOOP_BACK # 可选，如果不指定则自动查找。设置为LOOP_BACK时启用回环模式，发送什么就接收什么 baud_rate: 115200 # 可选，默认 115200 timeout: 1.0 # 可选，默认 1.0 read_timeout: 1.0 # 读取超时时间，1秒内不应答则报错 response_start_string: CMD # 可选，串口应答的开始字符串，默认为OK commands: # PWM控制命令 set_pwm: command: "CMD_PWM {frequency}" # 实际发送的命令格式，server会自动添加\r\n need_parse: false # 不需要解析响应内容 prompts: - "把PWM调到最大" - "把PWM调到最小" - "请将PWM设置为{value}" - "关闭PWM" - "把PWM调到一半" ``` 如果使用真实串口 ```yaml # config.yaml serial: port: COM11 # 或自动检测 baud_rate: 115200 # 可选，默认 115200 timeout: 1.0 # 可选，默认 1.0 read_timeout: 1.0 # 读取超时时间，1秒内不应答则报错 response_start_string: OK # 可选，串口应答的开始字符串，默认为OK commands: set_pwm: command: "PWM {frequency}\n" need_parse: false prompts: - "把PWM调到{value}" ``` ### MCP客户端配置在使用支持MCP协议的客户端（如Claude Desktop或Cline）时，需要在客户端的配置文件中添加以下内容：直接自动安装的配置方式源码开发的配置方式 #### 使用默认演示参数： ```json { "mcpServers": { "mcp2serial": { "command": "uv", "args": [ "--directory", "你的实际路径/mcp2serial", // 例如: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2serial" "run", "mcp2serial" ] } } } ``` #### 指定参数文件名 ```json { "mcpServers": { "mcp2serial": { "command": "uv", "args": [ "--directory", "你的实际路径/mcp2serial", // 例如: "C:/Users/Administrator/Documents/develop/my-mcp-server/mcp2serial" "run", "mcp2serial", "--config", // 可选参数，指定配置文件名 "Pico" // 可选参数，指定配置文件名，不需要添加_config.yaml后缀 ] } } } ``` 3. 运行服务器： ```bash # 确保已激活虚拟环境 .venv\Scripts\activate # 运行服务器（使用默认配置config.yaml 案例中用的LOOP_BACK 模拟串口，无需真实串口和串口设备） uv run src/mcp2serial/server.py 或 uv run mcp2serial # 运行服务器（使用指定配置Pico_config.yaml） uv run src/mcp2serial/server.py --config Pico 或 uv run mcp2serial --config Pico ``` ## 文档 - [安装指南](./docs/zh/installation.md) - [API文档](./docs/zh/api.md) - [配置说明](./docs/zh/configuration.md) ## 应用场景 1. **智能家居自动化** - 通过自然语言控制灯光、风扇等设备 - AI 根据环境自动调节设备参数 2. **工业自动化** - 智能控制生产线设备 - 实时监控和调整工艺参数 3. **教育和研究** - 物联网教学演示 - 硬件