read_tag.py 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746
  1. #!/usr/bin/env python3
  2. """PN5180 NFC tag reader — ported from working Pico firmware (pico-nfc-bridge.ino).
  3. Key learnings from pico-nfc-bridge.ino:
  4. - Must call setTransceiveMode() before every SEND_DATA
  5. - waitBusy() must wait for HIGH then LOW (not just LOW)
  6. - Bambu tags are MIFARE Classic 1K (ISO 14443A), not ISO 15693
  7. - SPI at 500kHz, 5µs CS setup, 100µs post-CS delay
  8. - MFC_AUTHENTICATE (0x0C) is a PN5180 host command — Crypto1 handled in hardware
  9. - HKDF-SHA256 derives per-sector keys from master key + UID
  10. """
  11. import hashlib
  12. import hmac
  13. import os
  14. import sys
  15. import time
  16. import gpiod
  17. import spidev
  18. def _env_int(name: str, default: int) -> int:
  19. value = os.environ.get(name)
  20. if value is None or value == "":
  21. return default
  22. try:
  23. return int(value)
  24. except ValueError:
  25. return default
  26. BUSY_PIN = _env_int("SPOOLBUDDY_NFC_BUSY_PIN", 25)
  27. RST_PIN = _env_int("SPOOLBUDDY_NFC_RST_PIN", 24)
  28. NSS_PIN = _env_int("SPOOLBUDDY_NFC_NSS_PIN", 23) # Manual CS by default
  29. SPI_BUS = _env_int("SPOOLBUDDY_NFC_SPI_BUS", 0)
  30. SPI_DEVICE = _env_int("SPOOLBUDDY_NFC_SPI_DEVICE", 0)
  31. SPI_SPEED_HZ = _env_int("SPOOLBUDDY_NFC_SPI_SPEED_HZ", 500_000)
  32. # Bambu Lab MIFARE Classic key derivation constants (from pico-nfc-bridge.ino)
  33. BAMBU_MASTER_KEY = bytes(
  34. [
  35. 0x9A,
  36. 0x75,
  37. 0x9C,
  38. 0xF2,
  39. 0xC4,
  40. 0xF7,
  41. 0xCA,
  42. 0xFF,
  43. 0x22,
  44. 0x2C,
  45. 0xB9,
  46. 0x76,
  47. 0x9B,
  48. 0x41,
  49. 0xBC,
  50. 0x96,
  51. ]
  52. )
  53. BAMBU_CONTEXT = b"RFID-A\x00" # 7 bytes including null terminator
  54. # Blocks to read for Bambu tag data, as daemon/pn5180.py reads them: block 6
  55. # holds the temperatures, block 9 the tray UUID (#2685)
  56. BAMBU_BLOCKS = [1, 2, 4, 5, 6, 9]
  57. # ISO 14443-3 anticollision: SEL codes of cascade levels 1-3, the cascade tag
  58. # that opens a level's four bytes when the UID goes on at the next level, and
  59. # the SAK bit that says it does. A 4-byte UID ends at level 1, a 7-byte UID
  60. # (NTAG, Ultralight) at level 2, a 10-byte UID at level 3 (#3258).
  61. CASCADE_LEVELS = (0x93, 0x95, 0x97)
  62. CASCADE_TAG = 0x88
  63. SAK_UID_INCOMPLETE = 0x04
  64. def hkdf_derive_keys(uid: bytes) -> bytes:
  65. """Derive 96 bytes of MIFARE key material (16 sectors * 6 bytes each).
  66. Uses HKDF-SHA256 with the Bambu master key as salt and the tag UID as IKM.
  67. """
  68. # HKDF-Extract: PRK = HMAC-SHA256(salt=master_key, IKM=uid)
  69. prk = hmac.new(BAMBU_MASTER_KEY, uid, hashlib.sha256).digest()
  70. # HKDF-Expand: generate 96 bytes using context "RFID-A\0"
  71. okm = b""
  72. t = b""
  73. counter = 1
  74. while len(okm) < 96:
  75. t = hmac.new(prk, t + BAMBU_CONTEXT + bytes([counter]), hashlib.sha256).digest()
  76. okm += t
  77. counter += 1
  78. return okm[:96]
  79. def get_sector_key(keys: bytes, block: int) -> bytes:
  80. """Get the 6-byte key for the sector containing the given block."""
  81. sector = block // 4
  82. return keys[sector * 6 : sector * 6 + 6]
  83. def _find_gpio_chip():
  84. for path in ["/dev/gpiochip4", "/dev/gpiochip0"]:
  85. try:
  86. chip = gpiod.Chip(path)
  87. if "pinctrl" in chip.get_info().label:
  88. return chip
  89. chip.close()
  90. except (FileNotFoundError, PermissionError, OSError):
  91. continue
  92. raise RuntimeError("No GPIO chip")
  93. class PN5180:
  94. def __init__(self):
  95. self._chip = _find_gpio_chip()
  96. self._lines = self._chip.request_lines(
  97. consumer="pn5180",
  98. config={
  99. BUSY_PIN: gpiod.LineSettings(direction=gpiod.line.Direction.INPUT),
  100. RST_PIN: gpiod.LineSettings(
  101. direction=gpiod.line.Direction.OUTPUT, output_value=gpiod.line.Value.ACTIVE
  102. ),
  103. NSS_PIN: gpiod.LineSettings(
  104. direction=gpiod.line.Direction.OUTPUT, output_value=gpiod.line.Value.ACTIVE
  105. ),
  106. },
  107. )
  108. self._spi = spidev.SpiDev()
  109. self._spi.open(SPI_BUS, SPI_DEVICE)
  110. self._spi.max_speed_hz = SPI_SPEED_HZ
  111. self._spi.mode = 0b00
  112. # #1424: Pi 5's RP1 spi-rp1 driver rejects SPI_NO_CS, which used to
  113. # work on Pi 4. Harmless either way on this hardware — NSS is wired
  114. # to GPIO23 (manual CS in _cs_low/_cs_high), so the kernel's CE0
  115. # toggling has no electrical effect on the reader.
  116. try:
  117. self._spi.no_cs = True
  118. except OSError:
  119. pass
  120. def close(self):
  121. self._spi.close()
  122. self._lines.release()
  123. self._chip.close()
  124. def _cs_low(self):
  125. self._lines.set_value(NSS_PIN, gpiod.line.Value.INACTIVE)
  126. time.sleep(0.000005) # 5µs setup
  127. def _cs_high(self):
  128. self._lines.set_value(NSS_PIN, gpiod.line.Value.ACTIVE)
  129. time.sleep(0.000100) # 100µs post-CS delay
  130. def _wait_busy(self, timeout_s=1.0):
  131. """Wait for BUSY to go HIGH (processing) then LOW (done) — matches Pico firmware."""
  132. deadline = time.monotonic() + min(timeout_s, 0.010)
  133. # Wait for BUSY HIGH (PN5180 started processing)
  134. while self._lines.get_value(BUSY_PIN) != gpiod.line.Value.ACTIVE:
  135. if time.monotonic() > deadline:
  136. break # Timeout waiting for HIGH — command may have processed already
  137. time.sleep(0.00001)
  138. # Wait for BUSY LOW (PN5180 done)
  139. deadline = time.monotonic() + timeout_s
  140. while self._lines.get_value(BUSY_PIN) == gpiod.line.Value.ACTIVE:
  141. if time.monotonic() > deadline:
  142. raise TimeoutError("BUSY timeout")
  143. time.sleep(0.0001)
  144. def _cmd(self, data):
  145. self._cs_low()
  146. self._spi.xfer2(list(data))
  147. self._cs_high()
  148. self._wait_busy()
  149. def _read_response(self, n):
  150. self._cs_low()
  151. result = self._spi.xfer2([0xFF] * n)
  152. self._cs_high()
  153. return result
  154. # -- Register ops --
  155. def write_reg(self, reg, val):
  156. self._cmd([0x00, reg, val & 0xFF, (val >> 8) & 0xFF, (val >> 16) & 0xFF, (val >> 24) & 0xFF])
  157. def write_reg_or(self, reg, mask):
  158. self._cmd([0x01, reg, mask & 0xFF, (mask >> 8) & 0xFF, (mask >> 16) & 0xFF, (mask >> 24) & 0xFF])
  159. def write_reg_and(self, reg, mask):
  160. self._cmd([0x02, reg, mask & 0xFF, (mask >> 8) & 0xFF, (mask >> 16) & 0xFF, (mask >> 24) & 0xFF])
  161. def read_reg(self, reg):
  162. self._cmd([0x04, reg])
  163. time.sleep(0.000100) # Extra 100µs before read
  164. return int.from_bytes(self._read_response(4), "little")
  165. def read_eeprom(self, addr, length):
  166. self._cmd([0x07, addr, length])
  167. time.sleep(0.000100)
  168. return bytes(self._read_response(length))
  169. # -- Commands --
  170. def reset(self):
  171. self._lines.set_value(RST_PIN, gpiod.line.Value.INACTIVE)
  172. time.sleep(0.050)
  173. self._lines.set_value(RST_PIN, gpiod.line.Value.ACTIVE)
  174. time.sleep(0.100)
  175. self._wait_busy(2.0)
  176. time.sleep(0.050)
  177. def load_rf_config(self, tx, rx):
  178. self.write_reg(0x03, 0xFFFFFFFF) # Clear IRQs first
  179. time.sleep(0.000100)
  180. self._cmd([0x11, tx, rx])
  181. time.sleep(0.010)
  182. def rf_on(self):
  183. self._cmd([0x16, 0x00])
  184. time.sleep(0.010)
  185. def rf_off(self):
  186. self._cmd([0x17, 0x00])
  187. time.sleep(0.005)
  188. def set_transceive_mode(self):
  189. """Set SYSTEM_CONFIG command bits to TRANSCEIVE (0x03) — CRITICAL!"""
  190. sys_cfg = self.read_reg(0x00)
  191. sys_cfg = (sys_cfg & 0xFFFFFFF8) | 0x03
  192. self.write_reg(0x00, sys_cfg)
  193. def send_data(self, data, valid_bits=0x00):
  194. self._cs_low()
  195. self._spi.xfer2([0x09, valid_bits] + list(data))
  196. self._cs_high()
  197. time.sleep(0.000100)
  198. self._wait_busy()
  199. def read_data(self, length):
  200. self._cmd([0x0A, 0x00])
  201. return bytes(self._read_response(length))
  202. # -- ISO 14443A --
  203. def activate_type_a(self):
  204. """Full Type A activation: WUPA -> Anticollision -> SELECT, for each cascade level.
  205. Returns (uid, sak) with the complete 4-, 7- or 10-byte UID, cascade tags
  206. dropped, and the SAK of the last SELECT; or None.
  207. """
  208. # Crypto off, CRC off
  209. self.write_reg_and(0x00, 0xFFFFFFBF)
  210. self.write_reg_and(0x12, 0xFFFFFFFE)
  211. self.write_reg_and(0x19, 0xFFFFFFFE)
  212. self.write_reg(0x03, 0xFFFFFFFF)
  213. # Reset to IDLE then TRANSCEIVE
  214. sys_cfg = self.read_reg(0x00)
  215. self.write_reg(0x00, sys_cfg & 0xFFFFFFF8) # IDLE
  216. time.sleep(0.001)
  217. self.write_reg(0x00, (sys_cfg & 0xFFFFFFF8) | 0x03) # TRANSCEIVE
  218. time.sleep(0.002)
  219. # WUPA (7-bit)
  220. self.send_data([0x52], valid_bits=0x07)
  221. time.sleep(0.005)
  222. rx_status = self.read_reg(0x13)
  223. rx_len = rx_status & 0x1FF
  224. if rx_len < 2 or rx_len == 511:
  225. # Try REQA
  226. self.write_reg(0x03, 0xFFFFFFFF)
  227. time.sleep(0.002)
  228. self.set_transceive_mode()
  229. time.sleep(0.002)
  230. self.send_data([0x26], valid_bits=0x07)
  231. time.sleep(0.005)
  232. rx_status = self.read_reg(0x13)
  233. rx_len = rx_status & 0x1FF
  234. if rx_len < 2 or rx_len == 511:
  235. return None
  236. atqa = self.read_data(2)
  237. if atqa[0] == 0xFF or atqa[0] == 0x00:
  238. return None
  239. uid = b""
  240. for level, sel in enumerate(CASCADE_LEVELS):
  241. if level > 0:
  242. # The previous SELECT turned CRC on; anticollision frames carry none
  243. self.write_reg_and(0x12, 0xFFFFFFFE)
  244. self.write_reg_and(0x19, 0xFFFFFFFE)
  245. # Anti-collision
  246. self.write_reg(0x03, 0xFFFFFFFF)
  247. self.set_transceive_mode()
  248. time.sleep(0.002)
  249. self.send_data([sel, 0x20])
  250. time.sleep(0.010)
  251. rx_status = self.read_reg(0x13)
  252. rx_len = rx_status & 0x1FF
  253. if rx_len < 5 or rx_len > 64:
  254. return None
  255. uid_buf = self.read_data(5)
  256. part = uid_buf[:4]
  257. bcc = part[0] ^ part[1] ^ part[2] ^ part[3]
  258. if bcc != uid_buf[4]:
  259. return None
  260. # SELECT
  261. self.write_reg(0x03, 0xFFFFFFFF)
  262. self.set_transceive_mode()
  263. time.sleep(0.002)
  264. # Enable CRC for SELECT
  265. self.write_reg_or(0x19, 0x01)
  266. self.write_reg_or(0x12, 0x01)
  267. self.send_data([sel, 0x70, part[0], part[1], part[2], part[3], bcc])
  268. time.sleep(0.010)
  269. rx_status = self.read_reg(0x13)
  270. rx_len = rx_status & 0x1FF
  271. if rx_len < 1:
  272. return None
  273. sak_buf = self.read_data(min(rx_len, 3))
  274. sak = sak_buf[0]
  275. if not sak & SAK_UID_INCOMPLETE:
  276. return bytes(uid + part), sak
  277. # UID goes on at the next level: these four bytes are the cascade
  278. # tag and the next three bytes of the UID
  279. if part[0] != CASCADE_TAG:
  280. print(f" SAK 0x{sak:02X} at cascade level {level + 1} without cascade tag: {part.hex().upper()}")
  281. return None
  282. uid += part[1:]
  283. print(f" UID still incomplete after cascade level 3: {uid.hex().upper()}")
  284. return None
  285. # -- MIFARE Classic --
  286. def mfc_authenticate(self, block: int, key: bytes, uid: bytes) -> bool:
  287. """MIFARE Classic authentication via PN5180 MFC_AUTHENTICATE (0x0C).
  288. The PN5180 handles Crypto1 internally. After success, bit 6 of
  289. SYSTEM_CONFIG is set (MFC_CRYPTO1_ON) and all subsequent RF
  290. communication is encrypted/decrypted by the hardware.
  291. Args:
  292. block: Block number to authenticate
  293. key: 6-byte MIFARE Key A
  294. uid: 4-byte tag UID
  295. Returns:
  296. True if authentication succeeded
  297. """
  298. # Wait for BUSY LOW before starting
  299. deadline = time.monotonic() + 0.100
  300. while self._lines.get_value(BUSY_PIN) == gpiod.line.Value.ACTIVE:
  301. if time.monotonic() > deadline:
  302. return False
  303. time.sleep(0.001)
  304. # MFC_AUTHENTICATE: [0x0C][key 6B][keyType][blockNo][uid 4B] = 13 bytes
  305. cmd = [0x0C] + list(key) + [0x60, block] + list(uid[:4])
  306. self._cs_low()
  307. self._spi.xfer2(cmd)
  308. self._cs_high()
  309. # Wait for BUSY HIGH then LOW (auth can take up to 1s)
  310. self._wait_busy(timeout_s=1.0)
  311. # Read 1-byte response: 0x00 = success
  312. self._cs_low()
  313. response = self._spi.xfer2([0xFF])
  314. self._cs_high()
  315. return response[0] == 0x00
  316. def mfc_read_block(self, block: int) -> bytes | None:
  317. """Read a 16-byte MIFARE Classic block (must be authenticated first).
  318. Returns 16 bytes of block data, or None on failure.
  319. """
  320. # Clear IRQs
  321. self.write_reg(0x03, 0xFFFFFFFF)
  322. # Set transceive mode (Crypto1 stays active from MFC_AUTHENTICATE)
  323. self.set_transceive_mode()
  324. time.sleep(0.001)
  325. # Enable TX and RX CRC for encrypted read
  326. self.write_reg_or(0x19, 0x01)
  327. self.write_reg_or(0x12, 0x01)
  328. # Send MIFARE READ command: 0x30 + block number
  329. self.send_data([0x30, block])
  330. time.sleep(0.010)
  331. # Check RX status
  332. rx_status = self.read_reg(0x13)
  333. rx_len = rx_status & 0x1FF
  334. if rx_len != 16:
  335. return None
  336. return self.read_data(16)
  337. def _ntag_reactivate(self) -> bool:
  338. """Full hardware reset + RF activation for NTAG re-selection between reads.
  339. The PN5180 enters an unrecoverable state after an NTAG READ command —
  340. simple RF off/on cycles cannot re-select the tag. A full GPIO hardware
  341. reset is required to clear the internal transceiver state.
  342. """
  343. self.reset()
  344. self.load_rf_config(0x00, 0x80) # ISO 14443A
  345. time.sleep(0.010)
  346. self.rf_on()
  347. time.sleep(0.030)
  348. self.set_transceive_mode()
  349. return self.activate_type_a() is not None
  350. def ntag_read_pages(self, start_page: int, num_pages: int) -> bytes | None:
  351. """Read NTAG pages (4 bytes each). No authentication required.
  352. Uses NTAG READ command (0x30) which returns 4 pages (16 bytes) at a time.
  353. The PN5180 cannot issue consecutive NTAG READs in one session — the card
  354. stops responding after the first READ. We do a full RF cycle and re-select
  355. with extended timing between each 4-page batch.
  356. """
  357. result = bytearray()
  358. pages_read = 0
  359. while pages_read < num_pages:
  360. if pages_read > 0:
  361. if not self._ntag_reactivate():
  362. print(f" Failed to reactivate card before page {start_page + pages_read}")
  363. return None
  364. # Setup: Crypto1 off, TX CRC on, RX CRC off, IDLE→TRANSCEIVE
  365. self.write_reg_and(0x00, 0xFFFFFFBF)
  366. self.write_reg_or(0x19, 0x01)
  367. self.write_reg_and(0x12, 0xFFFFFFFE)
  368. self.write_reg(0x03, 0xFFFFFFFF)
  369. sys_cfg = self.read_reg(0x00)
  370. self.write_reg(0x00, sys_cfg & 0xFFFFFFF8) # IDLE
  371. time.sleep(0.001)
  372. self.write_reg(0x00, (sys_cfg & 0xFFFFFFF8) | 0x03) # TRANSCEIVE
  373. time.sleep(0.002)
  374. # READ command: 0x30 + page → returns 16 bytes (4 pages)
  375. self.send_data([0x30, start_page + pages_read])
  376. time.sleep(0.010)
  377. rx_status = self.read_reg(0x13)
  378. rx_len = rx_status & 0x1FF
  379. if rx_len < 16:
  380. # Tag may have fewer pages than requested (e.g. MIFARE Ultralight
  381. # has only 16 pages). Return what we have so far.
  382. if result:
  383. return bytes(result)
  384. print(f" NTAG read page {start_page + pages_read}: rx_len={rx_len} (expected >=16)")
  385. return None
  386. data = self.read_data(16)
  387. pages_to_copy = min(4, num_pages - pages_read)
  388. result.extend(data[: pages_to_copy * 4])
  389. pages_read += 4
  390. return bytes(result)
  391. def reactivate_card(self) -> tuple[bytes, int] | None:
  392. """RF cycle and full re-select of the card. Returns (uid, sak) or None."""
  393. self.rf_off()
  394. time.sleep(0.010)
  395. self.write_reg(0x03, 0xFFFFFFFF) # Clear IRQs
  396. self.load_rf_config(0x00, 0x80) # ISO 14443A
  397. time.sleep(0.005)
  398. self.rf_on()
  399. time.sleep(0.020)
  400. return self.activate_type_a()
  401. def read_bambu_tag(self, uid: bytes) -> dict[int, bytes] | None:
  402. """Read Bambu tag data blocks using HKDF-derived keys.
  403. Args:
  404. uid: 4-byte tag UID (from activate_type_a)
  405. Returns:
  406. Dict mapping block number -> 16 bytes of data, or None on failure
  407. """
  408. # Derive per-sector keys from UID
  409. keys = hkdf_derive_keys(uid)
  410. # Clear Crypto1 state and IRQs
  411. self.write_reg_and(0x00, 0xFFFFFFBF) # Clear MFC_CRYPTO1_ON (bit 6)
  412. self.write_reg(0x03, 0xFFFFFFFF)
  413. # Reactivate card (may have timed out)
  414. result = self.reactivate_card()
  415. if result is None:
  416. print(" Failed to reactivate card")
  417. return None
  418. uid_check, _ = result
  419. if uid_check != uid:
  420. print(f" UID mismatch after reactivation: {uid_check.hex()} != {uid.hex()}")
  421. return None
  422. # Read blocks with per-sector authentication
  423. blocks = {}
  424. current_sector = -1
  425. for block in BAMBU_BLOCKS:
  426. sector = block // 4
  427. # Authenticate when entering a new sector
  428. if sector != current_sector:
  429. key = get_sector_key(keys, block)
  430. if not self.mfc_authenticate(block, key, uid):
  431. print(f" Auth failed for block {block} (sector {sector})")
  432. return None
  433. current_sector = sector
  434. # Read the block
  435. data = self.mfc_read_block(block)
  436. if data is None:
  437. print(f" Read failed for block {block}")
  438. return None
  439. blocks[block] = data
  440. return blocks
  441. def ntag_write_page(self, page: int, data: bytes) -> bool:
  442. """Write 4 bytes to a single NTAG page.
  443. NTAG WRITE command: 0xA2 + page_number + 4 bytes data.
  444. TX CRC on (tag requires it). Always returns True — the 4-bit ACK
  445. cannot be captured by the PN5180, so verification is deferred to
  446. ntag_write_pages() which reads back all written data.
  447. """
  448. if len(data) != 4:
  449. return False
  450. # Crypto1 off, TX CRC on (tag expects CRC), RX CRC off (ACK is 4-bit, no CRC)
  451. self.write_reg_and(0x00, 0xFFFFFFBF) # Crypto1 off
  452. self.write_reg_or(0x19, 0x01) # TX CRC on
  453. self.write_reg_and(0x12, 0xFFFFFFFE) # RX CRC off
  454. self.write_reg(0x03, 0xFFFFFFFF) # Clear IRQs
  455. # Reset state machine: IDLE then TRANSCEIVE
  456. sys_cfg = self.read_reg(0x00)
  457. self.write_reg(0x00, sys_cfg & 0xFFFFFFF8) # IDLE
  458. time.sleep(0.001)
  459. self.write_reg(0x00, (sys_cfg & 0xFFFFFFF8) | 0x03) # TRANSCEIVE
  460. time.sleep(0.002)
  461. # WRITE command: 0xA2 + page + 4 bytes
  462. self.send_data([0xA2, page] + list(data))
  463. time.sleep(0.005)
  464. # PN5180 cannot reliably capture the 4-bit ACK, so always return True
  465. return True
  466. def ntag_write_pages(self, start_page: int, data: bytes) -> bool:
  467. """Write data to consecutive NTAG pages starting at start_page.
  468. Pads last chunk to 4 bytes. Verification is skipped — the PN5180
  469. cannot reliably read back NTAG pages after a batch write (the
  470. second READ command gets no response). The write itself is reliable:
  471. the tag ACKs each page (RX SOF detected on every response).
  472. """
  473. # Pad to 4-byte boundary
  474. padded = bytearray(data)
  475. while len(padded) % 4 != 0:
  476. padded.append(0x00)
  477. # Write page by page
  478. num_pages = len(padded) // 4
  479. for i in range(0, len(padded), 4):
  480. page = start_page + (i // 4)
  481. chunk = bytes(padded[i : i + 4])
  482. if not self.ntag_write_page(page, chunk):
  483. print(f" NTAG write failed at page {page} (of {num_pages} pages)")
  484. return False
  485. time.sleep(0.002)
  486. print(f" NTAG write complete ({num_pages} pages)")
  487. return True
  488. def read_ntag(self, uid: bytes) -> bytes | None:
  489. """Read NTAG pages 4-20 (NDEF data area, 68 bytes). No auth needed.
  490. Used for SpoolEase / OpenPrintTag community tags.
  491. """
  492. # Reactivate card
  493. result = self.reactivate_card()
  494. if result is None:
  495. print(" Failed to reactivate card")
  496. return None
  497. return self.ntag_read_pages(start_page=4, num_pages=17)
  498. def _print_hex_dump(data: bytes, label: str, bytes_per_line: int = 16):
  499. """Print a hex dump with ASCII sidebar."""
  500. for i in range(0, len(data), bytes_per_line):
  501. chunk = data[i : i + bytes_per_line]
  502. hex_str = " ".join(f"{b:02X}" for b in chunk)
  503. ascii_str = "".join(chr(b) if 32 <= b < 127 else "." for b in chunk)
  504. print(f" {label}{i:3d}: {hex_str:<{bytes_per_line * 3}}|{ascii_str}|")
  505. def main():
  506. print("=" * 60)
  507. print("PN5180 NFC Tag Reader")
  508. print(" Supports: Bambu (MIFARE Classic) + NTAG (SpoolEase/OpenPrintTag)")
  509. print("=" * 60)
  510. try:
  511. nfc = PN5180()
  512. except (OSError, RuntimeError, PermissionError) as e:
  513. print(f"\nERROR: Failed to initialize NFC reader: {e}")
  514. # Check if it's a resource conflict
  515. error_str = str(e).lower()
  516. is_resource_conflict = any(x in error_str for x in ["busy", "resource", "already in use", "permission denied"])
  517. if is_resource_conflict:
  518. print("\nGPIO/SPI RESOURCE IN USE: Another process is using the NFC reader.")
  519. print("This typically means the SpoolBuddy daemon is already reading tags.")
  520. print("\nTo run this diagnostic, stop the daemon first:")
  521. print(" sudo systemctl stop bambuddy")
  522. print(" # Run diagnostic")
  523. print(" .../read_tag.py")
  524. print(" # Restart daemon when done:")
  525. print(" sudo systemctl start bambuddy")
  526. else:
  527. print("\nCheck:")
  528. print(" - Correct GPIO chip is available (/dev/gpiochip0 or /dev/gpiochip4)")
  529. print(f" - SPI device is available (SPI_BUS={SPI_BUS}, SPI_DEVICE={SPI_DEVICE})")
  530. print(" - GPIO and SPI permissions are correct")
  531. # Only print full traceback for unexpected errors
  532. import traceback
  533. traceback.print_exc()
  534. sys.exit(1)
  535. try:
  536. nfc.reset()
  537. ver = nfc.read_eeprom(0x10, 2)
  538. print(f"[1] Reset OK — product v{ver[1]}.{ver[0]}")
  539. nfc.load_rf_config(0x00, 0x80) # ISO 14443A
  540. time.sleep(0.010)
  541. nfc.rf_on()
  542. time.sleep(0.030)
  543. nfc.set_transceive_mode()
  544. rf = nfc.read_reg(0x1D)
  545. print(f"[2] RF ON (RF_STATUS=0x{rf:08X}, TX_RF={'ON' if rf & 1 else 'OFF'})")
  546. print("[3] Scanning for tag...")
  547. result = nfc.activate_type_a()
  548. if result is None:
  549. print(" No tag found.")
  550. sys.exit(1)
  551. uid, sak = result
  552. tag_types = {
  553. 0x00: "NTAG",
  554. 0x04: "NTAG (MIFARE Ultralight)",
  555. 0x08: "MIFARE Classic 1K",
  556. 0x18: "MIFARE Classic 4K",
  557. }
  558. print(f" UID : {uid.hex().upper()}")
  559. print(f" SAK : 0x{sak:02X} ({tag_types.get(sak, 'Unknown')})")
  560. if sak in (0x08, 0x18):
  561. # MIFARE Classic 1K or 4K — Bambu Lab tag
  562. print("[4] Reading Bambu tag data (MIFARE Classic)...")
  563. blocks = nfc.read_bambu_tag(uid)
  564. if blocks is None:
  565. print(" Failed to read tag data.")
  566. nfc.rf_off()
  567. sys.exit(1)
  568. print("[5] Tag data:")
  569. for block_num in BAMBU_BLOCKS:
  570. data = blocks[block_num]
  571. hex_str = " ".join(f"{b:02X}" for b in data)
  572. ascii_str = "".join(chr(b) if 32 <= b < 127 else "." for b in data)
  573. print(f" Block {block_num:2d}: {hex_str} |{ascii_str}|")
  574. raw = b""
  575. for block_num in BAMBU_BLOCKS:
  576. raw += blocks[block_num]
  577. print(f"\n Raw payload ({len(raw)} bytes): {raw.hex().upper()}")
  578. print(f" tray_uuid (block 9): {blocks[9][:16].hex().upper()}")
  579. elif sak in (0x00, 0x04):
  580. # NTAG / MIFARE Ultralight family — SpoolEase / OpenPrintTag
  581. print("[4] Reading NTAG data (pages 4-20)...")
  582. ntag_data = nfc.read_ntag(uid)
  583. if ntag_data is None:
  584. print(" Failed to read NTAG data.")
  585. nfc.rf_off()
  586. sys.exit(1)
  587. print(f"[5] NTAG data ({len(ntag_data)} bytes):")
  588. _print_hex_dump(ntag_data, "page ")
  589. else:
  590. print(f" Unsupported tag type (SAK=0x{sak:02X})")
  591. nfc.rf_off()
  592. sys.exit(1)
  593. nfc.rf_off()
  594. print("\n" + "=" * 60)
  595. print("Tag read complete!")
  596. print("=" * 60)
  597. except Exception as e:
  598. print(f"\nERROR: {e}")
  599. import traceback
  600. traceback.print_exc()
  601. sys.exit(1)
  602. finally:
  603. nfc.close()
  604. if __name__ == "__main__":
  605. main()