ESP common compile configurations

Compile-time configuration macros for Espressif ESP SoCs. More...

Detailed Description

Compile-time configuration macros for Espressif ESP SoCs.

Files

file  esp_wifi_params.h
 Parameters for the ESP SoCs WiFi netdev interface.
 
file  cpu_conf_common.h
 CPU specific configuration options.
 

Macros

#define BACKUP_RAM   __attribute__((section(".rtc.bss")))
 Declare the heap_stats function as available. More...
 
#define BACKUP_RAM_DATA   __attribute__((section(".rtc.data")))
 Memory marked with this attribute is retained during deep sleep and initialized with user provided data on cold boot.
 

Set default configuration parameters for the ESP-NOW netdev driver

#define ESP_NOW_STACKSIZE   (THREAD_STACKSIZE_DEFAULT)
 The size of the stack used for the ESP-NOW netdev driver thread.
 
#define ESP_NOW_PRIO   (GNRC_NETIF_PRIO)
 The priority of the ESP-NOW netdev driver thread. More...
 
#define ESP_NOW_SCAN_PERIOD   (10000000UL)
 Period in microseconds at which an ESP-NOW node scans for other ESP-NOW nodes in its range.
 
#define ESP_NOW_SOFT_AP_PASS   "ThisistheRIOTporttoESP"
 Passphrase used for the SoftAP interface of for all ESP-NOW nodes.
 
#define ESP_NOW_CHANNEL   (6)
 Channel used as broadcast medium by all ESP-NOW nodes together.
 
#define ESP_NOW_KEY   (NULL)
 Key used for the communication between ESP-NOW nodes. More...
 

Macro Definition Documentation

◆ BACKUP_RAM

#define BACKUP_RAM   __attribute__((section(".rtc.bss")))

Declare the heap_stats function as available.

Only if module esp_idf_heap is used, a platform specific heap_stats function has to be used.

Memory marked with this attribute is retained during deep sleep and initialized with 0 on cold boot.

Definition at line 39 of file cpu_conf_common.h.

◆ ESP_NOW_KEY

#define ESP_NOW_KEY   (NULL)

Key used for the communication between ESP-NOW nodes.

The key has to be defined to enable encrypted communication between ESP-NOW nodes. The key has to be of type uint8_t [16] and has to be exactly 16 bytes long. If the key is NULL (the default) communication is not encrypted.

Please note: If encrypted communication is used, a maximum of 6 nodes can communicate with each other, while in unencrypted mode, up to 20 nodes can communicate.

Definition at line 85 of file esp_now_params.h.

◆ ESP_NOW_PRIO

#define ESP_NOW_PRIO   (GNRC_NETIF_PRIO)

The priority of the ESP-NOW netdev driver thread.

Should not be changed.

Definition at line 43 of file esp_now_params.h.