esp-idf-hal/README.md
Christian Meusel 8fc7e6d35d
Add basic driver for LEDC (#43)
* Add basic LEDC driver

This driver allows to configure timers and channels but does not provide
advanced features like fading

* Added missing impl_channels.

* Use non-raw types for LEDC hw "handle" markers

This makes Timer and Channel Sync again.

* Add missing config and deps for dev building examples

* Add simple example for LEDC driver

* Channel changed to hold Timer as Borrow<>, to allow Arc etc.

* Provide unstable options from config.toml

This allows to build and run examples of this crate with cargo-espflash
1.2.0 which does not support passing unstable options.

* Provide ESP_IDF_SDKCONFIG_DEFAULTS from config.toml

This requires only to specify the target for a build explicitly.

* Use main task stack size from rust-esp32-std-demo

* Add multi-threaded example for LEDC

* Clean up ledc example and formatting

* Add note on running examples from this repository

* Fix build for ULP HAL

This LEDC interface is not available there.

* Build examples in CI too

* Use core types for no_std build of ledc

* Init channel config and hpoint with Default

This makes the initialization compatible with ESP IDF 4.3 and 4.4 where
the new field 'flag' has been added. As the default for hpoint was
previously zero, omitting it allows to use ..Default::default() in the
struct initialization in both cases.

* Install ldproxy in CI for building examples

It gets installed just before building examples because this takes its
time and should not delay other builds.

Co-authored-by: yunta <maciej.blomberg@mikoton.com>
2022-02-05 18:57:46 +02:00

1.7 KiB

An embedded-hal implementation for Rust on ESP32 and ESP-IDF

CI

  • This crate is intended for usage in ESP32 embedded projects that utilize and link with the ESP-IDF SDK.
  • For embedded projects that don't need Rust STD support, WiFi or BLE (and thus don't link with the ESP-IDF SDK), please check esp32-hal.

For more information, check out:

Hardware Notes

Each chip has a number of GPIO pins which are generally used by the SPI0 and SPI1 peripherals in order to connect external PSRAM and/or SPI Flash memory. The datasheets explicitly state that these are not recommended for use, however this crate includes them anyways for completeness.

Please refer to the table below to determine the pins which are not recommended for use for your chip.

Chip GPIOs
ESP32 6 - 11, 16 - 17
ESP32-C3 12 - 17
ESP32-S2 26 - 32
ESP32-S3 26 - 32, 33 - 37*

* When using Octal Flash and/or Octal PSRAM

Examples

The examples could be built and flashed conveniently with cargo-espflash. To run ledc-simple on an ESP32-C3:

$ cargo espflash --release --target riscv32imc-esp-espidf --example ledc-simple --monitor /dev/ttyUSB0