Skip to content

[ln882h_ble_tracker] Add component documentation#6703

Draft
Bl00d-B0b wants to merge 1 commit into
esphome:nextfrom
Bl00d-B0b:ln882h-ble-tracker-docs
Draft

[ln882h_ble_tracker] Add component documentation#6703
Bl00d-B0b wants to merge 1 commit into
esphome:nextfrom
Bl00d-B0b:ln882h-ble-tracker-docs

Conversation

@Bl00d-B0b
Copy link
Copy Markdown
Contributor

@Bl00d-B0b Bl00d-B0b commented May 27, 2026

Adds documentation for the ln882h_ble_tracker component introduced in esphome/esphome#16691, and updates related BLE platform pages to mention LN882H support.

New files

  • src/content/docs/components/ln882h_ble_tracker.mdx — Full component documentation:
    configuration variables, all four automation triggers, start_scan/stop_scan actions,
    Bluetooth Proxy support (bluetooth_proxy: true), single-core WiFi/BLE coexistence guidance,
    and a BLE Scanner debugging section.

  • src/content/docs/components/sensor/bthome_mithermometer.mdx — New page for the BTHome v2 /
    ATC Mi Thermometer sensor platform. Covers both ESP32 and LN882H, with a note that AES-CCM
    encryption (bindkey) is not supported on LN882H.

Updated files

  • src/content/docs/components/bluetooth_proxy.mdx — Added a note that on LN882H the proxy
    is built into ln882h_ble_tracker (bluetooth_proxy: true) and supports passive advertisement
    forwarding only; updated See Also.

  • src/content/docs/components/binary_sensor/ble_presence.mdx — Added LN882H compatibility
    note and See Also link.

  • src/content/docs/components/sensor/ble_rssi.mdx — Same.

  • src/content/docs/components/text_sensor/ble_scanner.mdx — Same, with a link to the
    LN882H debugging section.

Related: esphome/esphome#16691

esphome[bot]
esphome Bot previously requested changes May 27, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@esphome esphome Bot marked this pull request as draft May 27, 2026 16:22
@esphome
Copy link
Copy Markdown

esphome Bot commented May 27, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@netlify
Copy link
Copy Markdown

netlify Bot commented May 27, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 1c88942
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a197d82afd5570008430dc1
😎 Deploy Preview https://deploy-preview-6703--esphome.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 27, 2026

Review Change Stack

Walkthrough

This PR adds complete documentation for the ln882h_ble_tracker ESPHome component. It covers the component's role as a BLE hub, scan configuration options, available automations and triggers for BLE advertisements, scan control actions, practical guidance for single-core WiFi/BLE coexistence, and references to related BLE components.

Changes

LN882H BLE Tracker Documentation

Layer / File(s) Summary
Component overview and configuration
src/content/docs/components/ln882h_ble_tracker.mdx
Introduces the ln882h_ble_tracker as a global BLE hub compatible with existing ESP32 BLE sensor platforms. Documents configuration variables for scan behavior (interval, window, duration, active, continuous modes), BLE proxy forwarding, component ID, and lists supported automations.
Automations, triggers, and actions
src/content/docs/components/ln882h_ble_tracker.mdx
Details automations and triggers: on_ble_advertise with optional mac_address filtering, manufacturer-specific and service-specific advertisement triggers with manufacturer_id/service_uuid and optional mac_address filtering, on_scan_end trigger, plus start_scan and stop_scan actions with the continuous option.
Practical guidance and related resources
src/content/docs/components/ln882h_ble_tracker.mdx
Dedicated section on single-core WiFi/BLE coexistence with example configuration that starts scanning on Home Assistant client connect and stops on disconnect. Includes scan duty cycle notes for detection reliability and a See Also section linking to related BLE sensor and scanner components.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: adding component documentation for ln882h_ble_tracker.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The pull request description clearly describes the changes: adding documentation for the ln882h_ble_tracker component, creating new documentation files, and updating related BLE platform pages with LN882H support.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

esphome[bot]
esphome Bot previously requested changes May 27, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 27, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 27, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 27, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from b6a85f8 to 12b0bc1 Compare May 29, 2026 10:23
esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 716250f to a8738ae Compare May 29, 2026 10:25
esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 7537940 to f030a9a Compare May 29, 2026 10:26
esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 32e826e to 44413e1 Compare May 29, 2026 10:35
esphome[bot]
esphome Bot previously requested changes May 29, 2026
Copy link
Copy Markdown

@esphome esphome Bot left a comment

Choose a reason for hiding this comment

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

As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.

@Bl00d-B0b Bl00d-B0b changed the base branch from current to next May 29, 2026 10:36
@esphome esphome Bot added the next label May 29, 2026
@esphome esphome Bot dismissed their stale review May 29, 2026 10:36

Base branch has been corrected - dismissing previous review.

@esphome esphome Bot dismissed stale reviews from themself May 29, 2026 10:48

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from c3cee90 to 6c21c79 Compare May 29, 2026 10:48
@esphome esphome Bot dismissed their stale review May 29, 2026 10:49

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 6c21c79 to 3496fd8 Compare May 29, 2026 10:50
@esphome esphome Bot dismissed their stale review May 29, 2026 10:51

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 3496fd8 to 2e62ed5 Compare May 29, 2026 10:55
@esphome esphome Bot dismissed stale reviews from themself May 29, 2026 10:55

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 2e62ed5 to 90f4665 Compare May 29, 2026 11:02
@esphome esphome Bot dismissed their stale review May 29, 2026 11:03

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 90f4665 to 002c5db Compare May 29, 2026 11:24
@esphome esphome Bot dismissed their stale review May 29, 2026 11:25

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 002c5db to 13176ec Compare May 29, 2026 11:29
@esphome esphome Bot dismissed stale reviews from themself May 29, 2026 11:29

Base branch has been corrected - dismissing previous review.

@Bl00d-B0b Bl00d-B0b force-pushed the ln882h-ble-tracker-docs branch from 7565a4a to 1c88942 Compare May 29, 2026 11:50
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