RMT documentation clarification and refactoring #4080
Conversation
- declutter the TOC by removing the undistinguishable actions - change `switch` in examples to `button` (at the time this doc was originally created `button` didn't exist yet) - move the **Setting up** guides above the actions list - remove the IRRemoteESP8266 seealso link as it's not currently supported in any way
|
Warning Rate limit exceeded@nagyrobi has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 54 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe recent updates to the ESPHome documentation enhance clarity and usability for the remote transmitter and receiver components. Key improvements include refined references to transmitter descriptions, expanded keywords for searchability, and detailed setup instructions for infrared (IR) and radio frequency (RF) devices with YAML examples. New sections on RC Switch Protocol settings also provide practical guidance for optimizing device recognition, ensuring users can effectively implement these functionalities. Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
…ome/esphome-docs into remote_transmitter_refactor
nagyrobi
changed the title
remote_transmitter documentation clarification and refactoring
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
…ome/esphome-docs into remote_transmitter_refactor
![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
Outside diff range, codebase verification and nitpick comments (23)
guides/setting_up_rmt_devices.rst (12)
18-19: Add a note about specifying the correct GPIO pin.It's important to specify the correct GPIO pin to avoid conflicts with other components.
+ .. note:: + Ensure that the GPIO pin specified does not conflict with other components or functionalities on your ESP board.
14-16: Add a note about using a current-limiting resistor with IR LEDs.When using an IR LED, it's often necessary to use a current-limiting resistor to prevent damage to the LED.
+ .. note:: + When using an IR LED, consider adding a current-limiting resistor to prevent damage to the LED.
94-95: Add a note about specifying the correct GPIO pin.It's important to specify the correct GPIO pin to avoid conflicts with other components.
+ .. note:: + Ensure that the GPIO pin specified does not conflict with other components or functionalities on your ESP board.
89-92: Add a note about potential interference issues with RF signals.RF signals can be susceptible to interference from other devices or environmental factors.
+ .. note:: + Be aware that RF signals can be susceptible to interference from other devices or environmental factors. Consider testing in different locations to ensure reliable signal transmission.
21-26: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
remote_receiver: pin: GPIOXX # Specify the GPIO pin connected to the IR receiver dump: all # Dump all received codes to the log
50-55: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
remote_transmitter: pin: GPIOXX # Specify the GPIO pin connected to the IR transmitter carrier_duty_percent: 50% # Set the carrier duty cycle to 50% for IR signals
62-69: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
button: - platform: template name: Panasonic Power Button # Name of the button in the frontend on_press: - remote_transmitter.transmit_panasonic: address: 0x4004 # Address of the Panasonic device command: 0x8140DFA2 # Command to send
70-79: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
button: - platform: template name: Raw Code Power Button # Name of the button in the frontend on_press: - remote_transmitter.transmit_raw: carrier_frequency: 38kHz # Set the carrier frequency for IR signals code: [4088, -1542, 1019, -510, 513, -1019, 510, -509, 511, -510, 1020, -1020, 1022, -1019, 510, -509, 511, -510, 511, -509, 511, -510, 1020, -1019, 510, -511, 1020, -510, 512, -508, 510, -1020, 1022] # Raw IR code to send
98-105: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
remote_receiver: pin: GPIOXX # Specify the GPIO pin connected to the RF receiver dump: all # Dump all received codes to the log tolerance: 50% # Set the tolerance for signal recognition filter: 250us # Set the filter duration for signal recognition idle: 4ms # Set the idle duration for signal recognition buffer_size: 2kb # Set the buffer size (only for ESP8266)
145-148: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
remote_transmitter: pin: GPIOXX # Specify the GPIO pin connected to the RF transmitter carrier_duty_percent: 100% # Set the carrier duty cycle to 100% for RF signals
155-165: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
button: - platform: template name: RF Power Button # Name of the button in the frontend optimistic: true # Set the button state to optimistic on_press: - remote_transmitter.transmit_rc_switch_raw: code: '100010000000000010111110' # RF code to send protocol: 2 # Protocol to use for RF transmission repeat: times: 10 # Number of times to repeat the code wait_time: 0s # Time to wait between repeats
170-176: Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
button: - platform: template name: Raw Code Power Button # Name of the button in the frontend on_press: - remote_transmitter.transmit_raw: code: [4088, -1542, 1019, -510, 513, -1019, 510, -509, 511, -510, 1020, -1020, 1022, -1019, 510, -509, 511, -510, 511, -509, 511, -510, 1020, -1019, 510, -511, 1020, -510, 512, -508, 510, -1020, 1022] # Raw RF code to sendcomponents/remote_transmitter.rst (11)
5-7: Add a note about specifying the correct GPIO pin.It's important to specify the correct GPIO pin to avoid conflicts with other components.
+ .. note:: + Ensure that the GPIO pin specified does not conflict with other components or functionalities on your ESP board.
Line range hint
89-92:
Add a note about potential interference issues with RF signals.RF signals can be susceptible to interference from other devices or environmental factors.
+ .. note:: + Be aware that RF signals can be susceptible to interference from other devices or environmental factors. Consider testing in different locations to ensure reliable signal transmission.
Line range hint
85-125:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_abbwelcome: source_address: 0x1001 # Source address of the indoor station destination_address: 0x4001 # Destination address of the door three_byte_address: false # Address length of the system message_type: 0x0d # Message type for unlocking the door data: [0xab, 0xcd, 0xef] # Message data
Line range hint
135-152:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_aeha: address: 0x1FEF # Address to send the command to data: [0x1F, 0x3E, 0x06, 0x5F] # Command data
Line range hint
158-173:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_byronsx: address: '0x4f' # Address to send the command to command: '0x2' # Command to send
Line range hint
177-203:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_canalsat: device: 0x25 # Device to send the command to address: 0x00 # Address (or subdevice) to send the command to command: 0x02 # Command to send
Line range hint
229-244:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_coolix: first: 0xB23FE4 # First 24-bit Coolix code to send second: 0xB23FE4 # Second 24-bit Coolix code to send (optional)
Line range hint
248-269:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_dish: address: 1 # Number of the receiver to target command: 16 # Command to send
Line range hint
269-292:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_dooya: id: 0x001612E5 # 24-bit ID to send channel: 142 # 8-bit channel to send button: 12 # 4-bit button to send check: 3 # 4-bit check to send
Line range hint
292-313:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_drayton: address: '0x6180' # 16-bit ID to send channel: '0x12' # Switch/channel to send command: '0x02' # Command to send
Line range hint
313-326:
Add comments to the YAML examples for better clarity.Adding comments to the YAML examples can help users understand the purpose of each configuration line.
on_...: - remote_transmitter.transmit_jvc: data: 0x1234 # JVC code to send
nagyrobi
changed the title
remote_transmitter documentation clarification and refactoring
Description:
repeatoptions applicable to all the actions is templatable,wait_timeis in µs (not the usual ms!) when lambda is usedswitchin examples tobuttonas it's more appropriate for this kind of usage (at the time this doc was originally createdbuttondidn't exist yet)buffer_size: 2kbin the example that this should only be used on ESP8266 (ESP32 defaults to 10kb, this would be counterproductive).Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable): esphome/esphome#
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
/index.rstwhen creating new documents for new components or cookbook.