CANConfigPython

Python CLI and API for CANHub, CANFB, CANBridge, CANRPT and CANCOM configuration. The package runs a bundled Qt console subprocess, which uses WIICAN. It does not require a GUI installation or a separately installed Qt runtime.

0.1.0a2 is a prerelease. It corrects the documentation entry points and rebuilds Console/WIICAN with Qt 5.15.2. Windows supports Python 3.8+ on x86/x64: win32 bundles 32-bit native files, win_amd64 bundles 64-bit native files. Linux targets x86_64 with glibc 2.38 or newer (the audited manylinux baseline). Its bundled Qt 5.15.2 includes upstream compatibility fixes for current GCC. ARM64, macOS and musl are not supported.

canconfig / Python Client
    -> CANConfigConsole.exe + WIICAN.dll           (Windows)
    -> CANConfigConsole + libWIICAN.so.1           (Linux)

安装与首次检查 / Install and check

在 Python 虚拟环境中执行以下命令。Linux 可使用 python3；无需另装 Qt 或 WIICAN。 Run these commands in a Python virtual environment. Use python3 on Linux if needed.

python -m pip install CANConfigPython==0.1.0a2
canconfig --version --json
canconfig doctor --json

doctor 成功时返回 ok=true、exit_code=0、data.device_opened=false。 它检查随包运行库，不连接设备。schema、validate 和固件 --dry-run 也不打开硬件。 配置命令 info 和配置 --dry-run 会连接设备，并可能改变设备运行模式。

Doctor verifies the bundled runtime without opening a device. Check ok, exit_code and data.device_opened. Configuration info and configuration --dry-run connect to hardware and may change its run mode; use them only for an authorized target.

Upgrade to the latest prerelease with python -m pip install --upgrade --pre CANConfigPython. Uninstall with python -m pip uninstall CANConfigPython.

中文使用说明与英文手册 / User guides

完整的中英文手册已包含在安装包内。PyPI 简介不会提供源码目录中的文件网页； 请先导出文档，再在本机打开文件。以下操作无需连接设备或输入设备密码。

The complete Chinese and English manuals are included in the installed package. Export them to a new directory and open the files locally; no device is required.

canconfig docs export --output ./canconfig-docs

使用支持 Markdown 的编辑器阅读 .md 文件；Windows 也可执行 notepad .\canconfig-docs\user-guide.zh-CN.md 阅读文本。 The manuals cover installation, device selection, password handling, backup/export, validation/restore, JSON changes, firmware updates, failures and exit codes.

导出目录必须不存在；如果提示 output_exists，请换一个新目录名，例如 ./canconfig-docs-a2。导出不会覆盖已有文档，卸载也不会删除已导出的文件。 Export requires a new directory and never overwrites existing files.

Agent Skill 与用例 / Agent Skill and examples

canconfig skill export --output ./canconfig-skill

将整个导出目录交给所用 Agent，或按该 Agent 的要求安装。保留 references 和 assets 子目录，才能使用 Skill 内部的文档和用例链接。安装 Python 包不会自动修改 Agent 设置。 Keep the complete exported directory together. Package installation does not change Agent settings. Examples contain placeholder device identifiers and must be adapted to the confirmed device and authorized operation before use.

Python API

from canconfigpython import Client, ConfigError

client = Client()
try:
    result = client.execute("info", port="COM3")  # Linux: confirmed /dev/serial/by-id/... path
except ConfigError as error:
    print(error.code, error.message)
else:
    print(result["exit_code"], result["effects"], result["verification"])

execute(command, password=..., new_password=..., **options) uses snake_case options such as expect_uid, dry_run, and timeout_ms; command names match the CLI. Provide passwords from a secret store or prompt, not source code. Backend failures return the full result; check ok and exit_code. Local validation/runtime errors raise ConfigError. The wrapper does not automatically retry or roll back operations. The Python runtime layer uses only the standard library.

构建、验证记录与许可证 / Build, validation and licenses

导出文档后，在一个新的工作目录解压 canconfig-docs/native-source.tar.gz。 其顶层文件夹为 canconfigpython-source，其中包含：

Extract the exported source archive to read these documents. The PyPI source distribution also includes them. Simulated tests and installed-package checks do not establish real-device configuration, firmware or power-cycle acceptance.

Python 包装层和项目自有新增代码采用 MIT。Console 包含 XinLi 的 GPL-3.0-or-later Ymodem 实现，因此随包 Console 按 GPL-3.0-or-later 分发；Qt 和编译器运行库保留各自许可证。 The Python wrapper is MIT; the bundled Console is GPL-3.0-or-later. Every wheel contains its corresponding project source. Preserve all applicable third-party notices. Runtime hashes check bundle consistency; they are not publisher signatures.