can-hal-rs 0.4.1

Hardware-agnostic traits for CAN bus communication
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

<div align="center">
  <h1>can-hal-rs</h1>
  <p>
    <strong>Hardware-agnostic traits for CAN bus communication in Rust</strong>
  </p>
  <p>

[![crates.io](https://img.shields.io/crates/v/can-hal-rs?label=latest)](https://crates.io/crates/can-hal-rs)
[![Documentation](https://docs.rs/can-hal-rs/badge.svg)](https://docs.rs/can-hal-rs)
![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.81+-ab6000.svg)
![License](https://img.shields.io/crates/l/can-hal-rs.svg)
[![CI](https://github.com/can-hal-rs-contributors/can-hal-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/can-hal-rs-contributors/can-hal-rs/actions/workflows/ci.yml)

  </p>
</div>

`can-hal-rs` defines the interface. Backend crates implement it. Application code is portable across CAN hardware.

## `no_std` support

This crate is `no_std`-compatible (requires Rust 1.81+). The `std` feature is enabled by default. To use in embedded / `no_std` contexts:

```toml
[dependencies]
can-hal-rs = { version = "0.3", default-features = false }
```

## Traits

| Trait | Purpose |
|---|---|
| `Transmit` / `Receive` | Classic CAN (up to 8 bytes) |
| `TransmitFd` / `ReceiveFd` | CAN FD (up to 64 bytes) |
| `Filterable` | Hardware acceptance filtering |
| `BusStatus` | Bus state and error counters |

Async variants (`AsyncTransmit`, `AsyncReceive`, etc.) are available behind the `async` feature flag.

There is no shared `Driver` or `ChannelBuilder` trait - each backend exposes its own concrete driver and a typestate-driven builder where invalid combinations are compile errors. See the backend crates for details.

## Usage

```rust
use can_hal::{CanId, CanFrame, Transmit, Receive};

fn echo<T: Transmit<Error = E> + Receive<Error = E>, E: can_hal::CanError>(
    channel: &mut T,
) -> Result<(), E> {
    let msg = channel.receive()?;
    channel.transmit(msg.frame())?;
    Ok(())
}
```

## Backend crates

- [`can-hal-socketcan`](https://crates.io/crates/can-hal-socketcan) - Linux SocketCAN
- [`can-hal-pcan`](https://crates.io/crates/can-hal-pcan) - PEAK PCAN-Basic (Windows and Linux)
- [`can-hal-kvaser`](https://crates.io/crates/can-hal-kvaser) - KVASER CANlib (Windows and Linux)

## License

Licensed under either of [Apache License, Version 2.0](../LICENSE-APACHE) or [MIT License](../LICENSE-MIT) at your option.