Skip to content

Conversation

@michal-gora
Copy link
Owner

Description:

Related issue (if applicable): fixes

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

  • esphome/esphome#

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
Collaborator

@ederjc ederjc left a comment

Choose a reason for hiding this comment

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

Great!

You could mention in the docs that the measurement interval should not be set lower than 60s for constant operation.

swoboda1337 and others added 3 commits November 25, 2025 18:32
Co-authored-by: J. Nick Koston <nick@koston.org>
* Fix global links

* Fix

* Fix

* Fix legacy rst stuff

* Look only for links, ignore code and examples

---------

Co-authored-by: Clyde Stubbs <2366188+clydebarrow@users.noreply.github.com>
@michal-gora
Copy link
Owner Author

michal-gora commented Nov 25, 2025

Perfect, thanks!

It's actually mentioned in line 41 of xensiv_pas_co2.md that it should not be below 1 minute per measurement. Maybe I could rephrase it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants