Skip to content

[hdc302x] New component docs #5220

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

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

Conversation

joshuasing
Copy link

@joshuasing joshuasing commented Aug 10, 2025

Description:

Adds documentation for HDC302x temperature and relative humidity sensor component.

Related issue (if applicable): N/A

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

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 /components/index.rst when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing COMPONENT_NAME with your component name in UPPER_CASE format with underscores (e.g., BME280, SHT3X, DALLAS_TEMP):

    @esphomebot generate image COMPONENT_NAME
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/index.rst.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image DHT22

* Wrong image file extension (oops)
* Title underline too short
@joshuasing joshuasing marked this pull request as ready for review August 10, 2025 17:36
Copy link

netlify bot commented Aug 10, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit dbfa1de
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/689c8e1d7a12f50008544670
😎 Deploy Preview https://deploy-preview-5220--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 project configuration.


- **heater** (*Optional*, boolean): If true, enable the relative humidity sensor's integrated heater.
*Note: This will significantly impact temperature readings.*

Copy link
Author

Choose a reason for hiding this comment

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

Would it be best to document setting address and i2c_id as well if someone wants to use multiple HDC302x sensors?

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