# canmatrix

**Repository Path**: mirrors_ebroecker/canmatrix

## Basic Information

- **Project Name**: canmatrix
- **Description**: Converting Can (Controller Area Network) Database Formats .arxml .dbc .dbf .kcd ...
- **Primary Language**: Unknown
- **License**: BSD-2-Clause
- **Default Branch**: development
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2022-01-05
- **Last Updated**: 2025-11-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## Canmatrix is a python package to read and write several CAN (Controller Area Network) database formats.

[![PyPI](https://img.shields.io/pypi/v/canmatrix.svg)](https://pypi.org/project/canmatrix/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/canmatrix.svg)](https://pypi.org/project/canmatrix/)
[![Coverall](https://coveralls.io/repos/github/ebroecker/canmatrix/badge.svg?branch=development)](https://coveralls.io/github/ebroecker/canmatrix?branch=development)
[![GitHub issues](https://img.shields.io/github/issues-raw/ebroecker/canmatrix.svg)](https://github.com/ebroecker/canmatrix/issues)


## About

***Canmatrix*** implements a "Python Can Matrix Object" which describes the can-communication and the needed objects (Boardunits, Frames, Signals, Values, ...)
***Canmatrix*** also includes two **Tools** (canconvert and cancompare) for converting and comparing **CAN** databases.

- Multiple formats automotive related communication matrix file parsing.
- CAN message encoding and decoding.

**Supported file formats for import:**

    .dbc candb / Vector
    .dbf Busmaster (open source!)
    .kcd kayak (open source!)
    .arxml autosar system description
    .yaml dump of the python object
    .xls(x) excel xls-import, works with .xls-file generated by this lib
    .sym peak pcan can description
    .xml (fibex or CANopen eds)
    .ldf (lin bus) 
    .odx (diagnostic file)
    .eds

**Supported file formats for export:**

    .dbc
    .dbf
    .kcd
    .xls(x)
    .json Canard (open source!)
    .arxml (very basic implementation)
    .yaml (dump of the python object)
    .sym
    .xml (fibex)
    .lua (wireshark script)
    .scapy 

Project Homepage: https://github.com/ebroecker/canmatrix

Documentation: https://canmatrix.readthedocs.io


## Installation

https://canmatrix.readthedocs.io/en/latest/installation.html

[Chinese Translation / 安装中文方法解释及注意事项](https://github.com/ebroecker/canmatrix/wiki/%E5%AE%89%E8%A3%85%E4%B8%AD%E6%96%87%E6%96%B9%E6%B3%95%E8%A7%A3%E9%87%8A%E5%8F%8A%E6%B3%A8%E6%84%8F%E4%BA%8B%E9%A1%B9)


## Contributing

Source Code, Documentation, Examples, Report issues and Any other contributions are **extremely appreciated**.

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request