Docs.rs
  • esp32-0.37.0
    • esp32 0.37.0
    • Permalink
    • Docs.rs crate page
    • MIT OR Apache-2.0
    • Links
    • Repository
    • crates.io
    • Source
    • Owners
    • MabezDev
    • github:esp-rs:espressif
    • Dependencies
      • critical-section ^1.2.0 normal optional
      • defmt ^1.0.1 normal optional
      • vcell ^0.1.3 normal
    • Versions
    • 100% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate esp32

logo

esp320.37.0

  • All Items

Crate Items

  • Re-exports
  • Modules
  • Structs
  • Enums
  • Constants

Crates

  • esp32

Crate esp32

Source
Expand description

Peripheral access API for ESP32 microcontrollers (generated using svd2rust v0.35.0 ( ))

You can find an overview of the generated API here.

API features to be included in the next svd2rust release can be generated by cloning the svd2rust repository, checking out the above commit, and running cargo doc --open.

Re-exports§

pub use self::i2c0 as i2c1;
pub use self::i2s0 as i2s1;
pub use self::mcpwm0 as mcpwm1;
pub use self::spi0 as spi1;
pub use self::spi0 as spi2;
pub use self::spi0 as spi3;
pub use self::timg0 as timg1;
pub use self::uart0 as uart1;
pub use self::uart0 as uart2;
pub use self::uhci0 as uhci1;

Modules§

aes
AES (Advanced Encryption Standard) Accelerator
apb_ctrl
APB (Advanced Peripheral Bus) Controller
bb
BB Peripheral
dport
DPORT Peripheral
efuse
eFuse Controller
emac_dma
Ethernet DMA configuration and control registers
emac_ext
Ethernet Clock, PHY type, and SRAM configuration registers
emac_mac
Ethernet MAC configuration and control registers
flash_encryption
FLASH_ENCRYPTION Peripheral
frc_timer
FRC_TIMER Peripheral
generic
Common register and bit access and modify traits
gpio
General Purpose Input/Output
gpio_sd
Sigma-Delta Modulation
hinf
HINF Peripheral
i2c0
I2C (Inter-Integrated Circuit) Controller 0
i2s0
I2S (Inter-IC Sound) Controller 0
io_mux
Input/Output Multiplexer
ledc
LED Control PWM (Pulse Width Modulation)
mcpwm0
Motor Control Pulse-Width Modulation 0
nrx
NRX Peripheral
pcnt
Pulse Count Controller
rmt
Remote Control
rng
Hardware Random Number Generator
rsa
RSA (Rivest Shamir Adleman) Accelerator
rtc_cntl
Real-Time Clock Control
rtc_i2c
Low-power I2C (Inter-Integrated Circuit) Controller
rtc_io
Low-power Input/Output
sdhost
SD/MMC Host Controller
sens
SENS Peripheral
sha
SHA (Secure Hash Algorithm) Accelerator
slc
SLC Peripheral
slchost
SLCHOST Peripheral
spi0
SPI (Serial Peripheral Interface) Controller 0
timg0
Timer Group 0
twai0
Two-Wire Automotive Interface
uart0
UART (Universal Asynchronous Receiver-Transmitter) Controller 0
uhci0
Universal Host Controller Interface 0
wifi
MAC controller for Wi-Fi peripheral

Structs§

AES
AES (Advanced Encryption Standard) Accelerator
APB_CTRL
APB (Advanced Peripheral Bus) Controller
BB
BB Peripheral
DPORT
DPORT Peripheral
EFUSE
eFuse Controller
EMAC_DMA
Ethernet DMA configuration and control registers
EMAC_EXT
Ethernet Clock, PHY type, and SRAM configuration registers
EMAC_MAC
Ethernet MAC configuration and control registers
FLASH_ENCRYPTION
FLASH_ENCRYPTION Peripheral
FRC_TIMER
FRC_TIMER Peripheral
GPIO
General Purpose Input/Output
GPIO_SD
Sigma-Delta Modulation
HINF
HINF Peripheral
I2C0
I2C (Inter-Integrated Circuit) Controller 0
I2C1
I2C (Inter-Integrated Circuit) Controller 1
I2S0
I2S (Inter-IC Sound) Controller 0
I2S1
I2S (Inter-IC Sound) Controller 1
IO_MUX
Input/Output Multiplexer
LEDC
LED Control PWM (Pulse Width Modulation)
MCPWM0
Motor Control Pulse-Width Modulation 0
MCPWM1
Motor Control Pulse-Width Modulation 1
NRX
NRX Peripheral
PCNT
Pulse Count Controller
Peripherals
All the peripherals.
RMT
Remote Control
RNG
Hardware Random Number Generator
RSA
RSA (Rivest Shamir Adleman) Accelerator
RTC_CNTL
Real-Time Clock Control
RTC_I2C
Low-power I2C (Inter-Integrated Circuit) Controller
RTC_IO
Low-power Input/Output
SDHOST
SD/MMC Host Controller
SENS
SENS Peripheral
SHA
SHA (Secure Hash Algorithm) Accelerator
SLC
SLC Peripheral
SLCHOST
SLCHOST Peripheral
SPI0
SPI (Serial Peripheral Interface) Controller 0
SPI1
SPI (Serial Peripheral Interface) Controller 1
SPI2
SPI (Serial Peripheral Interface) Controller 2
SPI3
SPI (Serial Peripheral Interface) Controller 3
TIMG0
Timer Group 0
TIMG1
Timer Group 1
TWAI0
Two-Wire Automotive Interface
TryFromInterruptError
TryFromInterruptError
UART0
UART (Universal Asynchronous Receiver-Transmitter) Controller 0
UART1
UART (Universal Asynchronous Receiver-Transmitter) Controller 1
UART2
UART (Universal Asynchronous Receiver-Transmitter) Controller 2
UHCI0
Universal Host Controller Interface 0
UHCI1
Universal Host Controller Interface 1
WIFI
MAC controller for Wi-Fi peripheral

Enums§

Interrupt
Enumeration of all the interrupts.

Constants§

NVIC_PRIO_BITS
Number available in the NVIC for configuring priority

Results

Settings
Help
    type alias
    esp32::i2s0::CONF2
    CONF2 (rw) register accessor:
    type alias
    esp32::pcnt::unit::CONF2
    CONF2 (rw) register accessor:
    method
    esp32::i2s0::RegisterBlock::conf2
    0xa8 -
    method
    esp32::pcnt::unit::UNIT::conf2
    0x08 -
    module
    esp32::i2s0::conf2
    module
    esp32::pcnt::unit::conf2
    struct
    esp32::i2s0::conf2::CONF2_SPEC
    You can read this register and get conf2::R. You can reset…
    struct
    esp32::pcnt::unit::conf2::CONF2_SPEC
    You can read this register and get conf2::R. You can reset…
    type alias
    esp32::hinf::CIS_CONF2
    CIS_CONF2 (rw) register accessor:
    method
    esp32::hinf::RegisterBlock::cis_conf2
    0x28 -
    module
    esp32::hinf::cis_conf2
    type alias
    esp32::i2s0::PLC_CONF2
    PLC_CONF2 (rw) register accessor:
    method
    esp32::i2s0::RegisterBlock::plc_conf2
    0x94 -
    module
    esp32::i2s0::plc_conf2
    struct
    esp32::hinf::cis_conf2::CIS_CONF2_SPEC
    You can read this register and get cis_conf2::R. You can …
    struct
    esp32::i2s0::plc_conf2::PLC_CONF2_SPEC
    You can read this register and get plc_conf2::R. You can …
    type alias
    esp32::i2s0::CVSD_CONF2
    CVSD_CONF2 (rw) register accessor:
    method
    esp32::i2s0::RegisterBlock::cvsd_conf2
    0x88 -
    module
    esp32::i2s0::cvsd_conf2
    struct
    esp32::i2s0::cvsd_conf2::CVSD_CONF2_SPEC
    You can read this register and get cvsd_conf2::R. You can …
    method
    esp32::slchost::host_slchost_conf_w0::R::host_slchost_conf2
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w0::W::host_slchost_conf2
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w5::R::host_slchost_conf20
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w5::W::host_slchost_conf20
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w5::R::host_slchost_conf21
    Bits 8:15
    method
    esp32::slchost::host_slchost_conf_w5::W::host_slchost_conf21
    Bits 8:15
    method
    esp32::slchost::host_slchost_conf_w5::R::host_slchost_conf22
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w5::W::host_slchost_conf22
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w5::R::host_slchost_conf23
    Bits 24:31
    method
    esp32::slchost::host_slchost_conf_w5::W::host_slchost_conf23
    Bits 24:31
    method
    esp32::slchost::host_slchost_conf_w6::R::host_slchost_conf24
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w6::W::host_slchost_conf24
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w6::R::host_slchost_conf25
    Bits 8:15
    method
    esp32::slchost::host_slchost_conf_w6::W::host_slchost_conf25
    Bits 8:15
    method
    esp32::slchost::host_slchost_conf_w6::R::host_slchost_conf26
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w6::W::host_slchost_conf26
    Bits 16:23
    method
    esp32::slchost::host_slchost_conf_w6::R::host_slchost_conf27
    Bits 24:31
    method
    esp32::slchost::host_slchost_conf_w6::W::host_slchost_conf27
    Bits 24:31
    method
    esp32::slchost::host_slchost_conf_w7::R::host_slchost_conf28
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w7::W::host_slchost_conf28
    Bits 0:7
    method
    esp32::slchost::host_slchost_conf_w7::R::host_slchost_conf29
    Bits 8:15
    method
    esp32::slchost::host_slchost_conf_w7::W::host_slchost_conf29
    Bits 8:15
    type alias
    esp32::slchost::host_slchost_conf_w0::HOST_SLCHOST_CONF2_R
    Field HOST_SLCHOST_CONF2 reader -
    type alias
    esp32::slchost::host_slchost_conf_w0::HOST_SLCHOST_CONF2_W
    Field HOST_SLCHOST_CONF2 writer -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF20_R
    Field HOST_SLCHOST_CONF20 reader -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF20_W
    Field HOST_SLCHOST_CONF20 writer -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF21_R
    Field HOST_SLCHOST_CONF21 reader -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF21_W
    Field HOST_SLCHOST_CONF21 writer -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF22_R
    Field HOST_SLCHOST_CONF22 reader -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF22_W
    Field HOST_SLCHOST_CONF22 writer -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF23_R
    Field HOST_SLCHOST_CONF23 reader -
    type alias
    esp32::slchost::host_slchost_conf_w5::HOST_SLCHOST_CONF23_W
    Field HOST_SLCHOST_CONF23 writer -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF24_R
    Field HOST_SLCHOST_CONF24 reader -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF24_W
    Field HOST_SLCHOST_CONF24 writer -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF25_R
    Field HOST_SLCHOST_CONF25 reader -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF25_W
    Field HOST_SLCHOST_CONF25 writer -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF26_R
    Field HOST_SLCHOST_CONF26 reader -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF26_W
    Field HOST_SLCHOST_CONF26 writer -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF27_R
    Field HOST_SLCHOST_CONF27 reader -
    type alias
    esp32::slchost::host_slchost_conf_w6::HOST_SLCHOST_CONF27_W
    Field HOST_SLCHOST_CONF27 writer -
    type alias
    esp32::slchost::host_slchost_conf_w7::HOST_SLCHOST_CONF28_R
    Field HOST_SLCHOST_CONF28 reader -
    type alias
    esp32::slchost::host_slchost_conf_w7::HOST_SLCHOST_CONF28_W
    Field HOST_SLCHOST_CONF28 writer -
    type alias
    esp32::slchost::host_slchost_conf_w7::HOST_SLCHOST_CONF29_R
    Field HOST_SLCHOST_CONF29 reader -
    type alias
    esp32::slchost::host_slchost_conf_w7::HOST_SLCHOST_CONF29_W
    Field HOST_SLCHOST_CONF29 writer -
    type alias
    esp32::efuse::CONF
    CONF (rw) register accessor:
    type alias
    esp32::i2s0::CONF
    CONF (rw) register accessor:
    type alias
    esp32::ledc::CONF
    CONF (rw) register accessor:
    type alias
    esp32::ledc::hstimer::CONF
    CONF (rw) register accessor:
    type alias
    esp32::ledc::lstimer::CONF
    CONF (rw) register accessor:
    method
    esp32::efuse::RegisterBlock::conf
    0xfc -
    method
    esp32::i2s0::RegisterBlock::conf
    0x08 -
    method
    esp32::ledc::RegisterBlock::conf
    0x190 -
    method
    esp32::ledc::hstimer::HSTIMER::conf
    0x00 -
    method
    esp32::ledc::lstimer::LSTIMER::conf
    0x00 -
    module
    esp32::efuse::conf
    module
    esp32::i2s0::conf
    module
    esp32::ledc::conf
    module
    esp32::ledc::hstimer::conf
    module
    esp32::ledc::lstimer::conf
    module
    esp32::pcnt::unit::conf0
    Configuration register 0 for unit
    type alias
    esp32::ledc::hsch::CONF0
    CONF0 (rw) register accessor:
    type alias
    esp32::ledc::lsch::CONF0
    CONF0 (rw) register accessor:
    type alias
    esp32::pcnt::unit::CONF0
    CONF0 (rw) register accessor: Configuration register 0 for …
    type alias
    esp32::slc::CONF0
    CONF0 (rw) register accessor:
    type alias
    esp32::uart0::CONF0
    CONF0 (rw) register accessor:
    type alias
    esp32::uhci0::CONF0
    CONF0 (rw) register accessor:
    method
    esp32::ledc::hsch::HSCH::conf0
    0x00 -
    method
    esp32::ledc::lsch::LSCH::conf0
    0x00 -
    method
    esp32::pcnt::unit::UNIT::conf0
    0x00 - Configuration register 0 for unit
    method
    esp32::slc::RegisterBlock::conf0
    0x00 -
    method
    esp32::uart0::RegisterBlock::conf0
    0x20 -
    method
    esp32::uhci0::RegisterBlock::conf0
    0x00 -
    module
    esp32::ledc::hsch::conf0
    module
    esp32::ledc::lsch::conf0
    module
    esp32::slc::conf0
    module
    esp32::uart0::conf0
    module
    esp32::uhci0::conf0
    type alias
    esp32::i2s0::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::ledc::hsch::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::ledc::lsch::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::pcnt::unit::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::slc::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::uart0::CONF1
    CONF1 (rw) register accessor:
    type alias
    esp32::uhci0::CONF1
    CONF1 (rw) register accessor:
    method
    esp32::i2s0::RegisterBlock::conf1
    0xa0 -
    method
    esp32::ledc::hsch::HSCH::conf1
    0x0c -
    method
    esp32::ledc::lsch::LSCH::conf1
    0x0c -
    method
    esp32::pcnt::unit::UNIT::conf1
    0x04 -
    method
    esp32::slc::RegisterBlock::conf1
    0x60 -
    method
    esp32::uart0::RegisterBlock::conf1
    0x24 -
    method
    esp32::uhci0::RegisterBlock::conf1
    0x2c -
    module
    esp32::i2s0::conf1
    module
    esp32::ledc::hsch::conf1
    module
    esp32::ledc::lsch::conf1
    module
    esp32::pcnt::unit::conf1
    module
    esp32::slc::conf1
    module
    esp32::uart0::conf1
    module
    esp32::uhci0::conf1
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.
    method
    esp32::i2s0::RegisterBlock::conf2
    &RegisterBlock -> &CONF2
    0xa8 -
    method
    esp32::pcnt::unit::UNIT::conf2
    &UNIT -> &CONF2
    0x08 -