serial_port.py 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393
  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. self.raw_response_buffer = []
  42. def list_ports(self):
  43. """列出系统中可用的串口"""
  44. ports = []
  45. try:
  46. # 首先尝试使用serial.tools.list_ports
  47. try:
  48. detected_ports = [port.device for port in serial.tools.list_ports.comports()]
  49. ports.extend(detected_ports)
  50. except Exception as e:
  51. logger.warning(f"使用serial.tools.list_ports失败: {str(e)}")
  52. # 根据不同平台进行补充查找
  53. system = platform.system()
  54. if system == 'Windows':
  55. try:
  56. import winreg
  57. # 在Windows系统中读取注册表
  58. key = winreg.OpenKey(winreg.HKEY_LOCAL_MACHINE,
  59. r'HARDWARE\DEVICEMAP\SERIALCOMM')
  60. i = 0
  61. while True:
  62. try:
  63. port, value, _ = winreg.EnumValue(key, i)
  64. if value not in ports:
  65. ports.append(value)
  66. i += 1
  67. except OSError:
  68. break
  69. except Exception as e:
  70. logger.error(f"读取Windows串口注册表失败: {str(e)}")
  71. elif system == 'Darwin': # macOS
  72. # 使用glob查找/dev/tty.*设备
  73. darwin_ports = glob.glob('/dev/tty.*')
  74. # 过滤掉不需要的端口
  75. for port in darwin_ports:
  76. if not ('Bluetooth' in port or 'debug' in port or 'com.apple' in port) and port not in ports:
  77. ports.append(port)
  78. elif system == 'Linux':
  79. # 使用glob查找Linux系统中的串口
  80. linux_ports = glob.glob('/dev/ttyS*') + glob.glob('/dev/ttyUSB*') + glob.glob('/dev/ttyACM*')
  81. for port in linux_ports:
  82. if port not in ports:
  83. ports.append(port)
  84. logger.info(f"找到 {len(ports)} 个可用串口: {ports}")
  85. except Exception as e:
  86. logger.error(f"列出串口时出错: {str(e)}")
  87. return sorted(ports) # 排序返回
  88. def connect(self, port, baudrate=9600, timeout=1, **kwargs):
  89. """连接到串口"""
  90. try:
  91. # 构建配置
  92. config = SerialConfig(
  93. port=port,
  94. baudrate=baudrate,
  95. timeout=timeout,
  96. **kwargs
  97. )
  98. with self.lock:
  99. if self.is_connected:
  100. self.disconnect()
  101. logger.info(f"尝试连接串口: {port}, 波特率: {baudrate}")
  102. self.ser = serial.Serial(
  103. port=config.port,
  104. baudrate=config.baudrate,
  105. bytesize=config.bytesize,
  106. parity=config.parity,
  107. stopbits=config.stopbits,
  108. timeout=config.timeout,
  109. xonxoff=config.xonxoff,
  110. rtscts=config.rtscts,
  111. dsrdtr=config.dsrdtr
  112. )
  113. # 检查连接是否成功
  114. if not self.ser.is_open:
  115. raise Exception("串口打开失败")
  116. self.is_connected = True
  117. self.stop_event.clear()
  118. self.current_config = config
  119. self.reconnect_attempts = 0
  120. # 启动读取线程
  121. self.read_thread = threading.Thread(target=self._read_loop, daemon=True)
  122. self.read_thread.start()
  123. if self.status_callback:
  124. self.status_callback(True)
  125. logger.info(f"已连接到 {port},波特率 {baudrate}")
  126. return True, f"已连接到 {port},波特率 {baudrate}"
  127. except Exception as e:
  128. error_msg = f"连接失败: {str(e)}"
  129. logger.error(error_msg)
  130. if self.status_callback:
  131. self.status_callback(False)
  132. if self.error_callback:
  133. self.error_callback(error_msg)
  134. return False, error_msg
  135. def disconnect(self):
  136. """断开串口连接"""
  137. try:
  138. with self.lock:
  139. logger.info("断开串口连接")
  140. self.stop_event.set()
  141. if self.read_thread and self.read_thread.is_alive():
  142. self.read_thread.join(timeout=2.0)
  143. if self.read_thread.is_alive():
  144. logger.warning("读取线程未能正常终止")
  145. if self.ser and self.ser.is_open:
  146. try:
  147. self.ser.close()
  148. except Exception as e:
  149. logger.error(f"关闭串口时出错: {str(e)}")
  150. finally:
  151. self.ser = None
  152. self.is_connected = False
  153. self.current_config = None
  154. if self.status_callback:
  155. self.status_callback(False)
  156. return True, "已断开连接"
  157. except Exception as e:
  158. error_msg = f"断开连接失败: {str(e)}"
  159. logger.error(error_msg)
  160. if self.error_callback:
  161. self.error_callback(error_msg)
  162. return False, error_msg
  163. def _read_loop(self):
  164. """读取串口数据的循环"""
  165. logger.info("启动串口读取线程")
  166. while not self.stop_event.is_set():
  167. try:
  168. if self.ser and self.ser.is_open:
  169. # 使用in_waiting提高效率
  170. if self.ser.in_waiting > 0:
  171. data = self.ser.read(self.ser.in_waiting)
  172. # 默认将原始数据以十六进制存入缓冲区
  173. hex_data = data.hex()
  174. with self.lock:
  175. self.raw_response_buffer.append(hex_data)
  176. if self.data_callback:
  177. self.data_callback(hex_data)
  178. # 如果能解码为文本,也通知回调
  179. try:
  180. decoded_data = data.decode('utf-8').strip()
  181. if decoded_data and self.data_callback:
  182. self.data_callback(decoded_data)
  183. except:
  184. pass
  185. time.sleep(0.001)
  186. except Exception as e:
  187. error_msg = f"读取串口数据错误: {str(e)}"
  188. logger.error(error_msg)
  189. if self.error_callback:
  190. self.error_callback(error_msg)
  191. # 尝试重连
  192. if self._should_reconnect():
  193. logger.warning(f"尝试重连串口... (第{self.reconnect_attempts}次)")
  194. if self.current_config:
  195. # 等待一段时间后重连
  196. time.sleep(2)
  197. self.connect(
  198. port=self.current_config.port,
  199. baudrate=self.current_config.baudrate,
  200. timeout=self.current_config.timeout,
  201. bytesize=self.current_config.bytesize,
  202. parity=self.current_config.parity,
  203. stopbits=self.current_config.stopbits,
  204. xonxoff=self.current_config.xonxoff,
  205. rtscts=self.current_config.rtscts,
  206. dsrdtr=self.current_config.dsrdtr
  207. )
  208. break
  209. # 线程结束时清理资源
  210. logger.info("串口读取线程结束")
  211. # 只有错误退出才断开连接,stop_event触发的暂停不重置
  212. if not self.stop_event.is_set():
  213. with self.lock:
  214. self.is_connected = False
  215. if self.ser:
  216. try:
  217. self.ser.close()
  218. except:
  219. pass
  220. self.ser = None
  221. if self.status_callback:
  222. self.status_callback(False)
  223. def send_data(self, data, encoding='utf-8'):
  224. """发送数据到串口"""
  225. try:
  226. with self.lock:
  227. if not self.is_connected or not self.ser or not self.ser.is_open:
  228. return False, "串口未连接"
  229. # 确保数据以换行符结束
  230. if isinstance(data, str):
  231. if not data.endswith('\n'):
  232. data += '\n'
  233. bytes_data = data.encode(encoding)
  234. elif isinstance(data, bytes):
  235. if not data.endswith(b'\n'):
  236. bytes_data = data + b'\n'
  237. else:
  238. bytes_data = data
  239. else:
  240. raise TypeError("数据必须是字符串或字节类型")
  241. bytes_sent = self.ser.write(bytes_data)
  242. self.ser.flush() # 确保数据被发送
  243. logger.debug(f"发送数据到串口: {bytes_data.hex()[:50]}... (共{bytes_sent}字节)")
  244. return True, "发送成功"
  245. except Exception as e:
  246. error_msg = f"发送失败: {str(e)}"
  247. logger.error(error_msg)
  248. if self.error_callback:
  249. self.error_callback(error_msg)
  250. return False, error_msg
  251. def set_data_callback(self, callback):
  252. """设置数据接收回调函数"""
  253. self.data_callback = callback
  254. def set_status_callback(self, callback):
  255. """设置状态变化回调函数"""
  256. self.status_callback = callback
  257. def set_error_callback(self, callback):
  258. """设置错误回调函数"""
  259. self.error_callback = callback
  260. def get_status(self):
  261. """获取当前连接状态"""
  262. with self.lock:
  263. return {
  264. 'connected': self.is_connected,
  265. 'config': self.current_config,
  266. 'has_error': self.reconnect_attempts > 0
  267. }
  268. def _should_reconnect(self):
  269. """判断是否应该尝试重连"""
  270. self.reconnect_attempts += 1
  271. return self.reconnect_attempts <= self.max_reconnect_attempts
  272. def send_raw(self, data: bytes):
  273. """send raw binary data without adding newline"""
  274. try:
  275. with self.lock:
  276. if not self.is_connected or not self.ser or not self.ser.is_open:
  277. return False, "serial port not connected"
  278. bytes_sent = self.ser.write(data)
  279. self.ser.flush()
  280. return True, "send ok"
  281. except Exception as e:
  282. error_msg = "send raw failed: " + str(e)
  283. logger.error(error_msg)
  284. if self.error_callback:
  285. self.error_callback(error_msg)
  286. return False, error_msg
  287. def flush_input(self):
  288. """清空输入缓冲区"""
  289. try:
  290. with self.lock:
  291. if self.ser and self.ser.is_open:
  292. self.ser.reset_input_buffer()
  293. return True, "输入缓冲区已清空"
  294. return False, "串口未连接"
  295. except Exception as e:
  296. error_msg = f"清空缓冲区失败: {str(e)}"
  297. logger.error(error_msg)
  298. return False, error_msg
  299. def flush_output(self):
  300. """清空输出缓冲区"""
  301. try:
  302. with self.lock:
  303. if self.ser and self.ser.is_open:
  304. self.ser.reset_output_buffer()
  305. return True, "输出缓冲区已清空"
  306. return False, "串口未连接"
  307. except Exception as e:
  308. error_msg = f"清空缓冲区失败: {str(e)}"
  309. logger.error(error_msg)
  310. return False, error_msg
  311. def send_and_wait(self, data: bytes, timeout: float = 2.0, min_response_bytes: int = 1) -> bytes:
  312. """sync send and wait (read from buffer, thread continues running)"""
  313. import time
  314. # Clear buffer and send
  315. self.raw_response_buffer.clear()
  316. with self.lock:
  317. if not self.ser or not self.ser.is_open:
  318. return b''
  319. self.ser.reset_input_buffer()
  320. self.ser.write(data)
  321. self.ser.flush()
  322. response = b''
  323. start = time.time()
  324. while time.time() - start < timeout:
  325. while self.raw_response_buffer:
  326. hex_str = self.raw_response_buffer.pop(0)
  327. try:
  328. chunk = bytes.fromhex(hex_str)
  329. response += chunk
  330. if len(response) >= min_response_bytes:
  331. time.sleep(0.3)
  332. while self.raw_response_buffer:
  333. try:
  334. response += bytes.fromhex(self.raw_response_buffer.pop(0))
  335. except:
  336. pass
  337. return response
  338. except:
  339. pass
  340. time.sleep(0.01)
  341. return response
  342. # 创建全局串口实例
  343. global_serial = SerialPort()