# Serial Monitor

**Repository Path**: isletspace/Serial-Monitor

## Basic Information

- **Project Name**: Serial Monitor
- **Description**: 用pyside6实现的串口小工具，可以自动存储log至buffer，支持正则表达式对日志进行分块。
- **Primary Language**: Python
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-08-04
- **Last Updated**: 2023-12-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Serial Monitor

## 简介

一款 Windows / Linux 适用的串口监视器，暂时没有在 Mac 上进行开发和测试过。
具有以下特性：

- 自动遍历显示可用串口，自动存储和加在上次可用的串口
- 自动存储日志
- 利用正则表达式对接收的数据进行分块
- 可以对 OTS 传感器移动绘制进行实时绘图

## 串口参数修改

串口部分使用 `pyserial`，参数与 `pyserial` 一致，暂时不支持流控制修改。

## 日志存储

当你每次点击 `Connect` 时，就会自动创建一个秒级时间戳日志文件，日志文件名为 `log_buffer_2021-01-01_000000.log`，受到 `log_buffer_name` 的影响，如果你修改了 `log_buffer_name`，那么日志文件名也会随之改变。

如果你需要修改日志存储的路径或名称，需要使用文本工具打开 `config.json`，编辑 `log_buffer_name` 下的相关参数，可以写绝对路径，也可以写相对路径，相对路径是相对于 `serial_monitor` 的执行路径。

```json
    "log_buffer_name": "log_buffer"
```

或者

```json
    "log_buffer_name": "F:/log/log_buffer"
```

在 windows 里用 `\` 记得写成 `\\`，否则会报错。

## 数据分块

数据分块功能是利用正则表达式对文本框内当前的数据进行识别和处理的，流程如下：

1. 在文本框内输入合适的正则表达式；当正则表达式可用时，会自动存储正则表达式，下次打开软件时会自动加载；
2. 点击 `按正则表达式截取保存`，会弹出文件浏览器，提示选择分块数据的存储路径；
3. 数据分块成功时会提示分块数量，失败时会提示失败原因。

## 绘图

对 OTS 设备回传的数据，需要具有 CSV 格式，默认格式为：`ts,dx,dy`，即，单行数据为：`时间戳, x 坐标, y 坐标`。并且中间使用 `,` 分隔。
否则，绘图功能无法正常工作。

## 依赖

- pyserial==3.5
- PySide6==6.6.0
- PySide6_Essentials==6.5.2