https://github.com/esp-rs/esp32

Peripheral access crate for the ESP32
https://github.com/esp-rs/esp32

Last synced: 5 days ago
JSON representation

Peripheral access crate for the ESP32

• Host: GitHub
• URL: https://github.com/esp-rs/esp32
• Owner: esp-rs
• License: apache-2.0
• Archived: true
• Created: 2019-01-15T17:54:04.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-10-05T19:11:54.000Z (about 3 years ago)
• Last Synced: 2024-08-03T09:12:28.781Z (4 months ago)
• Language: Rust
• Homepage:
• Size: 3.57 MB
• Stars: 126
• Watchers: 13
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# esp32

[![Build Status](https://travis-ci.com/esp-rs/esp32.svg?branch=master)](https://travis-ci.com/esp-rs/esp32)

![crates.io](https://img.shields.io/crates/v/esp32.svg)

A peripheral access crate the ESP32. See the [`svd2rust repo`](https://github.com/rust-embedded/svd2rust) for more infomation on how to use this crate. Espressif do not provide an SVD for the esp32, so the svd used in this project has been generated from the C header documentation via the [idf2svd tool](https://github.com/MabezDev/idf2svd).

Join in on the discussion: https://matrix.to/#/#esp-rs:matrix.org!

## [`Documentation`](https://docs.rs/esp32/latest/esp32/)

## Building

Required dependencies:

- [form](https://crates.io/crates/form)

- [svd](https://github.com/stm32-rs/svdtools)

- [svd2rust](https://github.com/rust-embedded/svd2rust) - NOTE: Currently requires a `svd2rust` with this PR included: https://github.com/rust-embedded/svd2rust/pull/536

```

$ make

```

## Submitting new patches

The base svd file created from `idf2svd` should **not** be edited. Instead the svd is manipulated through the svdtools patching tool.

See [svd](https://github.com/stm32-rs/svdtools) and [stm32-rs yaml format](https://github.com/stm32-rs/stm32-rs#device-and-peripheral-yaml-format) for more infomation on the patching format

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  http://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

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.