Skip to content

[alarm_control_panel] Document MQTT JSON command payload with code#6269

Open
heythisisnate wants to merge 1 commit intoesphome:nextfrom
heythisisnate:acp-mqtt-command-json
Open

[alarm_control_panel] Document MQTT JSON command payload with code#6269
heythisisnate wants to merge 1 commit intoesphome:nextfrom
heythisisnate:acp-mqtt-command-json

Conversation

@heythisisnate
Copy link
Contributor

@heythisisnate heythisisnate commented Mar 12, 2026

Description:

Document the new MQTT JSON command payload format for the alarm control panel component, which allows sending a PIN code alongside state commands via MQTT.

Pull request in esphome with the component changes (if applicable):

Checklist:

  • Branch: next is for the next (beta) release and current is for the current stable release.

🤖 Generated with Claude Code

esphome[bot]
esphome bot previously requested changes Mar 12, 2026
Copy link

@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 March 12, 2026 17:30
@esphome
Copy link

esphome bot commented Mar 12, 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

netlify bot commented Mar 12, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit a2dcaea
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69b301ffb7dd910008cfc124
😎 Deploy Preview https://deploy-preview-6269--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.

@heythisisnate heythisisnate changed the base branch from current to next March 12, 2026 17:37
@esphome esphome bot added the next label Mar 12, 2026
@esphome esphome bot dismissed their stale review March 12, 2026 17:37

Base branch has been corrected - dismissing previous review.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

Caution

Review failed

Failed to post review comments

Walkthrough

This PR updates ESPHome release processes and documentation infrastructure. It transitions changelog generation from Markdown (.md) to MDX format with updated marker handling, introduces tracking for undocumented API changes in release notes, adds numerous new components (Audio File, Serial Proxy, RP2040 BLE, SEN6x, HDC302x, dew point sensor, speaker_source), expands existing component documentation with new configuration options and actions, and removes deprecated SSL fingerprint references from MQTT documentation. Version bumped to 2026.4.0-dev.

Changes

Cohort / File(s) Summary
Build Configuration
.gitattributes, data/version.yaml, lint.mjs
Added .webp binary marking; version bumped from 2026.2 to 2026.4; lint now ignores release_notes_template.mdx file.
Release Notes Generation System
script/generate_release_notes.py, script/prompt_templates/breaking_changes.txt, script/release_notes_template.mdx
Major refactoring: output path changed from content/changelog/{version}.md to src/content/docs/changelog/{version}.mdx; added undocumented API changes tracking; introduced _generate_breaking_changes_and_checklist_prompt method; template now uses MDX markers ({/* ... */}) instead of HTML comments; extended breaking_changes.txt with upgrade checklist and undocumented API changes sections; release_notes_template.mdx restructured with new MDX-compatible markers and sections.
New Component Documentation
src/content/docs/components/audio_file/index.mdx, src/content/docs/components/serial_proxy.mdx, src/content/docs/components/rp2040_ble.mdx, src/content/docs/components/sensor/sen6x.mdx, src/content/docs/components/sensor/hdc302x.mdx, src/content/docs/components/sensor/dew_point.mdx, src/content/docs/components/media_player/speaker_source.mdx
Added documentation for 7 new components covering audio file playback, serial proxy, RP2040 BLE stack, environmental sensors (SEN6x, HDC302x), dew point calculation, and speaker source media player routing.
Media Source Infrastructure
src/content/docs/components/media_source/index.mdx, src/content/docs/components/media_source/audio_file.mdx
Introduced new media_source domain documentation with audio_file media source platform supporting audio-file:// URI scheme.
New OTA Platform
src/content/docs/components/ota/zephyr_mcumgr.mdx, src/content/docs/components/ota/index.mdx
Added Zephyr MCUmgr OTA support for nRF52 with BLE and UART transport options; updated OTA index to reference new platform and changed API reference from ota_component.h to ota_backend.h across OTA variants.
Component Configuration Expansions
src/content/docs/components/alarm_control_panel/index.mdx, src/content/docs/components/esp32.mdx, src/content/docs/components/esp32_ble.mdx, src/content/docs/components/esp32_ble_server.mdx, src/content/docs/components/esp32_camera.mdx, src/content/docs/components/esp32_hosted.mdx, src/content/docs/components/esp8266.mdx, src/content/docs/components/esp_ldo.mdx, src/content/docs/components/http_request.mdx, src/content/docs/components/logger.mdx, src/content/docs/components/media_player/index.mdx, src/content/docs/components/media_player/speaker.mdx, src/content/docs/components/modbus.mdx, src/content/docs/components/modbus_controller.mdx, src/content/docs/components/nrf52.mdx, src/content/docs/components/ota/esphome.mdx, src/content/docs/components/ota/http_request.mdx, src/content/docs/components/ota/web_server.mdx, src/content/docs/components/rp2040.mdx, src/content/docs/components/safe_mode.mdx, src/content/docs/components/text_sensor/version.mdx, src/content/docs/components/uart.mdx, src/content/docs/components/usb_uart.mdx, src/content/docs/components/wifi.mdx, src/content/docs/components/ble_nus.mdx, src/content/docs/components/cc1101.mdx, src/content/docs/components/esp_ldo.mdx
Added numerous new configuration options (engineering_sample, enable_full_printf, max_clients, pixel_format, sdio_frequency, tft_upload_* options, band_mode, flush_timeout, debug_prefix), new actions (cc1101.set_frequency/power/modulation/etc., media_player mute/repeat/shuffle/etc., safe_mode.mark_successful, speaker volume controls), new conditions (media_player.is_muted), and expanded documentation for existing features across 25+ components.
Component Documentation Updates
src/content/docs/components/binary_sensor/esp32_touch.mdx, src/content/docs/components/display/epaper_spi.mdx, src/content/docs/components/display/mipi_dsi.mdx, src/content/docs/components/display/mipi_spi.mdx, src/content/docs/components/display/nextion.mdx, src/content/docs/components/online_image.mdx, src/content/docs/components/openthread.mdx, src/content/docs/components/sensor/integration.mdx, src/content/docs/components/sensor/lps22.mdx, src/content/docs/components/sensor/sen5x.mdx, src/content/docs/components/touchscreen/gt911.mdx
Expanded support matrix (ESP32-P4 for touch sensors; additional Waveshare display panels), added display examples and driver chips (ST7789P), expanded sensor platform tables, added action documentation (sensor.integration.set_value, hdc302x heater control), updated configuration descriptions, and added touchscreen IO Expander examples.
Documentation Removals
src/content/docs/components/mqtt.mdx, src/content/docs/guides/security_best_practices.mdx, src/content/docs/guides/cli.mdx
Removed deprecated SSL fingerprints documentation for ESP8266 (ssl_fingerprints option and mqtt-fingerprint CLI command) due to platform deprecation.
Guide and Miscellaneous Updates
src/content/docs/components/index.mdx, src/content/docs/guides/troubleshooting.mdx, src/content/docs/guides/supporters.mdx
Updated component index with new navigation entries (RP2040 BLE, Serial Proxy, OTA for nRF52, Media Source, Audio File, SEN6x, HDC302x, dew_point); expanded troubleshooting guide with ESP32 crash reporting procedures and improved stack trace decoding guidance; added new contributor entries to supporters list with updated timestamp.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Suggested labels

current, has-parent

Suggested reviewers

  • jesserockz
  • kbx81
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title '[alarm_control_panel] Document MQTT JSON command payload with code' clearly and specifically describes the main change: documentation of a new MQTT JSON payload format for the alarm control panel component.
Description check ✅ Passed The description is directly related to the changeset, explaining that it documents the new MQTT JSON command payload format allowing PIN code transmission via MQTT, and references the corresponding component PR.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

CodeRabbit can use TruffleHog to scan for secrets in your code with verification capabilities.

Add a TruffleHog config file (e.g. trufflehog-config.yml, trufflehog.yml) to your project to customize detectors and scanning behavior. The tool runs only when a config file is present.

…pport

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@heythisisnate heythisisnate force-pushed the acp-mqtt-command-json branch from 5e7c135 to a2dcaea Compare March 12, 2026 18:08
@heythisisnate heythisisnate marked this pull request as ready for review March 12, 2026 18:52
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