Skip to content

Commit 5e94bfd

Browse files
committed
Improve docs in boards.local.txt
1 parent 93807ea commit 5e94bfd

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

boards.local.txt

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,13 @@
11
# This is to allow providing extra defines like WS_MY_BOARD_NAME for any boards using generic module board definitions.
2-
# e.g. See if the board.txt already has extra defines anywhere, or only the basic empty board.defines=
2+
# Instead of the MY_BOARD_NAME suffix, it should match the unique Board ID in Wippersnapper_Boards.h, but
3+
# uppercase with underscores for dashes. e.g. "dfrobot-beetle-esp32c3" becomes WS_DFROBOT_BEETLE_ESP32C3 with -D for define.
4+
#
5+
# See if the board.txt already has extra board.defines= in any menu entries, or only the basic empty board.defines=
36
# so for example this existing one dfrobot_romeo_esp32s3.menu.PSRAM.enabled.build.defines=-DBOARD_HAS_PSRAM
4-
# then add a replacement entry with the existing plus new -DWS_MY_BOARD_NAME define.
7+
# then you would add a replacement entry with the existing plus additionally the new -DWS_UNIQUE_BOARD_NAME define:
8+
# dfrobot_romeo_esp32s3.menu.PSRAM.enabled.build.defines=-DBOARD_HAS_PSRAM -DWS_DFROBOT_UNIQUE_BOARD_ID
9+
#
10+
# Do the same for the board entry in the platformio.ini file: build_flags = -DWS_YOUR_UNIQUE_BOARD_ID
511

12+
# DF Robot ESP32-C3 shares define with Espressif ESP32_C3 Devkit/Module, so needs unique define:
613
dfrobot_beetle_esp32c3.build.defines=-DWS_DFROBOT_BEETLE_ESP32C3

0 commit comments

Comments
 (0)