[−][src]Crate esp_idf_bindgen
Re-exports
pub use self::nvs_open_mode_t as nvs_open_mode; |
pub use self::esp_interface_t as wifi_interface_t; |
pub use self::esp_netif_flags as esp_netif_flags_t; |
pub use self::esp_netif_ip_event_type as esp_netif_ip_event_type_t; |
pub use self::wifi_event_sta_wps_fail_reason_t as system_event_sta_wps_fail_reason_t; |
pub use self::esp_sleep_source_t as esp_sleep_wakeup_cause_t; |
Structs
Enums
ETS_STATUS | @addtogroup ets_apis @{ |
GPIO_INT_TYPE | |
RingbufferType_t | |
STATUS | |
_bindgen_ty_1 | |
adc1_channel_t |
|
adc2_channel_t |
|
adc_atten_t | @brief ADC attenuation parameter. Different parameters determine the range of the ADC. See |
adc_bits_width_t | @brief ADC resolution setting option. |
adc_channel_t | @brief ADC channels handle. See |
adc_i2s_source_t | @brief ESP32 ADC DMA source selection. |
adc_i2s_encode_t | @brief ADC digital controller encode option. |
adc_unit_t | @brief ADC units selected handle. |
eNotifyAction | Actions that can be performed when vTaskNotify() is called. |
eSleepModeStatus | Possible return values for eTaskConfirmSleepModeStatus(). |
eTaskState | Task states returned by eTaskGetState. |
err_enum_t | Definitions for error constants. |
esp_chip_id_t | @brief ESP chip ID |
esp_chip_model_t | @brief Chip models |
esp_crypto_cipher_alg_t | |
esp_crypto_hash_alg_t | |
esp_flash_io_mode_t | @brief Mode used for reading from SPI flash |
esp_flash_speed_t | @brief SPI flash clock speed values, always refer to them by the enum rather than the actual value (more speed may be appended into the list). |
esp_image_flash_size_t | @brief Supported SPI flash sizes |
esp_image_load_mode_t | |
esp_image_spi_freq_t | @brief SPI flash clock frequency |
esp_image_spi_mode_t | @brief SPI flash mode, used in esp_image_header_t |
esp_interface_t | |
esp_ip6_addr_type_t | |
esp_mac_type_t | |
esp_netif_dhcp_option_id_t | @brief Supported options for DHCP client or DHCP server |
esp_netif_dhcp_option_mode_t | @brief Mode for DHCP client or DHCP server option functions |
esp_netif_dhcp_status_t | @brief Status of DHCP client or DHCP server |
esp_netif_dns_type_t | @brief Type of DNS server |
esp_netif_flags | |
esp_netif_ip_event_type | |
esp_now_send_status_t | @brief Status of sending ESPNOW data . |
esp_ota_img_states_t | OTA_DATA states for checking operability of the app. |
esp_partition_subtype_t | @brief Partition subtype |
esp_partition_type_t | @brief Partition type |
esp_reset_reason_t | @brief Reset reasons |
esp_sleep_ext1_wakeup_mode_t | @brief Logic function used for EXT1 wakeup mode. |
esp_sleep_pd_domain_t | @brief Power domains which can be powered down in sleep mode |
esp_sleep_pd_option_t | @brief Power down options |
esp_sleep_source_t | @brief Sleep wakeup cause |
esp_timer_dispatch_t | @brief Method for dispatching timer callback |
gpio_drive_cap_t | |
gpio_int_type_t | |
gpio_mode_t | |
gpio_num_t | @endcond |
gpio_port_t | |
gpio_pull_mode_t | |
gpio_pulldown_t | |
gpio_pullup_t | |
i2c_mode_t | |
i2c_rw_t | |
i2c_opmode_t | |
i2c_trans_mode_t | |
i2c_addr_mode_t | |
i2c_ack_type_t | |
i2c_sclk_t | |
i2s_port_t | @brief I2S port number, the max port number is (I2S_NUM_MAX -1). |
i2s_bits_per_sample_t | @brief I2S bit width per sample. |
i2s_channel_t | @brief I2S channel. |
i2s_comm_format_t | @brief I2S communication standard format |
i2s_channel_fmt_t | @brief I2S channel format type |
i2s_mode_t | @brief I2S Mode, defaut is I2S_MODE_MASTER | I2S_MODE_TX |
i2s_clock_src_t | @brief I2S source clock |
i2s_event_type_t | @brief I2S event types |
i2s_dac_mode_t | @brief I2S DAC mode for i2s_set_dac_mode. |
i2s_pdm_dsr_t | @brief I2S PDM RX downsample mode |
ip_event_t | IP event declarations |
lwip_internal_netif_client_data_index | @} |
lwip_ip_addr_type | @ingroup ipaddr IP address types for use in ip_addr_t.type member. @see tcp_new_ip_type(), udp_new_ip_type(), raw_new_ip_type(). |
lwip_ipv6_scope_type | Symbolic constants for the 'type' parameters in some of the macros. These exist for efficiency only, allowing the macros to avoid certain tests when the address is known not to be of a certain type. Dead code elimination will do the rest. IP6_MULTICAST is supported but currently not optimized. @see ip6_addr_has_scope, ip6_addr_assign_zone, ip6_addr_lacks_zone. |
memp_t | Create the list of all memory pools managed by memp. MEMP_MAX represents a NULL pool at the end |
netif_mac_filter_action | MAC Filter Actions, these are passed to a netif's igmp_mac_filter or mld_mac_filter callback function. |
nvs_open_mode_t | @brief Mode of opening the non-volatile storage |
nvs_type_t | @brief Types of variables |
pbuf_layer | @ingroup pbuf Enumeration of pbuf layers |
pbuf_type | @ingroup pbuf Enumeration of pbuf types |
pdm_pcm_conv_t | @brief PDM PCM convter enable/disable. |
periph_module_t | |
rtc_cal_sel_t | @brief Clock source to be calibrated using rtc_clk_cal function |
rtc_cpu_freq_src_t | @brief CPU clock source |
rtc_cpu_freq_t | @brief CPU frequency values |
rtc_fast_freq_t | @brief RTC FAST_CLK frequency values |
rtc_slow_freq_t | @brief RTC SLOW_CLK frequency values |
rtc_xtal_freq_t | @brief Possible main XTAL frequency values. |
smartconfig_event_t | Smartconfig event declarations |
smartconfig_type_t | |
sntp_sync_mode_t | SNTP time update mode |
sntp_sync_status_t | SNTP sync status |
spi_flash_mmap_memory_t | @brief Enumeration which specifies memory space requested in an mmap call |
spi_flash_wrap_mode_t | |
system_event_id_t | System event types enumeration |
touch_cnt_slope_t | Touch sensor charge/discharge speed |
touch_fsm_mode_t | Touch sensor FSM mode |
touch_high_volt_t | Touch sensor high reference voltage |
touch_low_volt_t | Touch sensor low reference voltage |
touch_pad_t | Touch pad channel |
touch_tie_opt_t | Touch sensor initial charge level |
touch_trigger_mode_t | ESP32 Only |
touch_trigger_src_t | |
touch_volt_atten_t | Touch sensor high reference voltage attenuation |
uart_event_type_t | @brief UART event types used in the ring buffer |
uart_hw_flowcontrol_t | @brief UART hardware flow control modes |
uart_mode_t | @brief UART mode selection |
uart_parity_t | @brief UART parity constants |
uart_sclk_t | @brief UART source clock |
uart_signal_inv_t | @brief UART signal bit map |
uart_stop_bits_t | @brief UART stop bits number |
uart_word_length_t | @brief UART word length constants |
watchpoint_trigger_t | |
wifi_ant_mode_t | @brief WiFi antenna mode |
wifi_ant_t | @brief WiFi antenna |
wifi_auth_mode_t | |
wifi_bandwidth_t | |
wifi_cipher_type_t | |
wifi_country_policy_t | |
wifi_err_reason_t | |
wifi_event_sta_wps_fail_reason_t | Argument structure for WIFI_EVENT_STA_WPS_ER_FAILED event |
wifi_event_t | WiFi event declarations |
wifi_mode_t | |
wifi_phy_rate_t | @brief WiFi PHY rate encodings |
wifi_promiscuous_pkt_type_t | @brief Promiscuous frame type |
wifi_ps_type_t | |
wifi_scan_method_t | |
wifi_scan_type_t | |
wifi_second_chan_t | |
wifi_sort_method_t | |
wifi_storage_t | |
wifi_vendor_ie_id_t | @brief Vendor Information Element index |
wifi_vendor_ie_type_t | @brief Vendor Information Element type |
Constants
Statics
Functions
_Exit⚠ | |
__assert⚠ | |
__assert_func⚠ | |
__eprintf⚠ | |
__errno⚠ | |
__getdelim⚠ | |
__getline⚠ | |
__getreent⚠ | |
__gettzinfo⚠ | |
__itoa⚠ | |
__locale_ctype_ptr⚠ | |
__locale_ctype_ptr_l⚠ | |
__locale_mb_cur_max⚠ | |
__sinit⚠ | |
__srget_r⚠ | |
__swbuf_r⚠ | |
__utoa⚠ | |
_asiprintf_r⚠ | |
_asniprintf_r⚠ | |
_asnprintf_r⚠ | |
_asprintf_r⚠ | |
_atoi_r⚠ | |
_atol_r⚠ | |
_atoll_r⚠ | |
_calloc_r⚠ | |
_diprintf_r⚠ | |
_dprintf_r⚠ | |
_drand48_r⚠ | |
_dtoa_r⚠ | |
_erand48_r⚠ | |
_esp_error_check_failed⚠ | @cond |
_esp_error_check_failed_without_abort⚠ | @cond |
_exit⚠ | |
_fclose_r⚠ | |
_fcloseall_r⚠ | |
_fdopen_r⚠ | |
_fflush_r⚠ | |
_fgetc_r⚠ | |
_fgetc_unlocked_r⚠ | |
_fgetpos_r⚠ | |
_fgets_r⚠ | |
_fgets_unlocked_r⚠ | |
_findenv⚠ | |
_findenv_r⚠ | |
_fiprintf_r⚠ | |
_fiscanf_r⚠ | |
_fmemopen_r⚠ | |
_fopen_r⚠ | |
_fprintf_r⚠ | |
_fpurge_r⚠ | |
_fputc_r⚠ | |
_fputc_unlocked_r⚠ | |
_fputs_r⚠ | |
_fputs_unlocked_r⚠ | |
_fread_r⚠ | |
_fread_unlocked_r⚠ | |
_free_r⚠ | |
_freopen_r⚠ | |
_frxt_setup_switch⚠ | |
_fscanf_r⚠ | |
_fseek_r⚠ | |
_fseeko_r⚠ | |
_fsetpos_r⚠ | |
_ftell_r⚠ | |
_ftello_r⚠ | |
_funopen_r⚠ | |
_fwrite_r⚠ | |
_fwrite_unlocked_r⚠ | |
_getc_r⚠ | |
_getc_unlocked_r⚠ | |
_getchar_r⚠ | |
_getchar_unlocked_r⚠ | |
_getenv_r⚠ | |
_gets_r⚠ | |
_iprintf_r⚠ | |
_iscanf_r⚠ | |
_jrand48_r⚠ | |
_l64a_r⚠ | |
_lcong48_r⚠ | |
_lock_acquire⚠ | |
_lock_acquire_recursive⚠ | |
_lock_close⚠ | |
_lock_close_recursive⚠ | |
_lock_init⚠ | |
_lock_init_recursive⚠ | |
_lock_release⚠ | |
_lock_release_recursive⚠ | |
_lock_try_acquire⚠ | |
_lock_try_acquire_recursive⚠ | |
_lrand48_r⚠ | |
_malloc_r⚠ | |
_mblen_r⚠ | |
_mbstowcs_r⚠ | |
_mbtowc_r⚠ | |
_mkdtemp_r⚠ | |
_mkostemp_r⚠ | |
_mkostemps_r⚠ | |
_mkstemp_r⚠ | |
_mkstemps_r⚠ | |
_mktemp_r⚠ | |
_mrand48_r⚠ | |
_mstats_r⚠ | |
_nrand48_r⚠ | |
_open_memstream_r⚠ | |
_perror_r⚠ | |
_printf_r⚠ | |
_putc_r⚠ | |
_putc_unlocked_r⚠ | |
_putchar_r⚠ | |
_putchar_unlocked_r⚠ | |
_putenv_r⚠ | |
_puts_r⚠ | |
_raise_r⚠ | |
_realloc_r⚠ | |
_reallocf_r⚠ | |
_reclaim_reent⚠ | |
_remove_r⚠ | |
_rename_r⚠ | |
_rewind_r⚠ | |
_scanf_r⚠ | |
_seed48_r⚠ | |
_setenv_r⚠ | |
_signal_r⚠ | |
_siprintf_r⚠ | |
_siscanf_r⚠ | |
_sniprintf_r⚠ | |
_snprintf_r⚠ | |
_sprintf_r⚠ | |
_srand48_r⚠ | |
_sscanf_r⚠ | |
_strdup_r⚠ | |
_strerror_r⚠ | |
_strndup_r⚠ | |
_strtod_r⚠ | |
_strtoimax_r⚠ | |
_strtol_r⚠ | |
_strtold_r⚠ | |
_strtoll_r⚠ | |
_strtoul_r⚠ | |
_strtoull_r⚠ | |
_strtoumax_r⚠ | |
_system_r⚠ | |
_tempnam_r⚠ | |
_tmpfile_r⚠ | |
_tmpnam_r⚠ | |
_tzset_r⚠ | |
_ungetc_r⚠ | |
_unsetenv_r⚠ | |
_vasiprintf_r⚠ | |
_vasniprintf_r⚠ | |
_vasnprintf_r⚠ | |
_vasprintf_r⚠ | |
_vdiprintf_r⚠ | |
_vdprintf_r⚠ | |
_vfiprintf_r⚠ | |
_vfiscanf_r⚠ | |
_vfprintf_r⚠ | |
_vfscanf_r⚠ | |
_viprintf_r⚠ | |
_viscanf_r⚠ | |
_vprintf_r⚠ | |
_vscanf_r⚠ | |
_vsiprintf_r⚠ | |
_vsiscanf_r⚠ | |
_vsniprintf_r⚠ | |
_vsnprintf_r⚠ | |
_vsprintf_r⚠ | |
_vsscanf_r⚠ | |
_wcstoimax_r⚠ | |
_wcstombs_r⚠ | |
_wcstoumax_r⚠ | |
_wctomb_r⚠ | |
_xt_coproc_release⚠ | |
_xtos_clear_ints⚠ | |
_xtos_core_restore⚠ | |
_xtos_core_save⚠ | |
_xtos_core_shutoff⚠ | |
_xtos_dispatch_level1_interrupts⚠ | |
_xtos_dispatch_level2_interrupts⚠ | |
_xtos_dispatch_level3_interrupts⚠ | |
_xtos_dispatch_level4_interrupts⚠ | |
_xtos_dispatch_level5_interrupts⚠ | |
_xtos_dispatch_level6_interrupts⚠ | |
_xtos_ints_off⚠ | |
_xtos_ints_on⚠ | |
_xtos_memep_enable⚠ | |
_xtos_memep_initrams⚠ | |
_xtos_read_ints⚠ | |
_xtos_restore_intlevel⚠ | |
_xtos_restore_just_intlevel⚠ | |
_xtos_set_exception_handler⚠ | |
_xtos_set_interrupt_handler⚠ | |
_xtos_set_interrupt_handler_arg⚠ | |
_xtos_set_intlevel⚠ | |
_xtos_set_min_intlevel⚠ | |
_xtos_timer_0_delta⚠ | |
_xtos_timer_1_delta⚠ | |
_xtos_timer_2_delta⚠ | |
a64l⚠ | |
abort⚠ | |
abs⚠ | |
access⚠ | |
adc1_pad_get_io_num⚠ | @brief Get the GPIO number of a specific ADC1 channel. |
adc1_config_channel_atten⚠ | @brief Set the attenuation of a particular channel on ADC1, and configure its associated GPIO pin mux. |
adc1_config_width⚠ | @brief Configure ADC1 capture width, meanwhile enable output invert for ADC1. The configuration is for all channels of ADC1 @param width_bit Bit capture width for ADC1 |
adc1_get_raw⚠ | @brief Take an ADC1 reading from a single channel. @note ESP32: When the power switch of SARADC1, SARADC2, HALL sensor and AMP sensor is turned on, the input of GPIO36 and GPIO39 will be pulled down for about 80ns. When enabling power for any of these peripherals, ignore input from GPIO36 and GPIO39. Please refer to section 3.11 of 'ECO_and_Workarounds_for_Bugs_in_ESP32' for the description of this issue. |
adc1_ulp_enable⚠ | @brief Configure ADC1 to be usable by the ULP |
adc2_pad_get_io_num⚠ | @brief Get the GPIO number of a specific ADC2 channel. |
adc2_config_channel_atten⚠ | @brief Configure the ADC2 channel, including setting attenuation. |
adc2_get_raw⚠ | @brief Take an ADC2 reading on a single channel |
adc2_vref_to_gpio⚠ | @brief Output ADC2 reference voltage to GPIO 25 or 26 or 27 |
adc_gpio_init⚠ | @brief Initialize ADC pad @param adc_unit ADC unit index @param channel ADC channel index @return - ESP_OK success - ESP_ERR_INVALID_ARG Parameter error |
adc_i2s_mode_init⚠ | @brief Initialize I2S ADC mode @param adc_unit ADC unit index @param channel ADC channel index @return - ESP_OK success - ESP_ERR_INVALID_ARG Parameter error |
adc_power_off⚠ | @brief Power off SAR ADC This function will force power down for ADC |
adc_power_on⚠ | @brief Enable ADC power |
adc_set_clk_div⚠ | @brief Set ADC source clock @param clk_div ADC clock divider, ADC clock is divided from APB clock @return - ESP_OK success |
adc_set_data_inv⚠ | @brief Set ADC data invert @param adc_unit ADC unit index @param inv_en whether enable data invert @return - ESP_OK success - ESP_ERR_INVALID_ARG Parameter error |
adc_set_data_width⚠ | @brief Configure ADC capture width. |
adc_set_i2s_data_source⚠ | @brief Set I2S data source @param src I2S DMA data source, I2S DMA can get data from digital signals or from ADC. @return - ESP_OK success |
adjtime⚠ | |
alarm⚠ | |
aligned_alloc⚠ | |
arc4random⚠ | |
arc4random_uniform⚠ | |
arc4random_buf⚠ | |
asctime⚠ | |
asctime_r⚠ | |
asiprintf⚠ | |
asniprintf⚠ | |
asnprintf⚠ | |
at_quick_exit⚠ | |
atexit⚠ | |
atof⚠ | |
atoff⚠ | |
atoi⚠ | |
atol⚠ | |
atoll⚠ | |
bcmp⚠ | |
bcopy⚠ | |
bootloader_load_image⚠ | @brief Verify and load an app image (available only in space of bootloader). |
bootloader_load_image_no_verify⚠ | @brief Load an app image without verification (available only in space of bootloader). |
bsearch⚠ | |
bzero⚠ | |
calloc⚠ | |
cfree⚠ | |
chdir⚠ | |
chmod⚠ | |
chown⚠ | |
chroot⚠ | |
clearerr⚠ | |
clearerr_unlocked⚠ | |
clock⚠ | |
clock_getres⚠ | |
clock_gettime⚠ | |
clock_nanosleep⚠ | |
clock_settime⚠ | |
close⚠ | |
compare_and_set_extram⚠ | |
confstr⚠ | |
cpu_hal_clear_breakpoint⚠ | Clear and disable breakpoint. |
cpu_hal_clear_watchpoint⚠ | Clear and disable watchpoint. |
cpu_hal_set_breakpoint⚠ | Set and enable breakpoint at an instruction address. |
cpu_hal_set_vecbase⚠ | Set exception vector table base address. |
cpu_hal_set_watchpoint⚠ | Set and enable a watchpoint, specifying the memory range and trigger operation. |
creat⚠ | |
ctermid⚠ | |
ctime⚠ | |
ctime_r⚠ | |
daemon⚠ | |
dhcp_ip_addr_erase⚠ | |
dhcp_ip_addr_restore⚠ | |
dhcp_ip_addr_store⚠ | |
difftime⚠ | |
diprintf⚠ | |
div⚠ | |
dprintf⚠ | |
drand48⚠ | |
dup⚠ | |
dup2⚠ | |
eTaskConfirmSleepModeStatus⚠ | |
eTaskGetState⚠ | Obtain the state of any task. |
endusershell⚠ | |
erand48⚠ | |
err_to_errno⚠ | |
esp_base_mac_addr_get⚠ | @brief Return base MAC address which is set using esp_base_mac_addr_set. |
esp_base_mac_addr_set⚠ | @brief Set base MAC address with the MAC address which is stored in BLK3 of EFUSE or external storage e.g. flash and EEPROM. |
esp_chip_info⚠ | @brief Fill an esp_chip_info_t structure with information about the chip @param[out] out_info structure to be filled |
esp_cpu_in_ocd_debug_mode⚠ | @brief Returns true if a JTAG debugger is attached to CPU OCD (on chip debug) port. |
esp_cpu_reset⚠ | @brief Reset CPU using RTC controller @param cpu_id ID of the CPU to reset (0 = PRO, 1 = APP) |
esp_cpu_stall⚠ | @brief Stall CPU using RTC controller @param cpu_id ID of the CPU to stall (0 = PRO, 1 = APP) |
esp_cpu_unstall⚠ | @brief Un-stall CPU using RTC controller @param cpu_id ID of the CPU to un-stall (0 = PRO, 1 = APP) |
esp_crosscore_int_init⚠ | Initialize the crosscore interrupt system for this CPU. This needs to be called once on every CPU that is used by FreeRTOS. |
esp_crosscore_int_send_freq_switch⚠ | Send an interrupt to a CPU indicating it should update its CCOMPARE1 value due to a frequency switch. |
esp_crosscore_int_send_print_backtrace⚠ | Send an interrupt to a CPU indicating it should print its current backtrace |
esp_crosscore_int_send_yield⚠ | Send an interrupt to a CPU indicating it should yield its currently running task in favour of a higher-priority task that presumably just woke up. |
esp_deep_sleep⚠ | @brief Enter deep-sleep mode |
esp_deep_sleep_disable_rom_logging⚠ | @brief Disable logging from the ROM code after deep sleep. |
esp_deep_sleep_start⚠ | @brief Enter deep sleep with the configured wakeup options |
esp_default_wake_deep_sleep⚠ | @brief The default esp-idf-provided esp_wake_deep_sleep() stub. |
esp_deregister_freertos_idle_hook⚠ | @brief Unregister an idle callback. If the idle callback is registered to the idle hooks of both cores, the idle hook will be unregistered from both cores |
esp_deregister_freertos_idle_hook_for_cpu⚠ | @brief Unregister an idle callback from the idle hook of the specified core |
esp_deregister_freertos_tick_hook⚠ | @brief Unregister a tick callback. If the tick callback is registered to the tick hooks of both cores, the tick hook will be unregistered from both cores |
esp_deregister_freertos_tick_hook_for_cpu⚠ | @brief Unregister a tick callback from the tick hook of the specified core |
esp_derive_local_mac⚠ | @brief Derive local MAC address from universal MAC address. |
esp_efuse_mac_get_custom⚠ | @brief Return base MAC address which was previously written to BLK3 of EFUSE. |
esp_efuse_mac_get_default⚠ | @brief Return base MAC address which is factory-programmed by Espressif in BLK0 of EFUSE. |
esp_err_to_name⚠ | @brief Returns string for esp_err_t error codes |
esp_err_to_name_r⚠ | @brief Returns string for esp_err_t and system error codes |
esp_esptouch_set_timeout⚠ | @brief Set timeout of SmartConfig process. |
esp_event_dump⚠ | @brief Dumps statistics of all event loops. |
esp_event_handler_instance_register⚠ | @brief Register an instance of event handler to the default loop. |
esp_event_handler_instance_register_with⚠ | @brief Register an instance of event handler to a specific loop. |
esp_event_handler_instance_unregister⚠ | @brief Unregister a handler from the system event loop. |
esp_event_handler_instance_unregister_with⚠ | @brief Unregister a handler instance from a specific event loop. |
esp_event_handler_register⚠ | @brief Register an event handler to the system event loop (legacy). |
esp_event_handler_register_with⚠ | @brief Register an event handler to a specific loop (legacy). |
esp_event_handler_unregister⚠ | @brief Unregister a handler with the system event loop (legacy). |
esp_event_handler_unregister_with⚠ | @brief Unregister a handler from a specific event loop (legacy). |
esp_event_loop_create⚠ | @brief Create a new event loop. |
esp_event_loop_create_default⚠ | @brief Create default event loop |
esp_event_loop_delete⚠ | @brief Delete an existing event loop. |
esp_event_loop_delete_default⚠ | @brief Delete the default event loop |
esp_event_loop_init⚠ | @brief Initialize event loop |
esp_event_loop_run⚠ | @brief Dispatch events posted to an event loop. |
esp_event_loop_set_cb⚠ | @brief Set application specified event callback function |
esp_event_post⚠ | @brief Posts an event to the system default event loop. The event loop library keeps a copy of event_data and manages the copy's lifetime automatically (allocation + deletion); this ensures that the data the handler recieves is always valid. |
esp_event_post_to⚠ | @brief Posts an event to the specified event loop. The event loop library keeps a copy of event_data and manages the copy's lifetime automatically (allocation + deletion); this ensures that the data the handler recieves is always valid. |
esp_event_process_default⚠ | @brief Default event handler for system events |
esp_event_send⚠ | @brief Send a event to event task |
esp_event_send_internal⚠ | @brief Send a event to event task |
esp_event_set_default_eth_handlers⚠ | @brief Install default event handlers for Ethernet interface |
esp_event_set_default_wifi_handlers⚠ | @brief Install default event handlers for Wi-Fi interfaces (station and AP) |
esp_fill_random⚠ | @brief Fill a buffer with random bytes from hardware RNG |
esp_flash_chip_driver_initialized⚠ | Check if appropriate chip driver is set. |
esp_flash_erase_chip⚠ | @brief Erase flash chip contents |
esp_flash_erase_region⚠ | @brief Erase a region of the flash chip |
esp_flash_get_chip_write_protect⚠ | @brief Read if the entire chip is write protected |
esp_flash_get_protectable_regions⚠ | @brief Read the list of individually protectable regions of this SPI flash chip. |
esp_flash_get_protected_region⚠ | @brief Detect if a region of the SPI flash chip is protected |
esp_flash_get_size⚠ | @brief Detect flash size based on flash ID. |
esp_flash_init⚠ | @brief Initialise SPI flash chip interface. |
esp_flash_read⚠ | @brief Read data from the SPI flash chip |
esp_flash_read_encrypted⚠ | @brief Read and decrypt data from the SPI flash chip using on-chip hardware flash encryption |
esp_flash_read_id⚠ | @brief Read flash ID via the common "RDID" SPI flash command. |
esp_flash_set_chip_write_protect⚠ | @brief Set write protection for the SPI flash chip |
esp_flash_set_protected_region⚠ | @brief Update the protected status for a region of the SPI flash chip |
esp_flash_write⚠ | @brief Write data to the SPI flash chip |
esp_flash_write_encrypted⚠ | @brief Encrypted and write data to the SPI flash chip using on-chip hardware flash encryption |
esp_get_deep_sleep_wake_stub⚠ | @brief Get current wake from deep sleep stub @return Return current wake from deep sleep stub, or NULL if no stub is installed. |
esp_get_free_heap_size⚠ | @brief Get the size of available heap. |
esp_get_idf_version⚠ | Return full IDF version string, same as 'git describe' output. |
esp_get_minimum_free_heap_size⚠ | @brief Get the minimum heap that has ever been available |
esp_image_verify⚠ | @brief Verify an app image. |
esp_image_verify_bootloader⚠ | @brief Verify the bootloader image. |
esp_image_verify_bootloader_data⚠ | @brief Verify the bootloader image. |
esp_intr_alloc⚠ | @brief Allocate an interrupt with the given parameters. |
esp_intr_alloc_intrstatus⚠ | @brief Allocate an interrupt with the given parameters. |
esp_intr_disable⚠ | @brief Disable the interrupt associated with the handle |
esp_intr_enable⚠ | @brief Enable the interrupt associated with the handle |
esp_intr_free⚠ | @brief Disable and free an interrupt. |
esp_intr_get_cpu⚠ | @brief Get CPU number an interrupt is tied to |
esp_intr_get_intno⚠ | @brief Get the allocated interrupt for a certain handle |
esp_intr_mark_shared⚠ | @brief Mark an interrupt as a shared interrupt |
esp_intr_noniram_disable⚠ | @brief Disable interrupts that aren't specifically marked as running from IRAM |
esp_intr_noniram_enable⚠ | @brief Re-enable interrupts disabled by esp_intr_noniram_disable |
esp_intr_reserve⚠ | @brief Reserve an interrupt to be used outside of this framework |
esp_intr_set_in_iram⚠ | @brief Set the "in IRAM" status of the handler. |
esp_ip4addr_ntoa⚠ | @brief Converts numeric IP address into decimal dotted ASCII representation. |
esp_ip4addr_aton⚠ | @brief Ascii internet address interpretation routine The value returned is in network order. |
esp_light_sleep_start⚠ | @brief Enter light sleep with the configured wakeup options |
esp_netif_action_connected⚠ | @brief Default building block for network interface action upon IO driver connected event |
esp_netif_action_disconnected⚠ | @brief Default building block for network interface action upon IO driver disconnected event |
esp_netif_action_got_ip⚠ | @brief Default building block for network interface action upon network got IP event |
esp_netif_action_start⚠ | @brief Default building block for network interface action upon IO driver start event Creates network interface, if AUTOUP enabled turns the interface on, if DHCPS enabled starts dhcp server |
esp_netif_action_stop⚠ | @brief Default building block for network interface action upon IO driver stop event |
esp_netif_attach⚠ | @brief Attaches esp_netif instance to the io driver handle |
esp_netif_attach_wifi_ap⚠ | @brief Attaches wifi soft AP interface to supplied netif |
esp_netif_attach_wifi_station⚠ | @brief Attaches wifi station interface to supplied netif |
esp_netif_create_default_wifi_ap⚠ | @brief Creates default WIFI AP. In case of any init error this API aborts. |
esp_netif_create_default_wifi_mesh_netifs⚠ | @brief Creates default STA and AP network interfaces for esp-mesh. |
esp_netif_create_default_wifi_sta⚠ | @brief Creates default WIFI STA. In case of any init error this API aborts. |
esp_netif_create_ip6_linklocal⚠ | @brief Create interface link-local IPv6 address |
esp_netif_create_wifi⚠ | @brief Creates esp_netif WiFi object based on the custom configuration. |
esp_netif_deinit⚠ | @brief Deinitialize the esp-netif component (and the underlying TCP/IP stack) |
esp_netif_destroy⚠ | @brief Destroys the esp_netif object |
esp_netif_dhcpc_get_status⚠ | @brief Get DHCP client status |
esp_netif_dhcpc_option⚠ | @brief Set or Get DHCP client option |
esp_netif_dhcpc_start⚠ | @brief Start DHCP client (only if enabled in interface object) |
esp_netif_dhcpc_stop⚠ | @brief Stop DHCP client (only if enabled in interface object) |
esp_netif_dhcps_get_status⚠ | @brief Get DHCP Server status |
esp_netif_dhcps_option⚠ | @brief Set or Get DHCP server option |
esp_netif_dhcps_start⚠ | @brief Start DHCP server (only if enabled in interface object) |
esp_netif_dhcps_stop⚠ | @brief Stop DHCP server (only if enabled in interface object) |
esp_netif_get_all_ip6⚠ | @brief Get all IPv6 addresses of the specified interface |
esp_netif_get_desc⚠ | @brief Returns configured interface type for this esp-netif instance |
esp_netif_get_dns_info⚠ | @brief Get DNS Server information |
esp_netif_get_event_id⚠ | @brief Returns configured event for this esp-netif instance and supplied event type |
esp_netif_get_flags⚠ | @brief Returns configured flags for this interface |
esp_netif_get_handle_from_ifkey⚠ | @brief Searches over a list of created objects to find an instance with supplied if key |
esp_netif_get_hostname⚠ | @brief Get interface hostname. |
esp_netif_get_ifkey⚠ | @brief Returns configured interface key for this esp-netif instance |
esp_netif_get_io_driver⚠ | @brief Gets media driver handle for this esp-netif instance |
esp_netif_get_ip6_linklocal⚠ | @brief Get interface link-local IPv6 address |
esp_netif_get_ip6_global⚠ | @brief Get interface global IPv6 address |
esp_netif_get_ip_info⚠ | @brief Get interface's IP address information |
esp_netif_get_mac⚠ | @brief Get the mac address for the interface instance |
esp_netif_get_netif_impl_index⚠ | @brief Get net interface index from network stack implementation |
esp_netif_get_netif_impl_name⚠ | @brief Get net interface name from network stack implementation |
esp_netif_get_nr_of_ifs⚠ | @brief Returns number of registered esp_netif objects |
esp_netif_get_old_ip_info⚠ | @brief Get interface's old IP information |
esp_netif_get_route_prio⚠ | @brief Returns configured routing priority number |
esp_netif_init⚠ | @brief Initialize the underlying TCP/IP stack |
esp_netif_ip6_get_addr_type⚠ | @brief Get the IPv6 address type |
esp_netif_is_netif_up⚠ | @brief Test if supplied interface is up or down |
esp_netif_new⚠ | @brief Creates an instance of new esp-netif object based on provided config |
esp_netif_next⚠ | @brief Iterates over list of interfaces. Returns first netif if NULL given as parameter |
esp_netif_receive⚠ | @brief Passes the raw packets from communication media to the appropriate TCP/IP stack |
esp_netif_set_dns_info⚠ | @brief Set DNS Server information |
esp_netif_set_driver_config⚠ | @brief Configures driver related options of esp_netif object |
esp_netif_set_hostname⚠ | @brief Set the hostname of an interface |
esp_netif_set_ip4_addr⚠ | @brief Sets IPv4 address to the specified octets |
esp_netif_set_ip_info⚠ | @brief Set interface's IP address information |
esp_netif_set_mac⚠ | @brief Set the mac address for the interface instance |
esp_netif_set_old_ip_info⚠ | @brief Set interface old IP information |
esp_now_add_peer⚠ | @brief Add a peer to peer list |
esp_now_deinit⚠ | @brief De-initialize ESPNOW function |
esp_now_del_peer⚠ | @brief Delete a peer from peer list |
esp_now_fetch_peer⚠ | @brief Fetch a peer from peer list |
esp_now_get_peer⚠ | @brief Get a peer whose MAC address matches peer_addr from peer list |
esp_now_get_peer_num⚠ | @brief Get the number of peers |
esp_now_get_version⚠ | @brief Get the version of ESPNOW |
esp_now_init⚠ | @brief Initialize ESPNOW function |
esp_now_is_peer_exist⚠ | @brief Peer exists or not |
esp_now_mod_peer⚠ | @brief Modify a peer |
esp_now_register_recv_cb⚠ | @brief Register callback function of receiving ESPNOW data |
esp_now_register_send_cb⚠ | @brief Register callback function of sending ESPNOW data |
esp_now_send⚠ | @brief Send ESPNOW data |
esp_now_set_pmk⚠ | @brief Set the primary master key |
esp_now_unregister_recv_cb⚠ | @brief Unregister callback function of receiving ESPNOW data |
esp_now_unregister_send_cb⚠ | @brief Unregister callback function of sending ESPNOW data |
esp_ota_begin⚠ | @brief Commence an OTA update writing to the specified partition. |
esp_ota_check_rollback_is_possible⚠ | @brief Checks applications on the slots which can be booted in case of rollback. |
esp_ota_end⚠ | @brief Finish OTA update and validate newly written app image. |
esp_ota_erase_last_boot_app_partition⚠ | @brief Erase previous boot app partition and corresponding otadata select for this partition. |
esp_ota_get_app_description⚠ | @brief Return esp_app_desc structure. This structure includes app version. |
esp_ota_get_app_elf_sha256⚠ | @brief Fill the provided buffer with SHA256 of the ELF file, formatted as hexadecimal, null-terminated. If the buffer size is not sufficient to fit the entire SHA256 in hex plus a null terminator, the largest possible number of bytes will be written followed by a null. @param dst Destination buffer @param size Size of the buffer @return Number of bytes written to dst (including null terminator) |
esp_ota_get_boot_partition⚠ | @brief Get partition info of currently configured boot app |
esp_ota_get_last_invalid_partition⚠ | @brief Returns last partition with invalid state (ESP_OTA_IMG_INVALID or ESP_OTA_IMG_ABORTED). |
esp_ota_get_next_update_partition⚠ | @brief Return the next OTA app partition which should be written with a new firmware. |
esp_ota_get_partition_description⚠ | @brief Returns esp_app_desc structure for app partition. This structure includes app version. |
esp_ota_get_running_partition⚠ | @brief Get partition info of currently running app |
esp_ota_get_state_partition⚠ | @brief Returns state for given partition. |
esp_ota_mark_app_invalid_rollback_and_reboot⚠ | @brief This function is called to roll back to the previously workable app with reboot. |
esp_ota_mark_app_valid_cancel_rollback⚠ | @brief This function is called to indicate that the running app is working well. |
esp_ota_set_boot_partition⚠ | @brief Configure OTA data for a new boot partition |
esp_ota_write⚠ | @brief Write OTA update data to partition |
esp_ota_write_with_offset⚠ | @brief Write OTA update data to partition |
esp_partition_check_identity⚠ | @brief Check for the identity of two partitions by SHA-256 digest. |
esp_partition_deregister_external⚠ | @brief Deregister the partition previously registered using esp_partition_register_external @param partition pointer to the partition structure obtained from esp_partition_register_external, @return - ESP_OK on success - ESP_ERR_NOT_FOUND if the partition pointer is not found - ESP_ERR_INVALID_ARG if the partition comes from the partition table - ESP_ERR_INVALID_ARG if the partition was not registered using esp_partition_register_external function. |
esp_partition_erase_range⚠ | @brief Erase part of the partition |
esp_partition_find⚠ | @brief Find partition based on one or more parameters |
esp_partition_find_first⚠ | @brief Find first partition based on one or more parameters |
esp_partition_get⚠ | @brief Get esp_partition_t structure for given partition |
esp_partition_get_sha256⚠ | @brief Get SHA-256 digest for required partition. |
esp_partition_iterator_release⚠ | @brief Release partition iterator |
esp_partition_main_flash_region_safe⚠ | Check whether the region on the main flash is safe to write. |
esp_partition_mmap⚠ | @brief Configure MMU to map partition into data memory |
esp_partition_next⚠ | @brief Move partition iterator to the next partition found |
esp_partition_read⚠ | @brief Read data from the partition |
esp_partition_register_external⚠ | @brief Register a partition on an external flash chip |
esp_partition_table_verify⚠ | |
esp_partition_verify⚠ | @brief Verify partition data |
esp_partition_write⚠ | @brief Write data to the partition |
esp_random⚠ | @brief Get one random 32-bit word from hardware RNG |
esp_read_mac⚠ | @brief Read base MAC address and set MAC address of the interface. |
esp_register_freertos_idle_hook⚠ | @brief Register a callback to the idle hook of the core that calls this function. The callback should return true if it should be called by the idle hook once per interrupt (or FreeRTOS tick), and return false if it should be called repeatedly as fast as possible by the idle hook. |
esp_register_freertos_idle_hook_for_cpu⚠ | @brief Register a callback to be called from the specified core's idle hook. The callback should return true if it should be called by the idle hook once per interrupt (or FreeRTOS tick), and return false if it should be called repeatedly as fast as possible by the idle hook. |
esp_register_freertos_tick_hook⚠ | @brief Register a callback to be called from the calling core's tick hook. |
esp_register_freertos_tick_hook_for_cpu⚠ | @brief Register a callback to be called from the specified core's tick hook. |
esp_register_shutdown_handler⚠ | @brief Register shutdown handler |
esp_reset_reason⚠ | @brief Get reason of last reset @return See description of esp_reset_reason_t for explanation of each value. |
esp_restart⚠ | @brief Restart PRO and APP CPUs. |
esp_set_deep_sleep_wake_stub⚠ | @brief Install a new stub at runtime to run on wake from deep sleep |
esp_sleep_disable_wakeup_source⚠ | @brief Disable wakeup source |
esp_sleep_enable_ext0_wakeup⚠ | @brief Enable wakeup using a pin |
esp_sleep_enable_ext1_wakeup⚠ | @brief Enable wakeup using multiple pins |
esp_sleep_enable_gpio_wakeup⚠ | @brief Enable wakeup from light sleep using GPIOs |
esp_sleep_enable_timer_wakeup⚠ | @brief Enable wakeup by timer @param time_in_us time before wakeup, in microseconds @return - ESP_OK on success - ESP_ERR_INVALID_ARG if value is out of range (TBD) |
esp_sleep_enable_touchpad_wakeup⚠ | @brief Enable wakeup by touch sensor |
esp_sleep_enable_uart_wakeup⚠ | @brief Enable wakeup from light sleep using UART |
esp_sleep_enable_ulp_wakeup⚠ | @brief Enable wakeup by ULP coprocessor @note ULP wakeup source cannot be used when RTC_PERIPH power domain is forced to be powered on (ESP_PD_OPTION_ON) or when ext0 wakeup source is used. @return - ESP_OK on success - ESP_ERR_NOT_SUPPORTED if additional current by touch (CONFIG_ESP32_RTC_EXT_CRYST_ADDIT_CURRENT) is enabled. - ESP_ERR_INVALID_STATE if ULP co-processor is not enabled or if wakeup triggers conflict |
esp_sleep_get_ext1_wakeup_status⚠ | @brief Get the bit mask of GPIOs which caused wakeup (ext1) |
esp_sleep_get_touchpad_wakeup_status⚠ | @brief Get the touch pad which caused wakeup |
esp_sleep_get_wakeup_cause⚠ | @brief Get the wakeup source which caused wakeup from sleep |
esp_sleep_pd_config⚠ | @brief Set power down mode for an RTC power domain in sleep mode |
esp_smartconfig_fast_mode⚠ | @brief Set mode of SmartConfig. default normal mode. |
esp_smartconfig_get_version⚠ | @brief Get the version of SmartConfig. |
esp_smartconfig_set_type⚠ | @brief Set protocol type of SmartConfig. |
esp_smartconfig_start⚠ | @brief Start SmartConfig, config ESP device to connect AP. You need to broadcast information by phone APP. Device sniffer special packets from the air that containing SSID and password of target AP. |
esp_smartconfig_stop⚠ | @brief Stop SmartConfig, free the buffer taken by esp_smartconfig_start. |
esp_system_abort⚠ | @brief Trigger a software abort |
esp_timer_create⚠ | @brief Create an esp_timer instance |
esp_timer_deinit⚠ | @brief De-initialize esp_timer library |
esp_timer_delete⚠ | @brief Delete an esp_timer instance |
esp_timer_dump⚠ | @brief Dump the list of timers to a stream |
esp_timer_get_next_alarm⚠ | @brief Get the timestamp when the next timeout is expected to occur @return Timestamp of the nearest timer event, in microseconds. The timebase is the same as for the values returned by esp_timer_get_time. |
esp_timer_get_time⚠ | @brief Get time in microseconds since boot @return number of microseconds since esp_timer_init was called (this normally happens early during application startup). |
esp_timer_init⚠ | @brief Initialize esp_timer library |
esp_timer_start_once⚠ | @brief Start one-shot timer |
esp_timer_start_periodic⚠ | @brief Start a periodic timer |
esp_timer_stop⚠ | @brief Stop the timer |
esp_unregister_shutdown_handler⚠ | @brief Unregister shutdown handler |
esp_vApplicationIdleHook⚠ | |
esp_vApplicationTickHook⚠ | |
esp_vfs_lwip_sockets_register⚠ | |
esp_wake_deep_sleep⚠ | @brief Default stub to run on wake from deep sleep. |
esp_wifi_80211_tx⚠ | @brief Send raw ieee80211 data |
esp_wifi_ap_get_sta_aid⚠ | @brief Get AID of STA connected with soft-AP |
esp_wifi_ap_get_sta_list⚠ | @brief Get STAs associated with soft-AP |
esp_wifi_clear_default_wifi_driver_and_handlers⚠ | @brief Clears default wifi event handlers for supplied network interface |
esp_wifi_clear_fast_connect⚠ | @brief Currently this API is just an stub API |
esp_wifi_connect⚠ | @brief Connect the ESP32 WiFi station to the AP. |
esp_wifi_deauth_sta⚠ | @brief deauthenticate all stations or associated id equals to aid |
esp_wifi_deinit⚠ | @brief Deinit WiFi Free all resource allocated in esp_wifi_init and stop WiFi task |
esp_wifi_disconnect⚠ | @brief Disconnect the ESP32 WiFi station from the AP. |
esp_wifi_get_ant⚠ | @brief Get current antenna configuration |
esp_wifi_get_ant_gpio⚠ | @brief Get current antenna GPIO configuration |
esp_wifi_get_bandwidth⚠ | @brief Get the bandwidth of ESP32 specified interface |
esp_wifi_get_channel⚠ | @brief Get the primary/secondary channel of ESP32 |
esp_wifi_get_config⚠ | @brief Get configuration of specified interface |
esp_wifi_get_country⚠ | @brief get the current country info |
esp_wifi_get_event_mask⚠ | @brief Get mask of WiFi events |
esp_wifi_get_mac⚠ | @brief Get mac of specified interface |
esp_wifi_get_max_tx_power⚠ | @brief Get maximum transmiting power after WiFi start |
esp_wifi_get_mode⚠ | @brief Get current operating mode of WiFi |
esp_wifi_get_promiscuous⚠ | @brief Get the promiscuous mode. |
esp_wifi_get_promiscuous_ctrl_filter⚠ | @brief Get the subtype filter of the control packet in promiscuous mode. |
esp_wifi_get_promiscuous_filter⚠ | @brief Get the promiscuous filter. |
esp_wifi_get_protocol⚠ | @brief Get the current protocol bitmap of the specified interface |
esp_wifi_get_ps⚠ | @brief Get current WiFi power save type |
esp_wifi_init⚠ | @brief Init WiFi Alloc resource for WiFi driver, such as WiFi control structure, RX/TX buffer, WiFi NVS structure etc, this WiFi also start WiFi task |
esp_wifi_restore⚠ | @brief Restore WiFi stack persistent settings to default values |
esp_wifi_scan_get_ap_num⚠ | @brief Get number of APs found in last scan |
esp_wifi_scan_get_ap_records⚠ | @brief Get AP list found in last scan |
esp_wifi_scan_start⚠ | @brief Scan all available APs. |
esp_wifi_scan_stop⚠ | @brief Stop the scan in process |
esp_wifi_set_ant⚠ | @brief Set antenna configuration |
esp_wifi_set_ant_gpio⚠ | @brief Set antenna GPIO configuration |
esp_wifi_set_bandwidth⚠ | @brief Set the bandwidth of ESP32 specified interface |
esp_wifi_set_channel⚠ | @brief Set primary/secondary channel of ESP32 |
esp_wifi_set_config⚠ | @brief Set the configuration of the ESP32 STA or AP |
esp_wifi_set_country⚠ | @brief configure country info |
esp_wifi_set_csi⚠ | @brief Enable or disable CSI |
esp_wifi_set_csi_config⚠ | @brief Set CSI data configuration |
esp_wifi_set_csi_rx_cb⚠ | @brief Register the RX callback function of CSI data. |
esp_wifi_set_default_wifi_ap_handlers⚠ | @brief Sets default wifi event handlers for STA interface |
esp_wifi_set_default_wifi_sta_handlers⚠ | @brief Sets default wifi event handlers for STA interface |
esp_wifi_set_event_mask⚠ | @brief Set mask to enable or disable some WiFi events |
esp_wifi_set_mac⚠ | @brief Set MAC address of the ESP32 WiFi station or the soft-AP interface. |
esp_wifi_set_max_tx_power⚠ | @brief Set maximum transmitting power after WiFi start. |
esp_wifi_set_mode⚠ | @brief Set the WiFi operating mode |
esp_wifi_set_promiscuous⚠ | @brief Enable the promiscuous mode. |
esp_wifi_set_promiscuous_ctrl_filter⚠ | @brief Enable subtype filter of the control packet in promiscuous mode. |
esp_wifi_set_promiscuous_filter⚠ | @brief Enable the promiscuous mode packet type filter. |
esp_wifi_set_promiscuous_rx_cb⚠ | @brief Register the RX callback function in the promiscuous mode. |
esp_wifi_set_protocol⚠ | @brief Set protocol type of specified interface The default protocol is (WIFI_PROTOCOL_11B|WIFI_PROTOCOL_11G|WIFI_PROTOCOL_11N) |
esp_wifi_set_ps⚠ | @brief Set current WiFi power save type |
esp_wifi_set_storage⚠ | @brief Set the WiFi API configuration storage type |
esp_wifi_set_vendor_ie⚠ | @brief Set 802.11 Vendor-Specific Information Element |
esp_wifi_set_vendor_ie_cb⚠ | @brief Register Vendor-Specific Information Element monitoring callback. |
esp_wifi_sta_get_ap_info⚠ | @brief Get information of AP which the ESP32 station is associated with |
esp_wifi_start⚠ | @brief Start WiFi according to current configuration If mode is WIFI_MODE_STA, it create station control block and start station If mode is WIFI_MODE_AP, it create soft-AP control block and start soft-AP If mode is WIFI_MODE_APSTA, it create soft-AP and station control block and start soft-AP and station |
esp_wifi_stop⚠ | @brief Stop WiFi If mode is WIFI_MODE_STA, it stop station and free station control block If mode is WIFI_MODE_AP, it stop soft-AP and free soft-AP control block If mode is WIFI_MODE_APSTA, it stop station/soft-AP and free station/soft-AP control block |
ets_delay_us⚠ | @brief CPU do while loop for some time. In FreeRTOS task, please call FreeRTOS apis. |
ets_get_cpu_frequency⚠ | @brief Get the real CPU ticks per us to the ets. This function do not return real CPU ticks per us, just the record in ets. It can be used to check with the real CPU frequency. |
ets_get_detected_xtal_freq⚠ | @brief Get xtal_freq value, If value not stored in RTC_STORE5, than store. |
ets_get_xtal_scale⚠ | @brief Get xtal_freq/analog_8M*256 value calibrated in rtc module. |
ets_install_putc1⚠ | @brief Ets_printf have two output functions: putc1 and putc2, both of which will be called if need ouput. To install putc1, which is defaulted installed as ets_write_char_uart in none silent boot mode, as NULL in silent mode. |
ets_install_putc2⚠ | @brief Ets_printf have two output functions: putc1 and putc2, both of which will be called if need ouput. To install putc2, which is defaulted installed as NULL. |
ets_install_uart_printf⚠ | @brief Install putc1 as ets_write_char_uart. In silent boot mode(to void interfere the UART attached MCU), we can call this function, after booting ok. |
ets_intr_lock⚠ | @brief Lock the interrupt to level 2. This function direct set the CPU registers. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_intr_unlock⚠ | @brief Unlock the interrupt to level 0. This function direct set the CPU registers. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_isr_attach⚠ | @brief Attach a interrupt handler to a CPU interrupt number. This function equals to _xtos_set_interrupt_handler_arg(i, func, arg). In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_isr_mask⚠ | @brief Mask the interrupts which show in mask bits. This function equals to _xtos_ints_off(mask). In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_isr_unmask⚠ | @brief Unmask the interrupts which show in mask bits. This function equals to _xtos_ints_on(mask). In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_post⚠ | @brief Post an event to an Task. |
ets_printf⚠ | @brief Printf the strings to uart or other devices, similar with printf, simple than printf. Can not print float point data format, or longlong data format. So we maybe only use this in ROM. |
ets_run⚠ | @brief Start the Espressif Task Scheduler, which is an infinit loop. Please do not add code after it. |
ets_set_appcpu_boot_addr⚠ | @brief Set App cpu Entry code, code can be called in PRO CPU. When APP booting is completed, APP CPU will call the Entry code if not NULL. |
ets_set_idle_cb⚠ | @brief Set the Idle callback, when Tasks are processed, will call the callback before CPU goto sleep. |
ets_set_startup_callback⚠ | @brief Set Pro cpu Startup code, code can be called when booting is not completed, or in Entry code. When Entry code completed, CPU will call the Startup code if not NULL, else call ets_run. |
ets_set_user_start⚠ | @brief Set Pro cpu Entry code, code can be called in PRO CPU when booting is not completed. When Pro CPU booting is completed, Pro CPU will call the Entry code if not NULL. |
ets_task⚠ | @brief Init a task with processer, priority, queue to receive Event, queue length. |
ets_timer_arm⚠ | @brief Arm an ets timer, this timer range is 640 us to 429496 ms. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_arm_us⚠ | @brief Arm an ets timer, this timer range is 640 us to 429496 ms. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_deinit⚠ | @brief In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_disarm⚠ | @brief Disarm an ets timer. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_done⚠ | @brief Unset timer callback and argument to NULL. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_init⚠ | @brief Init ets timer, this timer range is 640 us to 429496 ms In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_timer_setfn⚠ | @brief Set timer callback and argument. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_unpack_flash_code⚠ | @brief unpack the image in flash to iram and dram, using cache, maybe decrypting. |
ets_unpack_flash_code_legacy⚠ | @brief unpack the image in flash to iram and dram, no using cache. |
ets_update_cpu_frequency⚠ | @brief Set the real CPU ticks per us to the ets, so that ets_delay_us will be accurate. Call this function when CPU frequency is changed. |
ets_update_cpu_frequency_rom⚠ | @brief Set the real CPU ticks per us to the ets, so that ets_delay_us will be accurate. |
ets_waiti0⚠ | @brief Unlock the interrupt to level 0, and CPU will go into power save mode(wait interrupt). This function direct set the CPU registers. In FreeRTOS, please call FreeRTOS apis, never call this api. |
ets_write_char_uart⚠ | @brief Output a char to uart, which uart to output(which is in uart module in ROM) is not in scope of the function. Can not print float point data format, or longlong data format |
execl⚠ | |
execle⚠ | |
execlp⚠ | |
execlpe⚠ | |
execv⚠ | |
execve⚠ | |
execvp⚠ | |
exit⚠ | |
explicit_bzero⚠ | |
faccessat⚠ | |
fchdir⚠ | |
fchmod⚠ | |
fchmodat⚠ | |
fchown⚠ | |
fchownat⚠ | |
fclose⚠ | |
fcntl⚠ | |
fdatasync⚠ | |
fdopen⚠ | |
feof⚠ | |
feof_unlocked⚠ | |
ferror⚠ | |
ferror_unlocked⚠ | |
fexecve⚠ | |
fflush⚠ | |
fflush_unlocked⚠ | |
ffs⚠ | |
ffsl⚠ | |
ffsll⚠ | |
fgetc⚠ | |
fgetc_unlocked⚠ | |
fgetpos⚠ | |
fgets⚠ | |
fileno⚠ | |
fileno_unlocked⚠ | |
fiprintf⚠ | |
fiscanf⚠ | |
flock⚠ | |
flockfile⚠ | |
fls⚠ | |
flsl⚠ | |
flsll⚠ | |
fmemopen⚠ | |
fopen⚠ | |
fork⚠ | |
fpathconf⚠ | |
fprintf⚠ | |
fpurge⚠ | |
fputc⚠ | |
fputc_unlocked⚠ | |
fputs⚠ | |
fread⚠ | |
fread_unlocked⚠ | |
free⚠ | |
freopen⚠ | |
fscanf⚠ | |
fseek⚠ | |
fseeko⚠ | |
fsetpos⚠ | |
fstat⚠ | |
fstatat⚠ | |
fsync⚠ | |
ftell⚠ | |
ftello⚠ | |
ftruncate⚠ | |
ftrylockfile⚠ | |
funlockfile⚠ | |
funopen⚠ | |
futimens⚠ | |
futimes⚠ | |
fwrite⚠ | |
fwrite_unlocked⚠ | |
getc⚠ | |
getc_unlocked⚠ | |
getchar⚠ | |
getchar_unlocked⚠ | |
getcwd⚠ | |
getdomainname⚠ | |
getdtablesize⚠ | |
getegid⚠ | |
getentropy⚠ | |
getenv⚠ | |
geteuid⚠ | |
getgid⚠ | |
getgroups⚠ | |
gethostid⚠ | |
gethostname⚠ | |
getitimer⚠ | |
getlogin⚠ | |
getopt⚠ | |
getpagesize⚠ | |
getpass⚠ | |
getpeereid⚠ | |
getpgid⚠ | |
getpgrp⚠ | |
getpid⚠ | |
getppid⚠ | |
gets⚠ | |
getsid⚠ | |
getsubopt⚠ | |
gettimeofday⚠ | |
getuid⚠ | |
getusershell⚠ | |
getw⚠ | |
getwd⚠ | |
gmtime⚠ | |
gmtime_r⚠ | |
gpio_config⚠ | @brief GPIO common configuration |
gpio_deep_sleep_hold_dis⚠ | @brief Disable all digital gpio pad hold function during Deep-sleep. |
gpio_deep_sleep_hold_en⚠ | @brief Enable all digital gpio pad hold function during Deep-sleep. |
gpio_get_drive_capability⚠ | @brief Get GPIO pad drive capability |
gpio_get_level⚠ | @brief GPIO get input level |
gpio_hold_dis⚠ | @brief Disable gpio pad hold function. |
gpio_hold_en⚠ | @brief Enable gpio pad hold function. |
gpio_init⚠ | @brief Initialize GPIO. This includes reading the GPIO Configuration DataSet to initialize "output enables" and pin configurations for each gpio pin. Please do not call this function in SDK. |
gpio_input_get⚠ | @brief Sample the value of GPIO input pins(0-31) and returns a bitmask. |
gpio_input_get_high⚠ | @brief Sample the value of GPIO input pins(32-39) and returns a bitmask. |
gpio_install_isr_service⚠ | @brief Install the driver's GPIO ISR handler service, which allows per-pin GPIO interrupt handlers. |
gpio_intr_ack⚠ | @brief Ack gpio interrupts to process pending interrupts. Please do not call this function in SDK. |
gpio_intr_ack_high⚠ | @brief Ack gpio interrupts to process pending interrupts. Please do not call this function in SDK. |
gpio_intr_disable⚠ | @brief Disable GPIO module interrupt signal |
gpio_intr_enable⚠ | @brief Enable GPIO module interrupt signal |
gpio_intr_handler_register⚠ | @brief Register an application-specific interrupt handler for GPIO pin interrupts. Once the interrupt handler is called, it will not be called again until after a call to gpio_intr_ack. Please do not call this function in SDK. |
gpio_intr_pending⚠ | @brief Get gpio interrupts which happens but not processed. Please do not call this function in SDK. |
gpio_intr_pending_high⚠ | @brief Get gpio interrupts which happens but not processed. Please do not call this function in SDK. |
gpio_iomux_in⚠ | @brief Set pad input to a peripheral signal through the IOMUX.
@param gpio_num GPIO number of the pad.
@param signal_idx Peripheral signal id to input. One of the |
gpio_iomux_out⚠ | @brief Set peripheral output to an GPIO pad through the IOMUX.
@param gpio_num gpio_num GPIO number of the pad.
@param func The function number of the peripheral pin to output pin.
One of the |
gpio_isr_handler_add⚠ | @brief Add ISR handler for the corresponding GPIO pin. |
gpio_isr_handler_remove⚠ | @brief Remove ISR handler for the corresponding GPIO pin. |
gpio_isr_register⚠ | @brief Register GPIO interrupt handler, the handler is an ISR. The handler will be attached to the same CPU core that this function is running on. |
gpio_matrix_in⚠ | @brief set gpio input to a signal, one gpio can input to several signals. |
gpio_matrix_out⚠ | @brief set signal output to gpio, one signal can output to several gpios. |
gpio_output_set⚠ | @brief Change GPIO(0-31) pin output by setting, clearing, or disabling pins, GPIO0<->BIT(0). There is no particular ordering guaranteed; so if the order of writes is significant, calling code should divide a single call into multiple calls. |
gpio_output_set_high⚠ | @brief Change GPIO(32-39) pin output by setting, clearing, or disabling pins, GPIO32<->BIT(0). There is no particular ordering guaranteed; so if the order of writes is significant, calling code should divide a single call into multiple calls. |
gpio_pad_hold⚠ | @brief Hold the pad from gpio number. |
gpio_pad_pulldown⚠ | @brief Pull down the pad from gpio number. |
gpio_pad_pullup⚠ | @brief Pull up the pad from gpio number. |
gpio_pad_select_gpio⚠ | @brief Select pad as a gpio function from IOMUX. |
gpio_pad_set_drv⚠ | @brief Set pad driver capability. |
gpio_pad_unhold⚠ | @brief Unhold the pad from gpio number. |
gpio_pin_wakeup_disable⚠ | @brief disable GPIOs to wakeup the ESP32. Please do not call this function in SDK. |
gpio_pin_wakeup_enable⚠ | @brief Set GPIO to wakeup the ESP32. Please do not call this function in SDK. |
gpio_pulldown_dis⚠ | @brief Disable pull-down on GPIO. |
gpio_pulldown_en⚠ | @brief Enable pull-down on GPIO. |
gpio_pullup_dis⚠ | @brief Disable pull-up on GPIO. |
gpio_pullup_en⚠ | @brief Enable pull-up on GPIO. |
gpio_reset_pin⚠ | @brief Reset an gpio to default state (select gpio function, enable pullup and disable input and output). |
gpio_set_direction⚠ | @brief GPIO set direction |
gpio_set_drive_capability⚠ | @brief Set GPIO pad drive capability |
gpio_set_intr_type⚠ | @brief GPIO set interrupt trigger type |
gpio_set_level⚠ | @brief GPIO set output level |
gpio_set_pull_mode⚠ | @brief Configure GPIO pull-up/pull-down resistors |
gpio_uninstall_isr_service⚠ | @brief Uninstall the driver's GPIO ISR service, freeing related resources. |
gpio_wakeup_disable⚠ | @brief Disable GPIO wake-up function. |
gpio_wakeup_enable⚠ | @brief Enable GPIO wake-up function. |
hall_sensor_read⚠ | @brief Read Hall Sensor |
heap_caps_aligned_alloc⚠ | @brief Allocate a aligned chunk of memory which has the given capabilities |
heap_caps_aligned_calloc⚠ | @brief Allocate a aligned chunk of memory which has the given capabilities. The initialized value in the memory is set to zero. |
heap_caps_aligned_free⚠ | @brief Used to deallocate memory previously allocated with heap_caps_aligned_alloc |
heap_caps_calloc⚠ | @brief Allocate a chunk of memory which has the given capabilities. The initialized value in the memory is set to zero. |
heap_caps_calloc_prefer⚠ | @brief Allocate a chunk of memory as preference in decreasing order. |
heap_caps_check_integrity⚠ | @brief Check integrity of all heaps with the given capabilities. |
heap_caps_check_integrity_addr⚠ | @brief Check integrity of heap memory around a given address. |
heap_caps_check_integrity_all⚠ | @brief Check integrity of all heap memory in the system. |
heap_caps_dump⚠ | @brief Dump the full structure of all heaps with matching capabilities. |
heap_caps_dump_all⚠ | @brief Dump the full structure of all heaps. |
heap_caps_free⚠ | @brief Free memory previously allocated via heap_caps_malloc() or heap_caps_realloc(). |
heap_caps_get_allocated_size⚠ | @brief Return the size that a particular pointer was allocated with. |
heap_caps_get_free_size⚠ | @brief Get the total free size of all the regions that have the given capabilities |
heap_caps_get_info⚠ | @brief Get heap info for all regions with the given capabilities. |
heap_caps_get_largest_free_block⚠ | @brief Get the largest free block of memory able to be allocated with the given capabilities. |
heap_caps_get_minimum_free_size⚠ | @brief Get the total minimum free memory of all regions with the given capabilities |
heap_caps_get_total_size⚠ | @brief Get the total size of all the regions that have the given capabilities |
heap_caps_malloc⚠ | @brief Allocate a chunk of memory which has the given capabilities |
heap_caps_malloc_extmem_enable⚠ | @brief Enable malloc() in external memory and set limit below which malloc() attempts are placed in internal memory. |
heap_caps_malloc_prefer⚠ | @brief Allocate a chunk of memory as preference in decreasing order. |
heap_caps_print_heap_info⚠ | @brief Print a summary of all memory with the given capabilities. |
heap_caps_realloc⚠ | @brief Reallocate memory previously allocated via heap_caps_malloc() or heap_caps_realloc(). |
heap_caps_realloc_prefer⚠ | @brief Allocate a chunk of memory as preference in decreasing order. |
heap_caps_register_failed_alloc_callback⚠ | @brief registers a callback function to be invoked if a memory allocation operation fails @param callback caller defined callback to be invoked @return ESP_OK if callback was registered. |
i2c_driver_install⚠ | @brief I2C driver install |
i2c_driver_delete⚠ | @brief I2C driver delete |
i2c_param_config⚠ | @brief I2C parameter initialization |
i2c_reset_tx_fifo⚠ | @brief reset I2C tx hardware fifo |
i2c_reset_rx_fifo⚠ | @brief reset I2C rx fifo |
i2c_isr_register⚠ | @brief I2C isr handler register |
i2c_isr_free⚠ | @brief to delete and free I2C isr. |
i2c_set_pin⚠ | @brief Configure GPIO signal for I2C sck and sda |
i2c_cmd_link_create⚠ | @brief Create and init I2C command link @note Before we build I2C command link, we need to call i2c_cmd_link_create() to create a command link. After we finish sending the commands, we need to call i2c_cmd_link_delete() to release and return the resources. |
i2c_cmd_link_delete⚠ | @brief Free I2C command link @note Before we build I2C command link, we need to call i2c_cmd_link_create() to create a command link. After we finish sending the commands, we need to call i2c_cmd_link_delete() to release and return the resources. |
i2c_master_start⚠ | @brief Queue command for I2C master to generate a start signal @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_write_byte⚠ | @brief Queue command for I2C master to write one byte to I2C bus @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_write⚠ | @brief Queue command for I2C master to write buffer to I2C bus @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_read_byte⚠ | @brief Queue command for I2C master to read one byte from I2C bus @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_read⚠ | @brief Queue command for I2C master to read data from I2C bus @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_stop⚠ | @brief Queue command for I2C master to generate a stop signal @note Only call this function in I2C master mode Call i2c_master_cmd_begin() to send all queued commands |
i2c_master_cmd_begin⚠ | @brief I2C master send queued commands. This function will trigger sending all queued commands. The task will be blocked until all the commands have been sent out. The I2C APIs are not thread-safe, if you want to use one I2C port in different tasks, you need to take care of the multi-thread issue. @note Only call this function in I2C master mode |
i2c_slave_write_buffer⚠ | @brief I2C slave write data to internal ringbuffer, when tx fifo empty, isr will fill the hardware fifo from the internal ringbuffer @note Only call this function in I2C slave mode |
i2c_slave_read_buffer⚠ | @brief I2C slave read data from internal buffer. When I2C slave receive data, isr will copy received data from hardware rx fifo to internal ringbuffer. Then users can read from internal ringbuffer. @note Only call this function in I2C slave mode |
i2c_set_period⚠ | @brief set I2C master clock period |
i2c_get_period⚠ | @brief get I2C master clock period |
i2c_filter_enable⚠ | @brief enable hardware filter on I2C bus Sometimes the I2C bus is disturbed by high frequency noise(about 20ns), or the rising edge of the SCL clock is very slow, these may cause the master state machine broken. enable hardware filter can filter out high frequency interference and make the master more stable. @note Enable filter will slow the SCL clock. |
i2c_filter_disable⚠ | @brief disable filter on I2C bus |
i2c_set_start_timing⚠ | @brief set I2C master start signal timing |
i2c_get_start_timing⚠ | @brief get I2C master start signal timing |
i2c_set_stop_timing⚠ | @brief set I2C master stop signal timing |
i2c_get_stop_timing⚠ | @brief get I2C master stop signal timing |
i2c_set_data_timing⚠ | @brief set I2C data signal timing |
i2c_get_data_timing⚠ | @brief get I2C data signal timing |
i2c_set_timeout⚠ | @brief set I2C timeout value @param i2c_num I2C port number @param timeout timeout value for I2C bus (unit: APB 80Mhz clock cycle) @return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error |
i2c_get_timeout⚠ | @brief get I2C timeout value @param i2c_num I2C port number @param timeout pointer to get timeout value @return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error |
i2c_set_data_mode⚠ | @brief set I2C data transfer mode |
i2c_get_data_mode⚠ | @brief get I2C data transfer mode |
i2s_hal_reset_fifo⚠ | @brief Reset I2S fifo |
i2s_hal_set_tx_mode⚠ | @brief Set I2S tx mode |
i2s_hal_set_rx_mode⚠ | @brief Set I2S rx mode |
i2s_hal_set_in_link⚠ | @brief Set I2S in link |
i2s_hal_get_tx_pdm⚠ | @brief Get I2S tx pdm |
i2s_hal_set_clk_div⚠ | @brief Set I2S clk div |
i2s_hal_set_tx_bits_mod⚠ | @brief Set I2S tx bits mod |
i2s_hal_set_rx_bits_mod⚠ | @brief Set I2S rx bits mod |
i2s_hal_reset⚠ | @brief Reset I2S tx |
i2s_hal_start_tx⚠ | @brief Start I2S tx |
i2s_hal_start_rx⚠ | @brief Start I2S rx |
i2s_hal_stop_tx⚠ | @brief Stop I2S tx |
i2s_hal_stop_rx⚠ | @brief Stop I2S rx |
i2s_hal_config_param⚠ | @brief Config I2S param |
i2s_hal_enable_master_mode⚠ | @brief Enable I2S master mode |
i2s_hal_enable_slave_mode⚠ | @brief Enable I2S slave mode |
i2s_hal_init⚠ | @brief Init the I2S hal and set the I2S to the default configuration. This function should be called first before other hal layer function is called |
i2s_set_pin⚠ | @brief Set I2S pin number |
i2s_set_pdm_rx_down_sample⚠ | @brief Set PDM mode down-sample rate In PDM RX mode, there would be 2 rounds of downsample process in hardware. In the first downsample process, the sampling number can be 16 or 8. In the second downsample process, the sampling number is fixed as 8. So the clock frequency in PDM RX mode would be (fpcm * 64) or (fpcm * 128) accordingly. @param i2s_num I2S_NUM_0, I2S_NUM_1 @param dsr i2s RX down sample rate for PDM mode. |
i2s_set_dac_mode⚠ | @brief Set I2S dac mode, I2S built-in DAC is disabled by default |
i2s_driver_install⚠ | @brief Install and start I2S driver. |
i2s_driver_uninstall⚠ | @brief Uninstall I2S driver. |
i2s_write⚠ | @brief Write data to I2S DMA transmit buffer. |
i2s_write_expand⚠ | @brief Write data to I2S DMA transmit buffer while expanding the number of bits per sample. For example, expanding 16-bit PCM to 32-bit PCM. |
i2s_read⚠ | @brief Read data from I2S DMA receive buffer |
i2s_set_sample_rates⚠ | @brief Set sample rate used for I2S RX and TX. |
i2s_stop⚠ | @brief Stop I2S driver |
i2s_start⚠ | @brief Start I2S driver |
i2s_zero_dma_buffer⚠ | @brief Zero the contents of the TX DMA buffer. |
i2s_set_clk⚠ | @brief Set clock & bit width used for I2S RX and TX. |
i2s_get_clk⚠ | @brief get clock set on particular port number. |
i2s_set_adc_mode⚠ | @brief Set built-in ADC mode for I2S DMA, this function will initialize ADC pad, and set ADC parameters. @param adc_unit SAR ADC unit index @param adc_channel ADC channel index @return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error |
i2s_adc_enable⚠ | @brief Start to use I2S built-in ADC mode @note This function would acquire the lock of ADC to prevent the data getting corrupted during the I2S peripheral is being used to do fully continuous ADC sampling. |
i2s_adc_disable⚠ | @brief Stop to use I2S built-in ADC mode @param i2s_num i2s port index @note This function would release the lock of ADC so that other tasks can use ADC. @return - ESP_OK Success - ESP_ERR_INVALID_ARG Parameter error - ESP_ERR_INVALID_STATE Driver state error |
imaxabs⚠ | |
imaxdiv⚠ | |
index⚠ | |
initstate⚠ | |
intr_matrix_set⚠ | @brief Attach an CPU interrupt to a hardware source. We have 4 steps to use an interrupt: 1.Attach hardware interrupt source to CPU. intr_matrix_set(0, ETS_WIFI_MAC_INTR_SOURCE, ETS_WMAC_INUM); 2.Set interrupt handler. xt_set_interrupt_handler(ETS_WMAC_INUM, func, NULL); 3.Enable interrupt for CPU. xt_ints_on(1 << ETS_WMAC_INUM); 4.Enable interrupt in the module. |
ioctl⚠ | |
ip4_addr_netmask_valid⚠ | |
ip4addr_aton⚠ | |
ip4addr_ntoa⚠ | returns ptr to static buffer; not reentrant! |
ip4addr_ntoa_r⚠ | |
ip6addr_aton⚠ | |
ip6addr_ntoa⚠ | returns ptr to static buffer; not reentrant! |
ip6addr_ntoa_r⚠ | |
ip4_addr_isbroadcast_u32⚠ | |
ipaddr_addr⚠ | |
ipaddr_aton⚠ | |
ipaddr_ntoa⚠ | |
ipaddr_ntoa_r⚠ | |
iprintf⚠ | |
iruserok⚠ | |
isalnum⚠ | |
isalnum_l⚠ | |
isalpha⚠ | |
isalpha_l⚠ | |
isascii⚠ | |
isascii_l⚠ | |
isatty⚠ | |
isblank⚠ | |
isblank_l⚠ | |
iscanf⚠ | |
iscntrl⚠ | |
iscntrl_l⚠ | |
isdigit⚠ | |
isdigit_l⚠ | |
isgraph⚠ | |
isgraph_l⚠ | |
islower⚠ | |
islower_l⚠ | |
isprint⚠ | |
isprint_l⚠ | |
ispunct⚠ | |
ispunct_l⚠ | |
issetugid⚠ | |
isspace⚠ | |
isspace_l⚠ | |
isupper⚠ | |
isupper_l⚠ | |
isxdigit⚠ | |
isxdigit_l⚠ | |
itoa⚠ | |
jrand48⚠ | |
kill⚠ | |
killpg⚠ | |
l64a⚠ | |
labs⚠ | |
lchown⚠ | |
lcong48⚠ | |
ldiv⚠ | |
link⚠ | |
linkat⚠ | |
llabs⚠ | |
lldiv⚠ | |
localtime⚠ | |
localtime_r⚠ | |
lockf⚠ | |
lrand48⚠ | |
lseek⚠ | |
lutimes⚠ | |
lwip_accept⚠ | |
lwip_bind⚠ | |
lwip_close⚠ | |
lwip_connect⚠ | |
lwip_fcntl⚠ | |
lwip_freeaddrinfo⚠ | |
lwip_getaddrinfo⚠ | |
lwip_gethostbyname⚠ | |
lwip_gethostbyname_r⚠ | |
lwip_getpeername⚠ | |
lwip_getsockname⚠ | |
lwip_getsockopt⚠ | |
lwip_htonl⚠ | |
lwip_htons⚠ | |
lwip_inet_ntop⚠ | |
lwip_inet_pton⚠ | |
lwip_ioctl⚠ | |
lwip_itoa⚠ | |
lwip_listen⚠ | |
lwip_poll⚠ | |
lwip_read⚠ | |
lwip_readv⚠ | |
lwip_recv⚠ | |
lwip_recvfrom⚠ | |
lwip_recvmsg⚠ | |
lwip_select⚠ | |
lwip_send⚠ | |
lwip_sendmsg⚠ | |
lwip_sendto⚠ | |
lwip_setsockopt⚠ | |
lwip_shutdown⚠ | |
lwip_socket⚠ | |
lwip_socket_thread_cleanup⚠ | |
lwip_socket_thread_init⚠ | |
lwip_strerr⚠ | |
lwip_stricmp⚠ | |
lwip_strnicmp⚠ | |
lwip_strnstr⚠ | |
lwip_write⚠ | |
lwip_writev⚠ | |
malloc⚠ | |
mblen⚠ | |
mbstowcs⚠ | |
mbtowc⚠ | |
mem_calloc⚠ | |
mem_free⚠ | |
mem_init⚠ | |
mem_malloc⚠ | |
mem_trim⚠ | |
memccpy⚠ | |
memchr⚠ | |
memcmp⚠ | |
memcpy⚠ | |
memmove⚠ | |
memp_free⚠ | |
memp_free_pool⚠ | |
memp_init⚠ | |
memp_init_pool⚠ | |
memp_malloc⚠ | |
memp_malloc_pool⚠ | |
memset⚠ | |
mkdir⚠ | |
mkdirat⚠ | |
mkdtemp⚠ | |
mkfifo⚠ | |
mkfifoat⚠ | |
mknodat⚠ | |
mkstemp⚠ | |
mkstemps⚠ | |
mktemp⚠ | |
mktime⚠ | |
mrand48⚠ | |
multi_heap_aligned_alloc⚠ | @brief allocate a chunk of memory with specific alignment |
multi_heap_aligned_free⚠ | @brief free() a buffer aligned in a given heap. |
multi_heap_check⚠ | @brief Check heap integrity |
multi_heap_dump⚠ | @brief Dump heap information to stdout |
multi_heap_free⚠ | @brief free() a buffer in a given heap. |
multi_heap_free_size⚠ | @brief Return free heap size |
multi_heap_get_allocated_size⚠ | @brief Return the size that a particular pointer was allocated with. |
multi_heap_get_info⚠ | @brief Return metadata about a given heap |
multi_heap_malloc⚠ | @brief malloc() a buffer in a given heap |
multi_heap_minimum_free_size⚠ | @brief Return the lifetime minimum free heap size |
multi_heap_realloc⚠ | @brief realloc() a buffer in a given heap. |
multi_heap_register⚠ | @brief Register a new heap for use |
multi_heap_set_lock⚠ | @brief Associate a private lock pointer with a heap |
nanosleep⚠ | |
netif_add⚠ | |
netif_add_ip6_address⚠ | |
netif_add_noaddr⚠ | |
netif_create_ip6_linklocal_address⚠ | |
netif_find⚠ | |
netif_get_by_index⚠ | |
netif_get_ip6_addr_match⚠ | |
netif_index_to_name⚠ | |
netif_init⚠ | |
netif_input⚠ | |
netif_ip6_addr_set⚠ | |
netif_ip6_addr_set_parts⚠ | |
netif_ip6_addr_set_state⚠ | |
netif_loop_output⚠ | |
netif_name_to_index⚠ | |
netif_poll⚠ | |
netif_remove⚠ | |
netif_set_addr⚠ | |
netif_set_default⚠ | |
netif_set_down⚠ | |
netif_set_gw⚠ | |
netif_set_ipaddr⚠ | |
netif_set_link_down⚠ | |
netif_set_link_up⚠ | |
netif_set_netmask⚠ | |
netif_set_up⚠ | |
nice⚠ | |
nrand48⚠ | |
nvs_close⚠ | @brief Close the storage handle and free any allocated resources |
nvs_commit⚠ | @brief Write any pending changes to non-volatile storage |
nvs_entry_find⚠ | @brief Create an iterator to enumerate NVS entries based on one or more parameters |
nvs_entry_info⚠ | @brief Fills nvs_entry_info_t structure with information about entry pointed to by the iterator. |
nvs_entry_next⚠ | @brief Returns next item matching the iterator criteria, NULL if no such item exists. |
nvs_erase_all⚠ | @brief Erase all key-value pairs in a namespace |
nvs_erase_key⚠ | @brief Erase key-value pair with given key name. |
nvs_flash_deinit⚠ | @brief Deinitialize NVS storage for the default NVS partition |
nvs_flash_deinit_partition⚠ | @brief Deinitialize NVS storage for the given NVS partition |
nvs_flash_erase⚠ | @brief Erase the default NVS partition |
nvs_flash_erase_partition⚠ | @brief Erase specified NVS partition |
nvs_flash_generate_keys⚠ | @brief Generate and store NVS keys in the provided esp partition |
nvs_flash_init⚠ | @brief Initialize the default NVS partition. |
nvs_flash_init_partition⚠ | @brief Initialize NVS flash storage for the specified partition. |
nvs_flash_read_security_cfg⚠ | @brief Read NVS security configuration from a partition. |
nvs_flash_secure_init⚠ | @brief Initialize the default NVS partition. |
nvs_flash_secure_init_partition⚠ | @brief Initialize NVS flash storage for the specified partition. |
nvs_get_blob⚠ | |
nvs_get_i8⚠ | @{*/ @brief get value for given key |
nvs_get_i16⚠ | |
nvs_get_i32⚠ | |
nvs_get_i64⚠ | |
nvs_get_stats⚠ | @brief Fill structure nvs_stats_t. It provides info about used memory the partition. |
nvs_get_str⚠ | @brief get value for given key |
nvs_get_u8⚠ | |
nvs_get_u16⚠ | |
nvs_get_u32⚠ | |
nvs_get_u64⚠ | |
nvs_get_used_entry_count⚠ | @brief Calculate all entries in a namespace. |
nvs_open⚠ | @brief Open non-volatile storage with a given namespace from the default NVS partition |
nvs_open_from_partition⚠ | @brief Open non-volatile storage with a given namespace from specified partition |
nvs_release_iterator⚠ | @brief Release iterator |
nvs_set_blob⚠ | @brief set variable length binary value for given key |
nvs_set_i8⚠ | @{*/ @brief set value for given key |
nvs_set_i16⚠ | |
nvs_set_i32⚠ | |
nvs_set_i64⚠ | |
nvs_set_str⚠ | |
nvs_set_u8⚠ | |
nvs_set_u16⚠ | |
nvs_set_u32⚠ | |
nvs_set_u64⚠ | |
on_exit⚠ | |
open⚠ | |
open_memstream⚠ | |
openat⚠ | |
pathconf⚠ | |
pause⚠ | |
pbuf_add_header⚠ | |
pbuf_add_header_force⚠ | |
pbuf_alloc⚠ | |
pbuf_alloc_reference⚠ | |
pbuf_alloced_custom⚠ | |
pbuf_cat⚠ | |
pbuf_chain⚠ | |
pbuf_clen⚠ | |
pbuf_clone⚠ | |
pbuf_coalesce⚠ | |
pbuf_copy⚠ | |
pbuf_copy_partial⚠ | |
pbuf_dechain⚠ | |
pbuf_free⚠ | |
pbuf_free_header⚠ | |
pbuf_get_at⚠ | |
pbuf_get_contiguous⚠ | |
pbuf_header⚠ | |
pbuf_header_force⚠ | |
pbuf_memcmp⚠ | |
pbuf_memfind⚠ | |
pbuf_put_at⚠ | |
pbuf_realloc⚠ | |
pbuf_ref⚠ | |
pbuf_remove_header⚠ | |
pbuf_skip⚠ | |
pbuf_strstr⚠ | |
pbuf_take⚠ | |
pbuf_take_at⚠ | |
pbuf_try_get_at⚠ | |
pcTaskGetTaskName⚠ | Get task name |
pclose⚠ | |
periph_module_disable⚠ | @brief disable peripheral module |
periph_module_enable⚠ | @brief enable peripheral module |
periph_module_reset⚠ | @brief reset peripheral module |
perror⚠ | |
pipe⚠ | |
poll⚠ | |
popen⚠ | |
posix_memalign⚠ | |
pread⚠ | |
printf⚠ | |
pselect⚠ | |
psignal⚠ | |
pthread_atfork⚠ | |
pthread_kill⚠ | |
pthread_sigmask⚠ | |
putc⚠ | |
putc_unlocked⚠ | |
putchar⚠ | |
putchar_unlocked⚠ | |
putenv⚠ | |
puts⚠ | |
putw⚠ | |
pvTaskGetThreadLocalStoragePointer⚠ | Get local storage pointer specific to the given task. |
pvTaskIncrementMutexHeldCount⚠ | |
pwrite⚠ | |
pxPortInitialiseStack⚠ | |
pxTaskGetStackStart⚠ | Returns the start of the stack associated with xTask. |
qsort⚠ | |
qsort_r⚠ | |
quick_exit⚠ | |
raise⚠ | |
rand⚠ | |
rand_r⚠ | |
random⚠ | |
read⚠ | |
readlink⚠ | |
readlinkat⚠ | |
realloc⚠ | |
reallocarray⚠ | |
reallocf⚠ | |
realpath⚠ | |
remove⚠ | |
rename⚠ | |
renameat⚠ | |
revoke⚠ | |
rewind⚠ | |
rindex⚠ | |
rmdir⚠ | |
rpmatch⚠ | |
rresvport⚠ | |
rtc_clk_8m_enable⚠ | @brief Enable or disable 8 MHz internal oscillator |
rtc_clk_8m_enabled⚠ | @brief Get the state of 8 MHz internal oscillator @return true if the oscillator is enabled |
rtc_clk_32k_enable⚠ | @brief Enable or disable 32 kHz XTAL oscillator @param en true to enable, false to disable |
rtc_clk_32k_enable_external⚠ | @brief Configure 32 kHz XTAL oscillator to accept external clock signal |
rtc_clk_32k_enabled⚠ | @brief Get the state of 32k XTAL oscillator @return true if 32k XTAL oscillator has been enabled |
rtc_clk_32k_bootstrap⚠ | @brief Enable 32k oscillator, configuring it for fast startup time. Note: to achieve higher frequency stability, rtc_clk_32k_enable function must be called one the 32k XTAL oscillator has started up. This function will initially disable the 32k XTAL oscillator, so it should not be called when the system is using 32k XTAL as RTC_SLOW_CLK. |
rtc_clk_8md256_enabled⚠ | @brief Get the state of /256 divider which is applied to 8MHz clock @return true if the divided output is enabled |
rtc_clk_apb_freq_get⚠ | @brief Get the current stored APB frequency. @return The APB frequency value as last set via rtc_clk_apb_freq_update(), in Hz. |
rtc_clk_apb_freq_update⚠ | @brief Store new APB frequency value into RTC_APB_FREQ_REG |
rtc_clk_apll_enable⚠ | @brief Enable or disable APLL |
rtc_clk_cal⚠ | @brief Measure RTC slow clock's period, based on main XTAL frequency |
rtc_clk_cal_ratio⚠ | @brief Measure ratio between XTAL frequency and RTC slow clock frequency @param cal_clk slow clock to be measured @param slow_clk_cycles number of slow clock cycles to average @return average ratio between XTAL frequency and slow clock frequency, Q13.19 fixed point format, or 0 if calibration has timed out. |
rtc_clk_cpu_freq_get_config⚠ | @brief Get the currently used CPU frequency configuration @param[out] out_config Output, CPU frequency configuration structure |
rtc_clk_cpu_freq_mhz_to_config⚠ | @brief Get CPU frequency config for a given frequency @param freq_mhz Frequency in MHz @param[out] out_config Output, CPU frequency configuration structure @return true if frequency can be obtained, false otherwise |
rtc_clk_cpu_freq_set_config⚠ | @brief Switch CPU frequency |
rtc_clk_cpu_freq_set_config_fast⚠ | @brief Switch CPU frequency (optimized for speed) |
rtc_clk_cpu_freq_set_xtal⚠ | @brief Switch CPU clock source to XTAL |
rtc_clk_cpu_freq_to_config⚠ | @brief Get CPU frequency config corresponding to a rtc_cpu_freq_t value @param cpu_freq CPU frequency enumeration value @param[out] out_config Output, CPU frequency configuration structure |
rtc_clk_fast_freq_get⚠ | @brief Get the RTC_FAST_CLK source @return currently selected clock source (one of rtc_fast_freq_t values) |
rtc_clk_fast_freq_set⚠ | @brief Select source for RTC_FAST_CLK @param fast_freq clock source (one of rtc_fast_freq_t values) |
rtc_clk_init⚠ | Initialize clocks and set CPU frequency |
rtc_clk_slow_freq_get⚠ | @brief Get the RTC_SLOW_CLK source @return currently selected clock source (one of rtc_slow_freq_t values) |
rtc_clk_slow_freq_get_hz⚠ | @brief Get the approximate frequency of RTC_SLOW_CLK, in Hz |
rtc_clk_slow_freq_set⚠ | @brief Select source for RTC_SLOW_CLK @param slow_freq clock source (one of rtc_slow_freq_t values) |
rtc_clk_wait_for_slow_cycle⚠ | @brief Busy loop until next RTC_SLOW_CLK cycle |
rtc_clk_xtal_freq_get⚠ | @brief Get main XTAL frequency |
rtc_clk_xtal_freq_update⚠ | @brief Update XTAL frequency |
rtc_init⚠ | Initialize RTC clock and power control related functions @param cfg configuration options as rtc_config_t |
rtc_sleep_init⚠ | @brief Prepare the chip to enter sleep mode |
rtc_sleep_set_wakeup_time⚠ | @brief Set target value of RTC counter for RTC_TIMER_TRIG_EN wakeup source @param t value of RTC counter at which wakeup from sleep will happen; only the lower 48 bits are used |
rtc_sleep_start⚠ | @brief Enter deep or light sleep mode |
rtc_time_get⚠ | @brief Get current value of RTC counter |
rtc_time_slowclk_to_us⚠ | @brief Convert time interval from RTC_SLOW_CLK to microseconds @param time_in_us Time interval in RTC_SLOW_CLK cycles @param slow_clk_period Period of slow clock in microseconds, Q13.19 fixed point format (as returned by rtc_slowck_cali). @return time interval in microseconds |
rtc_time_us_to_slowclk⚠ | @brief Convert time interval from microseconds to RTC_SLOW_CLK cycles @param time_in_us Time interval in microseconds @param slow_clk_period Period of slow clock in microseconds, Q13.19 fixed point format (as returned by rtc_slowck_cali). @return number of slow clock cycles |
rtc_vddsdio_get_config⚠ | Get current VDDSDIO configuration If VDDSDIO configuration is overridden by RTC, get values from RTC Otherwise, if VDDSDIO is configured by EFUSE, get values from EFUSE Otherwise, use default values and the level of MTDI bootstrapping pin. @return currently used VDDSDIO configuration |
rtc_vddsdio_set_config⚠ | Set new VDDSDIO configuration using RTC registers. If config.force == 1, this overrides configuration done using bootstrapping pins and EFUSE. |
ruserok⚠ | |
sbrk⚠ | |
scanf⚠ | |
sched_yield⚠ | |
seed48⚠ | |
select⚠ | |
setbuf⚠ | |
setbuffer⚠ | |
setdtablesize⚠ | |
setegid⚠ | |
setenv⚠ | |
seteuid⚠ | |
setgid⚠ | |
setgroups⚠ | |
sethostname⚠ | |
setitimer⚠ | |
setlinebuf⚠ | |
setpgid⚠ | |
setpgrp⚠ | |
setregid⚠ | |
setreuid⚠ | |
setsid⚠ | |
setstate⚠ | |
settimeofday⚠ | |
setuid⚠ | |
setusershell⚠ | |
setvbuf⚠ | |
sigaction⚠ | |
sigaddset⚠ | |
sigaltstack⚠ | |
sigdelset⚠ | |
sigemptyset⚠ | |
sigfillset⚠ | |
sigismember⚠ | |
signal⚠ | |
sigpause⚠ | |
sigpending⚠ | |
sigprocmask⚠ | |
sigqueue⚠ | |
sigsuspend⚠ | |
sigtimedwait⚠ | |
sigwait⚠ | |
sigwaitinfo⚠ | |
siprintf⚠ | |
siscanf⚠ | |
sleep⚠ | |
sniprintf⚠ | |
snprintf⚠ | |
sntp_get_sync_interval⚠ | @brief Get the sync interval of SNTP operation |
sntp_get_sync_mode⚠ | @brief Get set sync mode |
sntp_get_sync_status⚠ | @brief Get status of time sync |
sntp_restart⚠ | @brief Restart SNTP |
sntp_set_sync_interval⚠ | @brief Set the sync interval of SNTP operation |
sntp_set_sync_mode⚠ | @brief Set the sync mode |
sntp_set_sync_status⚠ | @brief Set status of time sync |
sntp_set_time_sync_notification_cb⚠ | @brief Set a callback function for time synchronization notification |
sntp_sync_time⚠ | @brief This function updates the system time. |
soc_get_available_memory_region_max_count⚠ | |
soc_get_available_memory_regions⚠ | |
spi_flash_cache2phys⚠ | @brief Given a memory address where flash is mapped, return the corresponding physical flash offset. |
spi_flash_cache_enabled⚠ | @brief Check at runtime if flash cache is enabled on both CPUs |
spi_flash_enable_cache⚠ | @brief Re-enable cache for the core defined as cpuid parameter. |
spi_flash_erase_range⚠ | @brief Erase a range of flash sectors |
spi_flash_erase_sector⚠ | @brief Erase the Flash sector. |
spi_flash_get_chip_size⚠ | @brief Get flash chip size, as set in binary image header |
spi_flash_guard_get⚠ | @brief Get the guard functions used for flash access |
spi_flash_guard_set⚠ | @brief Sets guard functions to access flash. |
spi_flash_init⚠ | @brief Initialize SPI flash access driver |
spi_flash_mmap⚠ | @brief Map region of flash memory into data or instruction address space |
spi_flash_mmap_dump⚠ | @brief Display information about mapped regions |
spi_flash_mmap_get_free_pages⚠ | @brief get free pages number which can be mmap |
spi_flash_mmap_pages⚠ | @brief Map sequences of pages of flash memory into data or instruction address space |
spi_flash_munmap⚠ | @brief Release region previously obtained using spi_flash_mmap |
spi_flash_phys2cache⚠ | @brief Given a physical offset in flash, return the address where it is mapped in the memory space. |
spi_flash_read⚠ | @brief Read data from Flash. |
spi_flash_read_encrypted⚠ | @brief Read data from Encrypted Flash. |
spi_flash_wrap_set⚠ | @brief set wrap mode of flash |
spi_flash_write⚠ | @brief Write data to Flash. |
spi_flash_write_encrypted⚠ | @brief Write data encrypted to Flash. |
sprintf⚠ | |
srand⚠ | |
srand48⚠ | |
srandom⚠ | |
sscanf⚠ | |
stat⚠ | |
stpcpy⚠ | |
stpncpy⚠ | |
strcasecmp⚠ | |
strcasecmp_l⚠ | |
strcat⚠ | |
strchr⚠ | |
strcmp⚠ | |
strcoll⚠ | |
strcoll_l⚠ | |
strcpy⚠ | |
strcspn⚠ | |
strdup⚠ | |
strerror⚠ | |
strerror_l⚠ | |
strerror_r⚠ | |
strftime⚠ | |
strftime_l⚠ | |
strlcat⚠ | |
strlcpy⚠ | |
strlen⚠ | |
strlwr⚠ | |
strncasecmp⚠ | |
strncasecmp_l⚠ | |
strncat⚠ | |
strncmp⚠ | |
strncpy⚠ | |
strndup⚠ | |
strnlen⚠ | |
strnstr⚠ | |
strpbrk⚠ | |
strrchr⚠ | |
strsep⚠ | |
strsignal⚠ | |
strspn⚠ | |
strstr⚠ | |
strtod⚠ | |
strtof⚠ | |
strtoimax⚠ | |
strtoimax_l⚠ | |
strtok⚠ | |
strtok_r⚠ | |
strtol⚠ | |
strtold⚠ | |
strtoll⚠ | |
strtoul⚠ | |
strtoull⚠ | |
strtoumax⚠ | |
strtoumax_l⚠ | |
strupr⚠ | |
strxfrm⚠ | |
strxfrm_l⚠ | |
symlink⚠ | |
symlinkat⚠ | |
sync⚠ | |
sys_delay_ms⚠ | |
sys_thread_sem_deinit⚠ | |
sys_thread_sem_get⚠ | |
sys_thread_sem_init⚠ | |
sysconf⚠ | |
system⚠ | |
tcgetpgrp⚠ | |
tcsetpgrp⚠ | |
tempnam⚠ | |
time⚠ | |
timer_create⚠ | |
timer_delete⚠ | |
timer_getoverrun⚠ | |
timer_gettime⚠ | |
timer_settime⚠ | |
timingsafe_bcmp⚠ | |
timingsafe_memcmp⚠ | |
tmpfile⚠ | |
tmpnam⚠ | |
toascii⚠ | |
toascii_l⚠ | |
tolower⚠ | |
tolower_l⚠ | |
touch_pad_clear_group_mask⚠ | @brief Clear touch sensor group mask. Touch pad module has two sets of signals, Interrupt is triggered only if at least one of touch pad in this group is "touched". This function will clear the register bits according to the given bitmask. @param set1_mask bitmask touch sensor signal group1, it's a 10-bit value @param set2_mask bitmask touch sensor signal group2, it's a 10-bit value @param en_mask bitmask of touch sensor work enable, it's a 10-bit value @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_clear_status⚠ | @brief To clear the touch sensor channel active status. |
touch_pad_config⚠ | @brief Configure touch pad interrupt threshold. |
touch_pad_deinit⚠ | @brief Un-install touch pad driver. @note After this function is called, other touch functions are prohibited from being called. @return - ESP_OK Success - ESP_FAIL Touch pad driver not initialized |
touch_pad_filter_delete⚠ | @brief delete touch pad filter driver and release the memory Need to call touch_pad_filter_start before all touch filter APIs @return - ESP_OK Success - ESP_ERR_INVALID_STATE driver state error |
touch_pad_filter_start⚠ | @brief start touch pad filter function This API will start a filter to process the noise in order to prevent false triggering when detecting slight change of capacitance. Need to call touch_pad_filter_start before all touch filter APIs |
touch_pad_filter_stop⚠ | @brief stop touch pad filter function Need to call touch_pad_filter_start before all touch filter APIs @return - ESP_OK Success - ESP_ERR_INVALID_STATE driver state error |
touch_pad_get_cnt_mode⚠ | @brief Get touch sensor charge/discharge speed for each pad @param touch_num touch pad index @param slope pointer to accept touch pad charge/discharge slope @param opt pointer to accept the initial voltage @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_get_filter_period⚠ | @brief get touch pad filter calibration period, in ms Need to call touch_pad_filter_start before all touch filter APIs @param p_period_ms pointer to accept period @return - ESP_OK Success - ESP_ERR_INVALID_STATE driver state error - ESP_ERR_INVALID_ARG parameter error |
touch_pad_get_fsm_mode⚠ | @brief Get touch sensor FSM mode @param mode pointer to accept FSM mode @return - ESP_OK on success |
touch_pad_get_group_mask⚠ | @brief Get touch sensor group mask. @param set1_mask pointer to accept bitmask of touch sensor signal group1, it's a 10-bit value @param set2_mask pointer to accept bitmask of touch sensor signal group2, it's a 10-bit value @param en_mask pointer to accept bitmask of touch sensor work enable, it's a 10-bit value @return - ESP_OK on success |
touch_pad_get_meas_time⚠ | @brief Get touch sensor measurement and sleep time @param sleep_cycle Pointer to accept sleep cycle number @param meas_cycle Pointer to accept measurement cycle count. @return - ESP_OK on success |
touch_pad_get_status⚠ | @brief Get the touch sensor channel active status mask. The bit position represents the channel number. The 0/1 status of the bit represents the trigger status. |
touch_pad_get_thresh⚠ | @brief Get touch sensor interrupt threshold @param touch_num touch pad index @param threshold pointer to accept threshold @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_get_trigger_mode⚠ | @brief Get touch sensor interrupt trigger mode @param mode pointer to accept touch sensor interrupt trigger mode @return - ESP_OK on success |
touch_pad_get_trigger_source⚠ | @brief Get touch sensor interrupt trigger source @param src pointer to accept touch sensor interrupt trigger source @return - ESP_OK on success |
touch_pad_get_voltage⚠ | @brief Get touch sensor reference voltage, @param refh pointer to accept DREFH value @param refl pointer to accept DREFL value @param atten pointer to accept the attenuation on DREFH @return - ESP_OK on success |
touch_pad_get_wakeup_status⚠ | @brief Get the touch pad which caused wakeup from deep sleep. @param pad_num pointer to touch pad which caused wakeup @return - ESP_OK Success - ESP_ERR_INVALID_ARG parameter is NULL |
touch_pad_init⚠ | @brief Initialize touch module. @note If default parameter don't match the usage scenario, it can be changed after this function. @return - ESP_OK Success - ESP_ERR_NO_MEM Touch pad init error |
touch_pad_intr_clear⚠ | @brief To clear touch pad interrupt @return - ESP_OK on success |
touch_pad_intr_disable⚠ | @brief To disable touch pad interrupt @return - ESP_OK on success |
touch_pad_intr_enable⚠ | @brief To enable touch pad interrupt @return - ESP_OK on success |
touch_pad_io_init⚠ | @brief Initialize touch pad GPIO @param touch_num touch pad index @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_isr_deregister⚠ | @brief Deregister the handler previously registered using touch_pad_isr_handler_register @param fn handler function to call (as passed to touch_pad_isr_handler_register) @param arg argument of the handler (as passed to touch_pad_isr_handler_register) @return - ESP_OK on success - ESP_ERR_INVALID_STATE if a handler matching both fn and arg isn't registered |
touch_pad_isr_register⚠ | @brief Register touch-pad ISR. The handler will be attached to the same CPU core that this function is running on. @param fn Pointer to ISR handler @param arg Parameter for ISR @return - ESP_OK Success ; - ESP_ERR_INVALID_ARG GPIO error - ESP_ERR_NO_MEM No memory |
touch_pad_meas_is_done⚠ | @brief Check touch sensor measurement status. |
touch_pad_read⚠ | @brief get touch sensor counter value. Each touch sensor has a counter to count the number of charge/discharge cycles. When the pad is not 'touched', we can get a number of the counter. When the pad is 'touched', the value in counter will get smaller because of the larger equivalent capacitance. |
touch_pad_read_filtered⚠ | @brief get filtered touch sensor counter value by IIR filter. |
touch_pad_read_raw_data⚠ | @brief get raw data (touch sensor counter value) from IIR filter process. Need not request hardware measurements. |
touch_pad_set_cnt_mode⚠ | @brief Set touch sensor charge/discharge speed for each pad. If the slope is 0, the counter would always be zero. If the slope is 1, the charging and discharging would be slow, accordingly. If the slope is set 7, which is the maximum value, the charging and discharging would be fast. @note The higher the charge and discharge current, the greater the immunity of the touch channel, but it will increase the system power consumption. @param touch_num touch pad index @param slope touch pad charge/discharge speed @param opt the initial voltage @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_filter_period⚠ | @brief set touch pad filter calibration period, in ms. Need to call touch_pad_filter_start before all touch filter APIs @param new_period_ms filter period, in ms @return - ESP_OK Success - ESP_ERR_INVALID_STATE driver state error - ESP_ERR_INVALID_ARG parameter error |
touch_pad_set_filter_read_cb⚠ | @brief Register the callback function that is called after each IIR filter calculation. @note The 'read_cb' callback is called in timer task in each filtering cycle. @param read_cb Pointer to filtered callback function. If the argument passed in is NULL, the callback will stop. @return - ESP_OK Success - ESP_ERR_INVALID_ARG set error |
touch_pad_set_fsm_mode⚠ | @brief Set touch sensor FSM mode, the test action can be triggered by the timer, as well as by the software. @param mode FSM mode @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_group_mask⚠ | @brief Set touch sensor group mask. Touch pad module has two sets of signals, 'Touched' signal is triggered only if at least one of touch pad in this group is "touched". This function will set the register bits according to the given bitmask. @param set1_mask bitmask of touch sensor signal group1, it's a 10-bit value @param set2_mask bitmask of touch sensor signal group2, it's a 10-bit value @param en_mask bitmask of touch sensor work enable, it's a 10-bit value @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_meas_time⚠ | @brief Set touch sensor measurement and sleep time. Excessive total time will slow down the touch response. Too small measurement time will not be sampled enough, resulting in inaccurate measurements. |
touch_pad_set_thresh⚠ | @brief Set touch sensor interrupt threshold @param touch_num touch pad index @param threshold threshold of touchpad count, refer to touch_pad_set_trigger_mode to see how to set trigger mode. @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_trigger_mode⚠ | @brief Set touch sensor interrupt trigger mode. Interrupt can be triggered either when counter result is less than threshold or when counter result is more than threshold. @param mode touch sensor interrupt trigger mode @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_trigger_source⚠ | @brief Set touch sensor interrupt trigger source. There are two sets of touch signals. Set1 and set2 can be mapped to several touch signals. Either set will be triggered if at least one of its touch signal is 'touched'. The interrupt can be configured to be generated if set1 is triggered, or only if both sets are triggered. @param src touch sensor interrupt trigger source @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_set_voltage⚠ | @brief Set touch sensor high voltage threshold of chanrge. The touch sensor measures the channel capacitance value by charging and discharging the channel. So the high threshold should be less than the supply voltage. @param refh the value of DREFH @param refl the value of DREFL @param atten the attenuation on DREFH @return - ESP_OK on success - ESP_ERR_INVALID_ARG if argument is wrong |
touch_pad_sw_start⚠ | @brief Trigger a touch sensor measurement, only support in SW mode of FSM @return - ESP_OK on success |
toupper⚠ | |
toupper_l⚠ | |
truncate⚠ | |
ttyname⚠ | |
ttyname_r⚠ | |
tzset⚠ | |
ualarm⚠ | |
uart_clear_intr_status⚠ | @brief Clear UART interrupt status |
uart_disable_intr_mask⚠ | @brief Clear UART interrupt enable bits |
uart_disable_pattern_det_intr⚠ | @brief UART disable pattern detect function. Designed for applications like 'AT commands'. When the hardware detects a series of one same character, the interrupt will be triggered. |
uart_disable_rx_intr⚠ | @brief Disable UART RX interrupt (RX_FULL & RX_TIMEOUT INTERRUPT) |
uart_disable_tx_intr⚠ | @brief Disable UART TX interrupt (TX_FULL & TX_TIMEOUT INTERRUPT) |
uart_driver_delete⚠ | @brief Uninstall UART driver. |
uart_driver_install⚠ | @brief Install UART driver and set the UART to the default configuration. |
uart_enable_intr_mask⚠ | @brief Set UART interrupt enable |
uart_enable_pattern_det_baud_intr⚠ | @brief UART enable pattern detect function. Designed for applications like 'AT commands'. When the hardware detect a series of one same character, the interrupt will be triggered. |
uart_enable_pattern_det_intr⚠ | @brief UART enable pattern detect function. Designed for applications like 'AT commands'. When the hardware detect a series of one same character, the interrupt will be triggered. @note This function only works for esp32. And this function is deprecated, please use uart_enable_pattern_det_baud_intr instead. |
uart_enable_rx_intr⚠ | @brief Enable UART RX interrupt (RX_FULL & RX_TIMEOUT INTERRUPT) |
uart_enable_tx_intr⚠ | @brief Enable UART TX interrupt (TX_FULL & TX_TIMEOUT INTERRUPT) |
uart_flush⚠ | @brief Alias of uart_flush_input. UART ring buffer flush. This will discard all data in the UART RX buffer. @note Instead of waiting the data sent out, this function will clear UART rx buffer. In order to send all the data in tx FIFO, we can use uart_wait_tx_done function. @param uart_num UART port number, the max port number is (UART_NUM_MAX -1). |
uart_flush_input⚠ | @brief Clear input buffer, discard all the data is in the ring-buffer. @note In order to send all the data in tx FIFO, we can use uart_wait_tx_done function. @param uart_num UART port number, the max port number is (UART_NUM_MAX -1). |
uart_get_baudrate⚠ | @brief Get the UART baud rate configuration. |
uart_get_buffered_data_len⚠ | @brief UART get RX ring buffer cached data length |
uart_get_collision_flag⚠ | @brief Returns collision detection flag for RS485 mode Function returns the collision detection flag into variable pointed by collision_flag. *collision_flag = true, if collision detected else it is equal to false. This function should be executed when actual transmission is completed (after uart_write_bytes()). |
uart_get_hw_flow_ctrl⚠ | @brief Get the UART hardware flow control configuration. |
uart_get_parity⚠ | @brief Get the UART parity mode configuration. |
uart_get_stop_bits⚠ | @brief Get the UART stop bit configuration. |
uart_get_wakeup_threshold⚠ | @brief Get the number of RX pin signal edges for light sleep wakeup. |
uart_get_word_length⚠ | @brief Get the UART data bit configuration. |
uart_intr_config⚠ | @brief Configure UART interrupts. |
uart_is_driver_installed⚠ | @brief Checks whether the driver is installed or not |
uart_isr_free⚠ | @brief Free UART interrupt handler registered by uart_isr_register. Must be called on the same core as uart_isr_register was called. |
uart_isr_register⚠ | @brief Register UART interrupt handler (ISR). |
uart_param_config⚠ | @brief Set UART configuration parameters. |
uart_pattern_get_pos⚠ | @brief Return the nearest detected pattern position in buffer. The positions of the detected pattern are saved in a queue, This function do nothing to the queue. @note If the RX buffer is full and flow control is not enabled, the detected pattern may not be found in the rx buffer due to overflow. |
uart_pattern_pop_pos⚠ | @brief Return the nearest detected pattern position in buffer. The positions of the detected pattern are saved in a queue, this function will dequeue the first pattern position and move the pointer to next pattern position. @note If the RX buffer is full and flow control is not enabled, the detected pattern may not be found in the rx buffer due to overflow. |
uart_pattern_queue_reset⚠ | @brief Allocate a new memory with the given length to save record the detected pattern position in rx buffer. |
uart_read_bytes⚠ | @brief UART read bytes from UART buffer |
uart_set_always_rx_timeout⚠ | @brief Configure behavior of UART RX timeout interrupt. |
uart_set_baudrate⚠ | @brief Set UART baud rate. |
uart_set_dtr⚠ | @brief Manually set the UART DTR pin level. |
uart_set_hw_flow_ctrl⚠ | @brief Set hardware flow control. |
uart_set_line_inverse⚠ | @brief Set UART line inverse mode |
uart_set_loop_back⚠ | @brief Configure TX signal loop back to RX module, just for the test usage. |
uart_set_mode⚠ | @brief UART set communication mode |
uart_set_parity⚠ | @brief Set UART parity mode. |
uart_set_pin⚠ | @brief Set UART pin number |
uart_set_rts⚠ | @brief Manually set the UART RTS pin level. @note UART must be configured with hardware flow control disabled. |
uart_set_rx_full_threshold⚠ | @brief Set uart threshold value for RX fifo full @note If application is using higher baudrate and it is observed that bytes in hardware RX fifo are overwritten then this threshold can be reduced |
uart_set_rx_timeout⚠ | @brief UART set threshold timeout for TOUT feature |
uart_set_stop_bits⚠ | @brief Set UART stop bits. |
uart_set_sw_flow_ctrl⚠ | @brief Set software flow control. |
uart_set_tx_empty_threshold⚠ | @brief Set uart threshold values for TX fifo empty |
uart_set_tx_idle_num⚠ | @brief Set UART idle interval after tx FIFO is empty |
uart_set_wakeup_threshold⚠ | @brief Set the number of RX pin signal edges for light sleep wakeup |
uart_set_word_length⚠ | @brief Set UART data bits. |
uart_tx_chars⚠ | @brief Send data to the UART port from a given buffer and length. |
uart_wait_tx_done⚠ | @brief Wait until UART TX FIFO is empty. |
uart_wait_tx_idle_polling⚠ | @brief Wait until UART tx memory empty and the last char send ok (polling mode). |
uart_write_bytes⚠ | @brief Send data to the UART port from a given buffer and length, |
uart_write_bytes_with_break⚠ | @brief Send data to the UART port from a given buffer and length, |
ucQueueGetQueueType⚠ | |
ulTaskNotifyTake⚠ | Simplified macro for receiving task notification. |
umask⚠ | |
ungetc⚠ | |
unlink⚠ | |
unlinkat⚠ | |
unsetenv⚠ | |
usleep⚠ | |
utimensat⚠ | |
utimes⚠ | |
utoa⚠ | |
uxListRemove⚠ | |
uxQueueGetQueueNumber⚠ | |
uxQueueMessagesWaiting⚠ | Return the number of messages stored in a queue. |
uxQueueMessagesWaitingFromISR⚠ | |
uxQueueSpacesAvailable⚠ | Return the number of free spaces available in a queue. This is equal to the number of items that can be sent to the queue before the queue becomes full if no items are removed. |
uxTaskGetNumberOfTasks⚠ | Get current number of tasks |
uxTaskGetSnapshotAll⚠ | |
uxTaskGetStackHighWaterMark⚠ | Returns the high water mark of the stack associated with xTask. |
uxTaskGetSystemState⚠ | Get the state of tasks in the system. |
uxTaskGetTaskNumber⚠ | |
uxTaskPriorityGet⚠ | Obtain the priority of any task. |
uxTaskPriorityGetFromISR⚠ | A version of uxTaskPriorityGet() that can be used from an ISR. |
uxTaskResetEventItemValue⚠ | |
vApplicationSleep⚠ | |
vListInitialise⚠ | |
vListInitialiseItem⚠ | |
vListInsert⚠ | |
vListInsertEnd⚠ | |
vPortAssertIfInISR⚠ | |
vPortEndScheduler⚠ | |
vPortEnterCritical⚠ | |
vPortExitCritical⚠ | |
vPortReleaseTaskMPUSettings⚠ | |
vPortSetStackWatchpoint⚠ | |
vPortStoreTaskMPUSettings⚠ | |
vPortYield⚠ | |
vPortYieldOtherCore⚠ | |
vQueueDelete⚠ | Delete a queue - freeing all the memory allocated for storing of items placed on the queue. |
vQueueSetQueueNumber⚠ | |
vQueueWaitForMessageRestricted⚠ | @cond |
vRingbufferDelete⚠ | @brief Delete a ring buffer |
vRingbufferGetInfo⚠ | @brief Get information about ring buffer status |
vRingbufferReturnItem⚠ | @brief Return a previously-retrieved item to the ring buffer |
vRingbufferReturnItemFromISR⚠ | @brief Return a previously-retrieved item to the ring buffer from an ISR |
vTaskAllocateMPURegions⚠ | Memory regions are assigned to a restricted task when the task is created by a call to xTaskCreateRestricted(). These regions can be redefined using vTaskAllocateMPURegions(). |
vTaskDelay⚠ | Delay a task for a given number of ticks. |
vTaskDelayUntil⚠ | Delay a task until a specified time. |
vTaskDelete⚠ | Remove a task from the RTOS real time kernel's management. |
vTaskEndScheduler⚠ | Stops the real time kernel tick. |
vTaskGetRunTimeStats⚠ | Get the state of running tasks as a string |
vTaskList⚠ | List all the current tasks. |
vTaskMissedYield⚠ | |
vTaskNotifyGiveFromISR⚠ | Simplified macro for sending task notification from ISR. |
vTaskPlaceOnEventList⚠ | |
vTaskPlaceOnEventListRestricted⚠ | |
vTaskPlaceOnUnorderedEventList⚠ | |
vTaskPriorityInherit⚠ | |
vTaskPrioritySet⚠ | Set the priority of any task. |
vTaskResume⚠ | Resumes a suspended task. |
vTaskSetTaskNumber⚠ | |
vTaskSetThreadLocalStoragePointer⚠ | Set local storage pointer specific to the given task. |
vTaskSetThreadLocalStoragePointerAndDelCallback⚠ | Set local storage pointer and deletion callback. |
vTaskSetTimeOutState⚠ | |
vTaskStartScheduler⚠ | @cond */ Starts the real time kernel tick processing. |
vTaskStepTick⚠ | |
vTaskSuspend⚠ | Suspend a task. |
vTaskSuspendAll⚠ | Suspends the scheduler without disabling interrupts. |
vTaskSwitchContext⚠ | |
vasiprintf⚠ | |
vasniprintf⚠ | |
vasnprintf⚠ | |
vdiprintf⚠ | |
vdprintf⚠ | |
vfiprintf⚠ | |
vfiscanf⚠ | |
vfork⚠ | |
vfprintf⚠ | |
vfscanf⚠ | |
vhangup⚠ | |
viprintf⚠ | |
viscanf⚠ | |
vprintf⚠ | |
vscanf⚠ | |
vsiprintf⚠ | |
vsiscanf⚠ | |
vsniprintf⚠ | |
vsnprintf⚠ | |
vsprintf⚠ | |
vsscanf⚠ | |
wcstoimax⚠ | |
wcstoimax_l⚠ | |
wcstombs⚠ | |
wcstoumax⚠ | |
wcstoumax_l⚠ | |
wctomb⚠ | |
write⚠ | |
xPortGetTickRateHz⚠ | |
xPortInIsrContext⚠ | |
xPortInterruptedFromISRContext⚠ | |
xPortStartScheduler⚠ | |
xQueueAddToSet⚠ | Adds a queue or semaphore to a queue set that was previously created by a call to xQueueCreateSet(). |
xQueueAltGenericReceive⚠ | |
xQueueAltGenericSend⚠ | @cond */ xQueueAltGenericSend() is an alternative version of xQueueGenericSend(). Likewise xQueueAltGenericReceive() is an alternative version of xQueueGenericReceive(). |
xQueueCRReceive⚠ | |
xQueueCRReceiveFromISR⚠ | |
xQueueCRSend⚠ | |
xQueueCRSendFromISR⚠ | |
xQueueCreateCountingSemaphore⚠ | |
xQueueCreateCountingSemaphoreStatic⚠ | |
xQueueCreateMutex⚠ | |
xQueueCreateMutexStatic⚠ | |
xQueueCreateSet⚠ | Queue sets provide a mechanism to allow a task to block (pend) on a read operation from multiple queues or semaphores simultaneously. |
xQueueGenericCreate⚠ | |
xQueueGenericReceive⚠ | It is preferred that the macro xQueueReceive() be used rather than calling this function directly. |
xQueueGenericReset⚠ | |
xQueueGenericSend⚠ | It is preferred that the macros xQueueSend(), xQueueSendToFront() and xQueueSendToBack() are used in place of calling this function directly. |
xQueueGenericSendFromISR⚠ | @{*/ It is preferred that the macros xQueueSendFromISR(), xQueueSendToFrontFromISR() and xQueueSendToBackFromISR() be used in place of calling this function directly. xQueueGiveFromISR() is an equivalent for use by semaphores that don't actually copy any data. |
xQueueGetMutexHolder⚠ | |
xQueueGiveFromISR⚠ | |
xQueueGiveMutexRecursive⚠ | |
xQueueIsQueueEmptyFromISR⚠ | @{*/ Utilities to query queues that are safe to use from an ISR. These utilities should be used only from witin an ISR, or within a critical section. |
xQueueIsQueueFullFromISR⚠ | |
xQueuePeekFromISR⚠ | A version of xQueuePeek() that can be called from an interrupt service routine (ISR). |
xQueueReceiveFromISR⚠ | Receive an item from a queue. It is safe to use this function from within an interrupt service routine. |
xQueueRemoveFromSet⚠ | Removes a queue or semaphore from a queue set. A queue or semaphore can only be removed from a set if the queue or semaphore is empty. |
xQueueSelectFromSet⚠ | xQueueSelectFromSet() selects from the members of a queue set a queue or semaphore that either contains data (in the case of a queue) or is available to take (in the case of a semaphore). xQueueSelectFromSet() effectively allows a task to block (pend) on a read operation on all the queues and semaphores in a queue set simultaneously. |
xQueueSelectFromSetFromISR⚠ | A version of xQueueSelectFromSet() that can be used from an ISR. |
xQueueTakeMutexRecursive⚠ | |
xRingbufferAddToQueueSetRead⚠ | @brief Add the ring buffer's read semaphore to a queue set. |
xRingbufferCanRead⚠ | @brief Check if the selected queue set member is the ring buffer's read semaphore |
xRingbufferCreate⚠ | @brief Create a ring buffer |
xRingbufferCreateNoSplit⚠ | @brief Create a ring buffer of type RINGBUF_TYPE_NOSPLIT for a fixed item_size |
xRingbufferGetCurFreeSize⚠ | @brief Get current free size available for an item/data in the buffer |
xRingbufferGetMaxItemSize⚠ | @brief Get maximum size of an item that can be placed in the ring buffer |
xRingbufferPrintInfo⚠ | @brief Debugging function to print the internal pointers in the ring buffer |
xRingbufferReceive⚠ | @brief Retrieve an item from the ring buffer |
xRingbufferReceiveFromISR⚠ | @brief Retrieve an item from the ring buffer in an ISR |
xRingbufferReceiveSplit⚠ | @brief Retrieve a split item from an allow-split ring buffer |
xRingbufferReceiveSplitFromISR⚠ | @brief Retrieve a split item from an allow-split ring buffer in an ISR |
xRingbufferReceiveUpTo⚠ | @brief Retrieve bytes from a byte buffer, specifying the maximum amount of bytes to retrieve |
xRingbufferReceiveUpToFromISR⚠ | @brief Retrieve bytes from a byte buffer, specifying the maximum amount of bytes to retrieve. Call this from an ISR. |
xRingbufferRemoveFromQueueSetRead⚠ | @brief Remove the ring buffer's read semaphore from a queue set. |
xRingbufferSend⚠ | @brief Insert an item into the ring buffer |
xRingbufferSendAcquire⚠ | @brief Acquire memory from the ring buffer to be written to by an external source and to be sent later. |
xRingbufferSendComplete⚠ | @brief Actually send an item into the ring buffer allocated before by
|
xRingbufferSendFromISR⚠ | @brief Insert an item into the ring buffer in an ISR |
xTaskCallApplicationTaskHook⚠ | Calls the hook function associated with xTask. Passing xTask as NULL has the effect of calling the Running tasks (the calling task) hook function. |
xTaskCheckForTimeOut⚠ | |
xTaskCreatePinnedToCore⚠ | |
xTaskCreateRestricted⚠ | |
xTaskGetAffinity⚠ | |
xTaskGetCurrentTaskHandle⚠ | |
xTaskGetCurrentTaskHandleForCPU⚠ | |
xTaskGetIdleTaskHandle⚠ | Get the handle of idle task for the current CPU. |
xTaskGetIdleTaskHandleForCPU⚠ | Get the handle of idle task for the given CPU. |
xTaskGetSchedulerState⚠ | |
xTaskGetTickCount⚠ | Get tick count |
xTaskGetTickCountFromISR⚠ | Get tick count from ISR |
xTaskIncrementTick⚠ | @cond |
xTaskNotify⚠ | Send task notification. |
xTaskNotifyFromISR⚠ | Send task notification from an ISR. |
xTaskNotifyWait⚠ | Wait for task notification |
xTaskPriorityDisinherit⚠ | |
xTaskRemoveFromEventList⚠ | |
xTaskRemoveFromUnorderedEventList⚠ | |
xTaskResumeAll⚠ | Resumes scheduler activity after it was suspended by a call to vTaskSuspendAll(). |
xTaskResumeFromISR⚠ | An implementation of vTaskResume() that can be called from within an ISR. |
xt_clock_freq⚠ | This function is defined to provide a deprecation warning whenever XT_CLOCK_FREQ macro is used. Update the code to use esp_clk_cpu_freq function instead. @return current CPU clock frequency, in Hz |
xt_get_interrupt_handler_arg⚠ | |
xt_ints_off⚠ | |
xt_ints_on⚠ | |
xt_set_exception_handler⚠ | |
xt_set_interrupt_handler⚠ | |
xthal_bcopy⚠ | |
xthal_cache_coherence_off⚠ | |
xthal_cache_coherence_on⚠ | |
xthal_cache_coherence_optin⚠ | |
xthal_cache_coherence_optout⚠ | |
xthal_calc_cacheadrdis⚠ | |
xthal_check_map⚠ | |
xthal_clear_regcached_code⚠ | |
xthal_compare_and_set⚠ | |
xthal_dcache_all_invalidate⚠ | |
xthal_dcache_all_unlock⚠ | |
xthal_dcache_all_writeback⚠ | |
xthal_dcache_all_writeback_inv⚠ | |
xthal_dcache_disable⚠ | |
xthal_dcache_enable⚠ | |
xthal_dcache_get_ways⚠ | |
xthal_dcache_hugerange_invalidate⚠ | |
xthal_dcache_hugerange_unlock⚠ | |
xthal_dcache_hugerange_writeback⚠ | |
xthal_dcache_hugerange_writeback_inv⚠ | |
xthal_dcache_line_invalidate⚠ | |
xthal_dcache_line_lock⚠ | |
xthal_dcache_line_unlock⚠ | |
xthal_dcache_line_writeback⚠ | |
xthal_dcache_line_writeback_inv⚠ | |
xthal_dcache_region_invalidate⚠ | |
xthal_dcache_region_lock⚠ | |
xthal_dcache_region_unlock⚠ | |
xthal_dcache_region_writeback⚠ | |
xthal_dcache_region_writeback_inv⚠ | |
xthal_dcache_set_ways⚠ | |
xthal_dcache_sync⚠ | |
xthal_disassemble⚠ | |
xthal_disassemble_size⚠ | |
xthal_encode_memory_type⚠ | |
xthal_get_cache_prefetch⚠ | |
xthal_get_cacheattr⚠ | |
xthal_get_ccompare⚠ | |
xthal_get_ccount⚠ | |
xthal_get_cpenable⚠ | |
xthal_get_dcacheattr⚠ | |
xthal_get_entry_for_address⚠ | |
xthal_get_icacheattr⚠ | |
xthal_get_int_vpri⚠ | |
xthal_get_intenable⚠ | |
xthal_get_interrupt⚠ | |
xthal_get_prid⚠ | |
xthal_get_vpri⚠ | |
xthal_get_vpri_locklevel⚠ | |
xthal_icache_all_invalidate⚠ | |
xthal_icache_all_unlock⚠ | |
xthal_icache_disable⚠ | |
xthal_icache_enable⚠ | |
xthal_icache_get_ways⚠ | |
xthal_icache_hugerange_invalidate⚠ | |
xthal_icache_hugerange_unlock⚠ | |
xthal_icache_line_invalidate⚠ | |
xthal_icache_line_lock⚠ | |
xthal_icache_line_unlock⚠ | |
xthal_icache_region_invalidate⚠ | |
xthal_icache_region_lock⚠ | |
xthal_icache_region_unlock⚠ | |
xthal_icache_set_ways⚠ | |
xthal_icache_sync⚠ | |
xthal_init_mem_cp⚠ | |
xthal_init_mem_extra⚠ | |
xthal_int_disable⚠ | |
xthal_int_enable⚠ | |
xthal_intlevel_to_vpri⚠ | |
xthal_invalidate_cp⚠ | |
xthal_invalidate_region⚠ | |
xthal_is_cacheable⚠ | |
xthal_is_device⚠ | |
xthal_is_kernel_executable⚠ | |
xthal_is_kernel_readable⚠ | |
xthal_is_kernel_writeable⚠ | |
xthal_is_user_executable⚠ | |
xthal_is_user_readable⚠ | |
xthal_is_user_writeable⚠ | |
xthal_is_writeback⚠ | |
xthal_memcpy⚠ | |
xthal_memep_inject_error⚠ | |
xthal_mpu_set_region_attribute⚠ | |
xthal_read_background_map⚠ | |
xthal_read_map⚠ | |
xthal_remove_soft_break⚠ | |
xthal_restore_cp0⚠ | |
xthal_restore_cp1⚠ | |
xthal_restore_cp2⚠ | |
xthal_restore_cp3⚠ | |
xthal_restore_cp4⚠ | |
xthal_restore_cp5⚠ | |
xthal_restore_cp6⚠ | |
xthal_restore_cp7⚠ | |
xthal_restore_cpregs⚠ | |
xthal_restore_extra⚠ | |
xthal_save_cp0⚠ | |
xthal_save_cp1⚠ | |
xthal_save_cp2⚠ | |
xthal_save_cp3⚠ | |
xthal_save_cp4⚠ | |
xthal_save_cp5⚠ | |
xthal_save_cp6⚠ | |
xthal_save_cp7⚠ | |
xthal_save_cpregs⚠ | |
xthal_save_extra⚠ | |
xthal_set_cache_prefetch⚠ | |
xthal_set_cache_prefetch_long⚠ | |
xthal_set_cacheattr⚠ | |
xthal_set_ccompare⚠ | |
xthal_set_cpenable⚠ | |
xthal_set_dcacheattr⚠ | |
xthal_set_icacheattr⚠ | |
xthal_set_int_vpri⚠ | |
xthal_set_intclear⚠ | |
xthal_set_intenable⚠ | |
xthal_set_intset⚠ | |
xthal_set_region_attribute⚠ | |
xthal_set_region_translation⚠ | |
xthal_set_region_translation_raw⚠ | |
xthal_set_soft_break⚠ | |
xthal_set_tram_trigger_func⚠ | |
xthal_set_vpri⚠ | |
xthal_set_vpri_intlevel⚠ | |
xthal_set_vpri_lock⚠ | |
xthal_set_vpri_locklevel⚠ | |
xthal_static_p2v⚠ | |
xthal_static_v2p⚠ | |
xthal_tram_done⚠ | |
xthal_tram_pending_to_service⚠ | |
xthal_tram_set_sync⚠ | |
xthal_v2p⚠ | |
xthal_validate_cp⚠ | |
xthal_vpri_to_intlevel⚠ | |
xthal_window_spill⚠ | |
xthal_write_map⚠ |
Type Definitions
BaseType_t | |
ETSEvent | |
ETSParam | |
ETSSignal | |
ETSTask | |
ETSTimer | |
ETSTimerFunc | @addtogroup ets_timer_apis @{ |
FILE | |
ListItem_t | |
List_t | |
MemoryRegion_t | |
MiniListItem_t | |
QueueHandle_t | Type by which queues are referenced. For example, a call to xQueueCreate() returns an QueueHandle_t variable that can then be used as a parameter to xQueueSend(), xQueueReceive(), etc. |
QueueSetHandle_t | Type by which queue sets are referenced. For example, a call to xQueueCreateSet() returns an xQueueSet variable that can then be used as a parameter to xQueueSelectFromSet(), xQueueAddToSet(), etc. |
QueueSetMemberHandle_t | Queue sets can contain both queues and semaphores, so the QueueSetMemberHandle_t is defined as a type to be used where a parameter or return value can be either an QueueHandle_t or an SemaphoreHandle_t. |
RingbufHandle_t | Type by which ring buffers are referenced. For example, a call to xRingbufferCreate() returns a RingbufHandle_t variable that can then be used as a parameter to xRingbufferSend(), xRingbufferReceive(), etc. |
SemaphoreHandle_t | |
StackType_t | |
StaticEventGroup_t | |
StaticListItem_t | |
StaticList_t | |
StaticMiniListItem_t | |
StaticQueue_t | |
StaticSemaphore_t | |
StaticTask_t | |
StaticTimer_t | |
TaskFunction_t | |
TaskHandle_t | task. h |
TaskHookFunction_t | Defines the prototype to which the application task hook function must conform. |
TaskParameters_t | |
TaskSnapshot_t | |
TaskStatus_t | |
TickType_t | |
TimeOut_t | |
TlsDeleteCallbackFunction_t | Prototype of local storage pointer deletion callback. |
UBaseType_t | |
XtHalVoidFunc | |
_LOCK_RECURSIVE_T | |
_LOCK_T | |
__FILE | |
__ULong | |
__blkcnt_t | |
__blksize_t | |
__builtin_va_list | |
__clock_t | |
__clockid_t | |
__compar_fn_t | |
__dev_t | |
__fsblkcnt_t | |
__fsfilcnt_t | |
__gid_t | |
__gnuc_va_list | |
__id_t | |
__ino_t | |
__int8_t | |
__int16_t | |
__int32_t | |
__int64_t | |
__int_least8_t | |
__int_least16_t | |
__int_least32_t | |
__int_least64_t | |
__intmax_t | |
__intptr_t | |
__key_t | |
__loff_t | |
__mode_t | |
__nlink_t | |
__off_t | |
__pid_t | |
__sa_family_t | |
__sigset_t | |
__size_t | |
__socklen_t | |
__ssize_t | |
__suseconds_t | |
__time_t | |
__timer_t | |
__tzinfo_type | |
__tzrule_type | |
__uid_t | |
__uint8_t | |
__uint16_t | |
__uint32_t | |
__uint64_t | |
__uint_least8_t | |
__uint_least16_t | |
__uint_least32_t | |
__uint_least64_t | |
__uintmax_t | |
__uintptr_t | |
__useconds_t | |
__va_list | |
_flock_t | |
_fpos_t | |
_iconv_t | |
_lock_t | |
_off64_t | |
_off_t | |
_sig_func_ptr | |
_ssize_t | |
_xtos_handler | |
_xtos_handler_func | |
blkcnt_t | |
blksize_t | |
caddr_t | |
clock_t | |
clockid_t | |
daddr_t | |
dev_t | |
dhcp_event_fn | |
err_t | |
error_t | |
esp_aes_128_encrypt_t | @brief The AES callback function when do WPS connect. |
esp_aes_128_decrypt_t | @brief The AES callback function when do WPS connect. |
esp_aes_decrypt_deinit_t | @brief Deinitialize AES decryption |
esp_aes_decrypt_init_t | @brief Initialize AES for decryption |
esp_aes_decrypt_t | @brief Decrypt one AES block |
esp_aes_encrypt_deinit_t | @brief Deinitialize AES encryption |
esp_aes_encrypt_init_t | @brief Initialize AES for encryption |
esp_aes_encrypt_t | @brief Encrypt one AES block |
esp_aes_unwrap_t | @brief The AES callback function when do STA connect. |
esp_aes_wrap_t | @brief The AES callback function when do STA connect. |
esp_alloc_failed_hook_t | @brief callback called when a allocation operation fails, if registered @param size in bytes of failed allocation @param caps capabillites requested of failed allocation @param function_name function which generated the failure |
esp_ccmp_decrypt_t | @brief Decrypt data using CCMP (Counter Mode CBC-MAC Protocol OR Counter Mode Cipher Block Chaining Message Authentication Code Protocol) which is used in IEEE 802.11i RSN standard. @tk: 128-bit Temporal Key for obtained during 4-way handshake @hdr: Pointer to IEEE802.11 frame headeri needed for AAD @data: Pointer to encrypted data buffer @data_len: Encrypted data length in bytes @decrypted_len: Length of decrypted data Returns: Pointer to decrypted data on success, NULL on failure |
esp_ccmp_encrypt_t | @brief Encrypt data using CCMP (Counter Mode CBC-MAC Protocol OR Counter Mode Cipher Block Chaining Message Authentication Code Protocol) which is used in IEEE 802.11i RSN standard. @tk: 128-bit Temporal Key for obtained during 4-way handshake @frame: Pointer to IEEE802.11 frame including header @len: Length of the frame including header @hdrlen: Length of the header @pn: Packet Number counter @keyid: Key ID to be mentioned in CCMP Vector @encrypted_len: Length of the encrypted frame including header |
esp_cpu_ccount_t | |
esp_crypto_cipher_t | |
esp_crypto_hash_t | |
esp_deep_sleep_wake_stub_fn_t | @brief Function type for stub to run on wake from sleep. |
esp_err_t | |
esp_event_base_t | |
esp_event_handler_instance_t | |
esp_event_handler_t | |
esp_event_loop_handle_t | |
esp_freertos_idle_cb_t | |
esp_freertos_tick_cb_t | |
esp_hmac_md5_t | @brief HMAC-MD5 over data buffer (RFC 2104)' |
esp_hmac_md5_vector_t | @brief HMAC-MD5 over data vector (RFC 2104) |
esp_hmac_sha1_t | @brief HMAC-SHA1 over data buffer (RFC 2104) |
esp_hmac_sha1_vector_t | @brief HMAC-SHA1 over data vector (RFC 2104) |
esp_hmac_sha256_vector_t | @brief The SHA256 callback function when do WPS connect. |
esp_ip4_addr_t | |
esp_ip6_addr_t | |
esp_ip_addr_t | |
esp_md5_vector_t | @brief MD5 hash for data vector |
esp_netif_config_t | |
esp_netif_driver_base_t | |
esp_netif_driver_ifconfig_t | |
esp_netif_inherent_config_t | |
esp_netif_iodriver_handle | @brief IO driver handle type |
esp_netif_netstack_config_t | @brief Specific L3 network stack configuration |
esp_netif_receive_t | @brief ESP-NETIF Receive function type |
esp_netif_t | |
esp_now_peer_info_t | |
esp_now_peer_num_t | |
esp_now_recv_cb_t | @brief Callback function of receiving ESPNOW data @param mac_addr peer MAC address @param data received data @param data_len length of received data |
esp_now_send_cb_t | @brief Callback function of sending ESPNOW data @param mac_addr peer MAC address @param status status of sending ESPNOW data (succeed or fail) |
esp_omac1_aes_128_t | @brief One-Key CBC MAC (OMAC1) hash with AES-128 for MIC computation |
esp_ota_handle_t | @brief Opaque handle for an application OTA update |
esp_partition_iterator_t | @brief Opaque partition iterator type |
esp_pbkdf2_sha1_t | @brief SHA1-based key derivation function (PBKDF2) for IEEE 802.11i |
esp_rc4_skip_t | @brief XOR RC4 stream to given data with skip-stream-start |
esp_sha1_prf_t | @brief SHA1-based Pseudo-Random Function (PRF) (IEEE 802.11i, 8.5.1.1) |
esp_sha1_vector_t | @brief SHA-1 hash for data vector |
esp_sha256_prf_t | @brief The AES callback function when do STA connect. |
esp_timer_cb_t | @brief Timer callback function type @param arg pointer to opaque user-specific data |
esp_timer_handle_t | @brief Opaque type representing a single esp_timer |
esp_vendor_ie_cb_t | @brief Function signature for received Vendor-Specific Information Element callback. @param ctx Context argument, as passed to esp_wifi_set_vendor_ie_cb() when registering callback. @param type Information element type, based on frame type received. @param sa Source 802.11 address. @param vnd_ie Pointer to the vendor specific element data received. @param rssi Received signal strength indication. |
ets_idle_cb_t | |
ets_isr_t | @addtogroup ets_intr_apis @{ |
fd_mask | |
filter_cb_t | @brief Callback function that is called after each IIR filter calculation. @note This callback is called in timer task in each filtering cycle. @note This callback should not be blocked. @param raw_value The latest raw data(touch sensor counter value) that points to all channels(raw_value[0..TOUCH_PAD_MAX-1]). @param filtered_value The latest IIR filtered data(calculated from raw data) that points to all channels(filtered_value[0..TOUCH_PAD_MAX-1]). |
fpos_t | |
fsblkcnt_t | |
fsfilcnt_t | |
gid_t | |
gpio_dev_t | |
gpio_intr_handler_fn_t | |
gpio_isr_handle_t | |
gpio_isr_t | |
i2c_port_t | @brief I2C port number, can be I2C_NUM_0 ~ (I2C_NUM_MAX-1). |
i2c_cmd_handle_t | |
i2s_dev_t | |
i2s_isr_handle_t | |
id_t | |
in_addr_t | |
in_port_t | |
ino_t | |
int_fast8_t | |
int_fast16_t | |
int_fast32_t | |
int_fast64_t | |
int_least8_t | |
int_least16_t | |
int_least32_t | |
int_least64_t | |
intmax_t | |
intr_handle_t | Handle to an interrupt handler |
intr_handler_t | Function prototype for interrupt handler function |
ip4_addr_t | ip4_addr_t uses a struct for convenience only, so that the same defines can operate both on ip4_addr_t as well as on ip4_addr_p_t. |
ip6_addr_t | IPv6 address |
ip_addr_t | |
key_t | |
locale_t | |
mem_ptr_t | |
mem_size_t | |
mode_t | |
multi_heap_handle_t | @brief Opaque handle to a registered heap |
netif_addr_idx_t | |
netif_ext_callback_fn | @ingroup netif Function used for extended netif status callbacks Note: When parsing reason argument, keep in mind that more reasons may be added in the future! @param netif netif that is affected by change @param reason change reason @param args depends on reason, see reason description |
netif_igmp_mac_filter_fn | Function prototype for netif igmp_mac_filter functions |
netif_init_fn | Function prototype for netif init functions. Set up flags and output/linkoutput callback functions in this function. |
netif_input_fn | Function prototype for netif->input functions. This function is saved as 'input' callback function in the netif struct. Call it when a packet has been received. |
netif_linkoutput_fn | Function prototype for netif->linkoutput functions. Only used for ethernet netifs. This function is called by ARP when a packet shall be sent. |
netif_mld_mac_filter_fn | Function prototype for netif mld_mac_filter functions |
netif_nsc_reason_t | @ingroup netif Extended netif status callback (NSC) reasons flags. May be extended in the future! |
netif_output_fn | Function prototype for netif->output functions. Called by lwIP when a packet shall be sent. For ethernet netif, set this to 'etharp_output' and set 'linkoutput'. |
netif_output_ip6_fn | Function prototype for netif->output_ip6 functions. Called by lwIP when a packet shall be sent. For ethernet netif, set this to 'ethip6_output' and set 'linkoutput'. |
netif_status_callback_fn | Function prototype for netif status- or link-callback functions. |
nfds_t | |
nlink_t | |
nvs_handle | |
nvs_handle_t | Opaque pointer type representing non-volatile storage handle |
nvs_iterator_t | Opaque pointer type representing iterator to nvs entries |
off_t | |
pbuf_free_custom_fn | Prototype for a function to free a custom pbuf |
pid_t | |
pthread_cond_t | |
pthread_key_t | |
pthread_mutex_t | |
pthread_t | |
register_t | |
rtc_clk_config_t | |
rtc_cntl_dev_t | |
rtc_config_t | |
rtc_cpu_freq_config_t | |
rtc_io_dev_t | |
rtc_sleep_config_t | |
rtc_vddsdio_config_t | |
s8_t | |
s16_t | |
s32_t | |
s64_t | |
sa_family_t | |
sbintime_t | |
sens_dev_t | |
shutdown_handler_t | Shutdown handler type |
sig_atomic_t | |
sig_t | |
sigset_t | |
size_t | |
sntp_sync_time_cb_t | @brief SNTP callback function for notifying about time sync event |
socklen_t | |
spi_flash_guard_end_func_t | @brief SPI flash critical section exit function. |
spi_flash_guard_start_func_t | @brief SPI flash critical section enter function. |
spi_flash_is_safe_write_address_t | @brief Function to protect SPI flash critical regions corruption. |
spi_flash_mmap_handle_t | @brief Opaque handle for memory region obtained from spi_flash_mmap. |
spi_flash_op_lock_func_t | @brief SPI flash operation lock function. |
spi_flash_op_unlock_func_t | @brief SPI flash operation unlock function. |
ssize_t | |
stack_t | |
suseconds_t | |
sys_mbox_t | |
sys_mutex_t | |
sys_prot_t | |
sys_sem_t | |
sys_thread_t | |
system_event_ap_probe_req_rx_t | Argument structure of event |
system_event_ap_staconnected_t | Argument structure of event |
system_event_ap_stadisconnected_t | Argument structure of event |
system_event_ap_staipassigned_t | Argument structure of event |
system_event_cb_t | @brief Application specified event callback function |
system_event_got_ip6_t | Argument structure of event |
system_event_handler_t | Event handler function type |
system_event_sta_authmode_change_t | Argument structure of SYSTEM_EVENT_STA_AUTHMODE_CHANGE event |
system_event_sta_connected_t | Argument structure of SYSTEM_EVENT_STA_CONNECTED event |
system_event_sta_disconnected_t | Argument structure of SYSTEM_EVENT_STA_DISCONNECTED event |
system_event_sta_got_ip_t | Argument structure of event |
system_event_sta_scan_done_t | Argument structure of SYSTEM_EVENT_SCAN_DONE event |
system_event_sta_wps_er_pin_t | Argument structure of SYSTEM_EVENT_STA_WPS_ER_PIN event |
time_t | |
timer_t | |
u8_t | |
u16_t | |
u32_t | |
u64_t | |
u_char | |
u_int | |
u_int8_t | |
u_int16_t | |
u_int32_t | |
u_int64_t | |
u_long | |
u_short | |
uart_isr_handle_t | |
uart_port_t | @brief UART port number, can be UART_NUM_0 ~ (UART_NUM_MAX -1). |
uid_t | |
uint | |
uint_fast8_t | |
uint_fast16_t | |
uint_fast32_t | |
uint_fast64_t | |
uint_least8_t | |
uint_least16_t | |
uint_least32_t | |
uint_least64_t | |
uintmax_t | |
ulong | |
useconds_t | |
ushort | |
va_list | |
wchar_t | |
wifi_csi_cb_t | @brief The RX callback function of Channel State Information(CSI) data. |
wifi_promiscuous_cb_t | @brief The RX callback function in the promiscuous mode. Each time a packet is received, the callback function will be called. |
wint_t | |
xt_exc_handler | |
xt_handler |