Document RadioFrequency entity#3067
Conversation
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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdds 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
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
📒 Files selected for processing (2)
blog/2026-04-22-radio-frequency-entity-platform.mddocs/core/entity/radio-frequency.md
|
@copilot address CodeRabbit comments |
Agent-Logs-Url: https://github.com/home-assistant/developers.home-assistant/sessions/7622b6e1-c753-4214-a5e4-fe964f24260a Co-authored-by: balloob <1444314+balloob@users.noreply.github.com>
Addressed in commit I applied the unresolved CodeRabbit wording suggestions in both files to use more concise and directive language:
This is a docs-only change (no UI changes). |
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Co-authored-by: Martin Hjelmare <marhje52@gmail.com>
Proposed change
Add docs for home-assistant/core#168447
Type of change
Checklist
Additional information
Summary by CodeRabbit