Skip to content

fix for wrong variable type for remote_receiver::on_pronto#6672

Open
hiFloh wants to merge 1 commit into
esphome:currentfrom
hiFloh:patch-1
Open

fix for wrong variable type for remote_receiver::on_pronto#6672
hiFloh wants to merge 1 commit into
esphome:currentfrom
hiFloh:patch-1

Conversation

@hiFloh
Copy link
Copy Markdown

@hiFloh hiFloh commented May 23, 2026

fix wrong variable type for remote_receiver::on_pronto

Description

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 /src/content/docs/components/index.mdx when creating new documents for new components or cookbook.

New Component Images

If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.

To generate a component image:

  1. Comment on this pull request with the following command, replacing component_name with your component name in lower_case format with underscores (e.g., bme280, sht3x, dallas_temp):

    @esphomebot generate image component_name
    
  2. The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.

  3. Extract the SVG file and place it in the /public/images/ folder of this repository.

  4. Use the image in your component's index table entry in /src/content/docs/components/index.mdx.

Example: For a component called "DHT22 Temperature Sensor", use:

@esphomebot generate image dht22

Note: All images used in ImgTable components must be placed in /public/images/ as the component resolves them to absolute paths.

fix wrong variable type for remote_receiver::on_pronto
@esphome esphome Bot added the current label May 23, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented May 23, 2026

Deploy Preview for esphome ready!

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

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

Review Change Stack

Walkthrough

This pull request updates the remote receiver component documentation. The dump codec entry previously describing Pronto format is replaced with a placeholder label, and the on_pronto automation trigger callback variable type is changed from std::string to remote_base::ProntoData.

Changes

Remote Receiver Pronto Documentation

Layer / File(s) Summary
Remote receiver Pronto documentation updates
src/content/docs/components/remote_receiver.mdx
The dump codec documentation for Pronto format is replaced with a placeholder label and blanked description. The on_pronto trigger callback type documentation is updated from std::string to remote_base::ProntoData.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: fixing the variable type documentation for remote_receiver::on_pronto from std::string to remote_base::ProntoData.
Description check ✅ Passed The description is related to the changeset, confirming it is a fix for wrong variable type documentation in remote_receiver::on_pronto, though it uses template placeholders.
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

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/components/remote_receiver.mdx`:
- Line 61: Replace the broken placeholder entry with the restored "pronto"
dumper documentation: add a dump entry named "pronto" (keyword pronto) and a
short description such as "Print remote code in <format> form. Useful for using
arbitrary protocols." so the docs list the pronto codec name and its description
(look for the dump entries block in remote_receiver.mdx and the placeholder line
containing "****" and replace it with the pronto entry).
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6f390160-ff15-4f26-ae1f-543f1cef6b96

📥 Commits

Reviewing files that changed from the base of the PR and between 87bab78 and 2774cd5.

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

- **panasonic**: Decode and dump Panasonic infrared codes.
- **pioneer**: Decode and dump Pioneer infrared codes.
- **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols.
- ****: Print remote code in form. Useful for using arbitrary protocols.
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.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Restore the pronto dump entry; current placeholder is broken.

Line 61 currently documents an empty codec name and empty description, so users can’t discover or configure the Pronto dumper correctly.

Proposed doc fix
-  - ****: Print remote code in  form. Useful for using arbitrary protocols.
+  - **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- ****: Print remote code in form. Useful for using arbitrary protocols.
- **pronto**: Print remote code in Pronto form. Useful for using arbitrary protocols.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/content/docs/components/remote_receiver.mdx` at line 61, Replace the
broken placeholder entry with the restored "pronto" dumper documentation: add a
dump entry named "pronto" (keyword pronto) and a short description such as
"Print remote code in <format> form. Useful for using arbitrary protocols." so
the docs list the pronto codec name and its description (look for the dump
entries block in remote_receiver.mdx and the placeholder line containing "****"
and replace it with the pronto entry).

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.

1 participant