Skip to content

Conversation

lufton
Copy link

@lufton lufton commented Sep 3, 2025

Description:

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

Copy link

netlify bot commented Sep 3, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit da0addd
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/68b8cee842e3e7000991b50d
😎 Deploy Preview https://deploy-preview-5326--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.

@lufton lufton changed the title New QMI8658 sensor documentation ADD QMI8658 IMU sensor documentation Sep 3, 2025
@lufton
Copy link
Author

lufton commented Sep 3, 2025

@esphomebot generate image QMI8658

Copy link

github-actions bot commented Sep 3, 2025

@lufton lufton changed the title ADD QMI8658 IMU sensor documentation Add QMI8658 IMU sensor documentation Sep 3, 2025
@lufton lufton marked this pull request as ready for review September 3, 2025 23:27
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