Skip to content
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

Explain about ESP32-S3-BOX-3 sensors #4458

Open
wants to merge 1 commit into
base: current
Choose a base branch
from

Conversation

igorsantos07
Copy link

And the fact they go unavailable with the currently available firmware, so people have more information to buy the device more consciously.

Description:

Long story short, there are two versions of the device available, and the "default" one (both in stores and in promos images) is the blue one, which is a bit more expensive and comes with extra parts that become useless with the currently available firmware. The device has all sensors working with the factory software, but once you install the wakeword assistant, they do not show on HA, given they're probably not implemented.

Interested users must be aware of this, so there's no chance they'll buy the extra parts thinking they'll get an assistant with sensors included. Or that, at least, they buy knowing it could be added... someday.

Related issue (if applicable): This issue got mentioned here (home-assistant/home-assistant.io#35299 (comment)) a month ago, but it's not directly related.

Pull request in esphome with YAML changes (if applicable): none

Checklist:

  • I am merging into next because this is new documentation that has a matching pull-request in esphome as linked above.
    or

  • I am merging into current because this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.

  • Link added in /index.rst when creating new documents for new components or cookbook.

And the fact they go unavailable with the currently available firmware, so people have more information to buy the device more consciously.
Copy link
Contributor

coderabbitai bot commented Nov 21, 2024

Walkthrough

The changes in this pull request primarily involve modifications to the projects/installer.html file, focusing on the content and structure of installation instructions for ESPHome devices. The description for the "ESP32-S3-BOX-3" has been updated to include a warning about firmware limitations and a recommendation to consider the 3B variant. Additionally, HTML structure adjustments enhance clarity, and visibility of elements is managed through new classes. JavaScript functionality for user interactions remains unchanged, ensuring dynamic updates to the installation process without introducing new features.

Changes

File Change Summary
projects/installer.html Expanded description for "ESP32-S3-BOX-3" device with firmware limitations warning; adjusted HTML structure for clarity; added classes for visibility control; retained existing JavaScript functionality for user interactions.

Possibly related PRs

  • Update bme280 description humidity #4257: This PR updates the BME280 sensor documentation to correct the description of the humidity configuration variable, which is relevant to the installation process for ESPHome devices.
  • Update bme280.rst with CSB pin hint #4439: This PR adds a note regarding the CSB pin connection for the BME280 sensor, enhancing the clarity of setup instructions, which aligns with the focus on improving user guidance in the main PR.

Suggested labels

current

Suggested reviewers

  • frenck

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
projects/installer.html (1)

233-240: LGTM! Clear and helpful warning about firmware limitations.

The warning message effectively communicates the firmware limitations and provides a clear recommendation for potential buyers. The text is well-structured and aligns perfectly with the PR objectives of preventing misunderstandings about device capabilities.

Minor suggestion: Consider adding a brief mention that these sensors work with the factory firmware, as mentioned in the PR description, to provide complete context.

     <p>
       Also, keep in mind that <u>the currently available firmware does not support
-      any of the sensors from the additional dock</u>. Thus, unless you want
+      any of the sensors from the additional dock</u> (though they work with factory firmware). Thus, unless you want
       to tinker yourself with the device, it's recommended to buy the 3B variant,
       which does not come with the blue dock that has temperature/humidity/radar
       sensors and the IR emitter/receiver. It also does not include the adapter
       bracket and breadboard, which would be exclusive to custom-made projects.
     </p>
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 485ddba and d62c200.

📒 Files selected for processing (1)
  • projects/installer.html (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
projects/installer.html (1)

Pattern **: - Do not generate or add any sequence diagrams

Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit d62c200
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/673eb29777fac1000892d889
😎 Deploy Preview https://deploy-preview-4458--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant