Python中canmatrix解析dbc文件应用常见示例_Python

前言

dbc文件是汽车行业常见的数据库文件，用于描述can总线数据的物理值、单位、发送周期、计算公式、信号名称等信息。

用python处理dbc文件的库有很多，比如 python-can，cantools和canmatrix，甚至可以用正则表达式自行进行解析。其解析本质差不多，下面分享下canmatrix常用的一些方法。

1. 相关库安装

canmatrix使用时直接"import canmatrix"即可，但是会打印出一些 "xxx is not supported"的提示信息，这是使用到的库没安装导致的。
在.\canmatrix\formats路径下有很多 xxx.py文件，这些文件用于解析相对应后缀名的文件。打开"xxx is not supported"对应的.py，安装文件中用到（import）的三方库即可。

2. dbc和excel格式互转

安装canmatrix后，在\python\pythonxx\scripts路径下，会有一个canconvert.exe。可以直接在命令行中：

输入"canconvert xxx.dbc xxx.xlsx"将dbc转成xlsx格式。（表格中一些单元格中的字体是透明的，可以全选改成黑色。）

输入"canconvert xxx.xls xxx.dbc"将xls转成dbc格式。（不支持xlsx格式，可先将xlsx导出为xls格式）

也可以用canmatrix.convert py脚本，比如：

from canmatrix import convert

convert.convert(
    r'aa.dbc',
    r'aa.xlsx'
)

canconvert导入导出的表格是有固定格式的，常用于临时查看dbc中的报文和信号。一般公司会有matrix特定的表格格式，这就需要特定处理了。

3. 读取dbc文件

3.1 matrix信息

import canmatrix
file = r'test.dbc'
dbs = canmatrix.formats.loadp(file)
print(type(dbs), dbs)

canmatrix.formats.loadp(file)用于load不同格式的文件。打印其信息，是一个字典类型。

matrix = dbs.get('')
print(type(matrix), matrix)
for k, v in matrix.__dict__.items():
    print(k, v)

获取字典中的value，其类型是canmatrix，dbc中的信息都在这里。打印其中包含的信息，如下图所示：

3.2 ecu信息

for ecu in matrix.ecus:
    print(type(ecu), ecu.__dict__)

matrix.ecus包含了dbc中所有的ecu节点，信息如下：

3.3 message(frame)信息

for msg in matrix.frames:
    print(type(msg), msg.__dict__)
    for k, v in msg.__dict__.items():
        print(k, v)

报文的信息的类型是frame，参考图中打印的信息，一般用到：
- name：报文的名称
- arbitration_id.id：报文的id
- transmitters：发送报文节点（发送节点只会有一个）
- receivers：接收报文的节点
- signals：报文中的信号
- signalgroups：报文中的signalgroups
- cycle_time：报文周期

一些其他信息会在attributes 字典中，比如nm或者诊断报文。如果有其他信息想知道，可以用类似方式打印其.__dict__查看。

3.4 signal信息

    for signal in msg.signals:
        print(type(signal), signal.__dict__)
        for k, v in signal.__dict__.items():
            print(k, v)

signal的信息参考图中打印的内容，一般用到：
- name：信号名称
- start_bit：在layout中的起始位
- size：长度（bit）
- is_little_endian：motorola（big）和intel（little）格式
- is_signed：有无符号
- offset和factor：偏移和系数，用于转换成物理值
- min和max：最小值和最大值
- is_multiplexer：多路复用信号的multiplexor signal
- mux_val：multiplex value
- multiplex：和is_multiplexer、mux_val两个量信息是重复的。当信号是multiplexor signal时，这个量是字符串“multiplexor”；当信号是multiplexed signal时，这个量是multiplex value。

3.5 signalgroup信息

    for signalgroup in msg.signalgroups:
        print(type(signalgroup), signalgroup.__dict__)
        for k, v in signalgroup.__dict__.items():
            print(k, v)

signalgroup中主要包含信号的信息，其中的信号也包含在frame中，注意避免信号重复使用。

4. 常见应用示例

以下示例都是应用于vector的达芬奇开发工具，其他工具不清楚是否适用。用到的场景基本都是读取dbc中的报文和信号名称，再做一些其他处理。

4.1 comcbk回调函数添加

一般e2e信号的名称是有特定字符的，可判断其名称来确定所在报文是否为e2e报文。再结合xml解析脚本，可以在comcbk中自动添加回调函数的名称。

def is_signal_e2e(signal: canmatrix.signal):
    """
    判断信号是否是e2e信号，checksum or rolling_counter
    """
    rcs = ("rollcnt", "rollingcounter", "alivecounter", "rolling_counter", "alive_counter", "rollgcnt")
    crcs = ("chksum", "chksm", "checksum", "crc")
    for rc in rcs:
        if rc.lower() in signal.name.lower():
            return true
    for crc in crcs:
        if crc.lower() in signal.name.lower():
            return true
    return false

4.2 can_wrapper模块arxml或者代码生成

一般在项目中，asw和com之间会有一个中间模块（can_wrapper）进行数据的映射。这个模块和com之间的delegation接口可根据读取dbc自动生成。达芬奇developer也可以批量自动创建，但和asw的接口就得手动创建了。所以这里提下生成can_wrapper过程中和dbc有关的部分。接口的名称可以根据信号名再加一些特定格式，数据类型按照信号size和is_signed等定义计算出。示例代码如下：

def get_signal_datatype(signal: canmatrix.signal):
    """
    计算信号生成代码的数据类型。
    """
    datatype = "unknowntype "
    if signal.is_float is true:
        if signal.size == 32:
            datatype = "float32"
        elif signal.size == 64:
            datatype = "float64"
        else:
            print(f"not supported <{signal.size}> size of <float> data type. <{signal.__dict__}>")
    elif (signal.factor != 1) or (signal.offset != 0):
        datatype = "float32"
    elif signal.size == 1:
        datatype = "boolean"
    elif signal.size <= 8:
        if signal.is_signed:
            datatype = "sint8"
        else:
            datatype = "uint8"
    elif signal.size <= 16:
        if signal.is_signed:
            datatype = "sint16"
        else:
            datatype = "uint16"
    elif signal.size <= 32:
        if signal.is_signed:
            datatype = "sint32"
        else:
            datatype = "uint32"
    elif signal.size <= 64:
        if signal.is_signed:
            datatype = "sint64"
        else:
            datatype = "uint64"
    else:
        print(f"unexpected datatype of signal. <{signal.__dict__}>")
    return f"{datatype}"