test_modbus_rtu.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458
  1. """V5 协议 (modbus_rtu) 单元测试。
  2. V5 (20261023) 相对 V4 的变化:
  3. 1. 取消广播发现/自动分配地址,地址由配置卡写入线架。
  4. 2. 地址查询握手(16 字节):
  5. 0x80 查询: [add][0x80][12 字节 UID][CRC_L][CRC_H]
  6. - 已绑定地址 -> 携带绑定 UID;未绑定地址 -> 12 字节全 0
  7. 0x81 应答: [add][0x81][12 字节 UID][CRC_L][CRC_H](线架自身 UID)
  8. 0x82 确认: [add][0x82][12 字节 UID][CRC_L][CRC_H]
  9. 0x83 应答: [add][0x83][12 字节 UID][CRC_L][CRC_H]
  10. 3. 批量读卡回归标准 MODBUS 0x03(帧内不再带 UID):
  11. 请求 8B: [add][0x03][0x00][0x02][0x00][0x48][CRC_L][CRC_H]
  12. 响应 149B: [add][0x03][0x90][144 数据字节][CRC_L][CRC_H]
  13. 每张卡 6 字节;无卡标记 = FF FF FF FF FF FF
  14. 4. 配置地址状态: 发送 AA B7 00 07 80 00 00 FF 00 00 02 64 03,
  15. 应答 55 00 00 02 [ANTLIST] [ADDR] [XOR] 03。
  16. 注: 过渡期兼容 V4 旧固件 161B 批量读响应(尾部多 12 字节 UID,UID 忽略)。
  17. """
  18. import sys
  19. import os
  20. from unittest.mock import MagicMock
  21. import pytest
  22. sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
  23. from modules.modbus_rtu import ( # noqa: E402
  24. ModbusRTUClient,
  25. calculate_crc16,
  26. verify_crc16,
  27. build_read_cards_request,
  28. build_address_query_request,
  29. parse_address_query_response,
  30. build_address_confirm_request,
  31. parse_address_confirm_response,
  32. build_config_address_enter_frame,
  33. parse_config_address_response,
  34. CARD_REG_ADDR,
  35. CARD_REG_QUANTITY,
  36. CARD_DATA_BYTES,
  37. ANTENNA_COUNT,
  38. NO_TAG_BYTES,
  39. BULK_RESPONSE_LEN,
  40. BULK_REQUEST_LEN,
  41. BULK_BYTE_COUNT,
  42. ADDRESS_FRAME_LEN,
  43. ZERO_UID,
  44. CONFIG_ADDRESS_ENTER_FRAME,
  45. ANTENNA_ADDRESSES,
  46. )
  47. # 协议文档示例 UID: 51 00 12 00 11 00 00 4C 30 31 33 56
  48. PANEL_UID = bytes.fromhex('510012001100004c30313356')
  49. PANEL_UID_HEX = PANEL_UID.hex()
  50. # 文档示例帧
  51. DOC_QUERY_ZERO = bytes.fromhex('0180' + '00' * 12 + '5401')
  52. DOC_QUERY_RESP = bytes.fromhex('0181510012001100004c30313356d0d3')
  53. DOC_CONFIRM_REQ = bytes.fromhex('0182510012001100004c30313356d510')
  54. DOC_CONFIRM_RESP = bytes.fromhex('0183510012001100004c30313356d791')
  55. DOC_READ_REQ = bytes.fromhex('010300020048e43c')
  56. DOC_CONFIG_ENTER = bytes.fromhex('aab70007800000ff0000026403')
  57. def build_bulk_response(addr: int, tag_data: bytes) -> bytes:
  58. """构造合法的 149 字节 V5 批量读响应帧。"""
  59. assert len(tag_data) == CARD_DATA_BYTES, f"tag_data 必须 {CARD_DATA_BYTES} 字节"
  60. frame = bytes([addr, 0x03, BULK_BYTE_COUNT]) + tag_data
  61. return frame + calculate_crc16(frame)
  62. def build_legacy_uid_bulk_response(addr: int, tag_data: bytes, uid: bytes = PANEL_UID) -> bytes:
  63. """构造 V4 旧固件 161 字节响应帧(尾部多 12 字节 UID)。"""
  64. assert len(tag_data) == CARD_DATA_BYTES
  65. assert len(uid) == 12
  66. frame = bytes([addr, 0x03, BULK_BYTE_COUNT]) + tag_data + uid
  67. return frame + calculate_crc16(frame)
  68. def build_exception_response(addr: int, function_code: int, exception_code: int) -> bytes:
  69. """构造 Modbus 异常响应帧 (5 字节)。"""
  70. frame = bytes([addr, function_code | 0x80, exception_code])
  71. return frame + calculate_crc16(frame)
  72. def build_config_response(antenna: int, addr: int, prefix: bytes = b'', suffix: bytes = b'') -> bytes:
  73. """构造配置卡应答帧 55 00 00 02 ANTLIST ADDR XOR 03。"""
  74. head = bytes([0x55, 0x00, 0x00, 0x02, antenna, addr])
  75. xor = 0
  76. for b in head:
  77. xor ^= b
  78. return prefix + head + bytes([xor, 0x03]) + suffix
  79. class TestAddressQueryProtocol:
  80. """0x80 / 0x81 地址查询。"""
  81. def test_build_query_zero_uid_matches_doc(self):
  82. """未绑定地址探测: 01 80 + 12×00 + CRC(54 01)。"""
  83. assert build_address_query_request(0x01, None) == DOC_QUERY_ZERO
  84. assert build_address_query_request(0x01) == DOC_QUERY_ZERO
  85. def test_build_query_with_uid(self):
  86. frame = build_address_query_request(0x01, PANEL_UID_HEX)
  87. assert len(frame) == ADDRESS_FRAME_LEN
  88. assert frame[:2] == bytes([0x01, 0x80])
  89. assert frame[2:14] == PANEL_UID
  90. assert frame[14:] == calculate_crc16(frame[:14])
  91. def test_parse_query_response_matches_doc(self):
  92. result = parse_address_query_response(DOC_QUERY_RESP)
  93. assert 'error' not in result
  94. assert result['success'] is True
  95. assert result['device_address'] == 0x01
  96. assert result['uid'] == PANEL_UID_HEX
  97. def test_parse_query_response_zero_uid_is_invalid(self):
  98. frame = bytes([0x01, 0x81]) + ZERO_UID
  99. result = parse_address_query_response(frame + calculate_crc16(frame))
  100. assert result['success'] is True
  101. assert result['uid'] is None
  102. def test_parse_query_response_all_ff_uid_is_invalid(self):
  103. frame = bytes([0x01, 0x81]) + b'\xff' * 12
  104. result = parse_address_query_response(frame + calculate_crc16(frame))
  105. assert result['uid'] is None
  106. def test_parse_query_response_crc_failure(self):
  107. bad = bytearray(DOC_QUERY_RESP)
  108. bad[-1] ^= 0xFF
  109. result = parse_address_query_response(bytes(bad))
  110. assert 'error' in result
  111. assert 'CRC' in result['error']
  112. def test_parse_query_response_wrong_function_code(self):
  113. frame = bytes([0x01, 0x82]) + PANEL_UID
  114. result = parse_address_query_response(frame + calculate_crc16(frame))
  115. assert 'error' in result
  116. def test_parse_query_response_exception(self):
  117. result = parse_address_query_response(build_exception_response(0x01, 0x80, 0x02))
  118. assert 'error' in result
  119. def test_parse_query_response_short(self):
  120. assert 'error' in parse_address_query_response(b'')
  121. assert 'error' in parse_address_query_response(DOC_QUERY_RESP[:8])
  122. class TestAddressConfirmProtocol:
  123. """0x82 / 0x83 地址确认。"""
  124. def test_build_confirm_matches_doc(self):
  125. assert build_address_confirm_request(0x01, PANEL_UID_HEX) == DOC_CONFIRM_REQ
  126. def test_parse_confirm_matches_doc(self):
  127. result = parse_address_confirm_response(DOC_CONFIRM_RESP)
  128. assert 'error' not in result
  129. assert result['success'] is True
  130. assert result['device_address'] == 0x01
  131. assert result['uid'] == PANEL_UID_HEX
  132. def test_parse_confirm_wrong_function_code(self):
  133. frame = bytes([0x01, 0x81]) + PANEL_UID
  134. result = parse_address_confirm_response(frame + calculate_crc16(frame))
  135. assert 'error' in result
  136. class TestModbusClientAddressOps:
  137. """ModbusRTUClient 的 0x80/0x82 客户端方法。"""
  138. def setup_method(self):
  139. self.client = ModbusRTUClient(MagicMock())
  140. self.client.serial.ser = MagicMock()
  141. def test_query_address_sends_doc_frame(self):
  142. self.client.serial.send_and_wait.return_value = DOC_QUERY_RESP
  143. result = self.client.query_address(0x01, uid=None)
  144. assert 'error' not in result
  145. assert result['uid'] == PANEL_UID_HEX
  146. sent = self.client.serial.send_and_wait.call_args[0][0]
  147. assert sent == DOC_QUERY_ZERO
  148. assert self.client.serial.send_and_wait.call_args.kwargs['min_response_bytes'] == ADDRESS_FRAME_LEN
  149. def test_confirm_address_sends_doc_frame(self):
  150. self.client.serial.send_and_wait.return_value = DOC_CONFIRM_RESP
  151. result = self.client.confirm_address(0x01, PANEL_UID_HEX)
  152. assert 'error' not in result
  153. assert result['uid'] == PANEL_UID_HEX
  154. sent = self.client.serial.send_and_wait.call_args[0][0]
  155. assert sent == DOC_CONFIRM_REQ
  156. def test_query_address_invalid_uid(self):
  157. result = self.client.query_address(0x01, uid=b'\x00' * 11)
  158. assert 'error' in result
  159. def test_query_address_serial_not_connected(self):
  160. self.client.serial.ser = None
  161. assert 'error' in self.client.query_address(0x01)
  162. def test_query_address_timeout(self):
  163. self.client.serial.send_and_wait.return_value = b''
  164. result = self.client.query_address(0x01)
  165. assert 'error' in result
  166. class TestReadAllAntennaCards:
  167. """V5 标准 MODBUS 0x03 批量读。"""
  168. def setup_method(self):
  169. self.client = ModbusRTUClient(MagicMock())
  170. self.client.serial.ser = MagicMock()
  171. def _mock_response(self, response_bytes: bytes):
  172. self.client.serial.send_and_wait.return_value = response_bytes
  173. def test_request_frame_matches_doc(self):
  174. """请求固定 8 字节: 01 03 00 02 00 48 E4 3C。"""
  175. self._mock_response(build_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  176. self.client.read_all_antenna_cards(0x01)
  177. sent = self.client.serial.send_and_wait.call_args[0][0]
  178. assert sent == DOC_READ_REQ
  179. assert len(sent) == BULK_REQUEST_LEN
  180. assert build_read_cards_request(0x01) == DOC_READ_REQ
  181. def test_min_response_bytes_is_149(self):
  182. self._mock_response(build_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  183. self.client.read_all_antenna_cards(0x01)
  184. kwargs = self.client.serial.send_and_wait.call_args.kwargs
  185. assert kwargs.get('min_response_bytes') == BULK_RESPONSE_LEN
  186. def test_no_panel_uid_in_v5_result(self):
  187. """V5 读卡结果不再包含 panel_uid(UID 走 0x80 查询)。"""
  188. self._mock_response(build_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  189. result = self.client.read_all_antenna_cards(0x01)
  190. assert 'error' not in result
  191. assert 'panel_uid' not in result
  192. def test_legacy_161_response_tolerated(self):
  193. """过渡期: V4 旧固件 161B 响应仍可解析,UID 忽略。"""
  194. self._mock_response(build_legacy_uid_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  195. result = self.client.read_all_antenna_cards(0x01)
  196. assert 'error' not in result
  197. assert len(result['cards']) == ANTENNA_COUNT
  198. assert 'panel_uid' not in result
  199. def test_no_tag_response(self):
  200. self._mock_response(build_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  201. result = self.client.read_all_antenna_cards(0x01)
  202. assert result['success'] is True
  203. assert result['device_address'] == 0x01
  204. assert result['function_code'] == 0x03
  205. assert len(result['cards']) == ANTENNA_COUNT
  206. for idx, card in enumerate(result['cards']):
  207. assert card['antenna'] == idx + 1
  208. assert card['present'] is False
  209. assert card['card_str'] == ''
  210. assert card['uid'] == ''
  211. def test_tag_on_antenna_24(self):
  212. tag = bytes([0xED, 0x9A, 0x57, 0xF9, 0x50, 0x01])
  213. tag_data = NO_TAG_BYTES * 23 + tag
  214. self._mock_response(build_bulk_response(0x03, tag_data))
  215. result = self.client.read_all_antenna_cards(0x03)
  216. cards = result['cards']
  217. assert len(cards) == 24
  218. assert all(not c['present'] for c in cards[:23])
  219. assert cards[23]['present'] is True
  220. assert cards[23]['card_str'] == 'ed9a57f95001'
  221. assert cards[23]['uid'] == 'ed:9a:57:f9:50:01'
  222. def test_tag_on_antenna_1(self):
  223. tag = bytes([0xAA, 0xBB, 0xCC, 0xDD, 0xEE, 0xFF])
  224. self._mock_response(build_bulk_response(0x01, tag + NO_TAG_BYTES * 23))
  225. result = self.client.read_all_antenna_cards(0x01)
  226. assert result['cards'][0]['present'] is True
  227. assert result['cards'][0]['card_str'] == 'aabbccddeeff'
  228. for i in range(1, 24):
  229. assert result['cards'][i]['present'] is False
  230. def test_multiple_tags(self):
  231. tag1 = bytes([0x11, 0x22, 0x33, 0x44, 0x55, 0x66])
  232. tag12 = bytes([0x77, 0x88, 0x99, 0xAA, 0xBB, 0xCC])
  233. tag24 = bytes([0xDD, 0xEE, 0xFF, 0x00, 0x11, 0x22])
  234. tag_data = bytearray(NO_TAG_BYTES * ANTENNA_COUNT)
  235. tag_data[0:6] = tag1
  236. tag_data[11 * 6:12 * 6] = tag12
  237. tag_data[23 * 6:24 * 6] = tag24
  238. self._mock_response(build_bulk_response(0x01, bytes(tag_data)))
  239. result = self.client.read_all_antenna_cards(0x01)
  240. assert result['cards'][0]['card_str'] == '112233445566'
  241. assert result['cards'][11]['card_str'] == '778899aabbcc'
  242. assert result['cards'][23]['card_str'] == 'ddeeff001122'
  243. assert result['cards'][1]['present'] is False
  244. def test_crc_failure(self):
  245. response = bytearray(build_bulk_response(0x01, NO_TAG_BYTES * ANTENNA_COUNT))
  246. response[-1] ^= 0xFF
  247. self._mock_response(bytes(response))
  248. result = self.client.read_all_antenna_cards(0x01)
  249. assert 'error' in result
  250. assert 'CRC' in result['error']
  251. def test_short_frame(self):
  252. self._mock_response(bytes([0x01, 0x03, 0x90] + [0xFF] * 7))
  253. assert 'error' in self.client.read_all_antenna_cards(0x01)
  254. def test_exception_response(self):
  255. self._mock_response(build_exception_response(0x01, 0x03, 0x02))
  256. result = self.client.read_all_antenna_cards(0x01)
  257. assert 'error' in result
  258. assert 'exception' in result['error'].lower()
  259. def test_unexpected_function_code(self):
  260. frame = bytes([0x01, 0x04, BULK_BYTE_COUNT]) + NO_TAG_BYTES * ANTENNA_COUNT
  261. self._mock_response(frame + calculate_crc16(frame))
  262. assert 'error' in self.client.read_all_antenna_cards(0x01)
  263. def test_serial_not_connected(self):
  264. self.client.serial.ser = None
  265. assert 'error' in self.client.read_all_antenna_cards(0x01)
  266. def test_empty_response(self):
  267. self._mock_response(b'')
  268. assert 'error' in self.client.read_all_antenna_cards(0x01)
  269. class TestReadAntennaCardSingle:
  270. """单卡提取 (向后兼容包装)。"""
  271. def setup_method(self):
  272. self.client = ModbusRTUClient(MagicMock())
  273. self.client.serial.ser = MagicMock()
  274. def test_extract_antenna_1_with_tag(self):
  275. tag = bytes([0xDE, 0xAD, 0xBE, 0xEF, 0x00, 0x01])
  276. self.client.serial.send_and_wait.return_value = build_bulk_response(
  277. 0x01, tag + NO_TAG_BYTES * 23)
  278. result = self.client.read_antenna_card(0x01, 1)
  279. assert 'error' not in result
  280. assert result['antenna'] == 1
  281. assert result['card_number_str'] == 'deadbeef0001'
  282. assert result['uid'] == 'de:ad:be:ef:00:01'
  283. assert result['card_number'] == int.from_bytes(tag, 'big')
  284. assert result['card_number_hex'] == f'0x{int.from_bytes(tag, "big"):012x}'
  285. def test_extract_antenna_no_tag(self):
  286. self.client.serial.send_and_wait.return_value = build_bulk_response(
  287. 0x01, NO_TAG_BYTES * 24)
  288. result = self.client.read_antenna_card(0x01, 5)
  289. assert result['antenna'] == 5
  290. assert result['card_number_str'] == ''
  291. assert result['uid'] == ''
  292. def test_invalid_antenna_number(self):
  293. assert 'error' in self.client.read_antenna_card(0x01, 25)
  294. assert 'error' in self.client.read_antenna_card(0x01, 0)
  295. def test_bulk_error_propagates(self):
  296. self.client.serial.send_and_wait.return_value = b''
  297. assert 'error' in self.client.read_antenna_card(0x01, 1)
  298. def test_does_not_send_v2_frame(self):
  299. """单卡读不得发 V2 逐天线帧 (0x0002+(n-1)*4)。"""
  300. self.client.serial.send_and_wait.return_value = build_bulk_response(
  301. 0x01, NO_TAG_BYTES * 24)
  302. self.client.read_antenna_card(0x01, 10)
  303. sent = self.client.serial.send_and_wait.call_args[0][0]
  304. assert sent == DOC_READ_REQ
  305. assert sent[2:4] != bytes([0x00, 0x26])
  306. class TestConfigAddressProtocol:
  307. """配置地址状态(刷配置卡设置地址)。"""
  308. def test_enter_frame_matches_doc(self):
  309. assert CONFIG_ADDRESS_ENTER_FRAME == DOC_CONFIG_ENTER
  310. assert build_config_address_enter_frame() == DOC_CONFIG_ENTER
  311. assert len(DOC_CONFIG_ENTER) == 13
  312. def test_parse_response_with_garbage_prefix(self):
  313. frame = build_config_response(antenna=3, addr=12)
  314. result = parse_config_address_response(b'\x00\xff' + frame + b'\x99')
  315. assert 'error' not in result
  316. assert result['antenna'] == 3
  317. assert result['address'] == 12
  318. assert result['raw_data'] == frame.hex()
  319. def test_parse_response_checks_xor(self):
  320. frame = bytearray(build_config_response(antenna=1, addr=5))
  321. frame[6] ^= 0xFF
  322. result = parse_config_address_response(bytes(frame))
  323. assert 'error' in result
  324. def test_parse_response_rejects_bad_antenna(self):
  325. assert 'error' in parse_config_address_response(build_config_response(0, 5))
  326. assert 'error' in parse_config_address_response(build_config_response(25, 5))
  327. def test_parse_response_short(self):
  328. assert 'error' in parse_config_address_response(b'')
  329. assert 'error' in parse_config_address_response(b'\x55\x00\x00\x02')
  330. class TestAntennaAddressesMapping:
  331. def test_all_antennas_share_card_register(self):
  332. for ant in range(1, 25):
  333. assert ANTENNA_ADDRESSES[ant] == CARD_REG_ADDR
  334. assert CARD_REG_QUANTITY == 0x48
  335. assert CARD_DATA_BYTES == 144
  336. class TestCrcHelpers:
  337. def test_request_crc_matches_doc(self):
  338. """文档示例请求帧 (01 03 00 02 00 48) CRC = E4 3C。"""
  339. assert calculate_crc16(bytes([0x01, 0x03, 0x00, 0x02, 0x00, 0x48])) == bytes([0xE4, 0x3C])
  340. def test_query_zero_uid_crc_matches_doc(self):
  341. frame = bytes([0x01, 0x80]) + ZERO_UID
  342. assert calculate_crc16(frame) == bytes([0x54, 0x01])
  343. def test_confirm_crc_matches_doc(self):
  344. frame = bytes([0x01, 0x82]) + PANEL_UID
  345. assert calculate_crc16(frame) == bytes([0xD5, 0x10])
  346. def test_verify_crc16_valid_frame(self):
  347. frame = bytes([0x01, 0x03, 0x90]) + b'\xff' * 144
  348. assert verify_crc16(frame + calculate_crc16(frame)) is True
  349. def test_verify_crc16_corrupted(self):
  350. frame = bytes([0x01, 0x03, 0x90]) + b'\xff' * 144
  351. crc = bytearray(calculate_crc16(frame))
  352. crc[0] ^= 0xFF
  353. assert verify_crc16(frame + bytes(crc)) is False
  354. if __name__ == '__main__':
  355. pytest.main([__file__, '-v'])