YStudio Y++

串口类

Y++ / YStudio 开发文档 · 一点滴

类对象支持库（不是扁平命令）。路径：支持库 → 扩展类库 → 串口类。

类型名必须写完整「串口类」。声明时自动创建，一般无需再调 创建*。

硬约束

  1. 类型名必须写「串口类」。
  2. 可先 枚举串口()；打开后读写字节/文本。
  3. 用完关闭；波特率等参数以打开方法为准。

快速开始

串口类 com
文本 ports[] = 枚举串口()
如果 (com.打开("COM3", 9600)) {
    com.写文本("AT\r\n")
    输出(com.读文本(1000))
    com.关闭()
}

串口类/创建

共 2 条。

创建串口

  • 签名：通用 创建串口()
  • 说明：本机串口（COM）会话。一般直接写「串口类 sp」，不必先调本命令。

枚举串口

  • 签名：文本数组 枚举串口()
  • 说明：枚举本机可用 COM 口名（含正被占用的口），返回文本数组。

串口类/方法

共 25 条。

打开

  • 签名：逻辑 打开(文本 端口名, [整数 波特率=9600], [整数 数据位=8], [整数 停止位=1], [整数 校验=0])
  • 说明：打开串口并应用通信参数。失败返回假，可用取错误()查看原因。
  • 参数一│文本 端口名: 如 “COM3”；COM10+ 内部自动走 \.\COMn
  • 参数二│[整数 波特率=9600]: 常用 9600/115200 等
  • 参数三│[整数 数据位=8]: 取值 5～8，默认 8
  • 参数四│[整数 停止位=1]: 1、2，或 15（表示 1.5）
  • 参数五│[整数 校验=0]: 0=无、1=奇、2=偶；少用 3=标记、4=空格

关闭

  • 签名：逻辑 关闭()
  • 说明：关闭串口句柄。已关闭再调也返回真。

是否已打开

  • 签名：逻辑 是否已打开()
  • 说明：当前是否已成功打开串口。

重置

  • 签名：无 重置()
  • 说明：关闭串口，并恢复默认：9600、8 数据位、1 停止位、校验 0（无）、超时 1000ms。

置波特率

  • 签名：逻辑 置波特率(整数 波特率)
  • 说明：设置波特率；若已打开则立即写入硬件。
  • 参数一│整数 波特率: 必须 >0，如 9600、115200

取波特率

  • 签名：整数 取波特率()
  • 说明：取当前波特率设置（未必等于设备真实协商值）。

置数据位

  • 签名：逻辑 置数据位(整数 位数)
  • 说明：设置数据位宽度；已打开时立即生效。
  • 参数一│整数 位数: 仅允许 5、6、7、8

取数据位

  • 签名：整数 取数据位()
  • 说明：取当前数据位（5～8）。

置停止位

  • 签名：逻辑 置停止位(整数 停止位)
  • 说明：设置停止位；已打开时立即生效。
  • 参数一│整数 停止位: 1、2，或 15（表示 1.5；也可用 3）

取停止位

  • 签名：整数 取停止位()
  • 说明：取当前停止位：1、2，或 15（表示 1.5）。

置校验

  • 签名：逻辑 置校验(整数 校验)
  • 说明：设置校验方式；已打开时立即生效。直接填整数，勿手写文本。
  • 参数一│整数 校验: 0=无、1=奇、2=偶；少用 3=标记、4=空格

取校验

  • 签名：整数 取校验()
  • 说明：取当前校验码：0 无、1 奇、2 偶、3 标记、4 空格。

置超时

  • 签名：逻辑 置超时(整数 毫秒)
  • 说明：设置读/写总超时（毫秒）。已打开时立即生效。
  • 参数一│整数 毫秒: ≥0；0=非阻塞读（立刻返回已有数据）；默认创建后为 1000

取超时

  • 签名：整数 取超时()
  • 说明：取当前超时毫秒数（0 表示非阻塞）。

置DTR

  • 签名：逻辑 置DTR(逻辑 开启)
  • 说明：拉高/拉低 DTR 信号线（须已打开）。
  • 参数一│逻辑 开启: 真=置位 DTR，假=清除

置RTS

  • 签名：逻辑 置RTS(逻辑 开启)
  • 说明：拉高/拉低 RTS 信号线（须已打开）。
  • 参数一│逻辑 开启: 真=置位 RTS，假=清除

清空缓冲

  • 签名：逻辑 清空缓冲([逻辑 清空接收=真], [逻辑 清空发送=真])
  • 说明：丢弃收/发缓冲区中未处理数据（须已打开）。
  • 参数一│[逻辑 清空接收=真]: 真则清空输入缓冲
  • 参数二│[逻辑 清空发送=真]: 真则清空输出缓冲

取可读字节数

  • 签名：整数 取可读字节数()
  • 说明：输入缓冲区当前可读字节数；未打开返回 0。

发送

  • 签名：逻辑 发送(文本 内容)
  • 说明：将文本按 UTF-8 编码写出（须已打开）。
  • 参数一│文本 内容: 要发送的字符串

发送字节集

  • 签名：逻辑 发送字节集(字节集 数据)
  • 说明：发送原始字节（须已打开）。
  • 参数一│字节集 数据: 可为空（空则直接成功）

接收

  • 签名：文本 接收([整数 最大字节=0], [整数 超时毫秒=-1])
  • 说明：读取数据并按 UTF-8 转成文本（须已打开）。超时无数据时返回空文本。
  • 参数一│[整数 最大字节=0]: ≤0 时默认最多读 4096 字节
  • 参数二│[整数 超时毫秒=-1]: <0 用当前置超时；≥0 仅本次覆盖

接收字节集

  • 签名：字节集 接收字节集([整数 最大字节=0], [整数 超时毫秒=-1])
  • 说明：读取原始字节（须已打开）。参数含义同「接收」。
  • 参数一│[整数 最大字节=0]: ≤0 时默认最多读 4096 字节
  • 参数二│[整数 超时毫秒=-1]: <0 用当前置超时；≥0 仅本次覆盖

取端口名

  • 签名：文本 取端口名()
  • 说明：取最近一次打开() 传入的端口名；未打开过则为空。

取错误

  • 签名：文本 取错误()
  • 说明：取最近一次失败原因；成功操作后一般为空。

枚举端口

  • 签名：文本数组 枚举端口()
  • 说明：枚举本机 COM 口名，等同自由命令「枚举串口()」。

易错对照

错误 正确
类型写成「串口」 必须「串口类」
忘记关闭 退出路径调用关闭

相关

字节集 · 管道类