Skip to content

[cc1101] Fix magn_target valid values#6804

Open
swoboda1337 wants to merge 1 commit into
esphome:currentfrom
swoboda1337:cc1101-magn-target-options
Open

[cc1101] Fix magn_target valid values#6804
swoboda1337 wants to merge 1 commit into
esphome:currentfrom
swoboda1337:cc1101-magn-target-options

Conversation

@swoboda1337

Copy link
Copy Markdown
Member

Description:

The magn_target config variable was documented as "Range: 24dB to 42dB in increments of 3". That is incorrect — the CC1101's AGC MAGN_TARGET values are not uniform 3 dB steps. The valid values (per the enum in cc1101/__init__.py) are 24, 27, 30, 33, 36, 38, 40, 42 dB (3 dB steps up to 36 dB, then 2 dB steps). Replaced the range text with the explicit list of options.

Related issue (if applicable): N/A

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

  • N/A

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.md when creating new documents for new components or cookbook.

Copilot AI review requested due to automatic review settings June 18, 2026 16:51
@swoboda1337 swoboda1337 added this to the 2026.6.1 milestone Jun 18, 2026
@esphome esphome Bot added the current label Jun 18, 2026
@swoboda1337 swoboda1337 removed this from the 2026.6.1 milestone Jun 18, 2026
@netlify

netlify Bot commented Jun 18, 2026

Copy link
Copy Markdown

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit e3a9a54
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/6a342216ace5eb00086650c7
😎 Deploy Preview https://deploy-preview-6804--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.

Copilot AI 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.

Pull request overview

Updates the CC1101 component documentation to accurately describe the valid magn_target AGC configuration values, replacing an incorrect “3 dB increments” range description with the explicit supported set.

Changes:

  • Replaced the magn_target “Range … increments of 3” text with an explicit options list (24, 27, 30, 33, 36, 38, 40, 42 dB).
  • Kept the default value documentation (42dB) unchanged.

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

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: 8d3d6df4-8a90-4c91-9ccc-757f05df0bce

📥 Commits

Reviewing files that changed from the base of the PR and between 9844744 and e3a9a54.

📒 Files selected for processing (1)
  • src/content/docs/components/cc1101.mdx

Walkthrough

The magn_target AGC option description in the CC1101 component documentation is updated from a range-with-increments format to an explicit enumerated list of discrete dB values (24dB through 42dB in 3dB steps), with the default remaining 42dB.

Changes

CC1101 AGC Documentation Fix

Layer / File(s) Summary
magn_target discrete options description
src/content/docs/components/cc1101.mdx
Replaces the range-with-increments wording for magn_target with an explicit list of allowed values: 24dB, 27dB, 30dB, 33dB, 36dB, 39dB, 42dB; default remains 42dB.

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 clearly and specifically describes the main change: fixing the documented valid values for the magn_target parameter in the CC1101 component.
Description check ✅ Passed The description is directly related to the changeset, providing clear context about the incorrect documentation and the correct enumerated values that replace it.
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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants