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

[esp32_rmt] Enable pullup and od mode based on pin scheme #4634

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

swoboda1337
Copy link
Contributor

@swoboda1337 swoboda1337 commented Feb 2, 2025

Description:

Update docs for esphome/esphome#8178

Related issue (if applicable): fixes

Pull request in esphome with YAML changes (if applicable): esphome/esphome#8178

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.

@swoboda1337 swoboda1337 changed the title [esp32_rmt] Enable pullup based on pin scheme [esp32_rmt] Enable pullup and od mode based on pin scheme Feb 2, 2025
@swoboda1337 swoboda1337 changed the base branch from current to next February 2, 2025 03:13
@probot-esphome probot-esphome bot added next and removed current labels Feb 2, 2025
Copy link

netlify bot commented Feb 2, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit df3eca5
🔍 Latest deploy log https://app.netlify.com/sites/esphome/deploys/679ee28b6d424b0008728d72
😎 Deploy Preview https://deploy-preview-4634--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.

Copy link
Contributor

coderabbitai bot commented Feb 2, 2025

Walkthrough

This pull request updates versioning information in configuration files and documentation, reflecting a new development version (2025.1.0-dev) while also modifying build and redirect configurations. Numerous documentation pages have been updated to clarify configuration variables, add new sections for audio components, BLE server functionality, and a web API for an alarm control panel, and to remove deprecated custom component content. Overall, the changes standardize version references, enhance documentation clarity, and consolidate outdated material.

Changes

File(s) / Grouped Files Change Summary
Doxyfile, _static/version, conf.py Updated version numbers from 2024.12.4 / 2024.12 to 2025.1.0-dev / 2025.1 reflecting the new development release.
Makefile Changed ESPHOME_REF from a fixed version (2024.12.4) to the dev branch for cloning the repository.
_redirects Added multiple new redirect rules for custom component paths and modified existing redirects to update target paths.
changelog/v1.14.0.rst Updated changelog with new components, integrations, and breaking change notes.
Components Documentation (various files) - Animation: Made type required and renamed use_transparency to transparency.
- Audio ADC: Added new pages for ES7210 and ES7243E and updated the core documentation.
- Audio DAC: Added documentation for ES8156 and reorganized the platforms section.
- Climate (midea): Added a new optional variable use_fahrenheit and updated temperature and beeper descriptions.
- Display: Updated multiple files (e.g., ili9xxx.rst, index.rst, nextion.rst, pvvx_mithermometer.rst, qspi_dbi.rst, rpi_dpi_rgb.rst, st7701s.rst) to clarify behavior of auto_clear_enabled, color options, and supported models.
- ESP32 BLE Server: Introduced new configuration variables and actions (firmware_version, on_connect, on_disconnect, services, etc.).
- Image & Online Image: Updated the type field to required and replaced use_transparency with transparency.
- LVGL: Added a new condition lvgl.page.is_showing, a new variable disp_bg_opa, and updated disp_bg_image.
- Modbus: Refined the description of send_wait_time for clearer timeout handling.
- Opentherm: Introduced new boiler-specific configuration variables and automations.
- Remote Receiver/Transmitter: Expanded configuration with additional optional parameters and new variables (e.g., id, rmt_symbols, clock_resolution, use_dma, etc.).
- Sensor (ADS1115 & Uptime): Added sample_rate for ADS1115 and updated description for update_interval.
- Text Sensor: Added a new uptime text sensor documentation.
- UDP: Introduced a new listen_address variable and multicast configuration examples.
- Web API: Added a new section for the Alarm Control Panel with GET and POST methods.
Deleted Files Removed several deprecated custom component documentation files including:
components/binary_sensor/custom.rst, components/climate/custom.rst, components/cover/custom.rst, components/light/custom.rst, components/sensor/custom.rst, components/switch/custom.rst, components/text_sensor/custom.rst, and various files under custom/ (e.g. custom_component.rst, i2c.rst, index.rst, spi.rst, uart.rst).
Guides & Index Updated guides (e.g., contributing.rst, diy.rst, getting_started_command_line.rst) to replace “custom components” with “external components” and added notes on logging levels; updated index.rst to include new Audio ADC and Audio DAC sections and removed the deprecated custom components section.
schema_doc.py Removed the custom documentation entry for custom/custom_component from the CUSTOM_DOCS dictionary.
web-api/index.rst Added a new section for the Alarm Control Panel with detailed GET and POST method descriptions.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WebAPI
    Client->>WebAPI: GET /alarm_control_panel/my_alarm
    WebAPI-->>Client: JSON { id, state, value }
    Client->>WebAPI: POST /alarm_control_panel/my_alarm/arm_home (with optional code)
    WebAPI-->>Client: 200 OK
Loading

Possibly related PRs

Suggested labels

next

Suggested reviewers

  • nagyrobi
  • jesserockz
✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Caution

Inline review comments failed to post. This is likely due to GitHub's limits when posting large numbers of comments.

Actionable comments posted: 1

🧹 Nitpick comments (11)
components/text_sensor/uptime.rst (1)

1-8: Refine Title and Introductory Text
The new file introduces the "Uptime Text Sensor" well. However, in line 8 the sentence “The uptime text sensor provides a human-readable representation the time since boot.” is slightly off grammatically. Consider changing it to “...provides a human-readable representation of the time since boot.”

components/remote_receiver.rst (1)

Line range hint 505-513: New note on enabling pull-up resistors.
A very welcome note has been added regarding receivers such as the TSOP38238 that may require a pull-up resistor. The provided YAML snippet clearly demonstrates how to configure the pin (including inverted, input: true, and pullup: true).

Suggestion: It might be useful to mention that the need for a pull-up resistor should be verified against the receiver’s datasheet since some boards might already have internal pull-ups enabled.

components/audio_adc/index.rst (4)

9-11: Component Description Overview
The description concisely explains what the audio_adc component does. Consider mentioning specific supported ADC models or common use cases to further guide users.


12-17: YAML Example Placeholder
The YAML code block provides a basic configuration example. For enhanced guidance, you might consider expanding the example with realistic placeholder values.


34-49: Automations Documentation Detailing audio_adc.set_mic_gain
The section on the automation action is well structured, specifying required fields with clarity. Enhancing it with an example automation workflow could further benefit users.


50-53: See Also Section
The ‘See Also’ block is brief and functional. Revisit whether additional related references or external resources might be added to enrich the section.

components/audio_dac/es8156.rst (1)

35-67: Detailed Configuration Examples
The examples for the ESP32 S3 Box 3 Lite are comprehensive, illustrating the integration of multiple components (audio_dac, i2s_audio, speaker, and switch). Verify that the pin configurations and component identifiers reflect the current hardware recommendations.

components/audio_adc/es7243e.rst (2)

15-20: YAML Example for ES7243E
The YAML configuration example is succinct and illustrates the basic setup for the ES7243E. Consider adding another example that includes more parameters for a comprehensive guide.


38-62: Comprehensive Configuration Examples
The configuration example for the ESP32 S3 Box Lite is thorough, covering multiple interconnected components. Double-check that the pin assignments and sample values match the latest recommended configurations for clarity and accuracy.

components/audio_adc/es7210.rst (2)

15-20: YAML Configuration Example Overview
The provided YAML snippet offers a clean, starter configuration example. Enhancing it with additional context or parameters could further improve user understanding.


36-40: Automations Support Note
The confirmation that all Audio ADC automations are supported is helpful. A brief pointer to an example automation could be a nice enhancement in future revisions.

🛑 Comments failed to post (1)
components/udp.rst (1)

293-316: ⚠️ Potential issue

Resolve Variable Naming Inconsistency in Multicast Example
In the multicast example, the configuration key is written as listen_addresses, while in the configuration variables section it is defined as listen_address (singular). This inconsistency could confuse users. Please confirm the intended option name and update either the configuration documentation or the example accordingly.

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

Successfully merging this pull request may close these issues.

1 participant