device.scan serial

device.scan serial

device.scan serial

功能

扫描系统串口并返回串口信息数组。

语法

参数

参数类型必填默认值说明
typeString否serial设备类型;当前仅支持 serial。

返回值

类型说明
Array返回串口信息对象数组。

串口信息字段

数组中每个串口信息对象的字段如下:

字段类型必定存在说明
typeString是设备类型,固定为 serial。
portString是系统串口名称。Windows 常见值如 COM3;Linux/macOS 常见值如 /dev/ttyUSB0、/dev/tty.usbserial。打开串口时传给 device.open({port: ...})。
nameString是设备友好名称。USB 串口优先使用产品名或厂商名;无法识别时等于 port。
kindString是串口来源类型。常见值为 usb、bluetooth、pci、unknown。
vidInt否USB Vendor ID。只有 USB 串口能识别到厂商 ID 时存在。
pidInt否USB Product ID。只有 USB 串口能识别到产品 ID 时存在。
serial_numberString是USB 设备序列号;系统未提供时为空字符串。
manufacturerString是USB 设备厂商名;系统未提供时为空字符串。
productString是USB 设备产品名;系统未提供时为空字符串。

示例

注意事项

  • vid 和 pid 只有 USB 串口识别到硬件 ID 时才存在。
  • serial_number、manufacturer、product 字段必定存在,但系统未提供对应值时为空字符串。