ESPHome 2025.12.0-dev
Loading...
Searching...
No Matches
defines.h
Go to the documentation of this file.
1#pragma once
2
3// This file is not used by the runtime, instead, a version is generated during
4// compilation with only the relevant feature flags for the current build.
5//
6// This file is only used by static analyzers and IDEs.
7
9
10// Informative flags
11#define ESPHOME_BOARD "dummy_board"
12#define ESPHOME_PROJECT_NAME "dummy project"
13#define ESPHOME_PROJECT_VERSION "v2"
14#define ESPHOME_PROJECT_VERSION_30 "v2"
15#define ESPHOME_VARIANT "ESP32"
16#define ESPHOME_DEBUG_SCHEDULER
17
18// Default threading model for static analysis (ESP32 is multi-threaded with atomics)
19#define ESPHOME_THREAD_MULTI_ATOMICS
20
21// logger
22#define ESPHOME_LOG_LEVEL ESPHOME_LOG_LEVEL_VERY_VERBOSE
23
24// Feature flags
25#define USE_ALARM_CONTROL_PANEL
26#define USE_AREAS
27#define USE_BINARY_SENSOR
28#define USE_BUTTON
29#define USE_CAMERA
30#define USE_CLIMATE
31#define USE_CONTROLLER_REGISTRY
32#define USE_COVER
33#define USE_DATETIME
34#define USE_DATETIME_DATE
35#define USE_DATETIME_DATETIME
36#define USE_DATETIME_TIME
37#define USE_DEBUG
38#define USE_DEEP_SLEEP
39#define USE_DEVICES
40#define USE_DISPLAY
41#define USE_ENTITY_ICON
42#define USE_ESP32_IMPROV_STATE_CALLBACK
43#define USE_EVENT
44#define USE_FAN
45#define USE_GRAPH
46#define USE_GRAPHICAL_DISPLAY_MENU
47#define USE_HOMEASSISTANT_TIME
48#define USE_HTTP_REQUEST_OTA_WATCHDOG_TIMEOUT 8000 // NOLINT
49#define USE_IMPROV_SERIAL_NEXT_URL
50#define USE_JSON
51#define USE_LIGHT
52#define USE_LOCK
53#define USE_LOGGER
54#define USE_LOGGER_RUNTIME_TAG_LEVELS
55#define USE_LVGL
56#define USE_LVGL_ANIMIMG
57#define USE_LVGL_ARC
58#define USE_LVGL_BINARY_SENSOR
59#define USE_LVGL_BUTTON
60#define USE_LVGL_BUTTONMATRIX
61#define USE_LVGL_CANVAS
62#define USE_LVGL_CHART
63#define USE_LVGL_CHECKBOX
64#define USE_LVGL_DROPDOWN
65#define USE_LVGL_FONT
66#define USE_LVGL_IMAGE
67#define USE_LVGL_IMAGEBUTTON
68#define USE_LVGL_KEY_LISTENER
69#define USE_LVGL_KEYBOARD
70#define USE_LVGL_LABEL
71#define USE_LVGL_LINE
72#define USE_LVGL_LIST
73#define USE_LVGL_MENU
74#define USE_LVGL_METER
75#define USE_LVGL_MSGBOX
76#define USE_LVGL_ROLLER
77#define USE_LVGL_ROTARY_ENCODER
78#define USE_LVGL_SLIDER
79#define USE_LVGL_SPAN
80#define USE_LVGL_SPINBOX
81#define USE_LVGL_SPINNER
82#define USE_LVGL_SWITCH
83#define USE_LVGL_TABLE
84#define USE_LVGL_TABVIEW
85#define USE_LVGL_TEXTAREA
86#define USE_LVGL_TILEVIEW
87#define USE_LVGL_TOUCHSCREEN
88#define USE_MDNS
89#define USE_MDNS_STORE_SERVICES
90#define MDNS_SERVICE_COUNT 3
91#define MDNS_DYNAMIC_TXT_COUNT 3
92#define SNTP_SERVER_COUNT 3
93#define USE_MEDIA_PLAYER
94#define USE_NEXTION_TFT_UPLOAD
95#define USE_NUMBER
96#define USE_OUTPUT
97#define USE_POWER_SUPPLY
98#define USE_QR_CODE
99#define USE_SELECT
100#define USE_SENSOR
101#define USE_STATUS_LED
102#define USE_STATUS_SENSOR
103#define USE_SWITCH
104#define USE_TEXT
105#define USE_TEXT_SENSOR
106#define USE_TIME
107#define USE_TOUCHSCREEN
108#define USE_UART_DEBUGGER
109#define USE_UPDATE
110#define USE_VALVE
111#define USE_ZWAVE_PROXY
112
113// Feature flags which do not work for zephyr
114#ifndef USE_ZEPHYR
115#define USE_AUDIO_DAC
116#define USE_AUDIO_FLAC_SUPPORT
117#define USE_AUDIO_MP3_SUPPORT
118#define USE_API
119#define USE_API_CLIENT_CONNECTED_TRIGGER
120#define USE_API_CLIENT_DISCONNECTED_TRIGGER
121#define USE_API_HOMEASSISTANT_ACTION_RESPONSES
122#define USE_API_HOMEASSISTANT_ACTION_RESPONSES_JSON
123#define USE_API_HOMEASSISTANT_SERVICES
124#define USE_API_HOMEASSISTANT_STATES
125#define USE_API_NOISE
126#define USE_API_PLAINTEXT
127#define USE_API_SERVICES
128#define USE_API_CUSTOM_SERVICES
129#define API_MAX_SEND_QUEUE 8
130#define USE_MD5
131#define USE_SHA256
132#define USE_MQTT
133#define USE_NETWORK
134#define USE_ONLINE_IMAGE_BMP_SUPPORT
135#define USE_ONLINE_IMAGE_PNG_SUPPORT
136#define USE_ONLINE_IMAGE_JPEG_SUPPORT
137#define USE_OTA
138#define USE_OTA_MD5
139#define USE_OTA_PASSWORD
140#define USE_OTA_SHA256
141#define ALLOW_OTA_DOWNGRADE_MD5
142#define USE_OTA_STATE_CALLBACK
143#define USE_OTA_VERSION 2
144#define USE_TIME_TIMEZONE
145#define USE_WIFI
146#define USE_WIFI_AP
147#define USE_WIFI_MANUAL_IP
148#define USE_WIREGUARD
149#endif
150
151// Arduino-specific feature flags
152#ifdef USE_ARDUINO
153#define USE_PROMETHEUS
154#define USE_WIFI_WPA2_EAP
155#define USE_I2S_LEGACY
156#endif
157
158// IDF-specific feature flags
159#ifdef USE_ESP_IDF
160#define USE_MQTT_IDF_ENQUEUE
161#define ESPHOME_LOOP_TASK_STACK_SIZE 8192
162#endif
163
164// ESP32-specific feature flags
165#ifdef USE_ESP32
166#define USE_ESPHOME_TASK_LOG_BUFFER
167
168#define USE_BLUETOOTH_PROXY
169#define BLUETOOTH_PROXY_MAX_CONNECTIONS 3
170#define BLUETOOTH_PROXY_ADVERTISEMENT_BATCH_SIZE 16
171#define USE_CAPTIVE_PORTAL
172#define USE_ESP32_BLE
173#define USE_ESP32_BLE_MAX_CONNECTIONS 3
174#define USE_ESP32_BLE_CLIENT
175#define USE_ESP32_BLE_DEVICE
176#define USE_ESP32_BLE_SERVER
177#define USE_ESP32_BLE_UUID
178#define USE_ESP32_BLE_ADVERTISING
179#define USE_ESP32_BLE_SERVER_SET_VALUE_ACTION
180#define USE_ESP32_BLE_SERVER_DESCRIPTOR_SET_VALUE_ACTION
181#define USE_ESP32_BLE_SERVER_NOTIFY_ACTION
182#define USE_ESP32_BLE_SERVER_CHARACTERISTIC_ON_WRITE
183#define USE_ESP32_BLE_SERVER_DESCRIPTOR_ON_WRITE
184#define USE_ESP32_BLE_SERVER_ON_CONNECT
185#define USE_ESP32_BLE_SERVER_ON_DISCONNECT
186#define ESPHOME_ESP32_BLE_TRACKER_LISTENER_COUNT 1
187#define ESPHOME_ESP32_BLE_TRACKER_CLIENT_COUNT 1
188#define ESPHOME_ESP32_BLE_GAP_EVENT_HANDLER_COUNT 2
189#define ESPHOME_ESP32_BLE_GAP_SCAN_EVENT_HANDLER_COUNT 1
190#define ESPHOME_ESP32_BLE_GATTC_EVENT_HANDLER_COUNT 1
191#define ESPHOME_ESP32_BLE_GATTS_EVENT_HANDLER_COUNT 1
192#define ESPHOME_ESP32_BLE_BLE_STATUS_EVENT_HANDLER_COUNT 2
193#define USE_ESP32_CAMERA_JPEG_ENCODER
194#define USE_HTTP_REQUEST_RESPONSE
195#define USE_I2C
196#define USE_IMPROV
197#define USE_ESP32_IMPROV_NEXT_URL
198#define USE_MICROPHONE
199#define USE_PSRAM
200#define USE_SOCKET_IMPL_BSD_SOCKETS
201#define USE_SOCKET_SELECT_SUPPORT
202#define USE_WAKE_LOOP_THREADSAFE
203#define USE_SPEAKER
204#define USE_SPI
205#define USE_VOICE_ASSISTANT
206#define USE_WEBSERVER
207#define USE_WEBSERVER_AUTH
208#define USE_WEBSERVER_OTA
209#define USE_WEBSERVER_PORT 80 // NOLINT
210#define USE_WEBSERVER_SORTING
211#define USE_WIFI_11KV_SUPPORT
212#define USE_WIFI_FAST_CONNECT
213#define USB_HOST_MAX_REQUESTS 16
214
215#ifdef USE_ARDUINO
216#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 3, 2)
217#define USE_ETHERNET
218#define USE_ETHERNET_KSZ8081
219#endif
220
221#ifdef USE_ESP_IDF
222#define USE_MICRO_WAKE_WORD
223#define USE_MICRO_WAKE_WORD_VAD
224#if defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32H2)
225#define USE_OPENTHREAD
226#endif
227#endif
228
229#if defined(USE_ESP32_VARIANT_ESP32S2)
230#define USE_LOGGER_USB_CDC
231#elif defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C3) || \
232 defined(USE_ESP32_VARIANT_ESP32C5) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32H2) || \
233 defined(USE_ESP32_VARIANT_ESP32P4)
234#define USE_LOGGER_USB_CDC
235#define USE_LOGGER_USB_SERIAL_JTAG
236#endif
237#endif
238
239// ESP8266-specific feature flags
240#ifdef USE_ESP8266
241#define USE_ADC_SENSOR_VCC
242#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 1, 2)
243#define USE_CAPTIVE_PORTAL
244#define USE_ESP8266_PREFERENCES_FLASH
245#define USE_HTTP_REQUEST_ESP8266_HTTPS
246#define USE_HTTP_REQUEST_RESPONSE
247#define USE_I2C
248#define USE_SOCKET_IMPL_LWIP_TCP
249
250#define USE_SPI
251
252// Dummy firmware payload for shelly_dimmer
253#define USE_SHD_FIRMWARE_MAJOR_VERSION 56
254#define USE_SHD_FIRMWARE_MINOR_VERSION 5
255// clang-format off
256#define USE_SHD_FIRMWARE_DATA \
257 {}
258// clang-format on
259
260#define USE_WEBSERVER
261#define USE_WEBSERVER_AUTH
262#define USE_WEBSERVER_PORT 80 // NOLINT
263#endif
264
265#ifdef USE_RP2040
266#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 3, 0)
267#define USE_HTTP_REQUEST_RESPONSE
268#define USE_I2C
269#define USE_LOGGER_USB_CDC
270#define USE_SOCKET_IMPL_LWIP_TCP
271#define USE_SPI
272#endif
273
274#ifdef USE_LIBRETINY
275#define USE_CAPTIVE_PORTAL
276#define USE_SOCKET_IMPL_LWIP_SOCKETS
277#define USE_SOCKET_SELECT_SUPPORT
278#define USE_WEBSERVER
279#define USE_WEBSERVER_AUTH
280#define USE_WEBSERVER_PORT 80 // NOLINT
281#endif
282
283#ifdef USE_HOST
284#define USE_HTTP_REQUEST_RESPONSE
285#define USE_SOCKET_IMPL_BSD_SOCKETS
286#define USE_SOCKET_SELECT_SUPPORT
287#endif
288
289#ifdef USE_NRF52
290#define USE_NRF52_DFU
291#define USE_NRF52_REG0_VOUT 5
292#define USE_NRF52_UICR_ERASE
293#define USE_SOFTDEVICE_ID 7
294#define USE_SOFTDEVICE_VERSION 1
295#endif
296
297// Disabled feature flags
298// #define USE_BSEC // Requires a library with proprietary license
299// #define USE_BSEC2 // Requires a library with proprietary license
300
301#define USE_DASHBOARD_IMPORT
302
303// Default counts for static analysis
304#define CONTROLLER_REGISTRY_MAX 2
305#define ESPHOME_COMPONENT_COUNT 50
306#define ESPHOME_DEVICE_COUNT 10
307#define ESPHOME_AREA_COUNT 10
308#define ESPHOME_ENTITY_ALARM_CONTROL_PANEL_COUNT 1
309#define ESPHOME_ENTITY_BINARY_SENSOR_COUNT 1
310#define ESPHOME_ENTITY_BUTTON_COUNT 1
311#define ESPHOME_ENTITY_CLIMATE_COUNT 1
312#define ESPHOME_ENTITY_COVER_COUNT 1
313#define ESPHOME_ENTITY_DATE_COUNT 1
314#define ESPHOME_ENTITY_DATETIME_COUNT 1
315#define ESPHOME_ENTITY_EVENT_COUNT 1
316#define ESPHOME_ENTITY_FAN_COUNT 1
317#define ESPHOME_ENTITY_LIGHT_COUNT 1
318#define ESPHOME_ENTITY_LOCK_COUNT 1
319#define ESPHOME_ENTITY_MEDIA_PLAYER_COUNT 1
320#define ESPHOME_ENTITY_NUMBER_COUNT 1
321#define ESPHOME_ENTITY_SELECT_COUNT 1
322#define ESPHOME_ENTITY_SENSOR_COUNT 1
323#define ESPHOME_ENTITY_SWITCH_COUNT 1
324#define ESPHOME_ENTITY_TEXT_COUNT 1
325#define ESPHOME_ENTITY_TEXT_SENSOR_COUNT 1
326#define ESPHOME_ENTITY_TIME_COUNT 1
327#define ESPHOME_ENTITY_UPDATE_COUNT 1
328#define ESPHOME_ENTITY_VALVE_COUNT 1