ESPHome 2025.9.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_COVER
32#define USE_DATETIME
33#define USE_DATETIME_DATE
34#define USE_DATETIME_DATETIME
35#define USE_DATETIME_TIME
36#define USE_DEEP_SLEEP
37#define USE_DEVICES
38#define USE_DISPLAY
39#define USE_ENTITY_ICON
40#define USE_ESP32_IMPROV_STATE_CALLBACK
41#define USE_EVENT
42#define USE_FAN
43#define USE_GRAPH
44#define USE_GRAPHICAL_DISPLAY_MENU
45#define USE_HOMEASSISTANT_TIME
46#define USE_HTTP_REQUEST_OTA_WATCHDOG_TIMEOUT 8000 // NOLINT
47#define USE_JSON
48#define USE_LIGHT
49#define USE_LOCK
50#define USE_LOGGER
51#define USE_LVGL
52#define USE_LVGL_ANIMIMG
53#define USE_LVGL_ARC
54#define USE_LVGL_BINARY_SENSOR
55#define USE_LVGL_BUTTON
56#define USE_LVGL_BUTTONMATRIX
57#define USE_LVGL_CANVAS
58#define USE_LVGL_CHART
59#define USE_LVGL_CHECKBOX
60#define USE_LVGL_DROPDOWN
61#define USE_LVGL_FONT
62#define USE_LVGL_IMAGE
63#define USE_LVGL_IMAGEBUTTON
64#define USE_LVGL_KEY_LISTENER
65#define USE_LVGL_KEYBOARD
66#define USE_LVGL_LABEL
67#define USE_LVGL_LINE
68#define USE_LVGL_LIST
69#define USE_LVGL_MENU
70#define USE_LVGL_METER
71#define USE_LVGL_MSGBOX
72#define USE_LVGL_ROLLER
73#define USE_LVGL_ROTARY_ENCODER
74#define USE_LVGL_SLIDER
75#define USE_LVGL_SPAN
76#define USE_LVGL_SPINBOX
77#define USE_LVGL_SPINNER
78#define USE_LVGL_SWITCH
79#define USE_LVGL_TABLE
80#define USE_LVGL_TABVIEW
81#define USE_LVGL_TEXTAREA
82#define USE_LVGL_TILEVIEW
83#define USE_LVGL_TOUCHSCREEN
84#define USE_MDNS
85#define USE_MEDIA_PLAYER
86#define USE_NEXTION_TFT_UPLOAD
87#define USE_NUMBER
88#define USE_OUTPUT
89#define USE_POWER_SUPPLY
90#define USE_QR_CODE
91#define USE_SELECT
92#define USE_SENSOR
93#define USE_STATUS_LED
94#define USE_STATUS_SENSOR
95#define USE_SWITCH
96#define USE_TEXT
97#define USE_TEXT_SENSOR
98#define USE_TIME
99#define USE_TOUCHSCREEN
100#define USE_UART_DEBUGGER
101#define USE_UPDATE
102#define USE_VALVE
103
104// Feature flags which do not work for zephyr
105#ifndef USE_ZEPHYR
106#define USE_AUDIO_DAC
107#define USE_AUDIO_FLAC_SUPPORT
108#define USE_AUDIO_MP3_SUPPORT
109#define USE_API
110#define USE_API_CLIENT_CONNECTED_TRIGGER
111#define USE_API_CLIENT_DISCONNECTED_TRIGGER
112#define USE_API_HOMEASSISTANT_SERVICES
113#define USE_API_HOMEASSISTANT_STATES
114#define USE_API_NOISE
115#define USE_API_PLAINTEXT
116#define USE_API_SERVICES
117#define USE_MD5
118#define USE_MQTT
119#define USE_NETWORK
120#define USE_ONLINE_IMAGE_BMP_SUPPORT
121#define USE_ONLINE_IMAGE_PNG_SUPPORT
122#define USE_ONLINE_IMAGE_JPEG_SUPPORT
123#define USE_OTA
124#define USE_OTA_PASSWORD
125#define USE_OTA_STATE_CALLBACK
126#define USE_OTA_VERSION 2
127#define USE_TIME_TIMEZONE
128#define USE_WIFI
129#define USE_WIFI_AP
130#define USE_WIREGUARD
131#endif
132
133// Arduino-specific feature flags
134#ifdef USE_ARDUINO
135#define USE_PROMETHEUS
136#define USE_WIFI_WPA2_EAP
137#define USE_I2S_LEGACY
138#endif
139
140// IDF-specific feature flags
141#ifdef USE_ESP_IDF
142#define USE_MQTT_IDF_ENQUEUE
143#endif
144
145// ESP32-specific feature flags
146#ifdef USE_ESP32
147#define USE_ESPHOME_TASK_LOG_BUFFER
148
149#define USE_BLUETOOTH_PROXY
150#define BLUETOOTH_PROXY_MAX_CONNECTIONS 3
151#define BLUETOOTH_PROXY_ADVERTISEMENT_BATCH_SIZE 16
152#define USE_CAPTIVE_PORTAL
153#define USE_ESP32_BLE
154#define USE_ESP32_BLE_CLIENT
155#define USE_ESP32_BLE_DEVICE
156#define USE_ESP32_BLE_SERVER
157#define USE_ESP32_BLE_UUID
158#define USE_ESP32_BLE_ADVERTISING
159#define USE_I2C
160#define USE_IMPROV
161#define USE_MICROPHONE
162#define USE_PSRAM
163#define USE_SOCKET_IMPL_BSD_SOCKETS
164#define USE_SOCKET_SELECT_SUPPORT
165#define USE_SPEAKER
166#define USE_SPI
167#define USE_VOICE_ASSISTANT
168#define USE_WEBSERVER
169#define USE_WEBSERVER_AUTH
170#define USE_WEBSERVER_OTA
171#define USE_WEBSERVER_PORT 80 // NOLINT
172#define USE_WEBSERVER_SORTING
173#define USE_WIFI_11KV_SUPPORT
174
175#ifdef USE_ARDUINO
176#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 2, 1)
177#define USE_ETHERNET
178#endif
179
180#ifdef USE_ESP_IDF
181#define USE_MICRO_WAKE_WORD
182#define USE_MICRO_WAKE_WORD_VAD
183#if defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32H2)
184#define USE_OPENTHREAD
185#endif
186#endif
187
188#if defined(USE_ESP32_VARIANT_ESP32S2)
189#define USE_LOGGER_USB_CDC
190#elif defined(USE_ESP32_VARIANT_ESP32S3) || defined(USE_ESP32_VARIANT_ESP32C3) || \
191 defined(USE_ESP32_VARIANT_ESP32C5) || defined(USE_ESP32_VARIANT_ESP32C6) || defined(USE_ESP32_VARIANT_ESP32H2) || \
192 defined(USE_ESP32_VARIANT_ESP32P4)
193#define USE_LOGGER_USB_CDC
194#define USE_LOGGER_USB_SERIAL_JTAG
195#endif
196#endif
197
198// ESP8266-specific feature flags
199#ifdef USE_ESP8266
200#define USE_ADC_SENSOR_VCC
201#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 1, 2)
202#define USE_CAPTIVE_PORTAL
203#define USE_ESP8266_PREFERENCES_FLASH
204#define USE_HTTP_REQUEST_ESP8266_HTTPS
205#define USE_I2C
206#define USE_SOCKET_IMPL_LWIP_TCP
207
208#define USE_SPI
209
210// Dummy firmware payload for shelly_dimmer
211#define USE_SHD_FIRMWARE_MAJOR_VERSION 56
212#define USE_SHD_FIRMWARE_MINOR_VERSION 5
213#define USE_SHD_FIRMWARE_DATA \
214 {}
215
216#define USE_WEBSERVER
217#define USE_WEBSERVER_AUTH
218#define USE_WEBSERVER_PORT 80 // NOLINT
219#endif
220
221#ifdef USE_RP2040
222#define USE_ARDUINO_VERSION_CODE VERSION_CODE(3, 3, 0)
223#define USE_I2C
224#define USE_LOGGER_USB_CDC
225#define USE_SOCKET_IMPL_LWIP_TCP
226#define USE_SPI
227#endif
228
229#ifdef USE_LIBRETINY
230#define USE_CAPTIVE_PORTAL
231#define USE_SOCKET_IMPL_LWIP_SOCKETS
232#define USE_SOCKET_SELECT_SUPPORT
233#define USE_WEBSERVER
234#define USE_WEBSERVER_AUTH
235#define USE_WEBSERVER_PORT 80 // NOLINT
236#endif
237
238#ifdef USE_HOST
239#define USE_SOCKET_IMPL_BSD_SOCKETS
240#define USE_SOCKET_SELECT_SUPPORT
241#endif
242
243// Disabled feature flags
244// #define USE_BSEC // Requires a library with proprietary license
245// #define USE_BSEC2 // Requires a library with proprietary license
246
247#define USE_DASHBOARD_IMPORT
248
249// Default counts for static analysis
250#define ESPHOME_COMPONENT_COUNT 50
251#define ESPHOME_DEVICE_COUNT 10
252#define ESPHOME_AREA_COUNT 10
253#define ESPHOME_ENTITY_ALARM_CONTROL_PANEL_COUNT 1
254#define ESPHOME_ENTITY_BINARY_SENSOR_COUNT 1
255#define ESPHOME_ENTITY_BUTTON_COUNT 1
256#define ESPHOME_ENTITY_CLIMATE_COUNT 1
257#define ESPHOME_ENTITY_COVER_COUNT 1
258#define ESPHOME_ENTITY_DATE_COUNT 1
259#define ESPHOME_ENTITY_DATETIME_COUNT 1
260#define ESPHOME_ENTITY_EVENT_COUNT 1
261#define ESPHOME_ENTITY_FAN_COUNT 1
262#define ESPHOME_ENTITY_LIGHT_COUNT 1
263#define ESPHOME_ENTITY_LOCK_COUNT 1
264#define ESPHOME_ENTITY_MEDIA_PLAYER_COUNT 1
265#define ESPHOME_ENTITY_NUMBER_COUNT 1
266#define ESPHOME_ENTITY_SELECT_COUNT 1
267#define ESPHOME_ENTITY_SENSOR_COUNT 1
268#define ESPHOME_ENTITY_SWITCH_COUNT 1
269#define ESPHOME_ENTITY_TEXT_COUNT 1
270#define ESPHOME_ENTITY_TEXT_SENSOR_COUNT 1
271#define ESPHOME_ENTITY_TIME_COUNT 1
272#define ESPHOME_ENTITY_UPDATE_COUNT 1
273#define ESPHOME_ENTITY_VALVE_COUNT 1