rp-hal

A Rust HAL impl for the RP family of microcontrollers from the Raspberry Pi Foundation
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Usage
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgements

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

• A Rust toolchain

Installation

1. Clone the repo or use the crate

   git clone https://github.com/rp-rs/rp-hal
   

   or

   cargo install rpXXXX-hal
   

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Run examples

UF2

For boards with uf2 flashloaders like the raspberry pi pico. Install elf2uf2-rs:

cargo install elf2uf2-rs

Make sure .cargo/config contains the following (it should by default):

runner = "elf2uf2-rs -d"

cargo run --example pico_pwm_blink # Run `cargo run --example` for more examples

Roadmap

NOTE This HAL is under active development. As such, it is likely to remain volatile until a 1.0.0 release.

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT OR Apache2.0 License. See MIT or APACHE2.0 for more information.

Contact

Project Link: https://github.com/rp-rs/rp-hal/issues

Acknowledgements

• Othneil Drew's README template