Skip to content

Commit 3615b95

Browse files
committed
add warning about user responsibilities, and expand the settings example
1 parent c0d6cfc commit 3615b95

File tree

1 file changed

+20
-7
lines changed

1 file changed

+20
-7
lines changed

platformio_override.sample.ini

+20-7
Original file line numberDiff line numberDiff line change
@@ -538,9 +538,19 @@ lib_deps = ${env:esp32dev.lib_deps}
538538
sui77/rc-switch @ 2.6.4
539539

540540
# ------------------------------------------------------------------------------
541-
# Advanced example: Inheriting all settings from an upstream "base" config, and
542-
# adding/overriding specific build flags, which is useful if you want to base
543-
# your environment on a stable core env but just override certain WLED defaults.
541+
# Advanced example: Inheriting all settings from an upstream WLED "release" config,
542+
# and adding/overriding specific build flags, which is useful if you want to base
543+
# your environment on a stable WLED release env but easily override some of its
544+
# defaults, such as the output pin numbers, the default ethernet board ID, etc.
545+
#
546+
# WARNING: The WLED project does NOT guarantee that your chosen "upstream" config
547+
# will exist or be maintained in the future. Environments can sometimes change
548+
# radically. The compiler will warn you if the upstream configuration doesn't
549+
# exist anymore, but it won't warn you if it's no longer maintained or has added
550+
# new flags that may impact your use-case. It is YOUR responsibility to periodically
551+
# check the status and any new defaults for your chosen upstream configuration.
552+
# However, it's *generally* safe to pick a well-known, popular release configuration
553+
# and tweak a few commonly used defaults such as its pin numbers and modes!
544554
# ------------------------------------------------------------------------------
545555

546556
[env:esp32_eth_custom]
@@ -550,9 +560,10 @@ lib_deps = ${env:esp32dev.lib_deps}
550560
extends = env:esp32_eth
551561

552562
;; Remove conflicting upstream flags to fix compiler "variable redefined" warnings.
553-
;; WARNING: Must specify the EXACT upstream "build_flags" flag VALUES to unset;
554-
;; because if we don't specify any value then it unsets ALL instances of the
555-
;; flag, meaning that it would erase our new values too.
563+
;; WARNING: Must specify the EXACT upstream "build_flags" flag VALUES to unset.
564+
;; If no value is specified, then ALL values for that flag will be removed, which
565+
;; also deletes any new values you're trying to set. Also be aware that the
566+
;; compiler deletes ALL instances of the EXACT VALUES you specify below.
556567
;; NOTE: If the upstream values are ever changed, the compiler will encounter
557568
;; duplicate values and complain about "variable redefined" again, meaning that
558569
;; these values will simply need to be revised. So maintenance is safe and easy.
@@ -567,5 +578,7 @@ build_unflags = ${env:esp32_eth.build_unflags}
567578
build_flags = ${env:esp32_eth.build_flags}
568579
;; Set/add your new flag values:
569580
-D WLED_RELEASE_NAME=\"ESP32_Ethernet_Custom\"
570-
-D RLYPIN=24
581+
-D RLYPIN=24 ;; Relay pin.
582+
-D WLED_ETH_DEFAULT=4 ;; "QuinLed-ESP32-Ethernet"
583+
-D DATA_PINS=16,3,1,4 ;; LED output channels.
571584

0 commit comments

Comments
 (0)