Skip to content

Conversation

@zigboi
Copy link

@zigboi zigboi commented Dec 21, 2025

pending acceptance of the esphome code change

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 /components/_index.md 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 /static/images/ folder of this repository.

  4. Use the image in your component's index table entry in /components/_index.md.

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

@esphomebot generate image dht22

@esphome esphome bot added the current label Dec 21, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 21, 2025

Walkthrough

Documentation update for the Mitsubishi climate_ir component. Added description of a new optional fahrenheit_compatibility boolean configuration option that ensures temperatures sent via Home Assistant match the handheld IR remote behavior when the UI displays Fahrenheit. Defaults to false.

Changes

Cohort / File(s) Summary
Documentation update
content/components/climate/climate_ir.md
Added documentation for new optional fahrenheit_compatibility boolean configuration option under Mitsubishi climate_ir section. Describes behavior for Fahrenheit temperature display compatibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Single documentation file with straightforward content addition
  • No code logic changes to validate
  • Configuration option behavior is clearly described

Suggested labels

current

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: documenting the fahrenheit_compatibility option for Mitsubishi climate IR, which matches the changeset summary.
Description check ✅ Passed The description is related to the changeset, noting it's pending acceptance of an ESPHome code change and references the documentation addition, though it uses placeholder text for issue/PR links.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

@netlify
Copy link

netlify bot commented Dec 21, 2025

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 2555806
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69485795ed7b520008ec4a2f
😎 Deploy Preview https://deploy-preview-5809--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.

Copy link
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: 0

🧹 Nitpick comments (2)
content/components/climate/climate_ir.md (2)

217-217: Fix formatting: double space before "Defaults".

Line 217 has two consecutive spaces before "Defaults to false."

-- **fahrenheit_compatibility** (*Optional*, boolean): Enable this setting if Home Assistant is displaying temperatures in Fahrenheit, so that temperatures set through Home Assistant are sent to the unit the same way as temperatures set on the handheld IR remote.  Defaults to `false`.
+- **fahrenheit_compatibility** (*Optional*, boolean): Enable this setting if Home Assistant is displaying temperatures in Fahrenheit, so that temperatures set through Home Assistant are sent to the unit the same way as temperatures set on the handheld IR remote. Defaults to `false`.

217-217: Consider aligning naming with similar options in other platforms for consistency.

Other platforms use use_fahrenheit (e.g., daikin_brc at line 107, midea_ir at line 183, whynter at line 297), while this uses fahrenheit_compatibility. The naming difference may be intentional given the distinct behavior (Home Assistant display synchronization vs. unit display), but verify against the corresponding code PR that this naming choice aligns with implementation expectations.

📜 Review details

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0093aa6 and 2555806.

📒 Files selected for processing (1)
  • content/components/climate/climate_ir.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**

⚙️ CodeRabbit configuration file

  • Do not generate or add any sequence diagrams

Files:

  • content/components/climate/climate_ir.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Build
🔇 Additional comments (1)
content/components/climate/climate_ir.md (1)

217-217: Documentation placement and format are correct.

The new option is properly placed in the Mitsubishi section, follows the established documentation format, and the description clearly explains the purpose and default behavior.

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