serial_port.py 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335
  1. import serial
  2. import serial.tools.list_ports
  3. import threading
  4. import time
  5. import logging
  6. import platform
  7. import glob
  8. from dataclasses import dataclass
  9. # 配置日志
  10. logging.basicConfig(
  11. level=logging.INFO,
  12. format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
  13. )
  14. logger = logging.getLogger('serial_port')
  15. @dataclass
  16. class SerialConfig:
  17. """串口配置数据类"""
  18. port: str
  19. baudrate: int = 115200
  20. bytesize: int = serial.EIGHTBITS
  21. parity: str = serial.PARITY_NONE
  22. stopbits: int = serial.STOPBITS_ONE
  23. timeout: float = 1.0
  24. xonxoff: bool = False
  25. rtscts: bool = False
  26. dsrdtr: bool = False
  27. class SerialPort:
  28. """串口通信类,提供串口连接、读写和状态管理功能"""
  29. def __init__(self):
  30. self.ser = None
  31. self.is_connected = False
  32. self.lock = threading.RLock() # 使用可重入锁
  33. self.read_thread = None
  34. self.stop_event = threading.Event()
  35. self.data_callback = None
  36. self.status_callback = None
  37. self.error_callback = None
  38. self.current_config = None
  39. self.reconnect_attempts = 0
  40. self.max_reconnect_attempts = 3
  41. def list_ports(self):
  42. """列出系统中可用的串口"""
  43. ports = []
  44. try:
  45. # 首先尝试使用serial.tools.list_ports
  46. try:
  47. detected_ports = [port.device for port in serial.tools.list_ports.comports()]
  48. ports.extend(detected_ports)
  49. except Exception as e:
  50. logger.warning(f"使用serial.tools.list_ports失败: {str(e)}")
  51. # 根据不同平台进行补充查找
  52. system = platform.system()
  53. if system == 'Windows':
  54. try:
  55. import winreg
  56. # 在Windows系统中读取注册表
  57. key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE,
  58. r'HARDWARE\DEVICEMAP\SERIALCOMM')
  59. i = 0
  60. while True:
  61. try:
  62. port, value, _ = winreg.EnumValue(key, i)
  63. if value not in ports:
  64. ports.append(value)
  65. i += 1
  66. except OSError:
  67. break
  68. except Exception as e:
  69. logger.error(f"读取Windows串口注册表失败: {str(e)}")
  70. elif system == 'Darwin': # macOS
  71. # 使用glob查找/dev/tty.*设备
  72. darwin_ports = glob.glob('/dev/tty.*')
  73. # 过滤掉不需要的端口
  74. for port in darwin_ports:
  75. if not ('Bluetooth' in port or 'debug' in port or 'com.apple' in port) and port not in ports:
  76. ports.append(port)
  77. elif system == 'Linux':
  78. # 使用glob查找Linux系统中的串口
  79. linux_ports = glob.glob('/dev/ttyS*') + glob.glob('/dev/ttyUSB*') + glob.glob('/dev/ttyACM*')
  80. for port in linux_ports:
  81. if port not in ports:
  82. ports.append(port)
  83. logger.info(f"找到 {len(ports)} 个可用串口: {ports}")
  84. except Exception as e:
  85. logger.error(f"列出串口时出错: {str(e)}")
  86. return sorted(ports) # 排序返回
  87. def connect(self, port, baudrate=9600, timeout=1, **kwargs):
  88. """连接到串口"""
  89. try:
  90. # 构建配置
  91. config = SerialConfig(
  92. port=port,
  93. baudrate=baudrate,
  94. timeout=timeout,
  95. **kwargs
  96. )
  97. with self.lock:
  98. if self.is_connected:
  99. self.disconnect()
  100. logger.info(f"尝试连接串口: {port}, 波特率: {baudrate}")
  101. self.ser = serial.Serial(
  102. port=config.port,
  103. baudrate=config.baudrate,
  104. bytesize=config.bytesize,
  105. parity=config.parity,
  106. stopbits=config.stopbits,
  107. timeout=config.timeout,
  108. xonxoff=config.xonxoff,
  109. rtscts=config.rtscts,
  110. dsrdtr=config.dsrdtr
  111. )
  112. # 检查连接是否成功
  113. if not self.ser.is_open:
  114. raise Exception("串口打开失败")
  115. self.is_connected = True
  116. self.stop_event.clear()
  117. self.current_config = config
  118. self.reconnect_attempts = 0
  119. # 启动读取线程
  120. self.read_thread = threading.Thread(target=self._read_loop, daemon=True)
  121. self.read_thread.start()
  122. if self.status_callback:
  123. self.status_callback(True)
  124. logger.info(f"已连接到 {port},波特率 {baudrate}")
  125. return True, f"已连接到 {port},波特率 {baudrate}"
  126. except Exception as e:
  127. error_msg = f"连接失败: {str(e)}"
  128. logger.error(error_msg)
  129. if self.status_callback:
  130. self.status_callback(False)
  131. if self.error_callback:
  132. self.error_callback(error_msg)
  133. return False, error_msg
  134. def disconnect(self):
  135. """断开串口连接"""
  136. try:
  137. with self.lock:
  138. logger.info("断开串口连接")
  139. self.stop_event.set()
  140. if self.read_thread and self.read_thread.is_alive():
  141. self.read_thread.join(timeout=2.0)
  142. if self.read_thread.is_alive():
  143. logger.warning("读取线程未能正常终止")
  144. if self.ser and self.ser.is_open:
  145. try:
  146. self.ser.close()
  147. except Exception as e:
  148. logger.error(f"关闭串口时出错: {str(e)}")
  149. finally:
  150. self.ser = None
  151. self.is_connected = False
  152. self.current_config = None
  153. if self.status_callback:
  154. self.status_callback(False)
  155. return True, "已断开连接"
  156. except Exception as e:
  157. error_msg = f"断开连接失败: {str(e)}"
  158. logger.error(error_msg)
  159. if self.error_callback:
  160. self.error_callback(error_msg)
  161. return False, error_msg
  162. def _read_loop(self):
  163. """读取串口数据的循环"""
  164. logger.info("启动串口读取线程")
  165. while not self.stop_event.is_set():
  166. try:
  167. if self.ser and self.ser.is_open:
  168. # 使用in_waiting提高效率
  169. if self.ser.in_waiting > 0:
  170. data = self.ser.read(self.ser.in_waiting)
  171. # 尝试解码,如果失败则返回原始数据
  172. try:
  173. decoded_data = data.decode('utf-8', errors='replace').strip()
  174. if decoded_data and self.data_callback:
  175. self.data_callback(decoded_data)
  176. except Exception as e:
  177. # 对于无法解码的二进制数据,以十六进制形式返回
  178. hex_data = data.hex()
  179. if hex_data and self.data_callback:
  180. self.data_callback(hex_data)
  181. logger.warning(f"收到无法解码的二进制数据,长度: {len(data)}字节")
  182. time.sleep(0.001)
  183. except Exception as e:
  184. error_msg = f"读取串口数据错误: {str(e)}"
  185. logger.error(error_msg)
  186. if self.error_callback:
  187. self.error_callback(error_msg)
  188. # 尝试重连
  189. if self._should_reconnect():
  190. logger.warning(f"尝试重连串口... (第{self.reconnect_attempts}次)")
  191. if self.current_config:
  192. # 等待一段时间后重连
  193. time.sleep(2)
  194. self.connect(
  195. port=self.current_config.port,
  196. baudrate=self.current_config.baudrate,
  197. timeout=self.current_config.timeout,
  198. bytesize=self.current_config.bytesize,
  199. parity=self.current_config.parity,
  200. stopbits=self.current_config.stopbits,
  201. xonxoff=self.current_config.xonxoff,
  202. rtscts=self.current_config.rtscts,
  203. dsrdtr=self.current_config.dsrdtr
  204. )
  205. break
  206. # 线程结束时清理资源
  207. logger.info("串口读取线程结束")
  208. with self.lock:
  209. self.is_connected = False
  210. if self.ser:
  211. try:
  212. self.ser.close()
  213. except:
  214. pass
  215. self.ser = None
  216. if self.status_callback:
  217. self.status_callback(False)
  218. def send_data(self, data, encoding='utf-8'):
  219. """发送数据到串口"""
  220. try:
  221. with self.lock:
  222. if not self.is_connected or not self.ser or not self.ser.is_open:
  223. return False, "串口未连接"
  224. # 确保数据以换行符结束
  225. if isinstance(data, str):
  226. if not data.endswith('\n'):
  227. data += '\n'
  228. bytes_data = data.encode(encoding)
  229. elif isinstance(data, bytes):
  230. if not data.endswith(b'\n'):
  231. bytes_data = data + b'\n'
  232. else:
  233. bytes_data = data
  234. else:
  235. raise TypeError("数据必须是字符串或字节类型")
  236. bytes_sent = self.ser.write(bytes_data)
  237. self.ser.flush() # 确保数据被发送
  238. logger.debug(f"发送数据到串口: {bytes_data.hex()[:50]}... (共{bytes_sent}字节)")
  239. return True, "发送成功"
  240. except Exception as e:
  241. error_msg = f"发送失败: {str(e)}"
  242. logger.error(error_msg)
  243. if self.error_callback:
  244. self.error_callback(error_msg)
  245. return False, error_msg
  246. def set_data_callback(self, callback):
  247. """设置数据接收回调函数"""
  248. self.data_callback = callback
  249. def set_status_callback(self, callback):
  250. """设置状态变化回调函数"""
  251. self.status_callback = callback
  252. def set_error_callback(self, callback):
  253. """设置错误回调函数"""
  254. self.error_callback = callback
  255. def get_status(self):
  256. """获取当前连接状态"""
  257. with self.lock:
  258. return {
  259. 'connected': self.is_connected,
  260. 'config': self.current_config,
  261. 'has_error': self.reconnect_attempts > 0
  262. }
  263. def _should_reconnect(self):
  264. """判断是否应该尝试重连"""
  265. self.reconnect_attempts += 1
  266. return self.reconnect_attempts <= self.max_reconnect_attempts
  267. def flush_input(self):
  268. """清空输入缓冲区"""
  269. try:
  270. with self.lock:
  271. if self.ser and self.ser.is_open:
  272. self.ser.reset_input_buffer()
  273. return True, "输入缓冲区已清空"
  274. return False, "串口未连接"
  275. except Exception as e:
  276. error_msg = f"清空缓冲区失败: {str(e)}"
  277. logger.error(error_msg)
  278. return False, error_msg
  279. def flush_output(self):
  280. """清空输出缓冲区"""
  281. try:
  282. with self.lock:
  283. if self.ser and self.ser.is_open:
  284. self.ser.reset_output_buffer()
  285. return True, "输出缓冲区已清空"
  286. return False, "串口未连接"
  287. except Exception as e:
  288. error_msg = f"清空缓冲区失败: {str(e)}"
  289. logger.error(error_msg)
  290. return False, error_msg
  291. # 创建全局串口实例
  292. global_serial = SerialPort()