esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

BTHome component docs

Open jesserockz opened this issue 1 month ago • 1 comments

Description:

This adds comprehensive documentation for the new BTHome v2 BLE component that enables ESP32 devices to broadcast sensor data using the BTHome protocol.

The documentation covers:

  • Complete configuration options including sensors, binary sensors, and encryption
  • All supported sensor types (temperature, humidity, battery, etc.)
  • All supported binary sensor types (motion, door, window, etc.)
  • Detailed examples showing basic and advanced usage
  • Integration with Home Assistant
  • Explanation of immediate advertising for event-driven sensors

Related issue (if applicable): fixes

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

  • esphome/esphome#11962

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

jesserockz avatar Nov 18 '25 09:11 jesserockz

Deploy Preview for esphome ready!

Name Link
Latest commit ebc024c04c39af938c1dbd6de85f60698e1ba252
Latest deploy log https://app.netlify.com/projects/esphome/deploys/691c3f9fb3ea0600083fb9a9
Deploy Preview https://deploy-preview-5640--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[bot] avatar Nov 18 '25 09:11 netlify[bot]