Skip to content

Only disable Arduino OTA when using -D WLED_DISABLE_OTA #4652

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Only disable Arduino OTA when using -D WLED_DISABLE_OTA #4652

wants to merge 2 commits into from
+19 −8

Conversation

blazoncek
Copy link
Collaborator

@blazoncek blazoncek commented Apr 20, 2025 •
edited by coderabbitai bot
Loading

  • since Update object is accessible even with ArduinoOTA disabled it should possible to use HTTP OTA regardless
  • this (using WLED_DISABLE_OTA) saves about 12kB while still allowing HTTP OTA updates
  • HTTP OTA updates can be blocked using PIN or OTA lock

Summary by CodeRabbit

  • Refactor
    • OTA update functionality is now always available, removing the previous option to disable it at build time. The fallback message for disabled OTA updates has been removed.
    • The "Enable ArduinoOTA" option in the settings UI is now hidden when OTA updates are disabled at compile time.

@blazoncek
Only disable Arduino OTA when using -D WLED_DISABLE_OTA
ca7d7d9 
- since Update object is accessible even with ArduinoOTA disabled it should possible to use HTTP OTA regardless
- this saves about 12kB while still allowing OTA updates
- HTTP OTA updates can be blocked using PIN or OTA lock
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 20, 2025 •
edited
Loading

Walkthrough

The changes introduce conditional compilation around OTA-related configuration, settings, and UI elements based on the WLED_DISABLE_OTA macro. OTA update HTTP handlers are now always registered unconditionally, removing the previous compile-time option to disable them. The global aOtaEnabled flag initialization is adjusted to reflect the compile-time OTA enable/disable state. Configuration serialization and deserialization of the OTA enable flag, OTA-related settings updates, and the visibility of the OTA checkbox in the UI are conditionally compiled or toggled accordingly. No changes were made to public interfaces or exported declarations.

Changes

File(s) Change Summary
wled00/wled_server.cpp Removed conditional compilation for OTA update HTTP handlers; OTA handlers are now always registered and the fallback 501 handler is eliminated. No changes to public interfaces.
wled00/cfg.cpp Added conditional compilation around serialization and deserialization of the aOtaEnabled configuration field to exclude it when OTA is disabled.
wled00/set.cpp Wrapped assignment to aOtaEnabled in the security settings handler with conditional compilation to exclude OTA setting updates when OTA is disabled.
wled00/wled.h Modified initialization of global aOtaEnabled variable to be true by default, or false if WLED_DISABLE_OTA is defined.
wled00/xml.cpp Added conditional compilation to hide the ArduinoOTA checkbox in the settings UI by toggling its visibility when OTA is disabled.
wled00/data/settings_sec.htm Wrapped the "Enable ArduinoOTA" checkbox input inside a new <div> with ID "aOTA" for UI visibility control.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ca7d7d9 and 8baf0fd.

📒 Files selected for processing (5)
  • wled00/cfg.cpp (4 hunks)
  • wled00/data/settings_sec.htm (1 hunks)
  • wled00/set.cpp (1 hunks)
  • wled00/wled.h (1 hunks)
  • wled00/xml.cpp (1 hunks)
✅ Files skipped from review due to trivial changes (3)
  • wled00/data/settings_sec.htm
  • wled00/xml.cpp
  • wled00/cfg.cpp
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: wled_build / Build Environments (lolin_s2_mini)
  • GitHub Check: wled_build / Build Environments (esp32s3_4M_qspi)
  • GitHub Check: wled_build / Build Environments (esp32s3dev_8MB_opi)
  • GitHub Check: wled_build / Build Environments (esp32dev)
  • GitHub Check: wled_build / Build Environments (esp32_eth)
  • GitHub Check: wled_build / Build Environments (esp8266_2m_160)
  • GitHub Check: wled_build / Build Environments (esp32dev_V4)
  • GitHub Check: wled_build / Build Environments (nodemcuv2_compat)
  • GitHub Check: wled_build / Build Environments (esp01_1m_full_160)
  • GitHub Check: wled_build / Build Environments (esp01_1m_full)
  • GitHub Check: wled_build / Build Environments (esp8266_2m)
  • GitHub Check: wled_build / Build Environments (nodemcuv2_160)
  • GitHub Check: wled_build / Build Environments (nodemcuv2)
  • GitHub Check: wled_build / Build Environments (esp32s3_4M_qspi)
  • GitHub Check: wled_build / Build Environments (usermods)
  • GitHub Check: wled_build / Build Environments (esp32_wrover)
  • GitHub Check: wled_build / Build Environments (esp32s3dev_16MB_opi)
  • GitHub Check: wled_build / Build Environments (esp32dev)
  • GitHub Check: wled_build / Build Environments (esp32dev_V4)
🔇 Additional comments (2)
wled00/set.cpp (1)

596-598: Correctly conditionally compiles OTA flag setting.

The change wraps the assignment of aOtaEnabled inside a conditional compilation block, ensuring that if OTA is disabled at compile time, the code to modify this flag from security settings will be excluded.

wled00/wled.h (1)

587-591: Properly initializes aOtaEnabled based on compile-time flag.

This change ensures that the global aOtaEnabled flag is initialized to false when OTA is disabled at compile time, but remains true by default otherwise. This aligns with the PR objective to only disable Arduino OTA when specifically configured to do so.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@DedeHai
Copy link
Collaborator

DedeHai commented Apr 20, 2025

do any of the WLED tools use arduino OTA? if not: should it be disabled by default assuming not many users actually use this method?

@blazoncek
Copy link
Collaborator Author

IDK what users actually use but chances are majority only uses HTTP updates (HA and mobile app use that).
If we choose to disable ArduinoOTA by default then we should rename the directive to WLED_ENABLE_ARDUINO_OTA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@blazoncek @DedeHai