Hardware Abstraction Layer (HAL) for NXP LPC82x microcontrollers, written in the Rust programming language
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.cargo
examples
scripts
src
tests
.gitignore
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
Cargo.toml
LICENSE
README.md
memory.x
rust-lpc82x-hal.sublime-project

README.md

LPC82x HAL crates.io Documentation Build Status

Introduction

Hardware Abstraction Layer (HAL) for NXP LPC82x microcontrollers, written in the Rust programming language. LPC82x HAL provides a high-level interface to the features of LPC82x MCUs, that is safe, convenient, and efficient.

LPC82x HAL leverages Rust's type system to prevent common mistakes. Things like attempting to use a peripheral that has not been properly initialized, or attempting to assign conflicting functions to the same pin, will all result in compile-time errors.

This crate is an implementation of embedded-hal. Please consider if you can make your code platform-independent, by depending on embedded-hal instead of this library.

Status

LPC82x HAL is still under heavy development. It is lacking APIs for many peripherals, and the APIs that already exist are mostly incomplete.

Do you need a feature that is currently missing? Please open an issue!

The existing APIs are expected to evolve significantly in the future. API stability is not guaranteed, which means future versions might not be compatible with code using the current version.

This crate currently requires a nightly version of the Rust toolchain. If you installed Rust via rustup, you can switch to the nightly version with rustup default nightly.

Help Wanted

Are you familiar with the LPC82x family? We need your help, even if you are not using LPC82x HAL. Some design issues require feedback from people familiar with the hardware and how it is used. Check out the help wanted tag on the issue tracker.

Do you want to contribute to LPC82x HAL? There's a number of good first issues on the issue tracker. If you're unsure about anything, check out our documentation on how to contribute, or just ask!

Usage

To include LPC82x HAL in you project, add the following to your Cargo.toml:

[dependencies]
lpc82x-hal = "0.2"

If you want to use LPC82x HAL in an application (as opposed to a library), there are additional things that need to be set up. Please refer to the API Reference for details.

Documentation

The API Reference should contain everything you need to use this library. If you think that anything's missing, please open an issue.

For functionality that is not yet covered by this crate, you may need to fall back to rust-lpc82x. Please refer to the rust-lpc82x documentation, should that be necessary.

The authoritative source on the LPC82x family is the LPC82x User Manual.

License

This project is open source software, licensed under the terms of the Zero Clause BSD License (0BSD, for short). This basically means you can do anything with the software, without any restrictions, but you can't hold the authors liable for problems.

See LICENSE for full details.

Supported by Braun Robotics