esp_board_manager_defs.h
Header File
Macros
-
ESP_BOARD_DEVICE_NAME_AUDIO_DAC
Reserved device names.
Audio DAC device base nameThe device name identifies a device in user applications The board manager defines the following device names for the corresponding devices You can use these names directly in user applications and in board_devices.yaml You may also define your own device names in applications and in board_devices.yaml, but they must be unique and must not conflict with the reserved names
-
ESP_BOARD_DEVICE_NAME_AUDIO_ADC
Audio ADC device base name
-
ESP_BOARD_DEVICE_NAME_FS_SDCARD
SD card device base name
-
ESP_BOARD_DEVICE_NAME_FS_FAT
FAT filesystem device base name
-
ESP_BOARD_DEVICE_NAME_LCD_TOUCH
LCD touch device base name
-
ESP_BOARD_DEVICE_NAME_DISPLAY_LCD
LCD display device base name
-
ESP_BOARD_DEVICE_NAME_LCD_POWER
LCD power control device base name
-
ESP_BOARD_DEVICE_NAME_LCD_BRIGHTNESS
LCD brightness control device base name
-
ESP_BOARD_DEVICE_NAME_LED_STRIP
LED strip device base name
-
ESP_BOARD_DEVICE_NAME_FS_SPIFFS
SPIFFS filesystem device base name
-
ESP_BOARD_DEVICE_NAME_LITTLEFS
LittleFS filesystem device base name
-
ESP_BOARD_DEVICE_NAME_GPIO_EXPANDER
GPIO expander device base name
-
ESP_BOARD_DEVICE_NAME_CAMERA
Camera device base name
-
ESP_BOARD_DEVICE_NAME_SD_POWER
SD card power control device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_0
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_1
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_2
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_3
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_4
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_5
ADC button device base name
-
ESP_BOARD_DEVICE_NAME_ADC_BUTTON_GROUP
ADC button device base name
-
ESP_BOARD_DEVICE_TYPE_AUDIO_CODEC
Device type keys.
Audio codec device typeThe type identifies the category of a device. Multiple devices can share the same type Format: lowercase letters, numbers, and underscores Must not be numbers only; must be unique within the configuration
-
ESP_BOARD_DEVICE_TYPE_FS_FAT
FAT filesystem device type
-
ESP_BOARD_DEVICE_TYPE_FS_SPIFFS
SPIFFS filesystem device type
-
ESP_BOARD_DEVICE_TYPE_LITTLEFS
LittleFS filesystem device type
-
ESP_BOARD_DEVICE_TYPE_LCD_TOUCH
LCD touch device type
-
ESP_BOARD_DEVICE_TYPE_LCD_TOUCH_I2C
LCD touch I2C device type
-
ESP_BOARD_DEVICE_TYPE_DISPLAY_LCD
LCD display SPI device type
-
ESP_BOARD_DEVICE_TYPE_GPIO_CTRL
GPIO control device type
-
ESP_BOARD_DEVICE_TYPE_LEDC_CTRL
LEDC control device type
-
ESP_BOARD_DEVICE_TYPE_LED_STRIP
LED strip device type
-
ESP_BOARD_DEVICE_TYPE_GPIO_EXPANDER
GPIO expander device type
-
ESP_BOARD_DEVICE_TYPE_CAMERA
Camera sensor device type
-
ESP_BOARD_DEVICE_TYPE_POWER_CTRL
Power control device type
-
ESP_BOARD_DEVICE_TYPE_BUTTON
Button device type
-
ESP_BOARD_PERIPH_FORMAT_STD_OUT
Peripheral format keys (I2S)
I2S standard output formatThese define valid values for the I2S format field The format uses hyphen-separated values Examples: tdm-out, tdm-in, std-out, std-in, pdm-out, pdm-in
-
ESP_BOARD_PERIPH_FORMAT_STD_IN
I2S standard input format
-
ESP_BOARD_PERIPH_NAME_I2C_MASTER
Peripheral name keys.
I2C master peripheral nameThese define commonly used peripheral names across different boards Using these macros ensures consistency and avoids typos
-
ESP_BOARD_PERIPH_NAME_I2S_AUDIO_OUT
I2S audio output peripheral name
-
ESP_BOARD_PERIPH_NAME_I2S_AUDIO_IN
I2S audio input peripheral name
-
ESP_BOARD_PERIPH_NAME_SPI_DISPLAY
SPI display peripheral name
-
ESP_BOARD_PERIPH_NAME_SPI_MASTER
SPI master peripheral name
-
ESP_BOARD_PERIPH_NAME_LEDC_BACKLIGHT
LEDC backlight peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_PA_CONTROL
GPIO power amplifier control peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_BACKLIGHT_CONTROL
GPIO backlight control peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_SD_POWER
GPIO SD card power control peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_LCD_RESET
GPIO LCD reset peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_POWER_LCD
GPIO LCD power peripheral name
-
ESP_BOARD_PERIPH_NAME_GPIO_MONITOR
GPIO monitor peripheral name
-
ESP_BOARD_PERIPH_NAME_ADC
ADC unit 1 peripheral name
-
ESP_BOARD_PERIPH_NAME_DAC
DAC channel 0 peripheral name
-
ESP_BOARD_PERIPH_NAME_RMT_TX
RMT transmitter peripheral name
-
ESP_BOARD_PERIPH_NAME_RMT_RX
RMT receiver peripheral name
-
ESP_BOARD_PERIPH_NAME_PCNT_UNIT
PCNT unit peripheral name
-
ESP_BOARD_PERIPH_NAME_MCPWM
MCPWM group 0 peripheral name
-
ESP_BOARD_PERIPH_NAME_UART_1
UART 1 peripheral name
-
ESP_BOARD_PERIPH_NAME_SDM
SDM peripheral name
-
ESP_BOARD_PERIPH_NAME_ANACMPR
Analog Comparator peripheral name
-
ESP_BOARD_PERIPH_NAME_LDO_MIPI
LDO for MIPI peripheral name
-
ESP_BOARD_PERIPH_NAME_DSI_DISPLAY
DSI display peripheral name
Enumerations
-
enum esp_board_periph_role_t
Peripheral role enum.
These define valid values for the peripheral role field The role describes the peripheral's function (for example: master/slave, host/device)
Values:
-
enumerator ESP_BOARD_PERIPH_ROLE_NONE
No specific role
-
enumerator ESP_BOARD_PERIPH_ROLE_MASTER
Master role
-
enumerator ESP_BOARD_PERIPH_ROLE_SLAVE
Slave role
-
enumerator ESP_BOARD_PERIPH_ROLE_IO
IO role
-
enumerator ESP_BOARD_PERIPH_ROLE_TX
Transmitter role
-
enumerator ESP_BOARD_PERIPH_ROLE_RX
Receiver role
-
enumerator ESP_BOARD_PERIPH_ROLE_CONTINUOUS
Continuous role
-
enumerator ESP_BOARD_PERIPH_ROLE_ONESHOT
Oneshot role
-
enumerator ESP_BOARD_PERIPH_ROLE_COSINE
Cosine role
-
enumerator ESP_BOARD_PERIPH_ROLE_NONE