Crate arduino_hal 

arduino-hal

Common HAL (hardware abstraction layer) for Arduino boards.

Note: This version of the documentation was built for Arduino Uno. This means that only items which are available for this board are visible. If you are using a different board, try building the documentation locally with

cargo doc --open

in your project (where arduino-hal is included with the feature-flag for your board).

Usage

For setting up a new project, the avr-hal-template is the recommended baseline. Applications should be built ontop of the following skeleton:

#![no_std]
#![no_main]

use panic_halt as _;

#[arduino_hal::entry]
fn main() -> ! {
    let dp = arduino_hal::Peripherals::take().unwrap();
    let pins = arduino_hal::pins!(dp);

    loop { }
}

For examples, please check the avr-hal examples: https://github.com/Rahix/avr-hal/tree/main/examples

Re-exports

pub use atmega_hal as hal;mcu-atmega

pub use atmega_hal::pac;mcu-atmega

pub use hal::Peripherals;board-selected

pub use port::Pins;board-selected

pub use adc::Adc;mcu-atmega

pub use i2c::I2c;mcu-atmega

pub use spi::Spi;mcu-atmega

pub use usart::Usart;mcu-atmega

pub use eeprom::Eeprom;board-selected

pub use avr_device;

Modules

adcmcu-atmega

Analog to Digital converter.

clockboard-selected

MCU core clock support.

eepromboard-selected

i2cmcu-atmega

I2C bus controller.

portboard-selected

GPIO & Pin control.

preludemcu-atmega

simple_pwmboard-selected

spimcu-atmega

SPI controller.

usartmcu-atmega

Macros

default_serialarduino-diecimila or arduino-mega1280 or arduino-mega2560 or arduino-uno

Convenience macro to instantiate the Usart driver for this board.

pinsboard-selected

Convenience macro to instantiate the Pins struct for this board.

Functions

delay_msboard-selected

Delay execution for a number of milliseconds.

delay_nsboard-selected

Delay execution for a number of nanoseconds.

delay_usboard-selected

Delay execution for a number of microseconds.

Type Aliases

DefaultClockboard-selected and (arduino-diecimila or arduino-leonardo or arduino-mega1280 or arduino-mega2560 or arduino-micro or arduino-nano or arduino-uno or nano168 or sparkfun-promicro or sparkfun-promini-5v or trinket-pro)

Default clock speed for this board.

Delayboard-selected

Delay type for embedded-hal compatibility.

Attribute Macros

entryrt

Attribute to declare the entry point of the program