Skip to content

Document RadioFrequency entity#3067

Merged
MartinHjelmare merged 6 commits into
masterfrom
claude/document-ha-pr-168447-YNjKM
Apr 25, 2026
Merged

Document RadioFrequency entity#3067
MartinHjelmare merged 6 commits into
masterfrom
claude/document-ha-pr-168447-YNjKM

Conversation

@balloob

@balloob balloob commented Apr 23, 2026

Copy link
Copy Markdown
Member

Proposed change

Add docs for home-assistant/core#168447

Type of change

  • Document existing features within Home Assistant
  • Document new or changing features for which there is an existing pull request elsewhere
  • Spelling or grammatical corrections, or rewording for improved clarity
  • Changes to the backend of this documentation
  • Remove stale or deprecated documentation

Checklist

  • I have read and followed the documentation guidelines.
  • I have verified that my changes render correctly in the documentation.

Additional information

  • This PR fixes or closes issue: fixes #
  • Link to relevant existing code or pull request:

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive documentation page for the Radio Frequency entity platform, explaining transmitter vs consumer roles, entity state behavior (last-sent timestamp), how to discover compatible transmitters, and how to send RF commands.
    • Published a blog post introducing the Radio Frequency entity platform with usage examples, configuration guidance, and current modulation support details (OOK).

claude added 3 commits April 22, 2026 04:04
Documents the new `radio_frequency` entity domain introduced in
home-assistant/core#168447, which provides an abstraction layer between
RF transceiver hardware and device-specific integrations, mirroring the
existing `infrared` entity platform.
Only `ModulationType.OOK` is currently supported. Call this out explicitly
and use OOK in the code examples.
Replace the placeholder garage-door example with adapted snippets from
home-assistant/core#168450, which shows the real config-flow filtering
by a sample command's frequency/modulation and the real send-command
path via rf_protocols.get_codes.
@balloob balloob changed the title Claude/document ha pr 168447 y nj km Document RadioFrequency entity Apr 23, 2026
@coderabbitai

coderabbitai Bot commented Apr 23, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 55a76a8b-5aca-485b-a5a2-beb631dead79

📥 Commits

Reviewing files that changed from the base of the PR and between e0e56ab and 4a021ff.

📒 Files selected for processing (2)
  • blog/2026-04-24-radio-frequency-entity-platform.md
  • docs/core/entity/radio-frequency.md
✅ Files skipped from review due to trivial changes (1)
  • blog/2026-04-24-radio-frequency-entity-platform.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/core/entity/radio-frequency.md

📝 Walkthrough

Walkthrough

Adds two documentation pieces: a reference page describing the Radio frequency entity platform (transmitter/consumer contracts, helpers, command requirements) and a blog post announcing the platform with examples and current capability notes.

Changes

Cohort / File(s) Summary
Reference Documentation
docs/core/entity/radio-frequency.md
New reference doc describing RadioFrequencyTransmitterEntity requirements, entity state semantics, supported_frequency_ranges, async_send_command contract, helper functions (async_get_transmitters, async_send_command), modulation filtering (OOK), and requirement to use rf_protocols.RadioFrequencyCommand.
Blog Announcement
blog/2026-04-24-radio-frequency-entity-platform.md
New blog post announcing the radio frequency entity platform, summarizing transmitter/consumer separation, config-flow compatibility filtering by frequency/modulation, example usage, and note that only ModulationType.OOK is currently supported.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'Document RadioFrequency entity' clearly summarizes the main change - adding documentation for the RadioFrequency entity platform.
Description check ✅ Passed The PR description follows the required template structure with Proposed change, Type of change selected, and Additional information sections completed with a link to the corresponding core PR.
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.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/document-ha-pr-168447-YNjKM

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@blog/2026-04-22-radio-frequency-entity-platform.md`:
- Line 70: Replace wordy/modal phrasing in the documentation: change "Each
loaded command exposes the frequency and modulation the device uses, which the
config flow needs in order to filter transmitters." to use "to" instead of "in
order to" (tighten to: "which the config flow needs to filter transmitters"),
and locate the sentence that uses "may" at the other paragraph and change the
modal "may" to a direct future/assertive form (e.g., replace "may" with "will"
or reword to a definitive statement) so the tone follows the Microsoft Style
Guide and the project's authoritative, concise voice.

In `@docs/core/entity/radio-frequency.md`:
- Around line 84-85: Change the soft/modal phrasing to direct imperative
instructions in the two sentences referencing
RadioFrequencyTransmitterEntity.async_send_command and the
radio_frequency.async_send_command helper: replace "should not call ...
directly. Use ..." or any softer phrasing with a single authoritative command
like "Do not call RadioFrequencyTransmitterEntity.async_send_command directly;
call radio_frequency.async_send_command instead, which handles state updates and
context management." Ensure both occurrences that mention
RadioFrequencyTransmitterEntity.async_send_command and
radio_frequency.async_send_command use this imperative tone and mirror each
other for consistency.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 1b8f4aae-444e-473e-a595-97868ead5fab

📥 Commits

Reviewing files that changed from the base of the PR and between 6f281d2 and 040cc22.

📒 Files selected for processing (2)
  • blog/2026-04-22-radio-frequency-entity-platform.md
  • docs/core/entity/radio-frequency.md

Comment thread blog/2026-04-22-radio-frequency-entity-platform.md Outdated
Comment thread docs/core/entity/radio-frequency.md Outdated
@balloob

balloob commented Apr 23, 2026

Copy link
Copy Markdown
Member Author

@copilot address CodeRabbit comments

Copilot AI commented Apr 23, 2026

Copy link
Copy Markdown
Contributor

@copilot address CodeRabbit comments

Addressed in commit 4173e95.

I applied the unresolved CodeRabbit wording suggestions in both files to use more concise and directive language:

  • blog/2026-04-22-radio-frequency-entity-platform.md
  • docs/core/entity/radio-frequency.md

This is a docs-only change (no UI changes).

Comment thread blog/2026-04-24-radio-frequency-entity-platform.md Outdated
Comment thread docs/core/entity/radio-frequency.md Outdated
Comment thread docs/core/entity/radio-frequency.md Outdated
@home-assistant

Copy link
Copy Markdown

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.

@home-assistant home-assistant Bot marked this pull request as draft April 24, 2026 10:51
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
@balloob balloob marked this pull request as ready for review April 24, 2026 23:10
@home-assistant home-assistant Bot requested a review from MartinHjelmare April 24, 2026 23:10
@MartinHjelmare MartinHjelmare merged commit f180908 into master Apr 25, 2026
5 checks passed
@MartinHjelmare MartinHjelmare deleted the claude/document-ha-pr-168447-YNjKM branch April 25, 2026 18:14
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.

4 participants