[sx127x] Update preamble_size docs

[swoboda1337]

Description:

Docs should say required not optional and remove the default.

Related issue (if applicable): fixes

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

• esphome/esphome#

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

[netlify]

✅ Deploy Preview for esphome ready!

Name	Link
🔨 Latest commit	0feb6b9
🔍 Latest deploy log	https://app.netlify.com/projects/esphome/deploys/687c3a5295873c000819c030
😎 Deploy Preview	https://deploy-preview-5089--esphome.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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

[ximex]

@swoboda1337 the linked PR set's it to optional with 8 as default value. So the opposite of what this PR changes

[swoboda1337]

@swoboda1337 the linked PR set's it to optional with 8 as default value. So the opposite of what this PR changes

That is for sx126x, sx127x it's required for Lora

[coderabbitai]

Walkthrough

The documentation for the SX127x component was updated to mark the "preamble_size" configuration variable as required instead of optional, and its description was simplified by removing the reference to a default value.

Changes

File(s)	Change Summary
components/sx127x.rst	Updated "preamble_size" to required and removed mention of default.

Suggested labels

has-parent, next

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31c0a99 and 0feb6b9.

📒 Files selected for processing (1)

• components/sx127x.rst (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

**

Instructions used from:

Sources:
⚙️ CodeRabbit Configuration File

🧠 Learnings (1)

📓 Common learnings

Learnt from: jesserockz
PR: esphome/esphome-docs#4865
File: .github/workflows/needs-docs.yml:0-0
Timestamp: 2025-05-01T03:29:47.922Z
Learning: In the esphome-docs repository, the "current" label is automatically added by a bot to pull requests, making it a reliable indicator for the target branch.

🔇 Additional comments (1)

components/sx127x.rst (1)

64-65: Required flag needs cross-check with implementation & sx127x vs sx126x distinction

Changing preamble_size from optional to Required is a breaking doc change.
Before merging, please confirm that:

1. The ESPHome sx127x backend actually rejects a missing value (it previously defaulted to 8).
2. The requirement only applies to sx127x (LoRa) and not sx126x, otherwise we’ll end up with diverging docs.

If either of the above is untrue the flag should stay Optional with a stated default.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[kbx81]

Thanks! 👍🏻