#arm #cortex-m #nrf52 #nrf #hal

no-std nrf-hal-common

Implementation details of the nRF HAL crates. Don’t use this directly, use one of the specific HAL crates instead (nrfXYZ-hal).

8 releases (4 breaking)

0.14.0 Sep 27, 2021
0.13.0 Aug 5, 2021
0.12.2 May 31, 2021
0.12.1 Mar 4, 2021
0.10.0 Apr 29, 2020

#13 in Embedded development

Download history 186/week @ 2021-08-10 131/week @ 2021-08-17 180/week @ 2021-08-24 51/week @ 2021-08-31 308/week @ 2021-09-07 188/week @ 2021-09-14 217/week @ 2021-09-21 131/week @ 2021-09-28 160/week @ 2021-10-05 139/week @ 2021-10-12 93/week @ 2021-10-19 97/week @ 2021-10-26 187/week @ 2021-11-02 288/week @ 2021-11-09 109/week @ 2021-11-16 155/week @ 2021-11-23

761 downloads per month
Used in 24 crates (7 directly)

MIT/Apache

430KB
10K SLoC

nrf-hal

HAL for the nRF51, nRF52 and nRF91 families of microcontrollers

CI

Please refer to the changelog to see what changed in the last releases.

Crates

Every nRF chip has its own crate, listed below:

Crate Docs crates.io target
nrf51-hal docs.rs crates.io thumbv6m-none-eabi
nrf52810-hal docs.rs crates.io thumbv7em-none-eabi
nrf52811-hal docs.rs crates.io thumbv7em-none-eabi
nrf52832-hal docs.rs crates.io thumbv7em-none-eabihf
nrf52833-hal docs.rs crates.io thumbv7em-none-eabihf
nrf52840-hal docs.rs crates.io thumbv7em-none-eabihf
nrf9160-hal docs.rs crates.io thumbv8m.main-none-eabihf

Device Reference Manuals from Nordic

Device Product Specification DK Reference Guide
nRF52810 v1.3 v1.3.1*
nRF52811 v1.0 v1.3.1*
nRF52832 v1.4 v1.3.1*
nRF52833 v1.3 v1.0.1
nRF52840 v1.1 v1.2
nRF9160 v2.0 v0.9.3

* These devices do not have a separate development kit and share the NRF52 DK

Development

Be sure to copy and edit the Cargo.example.toml file to Cargo.toml. The file will require editing dependent on the target you wish to work with and contains some further instructions. Similarly, check out the .vscode/settings.json file when used in the context of Visual Studio Code. By default, all of these files are configured to work with the nRF52840 target.

License

Licensed under either of

at your option.

Contribution

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

Summary of the Examples

Here follows a brief description of each demo for quick reference. For a more in-depth explanation on how the peripherals work please refer to the device reference manuals linked above, the readme for each demo and the comments in the demo code itself.

Demo Category Description
blinky-button-demo Hello World Blinky button demo
ccm-demo Encryption Cipher block chaining - message authentication code (CCM) mode demo
comp-demo Analog Pins Voltage comparator peripheral demo
ecb-demo Encryption AES electronic codebook mode encryption demo
gpiote-demo Digital Pins General-Purpose Input Output Tasks and Events module demo
i2s-controller-demo Audio Inter-IC Sound interface "controller mode (aka master mode)" demo
i2s-peripheral-demo Audio Inter-IC Sound interface "peripheral mode (aka slave mode)" demo
lpcomp-demo Analog Pins Low power voltage comparator demo
ppi-demo Channels Programmable peripheral interconnect (PPI) demo
pwm-demo Digital Pins Pulse width modulation demo
qdec-demo Sensor Decoding Quadrature sensor decoder (QDEC) demo
rtic-demo Framework The Real-Time Interrupt-driven Concurrency framework demo
spi-demo Digital Pins Serial peripheral interface master (SPIM) with EasyDMA demo
spis-demo Digital Pins Serial peripheral interface slave (SPIS) demo
twi-ssd1306 Digital Pins I2C compatible Two-Wire Interface with the SSD1306 OLED Display demo
twim-demo Digital Pins I2C compatible Two-Wire Interface Master mode demo
twis-demo Digital Pins I2C compatible Two-Wire Interface Slave mode demo
wdt-demo Timer Watchdog timer demo

Running the Examples

Each demo readme should contain instructions on how to run it. However, the information below describes the technologies used and can be used to troubleshoot your system setup. Run the demos from within their respective project directories. E.g. to run ccm-demo, you must be in the nrf-hal/examples/ccm-demo/ directory.

Since the demos are stand-alone projects you would NOT typically run them with cargo run --example xyz-demo like some cargo projects are configured to do.

Once Off System Setup

Install the cross compilation toolchain to target your device. You would typically pass the target as a parameter to cargo or explicitly set it in your cargo config file. If you get compilation errors about eh_personality then you have not set the target correctly. Here is an example of the target for a nRF52840 chip:

$ rustup target add thumbv7em-none-eabihf

Install the tools to flash the device.

$ cargo install cargo-embed

For Every Project (optional)

Setup the Cargo.toml file to use the correct features. Features allow for conditional compilation which is essential for a library like this that supports multiple different devices. Under the [features] section add the following line default = ["52840"] for the nRF52840-DK device or whatever other feature is applicable for your device. This is optional but it will allow you to simply call cargo run and cargo build instead of cargo run --features 52840 and cargo build --features 52840 respectively. Note that some demo projects do not have features so this step may not be necessary. If you get a whole bunch of compilation errors or plugins like rust-analyzer are not working then check that you have set the chip features correctly.

Dependencies

~2–12MB
~377K SLoC