-
-
Notifications
You must be signed in to change notification settings - Fork 2.3k
Docs/sharp ac climate page #6697
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
sven819
wants to merge
2
commits into
esphome:next
Choose a base branch
from
sven819:docs/sharp-ac-climate-page
base: next
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+134
−0
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| --- | ||
| description: "Instructions for setting up Sharp/Bosch/Buderus/IVT UART climate devices." | ||
| title: "Sharp AC Climate" | ||
| --- | ||
|
|
||
| import Figure from '@components/Figure.astro'; | ||
| import CN13PinoutImg from './images/cn13.png'; | ||
|
|
||
| The `sharp_ac` component allows communication with compatible Sharp/Bosch/Buderus/IVT indoor units over UART. | ||
|
|
||
| The component communicates with the indoor unit over UART and provides control and state reporting. | ||
|
|
||
| ## Hardware Connection | ||
|
|
||
| The indoor unit UART header exposes power and serial communication lines. | ||
|
|
||
| ### CN13 pinout | ||
|
|
||
| <Figure | ||
| src={CN13PinoutImg} | ||
| alt="CN13 wiring diagram" | ||
| caption="CN13 connector wiring" | ||
| layout="constrained" | ||
| /> | ||
|
|
||
| ### Pin mapping (HVAC to ESP) | ||
|
|
||
| | Wire color | HVAC signal | ESP signal | | ||
| | ---------- | ----------- | ---------- | | ||
| | Black | GND | GND | | ||
| | White | RX | TX | | ||
| | Green | TX | RX | | ||
| | Red | 5V | VCC | | ||
|
|
||
| > [!WARNING] | ||
| > Verify connector pinout and voltage levels before connecting. | ||
|
Comment on lines
+35
to
+36
|
||
|
|
||
| This component requires a [UART bus](/components/uart/) configured with: | ||
|
|
||
| - 8 data bits | ||
| - EVEN parity | ||
| - 1 stop bit | ||
| - Baud rate `9600` | ||
|
|
||
| > [!NOTE] | ||
| > Many indoor units use 5V UART levels. If your ESP board is 3.3V-only, use a proper level shifter. | ||
|
|
||
| ## Example configuration | ||
|
|
||
|
|
||
| ```yaml | ||
| logger: | ||
| baud_rate: 0 | ||
|
|
||
| uart: | ||
| id: ac_uart | ||
| tx_pin: GPIO1 | ||
| rx_pin: GPIO3 | ||
| data_bits: 8 | ||
| baud_rate: 9600 | ||
| parity: EVEN | ||
| stop_bits: 1 | ||
|
|
||
| climate: | ||
| - platform: sharp_ac | ||
| id: hvac | ||
| name: "Living Room AC" | ||
| uart_id: ac_uart | ||
| vane: | ||
| horizontal: | ||
| name: "Horizontal Vane" | ||
| vertical: | ||
| name: "Vertical Vane" | ||
| ion_switch: | ||
| name: "Plasmacluster" | ||
| connection_status: | ||
| name: "Connection Status" | ||
| reconnect_button: | ||
| name: "Reconnect" | ||
| ``` | ||
|
|
||
| > [!WARNING] | ||
| > If you are using the [Logger Component](/components/logger#logger), make sure you are not using the same pins, or disable UART | ||
| > logging with: | ||
| > | ||
| > ```yaml | ||
| > logger: | ||
| > baud_rate: 0 | ||
| > ``` | ||
|
|
||
| ## Supported features | ||
|
|
||
| - Target temperature range: `16 °C` to `30 °C` | ||
| - HVAC modes: `OFF`, `COOL`, `HEAT`, `DRY`, `FAN_ONLY` | ||
| - Fan modes: `AUTO`, `LOW`, `MEDIUM`, `HIGH` | ||
| - Presets: `NONE`, `ECO`, `BOOST` | ||
| - Swing modes: `OFF`, `HORIZONTAL`, `VERTICAL`, `BOTH` | ||
| - Current temperature reporting | ||
|
|
||
| ## Configuration variables | ||
|
|
||
| - **uart_id** (*Optional*, [ID](/guides/configuration-types#id)): The UART bus to use. | ||
| - **vane** (*Optional*): Additional vane position controls. | ||
|
|
||
| - **horizontal** (*Optional*): Horizontal vane `select` entity. | ||
|
|
||
| - All options from [Select](/components/select). | ||
|
|
||
| - **vertical** (*Optional*): Vertical vane `select` entity. | ||
|
|
||
| - All options from [Select](/components/select). | ||
|
|
||
| - **ion_switch** (*Optional*): Optional ion/plasmacluster switch entity. | ||
|
|
||
| - All options from [Switch](/components/switch). | ||
|
|
||
| - **connection_status** (*Optional*): Optional connection state text sensor. | ||
|
|
||
| - All options from [Text Sensor](/components/text_sensor). | ||
|
|
||
| - **reconnect_button** (*Optional*): Optional button that restarts the UART session. | ||
|
|
||
| - All options from [Button](/components/button). | ||
|
|
||
| - All other options from [Climate](/components/climate#config-climate). | ||
|
|
||
| ## Notes | ||
|
|
||
| - The integration initializes a connection sequence on boot and continuously polls status updates. | ||
| - `connection_status` reports setup progress (`Connecting (x/8)`) and `Connected` once initialization completes. | ||
|
Comment on lines
+128
to
+129
|
||
| - `reconnect_button` can be used to manually re-trigger the protocol initialization if communication stalls. | ||
|
|
||
| ## See Also | ||
|
|
||
| - [Climate Component](/components/climate/) | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.