Metadata-Version: 2.4
Name: python-can-hirain
Version: 0.2.1
Summary: python-can interface plugin for Hirain
Author-email: Jingwei Hirain <fei.guo@hirain.com>
License: MIT
Keywords: python-can,CAN,Hirain
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: python-can>=4.0.0
Dynamic: license-file

# python-can-hirain

Python CAN 接口适配器，用于通过 **python-can** 库操作 **HIRAIN TestBaseVCI** 硬件设备。

## 安装

使用 pip 安装：

```bash
pip install python-can-hirain
```

安装后，`hrcan` 接口会自动注册到 python-can 中，无需手动复制文件或修改 `__init__.py`。

## 快速开始

### CAN 通信示例

```python
import can
import time

# 初始化 CAN 通道
with can.Bus(interface="hrcan", channel=0, # 激活通道0为CANFD通道
    configs = [{
        'resistance': 1, # 启用终端电阻
        'mode' : TestBaseVCI_ChlMode.CAN, # 设置CAN通道
        'listenFlag' : 0, # 0-正常状态，1-通道为仅监听状态，不给ACK响应
        'baudrate': 500_000,
        'samplePoint': TestBaseVCI_SAMPLEPOINT.SAMPLE_75}]) as bus:
    pass
# 初始化 CANFD 通道
with can.Bus(interface="hrcan", channel=0, # 激活通道0为CANFD通道
        configs = [{
            'resistance': 1, # 启用终端电阻
            'mode' : TestBaseVCI_ChlMode.CANFD, # 设置CANFD通道
            'listenFlag' : 0, # 0-正常状态，1-通道为仅监听状态，不给ACK响应
            'abrBaudrate': 500_000,
            'dbrBaudrate': 2000_000,
            'abrSamplePoint': TestBaseVCI_SAMPLEPOINT.SAMPLE_80,
            'dbrSamplePoint': TestBaseVCI_SAMPLEPOINT.SAMPLE_80,}]) as bus:
    pass
```


## 环境要求

- **操作系统**: Windows 10/11, Ubuntu 20/22
- **硬件驱动**: TestBaseVCI 驱动程序 2.4.1+
- **Python**: 64 位 Python 3.7+
- **依赖库**: python-can

## 更多示例

查看 `demo/` 目录获取完整示例：
- `Test_can.py` - 经典 CAN 操作示例
- `Test_Canfd.py` - CAN FD 操作示例  
- `Test_diag.py` - 诊断功能示例

## 注意事项

- 确保 TestBaseVCI 驱动程序已正确安装
- Linux 系统上使用 sudo 时，可能需要添加 `-E` 参数保留环境变量
- 使用前请确认设备能被系统识别

## 支持

有关详细配置参数和高级用法，请参考 python-can 官方文档和 HIRAIN 二次开发SDK手册。
