nfcscript 0.0.1__tar.gz → 0.0.6__tar.gz

{nfcscript-0.0.1 → nfcscript-0.0.6}/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: nfcscript
-Version: 0.0.1
-Summary: NFC test script
+Version: 0.0.6
+Summary: A plugin-based core engine for DSL-style NFC testing automation.
 Author: crthu
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
-Requires-Dist: CarrotRFIDTester
+Requires-Dist: nfctester
 
 # nfcscript
 

{nfcscript-0.0.1 → nfcscript-0.0.6}/pyproject.toml

@@ -1,19 +1,19 @@
 [project]
 name = "nfcscript"
-version = "0.0.1"
-description = "NFC test script"
+version = "0.0.6"
+description = "A plugin-based core engine for DSL-style NFC testing automation."
 readme = "README.md"
 requires-python = ">=3.14"
 authors = [{name = "crthu"}]
 dependencies = [
-    "CarrotRFIDTester",
+    "nfctester",
 ]
 
 [tool.setuptools.packages.find]
 where = ["src"]
 
 [project.scripts]
-nfcscript = "nfcscript.main:main"
+nfcscript = "nfc.cli:main"
 
 [tool.pytest.ini_options]
 pythonpath = ["src"]
@@ -29,12 +29,14 @@ dev = [
 ]
 
 [tool.bumpversion]
-current_version = "0.0.1"
+current_version = "0.0.6"
+commit = true
+tag = true
 allow_dirty = true
+tag_name = "v{new_version}"
+message = "chore(release): bump version {current_version} → {new_version}"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
-search = 'version = "{current_version}"'
-replace = 'version = "{new_version}"'
 
 [[tool.bumpversion.files]]
 filename = "pyproject.toml"

nfcscript-0.0.6/src/nfc/__init__.py

@@ -0,0 +1,6 @@
+from .reader import *
+from .delay import *
+from .assertions import *
+from .bits import *
+from .hex_util import *
+from .checksum import *

nfcscript-0.0.6/src/nfc/assertions.py

@@ -0,0 +1,68 @@
+import inspect
+from typing import Any, TypeGuard, TypeVar
+
+from nfc.hex_util import FORMAT_HEX
+
+T = TypeVar("T")
+
+def _get_stack_trace() -> str:
+    """获取格式化的调用堆栈"""
+    # inspect.stack()[0] 是 _get_stack_trace
+    # inspect.stack()[1] 是 ASSERT_... 函数
+    # inspect.stack()[2:] 是实际的业务调用代码
+    stack = inspect.stack()[2:]
+    chain = []
+    for frame in stack:
+        # 简化路径，仅显示文件名
+        filename = frame.filename.split('\\')[-1].split('/')[-1]
+        chain.append(f"  at {filename}:{frame.lineno} in {frame.function}")
+    return "\n".join(chain)
+
+def ASSERT_LEN(data: Any, expected_len: int, msg: str | None = None) -> None:
+    actual_len = len(data)
+    if actual_len != expected_len:
+        error_msg = (
+            f"\nAssertion Failed: {msg}\n" if msg else ""
+        ) + (
+            f"Assertion Failed: Length mismatch\n"
+            f"  Expected: {expected_len}\n"
+            f"  Actual  : {actual_len}\n"
+            f"  Data    : {data}\n"
+            f"Stack Trace:\n{_get_stack_trace()}"
+        )
+        raise AssertionError(error_msg)
+
+def ASSERT_EQUAL(expected: Any, actual: Any, msg: str | None = None) -> None:
+    if actual != expected:
+        error_msg = (
+            f"\nAssertion Failed: {msg}\n" if msg else ""
+        ) + (
+            f"Assertion Failed: Value mismatch\n"
+            f"  Expected: {FORMAT_HEX(expected)} ({type(expected).__name__})\n"
+            f"  Actual  : {FORMAT_HEX(actual)} ({type(actual).__name__})\n"
+            f"Stack Trace:\n{_get_stack_trace()}"
+        )
+        raise AssertionError(error_msg)
+
+def ASSERT_IS_NONE(value: Any, msg: str | None = None) -> None:
+    if value is not None:
+        error_msg = (
+            f"\nAssertion Failed: {msg}\n" if msg else ""
+        ) + (
+            f"Assertion Failed: Expected None\n"
+            f"  Actual  : {value} ({type(value).__name__})\n"
+            f"Stack Trace:\n{_get_stack_trace()}"
+        )
+        raise AssertionError(error_msg)
+
+def ASSERT_IS_NOT_NONE(value: T | None, msg: str | None = None) -> TypeGuard[T]:
+    if value is None:
+        error_msg = (
+            f"\nAssertion Failed: {msg}\n" if msg else ""
+        ) + (
+            f"Assertion Failed: Expected Not None\n"
+            f"  Actual  : {value}\n"
+            f"Stack Trace:\n{_get_stack_trace()}"
+        )
+        raise AssertionError(error_msg)
+    return True

{nfcscript-0.0.1/src/nfcscript → nfcscript-0.0.6/src/nfc}/bits.py

@@ -1,4 +1,6 @@
-def bits_update(val: int, mask: int, data: int) -> int:
+from .hex_util import FORMAT_HEX
+
+def BITS_UPDATE(val: int, mask: int, data: int) -> int:
     """
     更新寄存器中的特定位域 (Read-Modify-Write)
     :param val:         当前寄存器的原始值
@@ -6,10 +8,10 @@ def bits_update(val: int, mask: int, data: int) -> int:
     :param data:        已移位对齐的新数值 (例如: 0x20, 即 1 << 5)
     :return:            更新后的寄存器值
     """
-    assert (data & ~mask) == 0, f"Data {hex(data)} contains bits outside mask {hex(mask)}"
+    assert (data & ~mask) == 0, f"Data {FORMAT_HEX(data)} contains bits outside mask {FORMAT_HEX(mask)}"
     return (val & ~mask) | (data & mask)
 
-def bits_set(val: int, mask: int) -> int:
+def BITS_SET(val: int, mask: int) -> int:
     """
     将寄存器中的指定位强制置 1 (OR 操作)
     
@@ -17,7 +19,7 @@ def bits_set(val: int, mask: int) -> int:
     """
     return val | mask
 
-def bits_reset(val: int, mask: int) -> int:
+def BITS_RESET(val: int, mask: int) -> int:
     """
     将寄存器中的指定位强制清 0 (AND-NOT 操作)
     

nfcscript-0.0.6/src/nfc/checksum.py

@@ -0,0 +1,10 @@
+from .assertions import ASSERT_LEN
+from .hex_util import FORMAT_HEX
+
+def GET_BCC(data: list[int]) -> int:
+    """
+    计算 BCC: data[0]^data[1]^data[2]^data[3]
+    :param data: 4字节的UID数据
+    """
+    ASSERT_LEN(data, 4, msg=f"计算BCC时输入数据长度应为4: {FORMAT_HEX(data)}")
+    return data[0] ^ data[1] ^ data[2] ^ data[3]

nfcscript-0.0.6/src/nfc/cli.py

@@ -0,0 +1,27 @@
+import sys
+import argparse
+import os
+import runpy
+
+def run_script(script_path):
+    # Add the script's directory to sys.path so it can find its dependencies
+    script_dir = os.path.dirname(os.path.abspath(script_path))
+    sys.path.insert(0, script_dir)
+    
+    # Run the script as __main__ so __name__ == "__main__" works inside the script
+    runpy.run_path(script_path, run_name="__main__")
+
+def main():
+    print("Hello from nfcscript!")
+    parser = argparse.ArgumentParser(description="NFC Script Runner")
+    parser.add_argument("script", help="Path to the script to run")
+    args = parser.parse_args()
+    
+    if not os.path.exists(args.script):
+        print(f"Error: Script not found: {args.script}")
+        sys.exit(1)
+        
+    run_script(args.script)
+
+if __name__ == "__main__":
+    main()

nfcscript-0.0.6/src/nfc/delay.py

@@ -0,0 +1,4 @@
+import time
+
+def DELAY_MS(ms: int) -> None:
+    time.sleep(ms / 1000.0)

nfcscript-0.0.6/src/nfc/hex_util.py

@@ -0,0 +1,99 @@
+import re
+
+# 位标记正则：匹配 N'hXX 格式 (如 7'h26, 4'hC)
+BIT_PATTERN = re.compile(r"(\d+)\s*\'h\s*([0-9a-fA-F]+)")
+
+def PARSE_HEX(text: str) -> tuple[str, int]:
+    """
+    解析文本 -> (纯十六进制字符串, 最后字节有效位数)
+    支持: "AA BB 7'h03" -> ("AABB03", 7)
+    """
+    last_bits = 0
+    cleaned = text.strip()
+
+    # 查找所有位标记
+    matches = list(BIT_PATTERN.finditer(cleaned))
+    if matches:
+        last_match = matches[-1]
+        last_bits = int(last_match.group(1))
+        hex_val = last_match.group(2)
+        
+        # 替换位标记为纯 hex
+        cleaned = cleaned[:last_match.start()] + hex_val + cleaned[last_match.end():]
+
+    # 去空格得到纯 hex
+    clean_hex = cleaned.replace(" ", "")
+    
+    # 简单的合法性检查
+    if clean_hex:
+        try:
+            bytes.fromhex(clean_hex)
+        except ValueError:
+            raise ValueError(f"不合法的十六进制数据: {clean_hex}")
+
+    return clean_hex, last_bits
+
+def FORMAT_HEX(data: int | bytes | list[int] | str, last_bits: int = 0) -> str:
+    """
+    格式化数据为带位标记的可视化格式
+    支持输入类型: int, bytes, list[int], str (纯 hex)
+    示例:
+        FORMAT_HEX(0xAABB03, 7)        -> "AA BB 7'h03"
+        FORMAT_HEX("AABB03", 7)        -> "AA BB 7'h03"
+        FORMAT_HEX(b'\xaa\xbb\x03', 7) -> "AA BB 7'h03"
+        FORMAT_HEX([0xAA, 0xBB, 0x03], 7) -> "AA BB 7'h03"
+    """
+    # 1. 统一转换为纯十六进制字符串
+    if isinstance(data, int):
+        hex_str = hex(data)[2:].upper()
+    elif isinstance(data, bytes):
+        hex_str = data.hex().upper()
+    elif isinstance(data, list):
+        hex_str = bytes(data).hex().upper()
+    elif isinstance(data, str):
+        hex_str = data.replace(" ", "").upper()
+    else:
+        raise TypeError(f"不支持的输入类型: {type(data)}")
+
+    if not hex_str:
+        return ""
+
+    # 2. 如果是整字节 (无 last_bits)
+    if last_bits == 0:
+        return ' '.join(hex_str[i:i+2] for i in range(0, len(hex_str), 2))
+
+    # 3. 有 last_bits，处理最后一个字节
+    if len(hex_str) <= 2:
+        return f"{last_bits}'h{hex_str}"
+    
+    prefix = hex_str[:-2]
+    last_byte = hex_str[-2:]
+    
+    formatted_prefix = ' '.join(prefix[i:i+2] for i in range(0, len(prefix), 2))
+    return f"{formatted_prefix} {last_bits}'h{last_byte}"
+
+if __name__ == "__main__":
+    # --- 测试例程 ---
+    print("=== Hex 工具测试 ===")
+    
+    # 测试用例: (data, last_bits, 类型名)
+    test_cases = [
+        ("AABB03", 7, "str"),
+        (0xAABB03, 7, "int"),
+        (b'\xAA\xBB\x03', 7, "bytes"),
+        ([0xAA, 0xBB, 0x03], 7, "list"),
+        ("FF", 4, "str"),
+        (0xFF, 4, "int"),
+        ("AABBCC", 0, "str"),
+        (0xAABBCC, 0, "int"),
+        (b'\xAA\xBB\xCC', 0, "bytes"),
+    ]
+    
+    for data, b, typename in test_cases:
+        formatted = FORMAT_HEX(data, b)
+        print(f"输入: ({data}, {b}, {typename}) -> 格式化: {formatted}")
+        
+        # 反向解析验证
+        parsed_h, parsed_b = PARSE_HEX(formatted)
+        print(f"解析: {formatted} -> Hex: {parsed_h}, Bits: {parsed_b}")
+        print("-" * 20)

nfcscript-0.0.6/src/nfc/reader.py

@@ -0,0 +1,197 @@
+from typing import Any
+
+from .assertions import ASSERT_EQUAL, ASSERT_IS_NOT_NONE, ASSERT_LEN
+from .checksum import GET_BCC
+from .hex_util import FORMAT_HEX
+from nfctester.hardware.serial_transport import SerialTransport
+from nfctester.drivers.pn532_hsu import PN532_HSU
+
+# Global state
+_transport: SerialTransport | None = None
+_driver: PN532_HSU | None = None
+_is_connected = False
+
+def connect(port="COM20"):
+    """
+    连接并初始化 PN532 读卡器。
+
+    Args:
+        port: 串口号，默认为 "COM20"。
+    """
+    global _transport, _driver, _is_connected
+    _transport = SerialTransport(port=port)
+    _driver = PN532_HSU(_transport)
+    _driver.connect()
+    _is_connected = True
+    print(f"Connected to PN532 on {_transport.ser.port}")
+
+def active(ll: bool = False, ignore_error: bool = False) -> dict | None:
+    """
+    寻卡操作，检测并激活目标卡片。
+
+    Args:
+        ll: 如果为 True，则执行底层抗冲突流程以兼容非标卡；
+            如果为 False，则使用 PN532 原生 find()。
+        ignore_error: 如果为 True，当 BCC 或 SAK 校验失败时，记录警告而不停止执行。
+
+    Returns:
+        dict: 包含卡片信息的字典，失败时返回 None。
+              Key 说明:
+              - 'uid' (bytes): 卡片的 UID。
+              - 'atq' (bytes): 卡片的 ATQ (Answer To Request)。
+              - 'sak' (int):   卡片的 SAK (Select Acknowledge)。
+              - 'raw' (bytes): PN532 返回的原始响应数据。
+    """
+    ASSERT_IS_NOT_NONE(_driver, msg="NFC driver not connected. Call connect() first.")
+        
+    if not ll:
+        return _driver.find()
+    else:
+        # 手动底层寻卡流程
+        # 1. REQA
+        res_reqa = reqa()
+        if not res_reqa:
+            return None
+        atq = bytes(res_reqa[0])
+        
+        # 2. 抗冲突与选择
+        full_uid = []
+        sak = 0
+        for cl in [1, 2, 3]:
+            res = anticoll(cl_level=cl, nvb=0x20)
+            if not res or not res[0]:
+                return None
+                
+            data = res[0]
+            # 只有当有数据时才进行长度校验
+            if len(data) > 0:
+                ASSERT_LEN(data, 5, msg=f"CL{cl} 抗冲突返回数据长度不符: {FORMAT_HEX(data)}")
+                
+                # 计算期望的 BCC
+                expected_bcc = GET_BCC(data[0:4])
+                
+                if not ignore_error:
+                    ASSERT_EQUAL(expected_bcc, data[4], msg=f"CL{cl} BCC 校验失败: data={FORMAT_HEX(data)}")
+                elif data[4] != expected_bcc:
+                    print(f"Warning: CL{cl} BCC 校验失败")
+            
+            has_next = (data[0] == 0x88)
+            uid_to_select = data[0:5]
+            sak_res = select(cl_level=cl, uid=uid_to_select)
+            
+            # SAK 校验
+            if not sak_res:
+                if not ignore_error: ASSERT_IS_NOT_NONE(sak_res, msg=f"CL{cl} SAK 选择失败")
+                else: print(f"Warning: CL{cl} SAK 选择失败")
+            
+            if has_next:
+                full_uid.extend(data[1:4])
+            else:
+                full_uid.extend(data[0:4])
+                # 记录最后一次 SELECT 的 SAK
+                sak = sak_res[0] if sak_res else 0
+                break
+        
+        # 返回兼容的字典格式
+        return {
+            'uid': bytes(full_uid),
+            'atq': atq,
+            'sak': sak,
+            'raw': bytes(full_uid) # 兼容原有的 raw 字段
+        }
+    
+def transceive(data: list[int], tx_crc: bool = True, rx_crc: bool = True) -> list[int]:
+    """
+    使用底层帧交互方式发送数据。
+
+    Args:
+        data: 要发送的字节列表。
+        tx_crc: 发送时是否自动添加 CRC。
+        rx_crc: 接收时是否自动校验 CRC。
+
+    Returns:
+        list[int]: 接收到的数据字节列表。
+    """
+    ASSERT_IS_NOT_NONE(_driver, msg="NFC driver not connected.")
+    _driver.set_crc(tx_crc, rx_crc)
+    res = _driver.transceive(bytes(data))
+    # print(f"transceive: {FORMAT_HEX(data)}")
+    return list(res) if res is not None else []
+
+def transceive_bits(data: list[int], last_tx_bits: int = 0, tx_crc: bool = True, rx_crc: bool = True) -> tuple[list[int], int]:
+    """
+    使用底层帧交互方式发送数据，并支持对最后一个字节进行位控制。
+
+    Args:
+        data: 要发送的字节列表。
+        last_tx_bits: 最后一个字节实际发送的有效位数 (1-7)，
+                      0 表示发送完整字节。
+        tx_crc: 发送时是否自动添加 CRC。
+        rx_crc: 接收时是否自动校验 CRC。
+
+    Returns:
+        tuple[list[int], int]: (接收到的数据字节列表, 最后一个字节的有效位数)。
+                               最后一个字节的有效位数 0 表示完整字节。
+    """
+    ASSERT_IS_NOT_NONE(_driver, msg="NFC driver not connected.")
+    _driver.set_crc(tx_crc, rx_crc)
+    res = _driver.transceive(bytes(data), last_tx_bits=last_tx_bits)
+    # print(f"transceive: {FORMAT_HEX(data, last_tx_bits)}")
+    return (list(res) if res is not None else []), _driver.last_rx_bits
+
+def reqa() -> tuple[list[int], int] | None:
+    """ISO14443-A REQA (7 bits)"""
+    # REQA: 0x26，短帧，仅发送 7 bits，响应无 CRC
+    return transceive_bits([0x26], last_tx_bits=7, tx_crc=False, rx_crc=False)
+
+def wupa() -> tuple[list[int], int] | None:
+    """ISO14443-A WUPA (7 bits)"""
+    # WUPA: 0x52，短帧，仅发送 7 bits，响应无 CRC
+    return transceive_bits([0x52], last_tx_bits=7, tx_crc=False, rx_crc=False)
+
+def halt() -> list[int] | None:
+    """ISO14443-A HALT (Standard Frame)"""
+    # HALT: 0x50 0x00 + CRC
+    return transceive([0x50, 0x00], tx_crc=True, rx_crc=True)
+
+def anticoll(cl_level: int, nvb: int = 0x20, uid_prefix: list[int] = []) -> tuple[list[int], int] | None:
+    """
+    ISO14443-A ANTICOLL (Anti-collision)
+    :param cl_level: 1 (0x93) or 2 (0x95)
+    :param nvb: Number of Valid Bits，定义了包含 SEL 和 NVB 在内的有效位数
+    :param uid_prefix: 已知的部分 UID (0-4 字节)
+    :return: (响应数据, last_rx_bits)
+    """
+    cmd = [0x93 if cl_level == 1 else 0x95, nvb] + uid_prefix
+    # 抗冲突响应无 CRC
+    return transceive_bits(cmd, last_tx_bits=0, tx_crc=False, rx_crc=False)
+
+def select(cl_level: int, uid: list[int]) -> list[int] | None:
+    """
+    ISO14443-A SELECT (Standard Frame)
+    :param cl_level: 1 (0x93) or 2 (0x95)
+    :param uid: 完整 5 字节 UID (包含 BCC)
+    """
+    cmd = [0x93 if cl_level == 1 else 0x95, 0x70] + uid
+    # 选择帧需带 CRC
+    return transceive(cmd, tx_crc=True, rx_crc=True)
+
+def field_on():
+    """开启 PN532 的 RF 场。"""
+    ASSERT_IS_NOT_NONE(_driver, msg="NFC driver not connected.")
+    _driver.set_rf_field(True)
+
+def field_off():
+    """关闭 PN532 的 RF 场。"""
+    ASSERT_IS_NOT_NONE(_driver, msg="NFC driver not connected.")
+    _driver.set_rf_field(False)
+
+def close():
+    """
+    断开与 PN532 读卡器的连接。
+    """
+    global _is_connected
+    if _is_connected and _driver:
+        _driver.disconnect()
+        _is_connected = False
+        print("Disconnected")

{nfcscript-0.0.1 → nfcscript-0.0.6}/src/nfcscript.egg-info/PKG-INFO

@@ -1,11 +1,11 @@
 Metadata-Version: 2.4
 Name: nfcscript
-Version: 0.0.1
-Summary: NFC test script
+Version: 0.0.6
+Summary: A plugin-based core engine for DSL-style NFC testing automation.
 Author: crthu
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
-Requires-Dist: CarrotRFIDTester
+Requires-Dist: nfctester
 
 # nfcscript
 

{nfcscript-0.0.1 → nfcscript-0.0.6}/src/nfcscript.egg-info/SOURCES.txt

@@ -1,9 +1,13 @@
 README.md
 pyproject.toml
-src/nfcscript/__init__.py
-src/nfcscript/assertions.py
-src/nfcscript/bits.py
-src/nfcscript/main.py
+src/nfc/__init__.py
+src/nfc/assertions.py
+src/nfc/bits.py
+src/nfc/checksum.py
+src/nfc/cli.py
+src/nfc/delay.py
+src/nfc/hex_util.py
+src/nfc/reader.py
 src/nfcscript.egg-info/PKG-INFO
 src/nfcscript.egg-info/SOURCES.txt
 src/nfcscript.egg-info/dependency_links.txt

nfcscript-0.0.6/src/nfcscript.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+nfcscript = nfc.cli:main

nfcscript-0.0.6/src/nfcscript.egg-info/requires.txt

@@ -0,0 +1 @@
+nfctester

nfcscript-0.0.6/src/nfcscript.egg-info/top_level.txt

@@ -0,0 +1 @@
+nfc

nfcscript-0.0.1/src/nfcscript/assertions.py

@@ -1,37 +0,0 @@
-import inspect
-from typing import Any
-
-def _get_stack_trace() -> str:
-    """获取格式化的调用堆栈"""
-    # inspect.stack()[0] 是 _get_stack_trace
-    # inspect.stack()[1] 是 ASSERT_... 函数
-    # inspect.stack()[2:] 是实际的业务调用代码
-    stack = inspect.stack()[2:]
-    chain = []
-    for frame in stack:
-        # 简化路径，仅显示文件名
-        filename = frame.filename.split('\\')[-1].split('/')[-1]
-        chain.append(f"  at {filename}:{frame.lineno} in {frame.function}")
-    return "\n".join(chain)
-
-def ASSERT_LEN(data: Any, expected_len: int) -> None:
-    actual_len = len(data)
-    if actual_len != expected_len:
-        error_msg = (
-            f"\nAssertion Failed: Length mismatch\n"
-            f"  Expected: {expected_len}\n"
-            f"  Actual  : {actual_len}\n"
-            f"  Data    : {data}\n"
-            f"Stack Trace:\n{_get_stack_trace()}"
-        )
-        raise AssertionError(error_msg)
-
-def ASSERT_EQUAL(actual: Any, expected: Any) -> None:
-    if actual != expected:
-        error_msg = (
-            f"\nAssertion Failed: Value mismatch\n"
-            f"  Expected: {expected} ({type(expected).__name__})\n"
-            f"  Actual  : {actual} ({type(actual).__name__})\n"
-            f"Stack Trace:\n{_get_stack_trace()}"
-        )
-        raise AssertionError(error_msg)

nfcscript-0.0.1/src/nfcscript/main.py

@@ -1,5 +0,0 @@
-def main():
-    print("Hello from nfcscript!")
-
-if __name__ == "__main__":
-    main()

nfcscript-0.0.1/src/nfcscript.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-nfcscript = nfcscript.main:main

nfcscript-0.0.1/src/nfcscript.egg-info/requires.txt

@@ -1 +0,0 @@
-CarrotRFIDTester

nfcscript-0.0.1/src/nfcscript.egg-info/top_level.txt

@@ -1 +0,0 @@
-nfcscript