Skip to content

Conversation

@swoboda1337
Copy link
Member

Description:

Add update docs

Related issue (if applicable): fixes

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

@netlify
Copy link

netlify bot commented Oct 28, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e958c48
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/690029a253dda600081ac918
😎 Deploy Preview https://deploy-preview-5532--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.

@netlify
Copy link

netlify bot commented Oct 28, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 0a6469c
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/690b7972360a1600099470ca
😎 Deploy Preview https://deploy-preview-5532--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.

swoboda1337 and others added 3 commits November 3, 2025 17:11
Co-authored-by: J. Nick Koston <nick+github@koston.org>
Co-authored-by: J. Nick Koston <nick+github@koston.org>
Co-authored-by: J. Nick Koston <nick+github@koston.org>
@swoboda1337 swoboda1337 requested a review from bdraco November 5, 2025 15:35
bdraco
bdraco previously approved these changes Nov 5, 2025
@swoboda1337
Copy link
Member Author

Thanks!

@swoboda1337 swoboda1337 merged commit 2cf7f66 into esphome:next Nov 5, 2025
4 checks passed
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.

2 participants