Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.09 KB

README.md

File metadata and controls

81 lines (55 loc) · 2.09 KB
Raw

stm32g4-hal

🚧 Work in progress

stm32g4-hal contains a multi device hardware abstraction on top of the peripheral access API for the STMicro STM32G4 series microcontrollers. The selection of the MCU is done by feature gates, typically specified by board support crates.

Usage

This crate will eventually contain support for multiple microcontrollers in the stm32g4 family. Which specific microcontroller you want to build for has to be specified with a feature, for example stm32g431.

Currently supported configurations are:

  • stm32g431
  • stm32g441
  • stm32g471
  • stm32g473
  • stm32g474
  • stm32g483
  • stm32g484
  • stm32g491

Building an Example

If you are compiling the crate on its own for development or running examples, specify your microcontroller on the command line. For example:

cargo build --example blinky --features stm32g431,defmt

Running examples

Examples can be built and run using cargo run. It is necessary to provide any required features followed by the name of the chip.

cargo run --example blinky --features stm32g431,defmt --release -- --chip STM32G431CBUx

A list of chips supported by probe-rs can be found by running

probe-rs chip list

For furher information, see the documentation for probe-rs.

Using as a Dependency

When using this crate as a dependency in your project, the microcontroller can be specified as part of the Cargo.toml definition.

[dependencies]
stm32g4-hal = { version = "0.0.1", features = ["stm32g431", "defmt"] }

Documentation

The documentation can be found at docs.rs.

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.