# NetSerialPortDebugger

**Repository Path**: hey_hh/net-serial-port-debugger

## Basic Information

- **Project Name**: NetSerialPortDebugger
- **Description**: 串口调试工具，使用网络转发串口数据以实现调试远程串口的需求
- **Primary Language**: C#
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 2
- **Created**: 2023-05-29
- **Last Updated**: 2025-06-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# NetSerialPortDebugger

#### 介绍
串口调试工具，使用网络转发串口数据以实现调试远程串口的需求

#### 软件架构
程序主体使用.net6实现,服务部署使用.net7  
基础结构划分情况如下  
SerialPortProxyService.Common - 核心、公共逻辑
SerialPortProxyService.Win - GUI模式逻辑，基于WPF+handycontrol
SerialPortProxyService - 服务模式逻辑
SerialPortProxyService.Test - 测试代码,用作部分单元测试不便于测试的场景
SerialPortProxyService.MSTest - 单元测试,基于MSTest框架
SerialPortProxyService.Console - 部分测试代码,命令行模式逻辑


#### 使用说明
提供双向通信功能，
将串口数据通过网络转发，
网口获取到的数据再发送给串口


其他  
互联网环境中需要进行内网穿透的配置，或是使用局域网中的路由器所提供的NAT功能临时映射到本地ip


### 程序运行模式
提供如下几种运行模式
1. GUI模式 - 作为工具性质场景使用
2. 命令行模式 - 此模式可以作为中间件在其他需要使用的位置进行调用 - 此模式支持跨平台场景
3. 系统服务模式 - 此模式可以部署为系统服务,支持windows及linux下systemd - 次模式支持跨平台场景


### 最佳实践
此处将具体实际串口设备的一端称为客户端, 将对端称呼为服务端。  
客户端需要配置服务端的ip、端口以及监听的串口。  
服务端监听本机所有的ip(当前默认端口为5000)、需要监听的串口。  


服务端需要通过虚拟串口工具模拟一对串口，
本程序监听其中一个串口，数据将自动转发到配对的串口中,需要测试的程序监听剩余的虚拟串口即可。 
客户端需要监听需要调试的串口。
需要注意首先需要启动服务端,随后启动客户端。  
后续所有串口消息均会通过网络进行转发，此过程是双向转发。  


### 命令行模式下配置文件说明
配置文件保存在appsettings.json中  
示例如下
```
{
  "Mode": "Server",
  "Net": {
    "IP": "127.0.0.1",
    "Port": 5000
  },
  "Serial": {
    "PortName": "COM1",
    "BaudRate": 9600,
    "Parity": "Odd",
    "DataBits": 8,
    "StopBits": "One"
  }
}
```

参数说明  
参数| 说明
-|-
Mode|Server:服务模式,  Client:客户端模式

net下参数
参数| 说明
-|-
IP|服务端运行ip,如果当前为服务模式将绑定网卡中的所有ip而不是使用此配置
Port|服务端运行端口


serial下参数
参数| 说明
-|-
PortName|串口名称
BaudRate|波特率
Parity|校验位: None,Odd,Even,Mark,Space
DataBits|数据位,取值范围0-8
StopBits|停止位: None,One,Two,OnePointFive



#### 参与贡献

1.  Fork 本仓库
2.  新建 Feat_xxx 分支
3.  提交代码
4.  新建 Pull Request