cerinima / pcan-basic

PCAN Basic API written in Rust.

pcan-basic

Safe Rust wrapper around the pcan-basic-sys crate wrapping V4.6.0.600 of the PCAN-Basic API provided by the PEAK-System Technik GmbH.

Disclaimer: Since I am currently working on this crate, API changes may appear at any time. Please consider this if you want to use this crate. However, most features should be stable so not much to worry about.

Installation

Windows

• Install the PCAN-Basic API driver
• Use pcan-basic as a dependency

Linux

• Install the PCAN-Basic API driver
• Use pcan-basic as a dependency

Features

• Support for Windows and Linux
• Sending and receiving of CAN-bus frames
• Hardware identification features
• Additional information features
• Data flow features
• Log features
• Trace features
• IO features
• Many example files to choose from
• Proper documentation for each part of the API
• Implementation of the special API
• Implementation of CanFd sockets
• Proper testing of features for which I do not have the hardware available
• Trace file format implementation (will most likely go into cantools)

License / Terms of Usage

The source code of this project is licensed under the MIT/Apache-2.0 license. This implies that you are free to use, share, and adapt it. However, please give appropriate credit by citing the project.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the MIT/Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Contact

If you have problems using the software, find mistakes, or have general questions please use the issue tracker to contact us.

Contributors

• Tim Lucas Sabelmann