Skip to content

[mitsubishi_cn105] Add documentation for Mitsubishi CN105 climate component#6313

Open
crnjan wants to merge 2 commits intoesphome:nextfrom
crnjan:feature/mitsubishi_cn105
Open

[mitsubishi_cn105] Add documentation for Mitsubishi CN105 climate component#6313
crnjan wants to merge 2 commits intoesphome:nextfrom
crnjan:feature/mitsubishi_cn105

Conversation

@crnjan
Copy link

@crnjan crnjan commented Mar 20, 2026

Description

Adds documentation for the Mitsubishi CN105 climate platform.

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

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.

esphome[bot]
esphome bot previously requested changes Mar 20, 2026
Copy link

@esphome esphome bot left a comment

Choose a reason for hiding this comment

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

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 esphome bot marked this pull request as draft March 20, 2026 16:40
@esphome
Copy link

esphome bot commented Mar 20, 2026

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 20, 2026

Walkthrough

Added comprehensive documentation page for the Mitsubishi CN105 climate component, including hardware communication details, wiring instructions, pinout diagram, YAML configuration examples, and supported features. Updated the documentation component index to reference the new page.

Changes

Cohort / File(s) Summary
Mitsubishi CN105 Documentation
src/content/docs/components/climate/mitsubishi_cn105.mdx
New documentation page covering overview, UART hardware configuration, CN105 pinout with wiring diagrams, YAML configuration example, supported features (temperature range, modes, fan speed mappings), and configuration variable reference.
Documentation Index
src/content/docs/components/index.mdx
Added Mitsubishi CN105 climate component entry to the climate components table with associated icon reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested labels

has-parent, next

Suggested reviewers

  • jesserockz
  • nagyrobi
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding documentation for the Mitsubishi CN105 climate component, which matches the changeset exactly.
Description check ✅ Passed The description is directly related to the changeset, explaining that documentation for the Mitsubishi CN105 climate platform is being added and referencing the matching esphome PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Tip

You can make CodeRabbit's review stricter and more nitpicky using the `assertive` profile, if that's what you prefer.

Change the reviews.profile setting to assertive to make CodeRabbit's nitpick more issues in your PRs.

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: 1

🧹 Nitpick comments (1)
src/content/docs/components/climate/mitsubishi_cn105.mdx (1)

51-58: Make UART framing fields explicit in the example config.

The prose says 8 data bits and 1 stop bit are required; adding those keys directly to the YAML example avoids ambiguity for copy/paste users.

Suggested tweak
 uart:
   id: ac_uart
   tx_pin: GPIO1
   rx_pin: GPIO3
+  data_bits: 8
   baud_rate: 2400
   parity: EVEN
+  stop_bits: 1
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/components/climate/mitsubishi_cn105.mdx` around lines 51 -
58, The example UART YAML in the Mitsubishi CN105 doc omits framing fields;
update the uart example block (the mapping with id: ac_uart, tx_pin: GPIO1,
rx_pin: GPIO3, baud_rate: 2400, parity: EVEN) to include explicit data_bits: 8
and stop_bits: 1 so the config matches the prose and is unambiguous for
copy/paste users.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@src/content/docs/components/index.mdx`:
- Line 696: The ImgTable row added in the components index uses a relative image
filename ("mitsubishi_electric.png") which violates the ImgTable convention;
update the image reference in the array entry (the row for "Mitsubishi CN105
Climate") to the absolute path under /images/ (e.g., "/images/…") so it points
to the file stored in /public/images/, ensuring the ImgTable entry uses the
absolute image path convention.

---

Nitpick comments:
In `@src/content/docs/components/climate/mitsubishi_cn105.mdx`:
- Around line 51-58: The example UART YAML in the Mitsubishi CN105 doc omits
framing fields; update the uart example block (the mapping with id: ac_uart,
tx_pin: GPIO1, rx_pin: GPIO3, baud_rate: 2400, parity: EVEN) to include explicit
data_bits: 8 and stop_bits: 1 so the config matches the prose and is unambiguous
for copy/paste users.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 19b8d9a1-ca44-49ac-a532-3873ff547297

📥 Commits

Reviewing files that changed from the base of the PR and between 6c89bcd and f6f6bd3.

⛔ Files ignored due to path filters (2)
  • public/images/mitsubishi_electric.png is excluded by !**/*.png
  • src/content/docs/components/climate/images/cn105_wiring.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • src/content/docs/components/climate/mitsubishi_cn105.mdx
  • src/content/docs/components/index.mdx

@netlify
Copy link

netlify bot commented Mar 20, 2026

Deploy Preview for esphome ready!

Name Link
🔨 Latest commit 9ebd564
🔍 Latest deploy log https://app.netlify.com/projects/esphome/deploys/69bd9762c7c8fa0009af11af
😎 Deploy Preview https://deploy-preview-6313--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.

@crnjan crnjan changed the base branch from current to next March 20, 2026 16:49
@esphome esphome bot added the next label Mar 20, 2026
@esphome esphome bot dismissed their stale review March 20, 2026 16:49

Base branch has been corrected - dismissing previous review.

@crnjan crnjan marked this pull request as ready for review March 20, 2026 16:52
@crnjan crnjan force-pushed the feature/mitsubishi_cn105 branch from f6f6bd3 to 4388add Compare March 20, 2026 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant