-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix: Update platformio_override.sample.ini #4617
base: main
Are you sure you want to change the base?
Conversation
Add custom_usermods to 433MHz RF example
WalkthroughThe change involves modifications to the Changes
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (2)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
thanks for the updated example. can ou remove the old definition while you are at it? |
Remove the buildflag for the usermod, as it is not longer needed
@@ -533,6 +533,7 @@ monitor_filters = esp32_exception_decoder | |||
# 433MHz RF remote example for esp32dev | |||
[env:esp32dev_usermod_RF433] | |||
extends = env:esp32dev | |||
build_flags = ${env:esp32dev.build_flags} -D USERMOD_RF433 | |||
build_flags = ${env:esp32dev.build_flags} | |||
custom_usermods = usermod_v2_RF433 | |||
lib_deps = ${env:esp32dev.lib_deps} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The entire lib_deps
statement should be deleted too. That's handled automatically by the PlatformIO Libraries feature we use now.
In this case it's handled here now:
https://github.com/wled/WLED/blob/main/usermods/usermod_v2_RF433/library.json
So users only need to set custom_usermods
, nothing else. :)
@@ -533,6 +533,7 @@ monitor_filters = esp32_exception_decoder | |||
# 433MHz RF remote example for esp32dev | |||
[env:esp32dev_usermod_RF433] | |||
extends = env:esp32dev | |||
build_flags = ${env:esp32dev.build_flags} -D USERMOD_RF433 | |||
build_flags = ${env:esp32dev.build_flags} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is actually redundant now and would work equally well if deleted. If deleted, it automatically inherits those exact build flags from the extends
.
The ${env:esp32dev.build_flags}
is however vitally important if the user wants to add extra WLED build flags that configure the usermod, so the example should still stay.
But maybe change it to this:
;; Uncomment and append your own build flags here if you want to configure the usermod:
; build_flags = ${env:esp32dev.build_flags}
Add custom_usermods to 433MHz RF example
Summary by CodeRabbit