modbus_rtu.py 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451
  1. from typing import Optional
  2. import threading
  3. # ========== 地址配置协议 ==========
  4. def build_broadcast_query() -> bytes:
  5. """构建广播查询指令
  6. DTU定时发送广播指令查询未配置地址的从机
  7. 格式: 00 40 00 40 00 (无CRC, 固定5字节)
  8. """
  9. return bytes([0x00, 0x40, 0x00, 0x40, 0x00])
  10. def parse_device_response(data: bytes) -> Optional[dict]:
  11. """解析从机应答
  12. 从机应答格式: 00 + 41 + 12个UID + CRC_L + CRC_H
  13. 例如: 00 41 18 00 40 00 14 00 00 59 59 54 30 56 AE 34
  14. """
  15. if len(data) < 16:
  16. return {'error': '数据长度不足', 'raw_data': data.hex()}
  17. if data[1] != 0x41:
  18. return {'error': f"非预期功能码: {data[1]:#x}", 'raw_data': data.hex()}
  19. uid_bytes = data[2:14]
  20. uid_hex = uid_bytes.hex()
  21. # CRC 校验失败则拒绝(传入完整 16 字节帧,最后两字节为 CRC)
  22. if not verify_crc16(data):
  23. return {'error': 'CRC校验失败', 'raw_data': data.hex()}
  24. # UID 有效性检查:拒绝明显是噪声或碰撞产生的数据
  25. zero_count = uid_bytes.count(0)
  26. if zero_count > 6:
  27. return {'error': f"UID中零字节过多({zero_count}/12)", 'raw_data': data.hex()}
  28. # 检查碰撞:UID 中不应有大量重复字节
  29. from collections import Counter
  30. counts = Counter(uid_bytes)
  31. if counts.most_common(1)[0][1] > 8:
  32. return {'error': f"UID中单字节重复过多({counts.most_common(1)})", 'raw_data': data.hex()}
  33. return {
  34. 'function_code': 0x41,
  35. 'uid': uid_hex,
  36. 'uid_readable': ':'.join(f'{b:02x}' for b in uid_bytes),
  37. 'source_address': data[0],
  38. 'raw_data': data.hex()
  39. }
  40. def build_confirm_address(device_address: int, uid: bytes) -> bytes:
  41. """构建确认地址指令
  42. DTU遍历已存储的UID和地址,如果存在匹配的UID则发送确认指令
  43. 格式: add + 44 + 00 + 12个UID + CRC_L + CRC_H
  44. """
  45. if len(uid) != 12:
  46. raise ValueError(f"UID长度必须是12字节,当前: {len(uid)}")
  47. data = bytes([device_address, 0x44, 0x00]) + uid
  48. return data + calculate_crc16(data)
  49. def build_assign_address(uid: bytes, address: int) -> bytes:
  50. """构建分配地址指令
  51. 如果DTU中没有该UID的记录,则分配新地址
  52. 格式: 00 + 42 + 12个UID + add + CRC_L + CRC_H
  53. """
  54. if len(uid) != 12:
  55. raise ValueError(f"UID长度必须是12字节,当前: {len(uid)}")
  56. if address < 1 or address > 247:
  57. raise ValueError(f"设备地址必须在1-247之间,当前: {address}")
  58. data = bytes([0x00, 0x42]) + uid + bytes([address])
  59. return data + calculate_crc16(data)
  60. def parse_address_assignment_response(data: bytes) -> dict:
  61. """解析地址分配响应
  62. 模块应答格式: add + 43 + 00 + CRC_L + CRC_H
  63. 例如: 01 43 00 11 30
  64. """
  65. if len(data) < 5:
  66. return {'error': '数据长度不足', 'raw_data': data.hex()}
  67. device_address = data[0]
  68. if data[1] != 0x43:
  69. return {'error': f"非预期功能码: {data[1]:#x}", 'raw_data': data.hex()}
  70. if not verify_crc16(data):
  71. logger.warning(f"CRC校验失败: {data.hex()}")
  72. return {
  73. 'device_address': device_address,
  74. 'function_code': 0x43,
  75. 'raw_data': data.hex()
  76. }
  77. class AddressConfigProtocol:
  78. """地址配置协议处理器"""
  79. def __init__(self, serial_port):
  80. self.serial = serial_port
  81. self.default_timeout = 5.0 # 设备广播响应可能较慢,给足时间
  82. self.stored_devices = {}
  83. self.config_lock = threading.RLock() # 地址配置期间占用,避免与轮询冲突
  84. def add_stored_device(self, uid: str, address: int):
  85. """添加已存储的设备"""
  86. self.stored_devices[uid] = address
  87. def get_stored_devices(self) -> dict:
  88. """获取已存储的设备列表"""
  89. return self.stored_devices.copy()
  90. def broadcast_query(self, timeout: float = None) -> list:
  91. """send broadcast query and collect all valid 00 41 responses"""
  92. import time
  93. with self.config_lock:
  94. request = build_broadcast_query()
  95. logger.info(f"send broadcast: {request.hex()}")
  96. timeout = timeout or self.default_timeout
  97. # 先清空输入缓冲区,避免残留数据干扰
  98. self.serial.flush_input()
  99. time.sleep(0.05)
  100. # 发送广播并等待响应;部分设备需要 2~3 秒才应答
  101. response = self.serial.send_and_wait(request, timeout=timeout, min_response_bytes=16)
  102. # 部分从机应答会被后台读取线程滞后收到,再额外等待一段收集窗口
  103. # 注意:这里不能再次调用 send_and_wait,因为它会清空缓冲区
  104. time.sleep(0.8)
  105. extra = b''
  106. with self.serial.lock:
  107. while self.serial.raw_response_buffer:
  108. try:
  109. extra += bytes.fromhex(self.serial.raw_response_buffer.pop(0))
  110. except Exception:
  111. self.serial.raw_response_buffer.pop(0)
  112. if self.serial.ser and self.serial.ser.is_open and self.serial.ser.in_waiting > 0:
  113. extra += self.serial.ser.read(self.serial.ser.in_waiting)
  114. if extra:
  115. logger.info(f"broadcast extra response ({len(extra)}B): {extra.hex()}")
  116. if response:
  117. response += extra
  118. else:
  119. response = extra
  120. responses = []
  121. if response and len(response) >= 16:
  122. logger.info(f"got raw response ({len(response)}B): {response.hex()}")
  123. # RS485 半双工会回显已发送的数据,导致 response 开头可能有 5 字节回显
  124. # 在 response 中搜索所有 00 41 标记,尝试从中提取 16 字节帧解析
  125. for i in range(len(response) - 15 + 1):
  126. if response[i] == 0x00 and response[i + 1] == 0x41:
  127. chunk = response[i:i + 16]
  128. if len(chunk) >= 16:
  129. parsed = parse_device_response(chunk)
  130. if "error" not in parsed:
  131. if not any(p.get('uid') == parsed['uid'] for p in responses):
  132. responses.append(parsed)
  133. else:
  134. logger.info(f"no response or too short: {len(response) if response else 0}B")
  135. logger.info(f"broadcast done, got {len(responses)} valid unique responses")
  136. return responses
  137. def _next_available_address(self) -> int:
  138. """从 1~247 中找一个未被 stored_devices 占用的地址"""
  139. used = set(self.stored_devices.values())
  140. for addr in range(1, 248):
  141. if addr not in used:
  142. return addr
  143. raise RuntimeError("Modbus 地址 1~247 已全部占用")
  144. def process_responses(self, responses: list) -> list:
  145. """处理广播查询响应:给每个应答设备分配地址(优先使用已记录地址)"""
  146. import time
  147. with self.config_lock:
  148. results = []
  149. for resp in responses:
  150. if 'error' in resp:
  151. results.append({'status': 'error', 'message': resp['error']})
  152. continue
  153. uid = resp['uid']
  154. src_addr = resp.get('source_address', 0)
  155. device_address = self.stored_devices.get(uid)
  156. # 优先使用地址表中已保存的地址;没有则分配下一个可用地址
  157. if device_address:
  158. new_address = device_address
  159. logger.info(f"UID={uid} 源地址={src_addr},地址表存在记录,分配已有地址={new_address}")
  160. else:
  161. new_address = self._next_available_address()
  162. logger.info(f"UID={uid} 源地址={src_addr},地址表无记录,分配新地址={new_address}")
  163. request = build_assign_address(bytes.fromhex(uid), new_address)
  164. logger.info(f"发送分配地址帧: {request.hex()}")
  165. self.serial.flush_input()
  166. time.sleep(0.05)
  167. success, msg = self.serial.send_raw(request)
  168. if not success:
  169. logger.error(f"UID={uid} 分配地址帧发送失败: {msg}")
  170. results.append({
  171. 'status': 'error',
  172. 'uid': uid,
  173. 'message': f"send failed: {msg}"
  174. })
  175. continue
  176. # 等待并解析从机的 43 确认响应
  177. time.sleep(0.1)
  178. ack = self.serial.send_and_wait(b'', timeout=0.5, min_response_bytes=5)
  179. ack_parsed = None
  180. if ack and len(ack) >= 5:
  181. # 过滤回显/噪声,找到 43 响应帧
  182. for i in range(len(ack) - 4):
  183. if ack[i + 1] == 0x43:
  184. chunk = ack[i:i + 5]
  185. ack_parsed = parse_address_assignment_response(chunk)
  186. break
  187. if ack_parsed and 'error' not in ack_parsed:
  188. logger.info(f"UID={uid} 地址={new_address} 已确认 (响应: {ack_parsed.get('raw_data')})")
  189. self.stored_devices[uid] = new_address
  190. results.append({
  191. 'status': 'assigned',
  192. 'uid': uid,
  193. 'address': new_address,
  194. 'request': request.hex(),
  195. 'ack': ack_parsed.get('raw_data')
  196. })
  197. else:
  198. # 即使未收到确认也保存地址:部分从机不返回 43,但实际已生效
  199. logger.warning(f"UID={uid} 地址={new_address} 未收到 43 确认,仍视为已分配")
  200. self.stored_devices[uid] = new_address
  201. results.append({
  202. 'status': 'assigned',
  203. 'uid': uid,
  204. 'address': new_address,
  205. 'request': request.hex(),
  206. 'ack': ack.hex() if ack else None
  207. })
  208. return results
  209. def auto_configure(self, timeout: float = None) -> dict:
  210. """自动配置所有未配置的设备"""
  211. with self.config_lock:
  212. logger.info("开始自动配置设备...")
  213. responses = self.broadcast_query(timeout)
  214. if not responses:
  215. return {
  216. 'success': True,
  217. 'message': '未发现任何从机设备',
  218. 'discovered': 0,
  219. 'configured': 0,
  220. 'results': []
  221. }
  222. results = self.process_responses(responses)
  223. assigned = sum(1 for r in results if r.get('status') == 'assigned')
  224. errors = sum(1 for r in results if r.get('status') == 'error')
  225. return {
  226. 'success': errors == 0,
  227. 'discovered': len(responses),
  228. 'confirmed': 0,
  229. 'assigned': assigned,
  230. 'errors': errors,
  231. 'results': results,
  232. 'stored_devices': self.get_stored_devices()
  233. }
  234. def save_config(self, filepath: str) -> bool:
  235. """保存配置到文件"""
  236. import json
  237. try:
  238. with open(filepath, 'w') as f:
  239. json.dump(self.stored_devices, f, indent=2)
  240. return True
  241. except Exception as e:
  242. logger.error(f"保存配置失败: {e}")
  243. return False
  244. def load_config(self, filepath: str) -> bool:
  245. """从文件加载配置"""
  246. import json
  247. try:
  248. with open(filepath, 'r') as f:
  249. self.stored_devices = json.load(f)
  250. return True
  251. except Exception as e:
  252. logger.error(f"加载配置失败: {e}")
  253. return False
  254. # ========== Modbus RTU Client ==========
  255. # 天线地址映射表(天线编号 -> Modbus寄存器地址)
  256. ANTENNA_ADDRESSES = {i: 0x0001 + (i - 1) for i in range(1, 25)}
  257. import struct
  258. import logging
  259. logger = logging.getLogger('serial_mqtt_gateway')
  260. def calculate_crc16(data: bytes) -> bytes:
  261. """计算Modbus CRC16校验"""
  262. crc = 0xFFFF
  263. for byte in data:
  264. crc ^= byte
  265. for _ in range(8):
  266. if crc & 0x0001:
  267. crc = (crc >> 1) ^ 0xA001
  268. else:
  269. crc >>= 1
  270. return struct.pack('<H', crc)
  271. def verify_crc16(data: bytes) -> bool:
  272. """验证Modbus CRC16校验"""
  273. if len(data) < 2:
  274. return False
  275. received_crc = struct.unpack('<H', data[-2:])[0]
  276. calculated_crc = struct.unpack('<H', calculate_crc16(data[:-2]))[0]
  277. return received_crc == calculated_crc
  278. class ModbusRTUClient:
  279. """Modbus RTU 客户端"""
  280. def __init__(self, serial_port):
  281. self.serial = serial_port
  282. self.default_timeout = 2.0
  283. def _build_request(self, device_address: int, function_code: int, data: bytes = b'') -> bytes:
  284. """构建Modbus请求帧"""
  285. pdu = bytes([device_address, function_code]) + data
  286. return pdu + calculate_crc16(pdu)
  287. def _send_receive(self, request: bytes, expected_min_len: int = 5, timeout: float = None) -> dict:
  288. """send request and receive response using sync method"""
  289. timeout = timeout or self.default_timeout
  290. if not self.serial.ser:
  291. return {"error": "serial not connected"}
  292. response = self.serial.send_and_wait(request, timeout=timeout, min_response_bytes=expected_min_len)
  293. if not response or len(response) < expected_min_len:
  294. return {"error": "response timeout or too short", "raw_data": response.hex() if response else ""}
  295. if not verify_crc16(response):
  296. logger.warning(f"CRC check failed: {response.hex()}")
  297. return {"error": "CRC check failed", "raw_data": response.hex()}
  298. return {
  299. "success": True,
  300. "device_address": response[0],
  301. "function_code": response[1],
  302. "data": response[2:-2].hex(),
  303. "raw_data": response.hex()
  304. }
  305. def read_antenna_card(self, device_address: int, antenna_num: int, timeout: float = None) -> dict:
  306. """读取天线卡号
  307. 协议: 读寄存器 0x0002+(ant-1)*4, 共4个寄存器(8字节卡号)
  308. """
  309. reg_addr = 0x0002 + (antenna_num - 1) * 4
  310. request_data = struct.pack('>HH', reg_addr, 4) # 读取4个寄存器
  311. request = self._build_request(device_address, 0x03, request_data)
  312. result = self._send_receive(request, timeout=timeout)
  313. if 'error' in result:
  314. return result
  315. data_str = result.get('data', '')
  316. data_bytes = bytes.fromhex(data_str) if isinstance(data_str, str) and data_str else b''
  317. if len(data_bytes) >= 8:
  318. # 8字节卡号, big-endian
  319. card_number = int.from_bytes(data_bytes[:8], 'big')
  320. card_str = data_bytes[:8].hex()
  321. return {
  322. 'card_number': card_number,
  323. 'card_number_hex': f'0x{card_number:016x}',
  324. 'card_number_str': card_str,
  325. 'antenna': antenna_num,
  326. 'uid': ':'.join(data_bytes[:8].hex()[i:i+2] for i in range(0, 16, 2)),
  327. **result
  328. }
  329. return {'error': f'数据长度不足({len(data_bytes)}B,需要8B)', **result}
  330. def read_holding_registers(self, device_address: int, start_address: int, quantity: int = 1, timeout: float = None) -> dict:
  331. """读取保持寄存器"""
  332. request_data = struct.pack('>HH', start_address, quantity)
  333. request = self._build_request(device_address, 0x03, request_data)
  334. result = self._send_receive(request, timeout=timeout)
  335. if 'error' in result:
  336. return result
  337. data_str = result.get('data', '')
  338. data_bytes = bytes.fromhex(data_str) if isinstance(data_str, str) and data_str else b''
  339. registers = []
  340. for i in range(0, len(data_bytes), 2):
  341. if i + 1 < len(data_bytes):
  342. registers.append(struct.unpack('>H', data_bytes[i:i+2])[0])
  343. return {'registers': registers, **result}
  344. def write_single_register(self, device_address: int, register_address: int, value: int, timeout: float = None) -> dict:
  345. """写单个寄存器"""
  346. request_data = struct.pack('>HH', register_address, value)
  347. request = self._build_request(device_address, 0x06, request_data)
  348. return self._send_receive(request, timeout=timeout)
  349. def set_rgb_led(self, device_address: int, led_number: int, color: int, timeout: float = None) -> dict:
  350. """设置RGB灯
  351. Register 0x0001, value = (led_number << 8) | color
  352. color: 0=off, 1=flashing red, 2=flashing green, 3=flashing blue
  353. """
  354. value = (led_number << 8) | (color & 0xFF)
  355. return self.write_single_register(device_address, 0x0001, value, timeout)
  356. def scan_devices(self, max_address: int = 247) -> list:
  357. """scan online devices using Modbus 03"""
  358. import time
  359. devices = []
  360. for addr in range(1, min(max_address + 1, 248)):
  361. request = self._build_request(addr, 0x03, struct.pack('>HH', 0x0000, 0x0001))
  362. response = self.serial.send_and_wait(request, timeout=0.3, min_response_bytes=5)
  363. if response and len(response) >= 5 and verify_crc16(response):
  364. devices.append(addr)
  365. return devices