esphome-docs icon indicating copy to clipboard operation
esphome-docs copied to clipboard

[sx126x] Add sx126x component

Open swoboda1337 opened this issue 8 months ago • 2 comments

Description:

The SX126X component allows you to configure/control the SX1261, SX1261 and SX1268 transceivers in ESPHome. Supported frequencies range from 150 MHz to 960 MHz. Supported modulations include LoRa, FSK, GFSK, MSK and GMSK. There are many devices in the market with an ESP32 already packaged with these radios.

Datasheet: https://www.semtech.com/products/wireless-rf/lora-connect/sx1262#documentation

Related issue (if applicable): fixes

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

  • esphome/esphome#8516

Checklist:

  • [x] 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.

  • [x] Link added in /components/index.rst when creating new documents for new components or cookbook.

swoboda1337 avatar Apr 04 '25 16:04 swoboda1337

Deploy Preview for esphome ready!

Name Link
Latest commit 946abe3bd19ff63cba0b9d60269732e1eeaf3ba2
Latest deploy log https://app.netlify.com/projects/esphome/deploys/686b4c206e963a00087e056c
Deploy Preview https://deploy-preview-4794--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.

netlify[bot] avatar Apr 04 '25 16:04 netlify[bot]

Walkthrough

This pull request updates several version numbers and documentation details. The version identifiers have been revised across configuration files (Doxygen, _static/version, conf.py, and Makefile), shifting from a stable release to a development version. Additionally, new optional configuration variables and documentation entries have been added for various components (CAN bus, ESPHome, logger, PSRAM, SX126x transceivers, and output components), and new CLI options have been introduced.

Changes

File(s) Change Summary
Doxygen, _static/version, conf.py, Makefile Updated version and reference values: PROJECT_NUMBER changed from 2025.3.3 to 2025.4.0-dev, conf.py version updated from "2025.3" to "2025.4", and ESPHOME_REF in Makefile switched from 2025.3.3 to dev.
components/canbus/esp32_can.rst, components/esphome.rst Added new optional configuration variables: tx_enqueue_timeout for the ESP32 CAN bus and debug_scheduler for ESPHome.
components/logger.rst Revised the description of deassert_rts_dtr to clarify its sequential handling of UART signals.
components/psram.rst Updated defaults for configuration variables (mode defaults to quad, speed defaults to 40MHz) and added a new "Restrictions" section outlining PSRAM limitations.
components/index.rst Added new documentation entries for hardware components: MCP4661 (Output Components) and SX1261/2/8 (Wireless Communication).
components/output/mcp4461.rst, components/sx126x.rst Introduced new documentation pages for the MCP4461 output component and the SX126x transceiver configuration.
guides/cli.rst Added new command-line options (--upload_speed BAUD_RATE and --reset) for the esphome run, upload, and logs commands.

Possibly related PRs

  • esphome/esphome-docs#4110: Involves a similar update to the PROJECT_NUMBER in the Doxygen configuration.
  • esphome/esphome-docs#3916: Contains modifications to the PROJECT_NUMBER tag in the Doxygen file.
  • esphome/esphome-docs#4125: Directly relates to the update of the PROJECT_NUMBER in the Doxygen configuration file.

Suggested labels

next

Suggested reviewers

  • jesserockz
  • frenck

🪧 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot] avatar Apr 04 '25 16:04 coderabbitai[bot]

@bdraco The component was merged but not the docs. Thanks!

swoboda1337 avatar Jul 07 '25 16:07 swoboda1337

I was too tired to double check it again last night. I have it on my list for later today

bdraco avatar Jul 07 '25 16:07 bdraco

Ok thanks, sounds good

swoboda1337 avatar Jul 07 '25 16:07 swoboda1337

Thanks @swoboda1337

bdraco avatar Jul 08 '25 02:07 bdraco