common_hal_interface 1.0.16-alpha

A common interface between Rust HALs, for use in the Iron Coder IDE
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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

# common_hal_interface

A common interface between Rust HALs, for use in the Iron Coder IDE.

**One interface, any board.** The same macro names work across all supported platforms - just change the feature flag.

## Quick Start

```toml
[dependencies]
# Pick ONE feature for your board:
common_hal_interface = { version = "1.0.16-alpha", features = ["adafruit-feather-rp2040"] }
# OR: features = ["rp-pico"]
# OR: features = ["rp2040"]  (raw hal, no BSP)
# OR: features = ["arduino-uno"]
# OR: features = ["esp"]
```

```rust
use common_hal_interface::*;

// Same code works on any supported board!
rp2040_setup!(pac, core, clocks, pins);
let i2c = setup_i2c!(pac, clocks, 400_000u32, I2C1, pins.sda, pins.scl);
```

## Features

### RP2040 Boards
| Feature | Board | BSP Crate |
|---------|-------|-----------|
| `adafruit-feather-rp2040` | Adafruit Feather RP2040 | `adafruit-feather-rp2040` |
| `rp-pico` | Raspberry Pi Pico | `rp-pico` |
| `rp2040` | Raw HAL (no BSP) | `rp2040-hal` |

### Arduino Boards
| Feature | Board |
|---------|-------|
| `arduino-uno` | Arduino Uno |
| `arduino-nano` | Arduino Nano |
| `arduino-mega2560` | Arduino Mega 2560 |
| `arduino-leonardo` | Arduino Leonardo |

### Other
| Feature | Platform |
|---------|----------|
| `esp` | ESP32 family |
| `stm32f4` | STM32F4 (WIP) |

## Universal Macros

### RP2040 (all boards)

| Macro | Description |
|-------|-------------|
| `rp2040_setup!(pac, core, clocks, pins)` | Initialize peripherals |
| `new_delay!(core, clocks)` | Create cortex-m delay |
| `new_timer!(pac, clocks)` | Create hardware timer |
| `setup_i2c!(pac, clocks, baud, I2Cx, sda, scl)` | Set up I2C |
| `setup_spi!(pac, clocks, baud, SPIx, mosi, miso, sck, mode)` | Set up SPI |
| `setup_uart!(pac, clocks, baud, UARTx, tx, rx)` | Set up UART |
| `setup_neopixel!(pac, pin, clocks, timer)` | Set up WS2812 NeoPixel |
| `setup_onboard_neopixel!(pac, pins, clocks, timer)` | Set up onboard NeoPixel |

### Arduino

| Macro | Description |
|-------|-------------|
| `arduino_setup!(dp, pins)` | Initialize peripherals |
| `setup_serial!(dp, pins, baud)` | Set up serial |
| `setup_i2c!(dp, sda, scl, freq)` | Set up I2C |
| `setup_spi!(dp, sck, mosi, miso, ss)` | Set up SPI |

### ESP

| Macro | Description |
|-------|-------------|
| `esp_setup!()` | Initialize peripherals |
| `delay_ms!(ms)` | Delay milliseconds |
| `setup_i2c!(peripheral, sda, scl, freq_khz)` | Set up I2C |
| `setup_spi!(peripheral, sck, mosi, miso, freq_khz)` | Set up SPI |

## Example: Adafruit Feather RP2040

```rust
#![no_std]
#![no_main]

use adafruit_feather_rp2040::entry;
use panic_halt as _;
use ws2812_pio::Ws2812;
use common_hal_interface::*;

#[entry]
fn main() -> ! {
    // Initialize - same on any RP2040 board
    rp2040_setup!(pac, core, clocks, pins);

    let mut delay = new_delay!(core, clocks);
    let timer = new_timer!(pac, clocks);

    // I2C on labeled pins
    let i2c = setup_i2c!(pac, clocks, 400_000u32, I2C1, pins.sda, pins.scl);

    // NeoPixel on D4
    let ws = setup_neopixel!(pac, pins.d4, clocks, timer);

    loop {
        delay.delay_ms(100);
    }
}
```

## Switching Boards

To switch from Feather to Pico, just change:

1. `Cargo.toml`: `features = ["rp-pico"]`
2. `use` statement: `use rp_pico::entry;`
3. Pin names (BSP-specific): `pins.gpio2` instead of `pins.sda`

The macro calls stay the same!

## License

MIT