read_tag.py 25 KB

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