Add raw timings example to remote_transmitter #5070
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
""" WalkthroughThe documentation for the Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
components/remote_transmitter.rst (2)
1071-1071: Grammar – use “a signal” instead of “an signal”.-- ``.transmit()``: Transmit an signal using the remote transmitter. +- ``.transmit()``: Transmit a signal using the remote transmitter.
1075-1083: Example tweaks for consistency & clarity.
- Variable naming – earlier examples use
my_transmitter; switching toremote_transmitter_idmay confuse newcomers.- Consider an inline comment that the values are micro-seconds and the sign indicates level (positive = HIGH, negative = LOW).
set_send_wait(2000)is a 2 ms gap; most remotes repeat after 10 ms-20 ms. A 10 000 µs value would better mirror previous YAML examples.- auto call = id(remote_transmitter_id).transmit(); + auto call = id(my_transmitter).transmit(); // replace with your transmitter ID @@ - call.set_send_wait(2000); + // wait time in micro-seconds; 10 000 µs (=10 ms) is common + call.set_send_wait(10'000);
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
components/remote_transmitter.rst(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
⚙️ Source: CodeRabbit Configuration File
List of files the instruction was applied to:
components/remote_transmitter.rst
🧠 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.
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (1)
components/remote_transmitter.rst (1)
1068-1069: Clarification looks good.Replacing “IR code” with the more generic signal makes the sentence accurate for RF users as well.
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
|
Base branch is correct. This is a improvements in the current documentation and is not for a new component or feature. |
esphome
bot
dismissed stale reviews from github-actions[bot], github-actions[bot], github-actions[bot], and github-actions[bot]
Stale
|
@jesserockz Can I ask for a review here too? This does not touch on the |
![esphome[bot]](https://avatars.githubusercontent.com/in/247347?s=60&v=4){kind=small}
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
There was a problem hiding this comment.
As this is a feature matched with a PR in https://github.com/esphome/esphome, please target your PR to the next branch and rebase.
esphome
bot
dismissed
their stale review
Base branch has been corrected - dismissing previous review.
esphome
bot
dismissed
their stale review
Base branch has been corrected - dismissing previous review.
Description:
I had trouble sending a clean signal from Lambda and ChatGPT didn't generate a correct example, so I propose adding an example to the documentation. I saw that others had the same problem
https://github.com/esphome/esphome/pull/6300#issuecomment-2985847956Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause 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.rstwhen creating new documents for new components or cookbook.