Skip to content

Commit 9904a62

Browse files
committed
Update compile flags and doc
1 parent 2864073 commit 9904a62

File tree

3 files changed

+20
-9
lines changed

3 files changed

+20
-9
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ He is making great Arduino libraries.
3030
- [Ethernet Support](#ethernet-support)
3131
- [Logo](#logo)
3232
- [mDNS](#mdns)
33+
- [Compile Flags](#compile-flags)
3334

3435
## Changes
3536

@@ -241,3 +242,11 @@ If not provided, the logo won't appear in the Captive Portal.
241242
242243
mDNS takes quite a lot of space in flash (about 25KB).
243244
You can disable it by setting `-D ESPCONNECT_NO_MDNS`.
245+
246+
### Compile Flags
247+
248+
- `-D ESPCONNECT_NO_MDNS`: disable mDNS
249+
- `-D ESPCONNECT_DEBUG`: enable debug logs on ESP8266
250+
- `-D ESPCONNECT_NO_CAPTIVE_PORTAL`: disable Captive Portal and ESPAsyncWebServer dependency
251+
- `-D ESPCONNECT_NO_STD_STRING`: use Arduino `String` instead of `std::string`
252+
- `-D ESPCONNECT_NO_LOGGING`: disable logging

docs/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ He is making great Arduino libraries.
3030
- [Ethernet Support](#ethernet-support)
3131
- [Logo](#logo)
3232
- [mDNS](#mdns)
33+
- [Compile Flags](#compile-flags)
3334

3435
## Changes
3536

@@ -241,3 +242,11 @@ If not provided, the logo won't appear in the Captive Portal.
241242
242243
mDNS takes quite a lot of space in flash (about 25KB).
243244
You can disable it by setting `-D ESPCONNECT_NO_MDNS`.
245+
246+
### Compile Flags
247+
248+
- `-D ESPCONNECT_NO_MDNS`: disable mDNS
249+
- `-D ESPCONNECT_DEBUG`: enable debug logs on ESP8266
250+
- `-D ESPCONNECT_NO_CAPTIVE_PORTAL`: disable Captive Portal and ESPAsyncWebServer dependency
251+
- `-D ESPCONNECT_NO_STD_STRING`: use Arduino `String` instead of `std::string`
252+
- `-D ESPCONNECT_NO_LOGGING`: disable logging

platformio.ini

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,18 +16,11 @@ build_flags =
1616
-Wall -Wextra
1717
-D CONFIG_ARDUHAL_LOG_COLORS
1818
-D CORE_DEBUG_LEVEL=ARDUHAL_LOG_LEVEL_DEBUG
19-
; ------------------------------
20-
; Logging ON by default
21-
; -D ESPCONNECT_NO_LOGGING
22-
; ------------------------------
23-
-D NVS_LOG
24-
; -H -M
25-
; -D HTTPCLIENT_NOSECURE
26-
; -D ESPCONNECT_NO_MDNS
27-
; -D DEBUG_ESP_CORE
19+
; -D ESPCONNECT_DEBUG
2820
; -D ESPCONNECT_NO_MDNS
2921
; -D ESPCONNECT_NO_CAPTIVE_PORTAL
3022
; -D ESPCONNECT_NO_STD_STRING
23+
; -D ESPCONNECT_NO_LOGGING
3124
lib_compat_mode = strict
3225
lib_ldf_mode = chain
3326
lib_deps =

0 commit comments

Comments
 (0)