https://github.com/tuemb/peak-can-rs
Rust wrapper for API by PEAK
https://github.com/tuemb/peak-can-rs
Last synced: 3 months ago
JSON representation
Rust wrapper for API by PEAK
- Host: GitHub
- URL: https://github.com/tuemb/peak-can-rs
- Owner: TuEmb
- License: apache-2.0
- Created: 2025-03-24T08:21:06.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-03-24T09:42:53.000Z (3 months ago)
- Last Synced: 2025-03-24T09:51:28.824Z (3 months ago)
- Language: Rust
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# peak-can-rs
A Rust wrapper for PEAK-System's PCAN-Basic API, providing access to PEAK CAN interfaces.
## Features
- Supports sending and receiving CAN messages.
- Provides a safe Rust interface for working with PCAN devices.
- FFI bindings to the PCAN-Basic library.
## Requirements
- Windows OS
- PEAK-System PCAN drivers installed
- `PCANBasic.lib` and `PCANBasic.dll` available
## Installation
### 1. Install the PCAN-Basic Library
Download and install the [PCAN-Basic API](https://www.peak-system.com/PCAN-Basic.239.0.html) from PEAK-System.
### 2. Add `peak-can-rs` to Your Cargo Project
```toml
[dependencies]
peak-can = "0.1.0"
```
## Usage
### Example: Sending a CAN Message
```
cargo run --example receive
```
### Example: Receiving a CAN Message
```
cargo run --example receive
```
## Linking PCANBasic.lib
If you get a linking error, ensure `PCANBasic.lib` is in your library path:
1. Download `PCANBasic.lib` from https://www.peak-system.com/Software-Information.77.0.html?&L=1.
2. Modify `build.rs` in your Rust project:
```rust
fn main() {
println!("cargo:rustc-link-search=native=C:\\Libraries\\PCANBasic");
println!("cargo:rustc-link-lib=static=PCANBasic");
}
```
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
## Contributions
Contributions are welcome! Feel free to open an issue or a pull request.