mirror of
https://github.com/geoffdavis/esphome-mitsubishiheatpump
synced 2024-08-30 18:12:13 +00:00
Even more doc tweaks.
This commit is contained in:
parent
3cdc870b4a
commit
9cc1c4e081
27
README.md
27
README.md
@ -1,8 +1,7 @@
|
|||||||
# esphome-mitsubishiheatpump
|
# esphome-mitsubishiheatpump
|
||||||
ESPHome Climate Component for Mitsubishi Heatpumps using direct serial connection
|
|
||||||
|
|
||||||
Wirelessly control your Mitsubishi Comfort HeatPump with an ESP8266 or ESP32
|
Wirelessly control your Mitsubishi Comfort HVAC equipment with an ESP8266 or
|
||||||
using the [ESPHome](https://esphome.io) framework.
|
ESP32 using the [ESPHome](https://esphome.io) framework.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
* Instant feedback of command changes via RF Remote to HomeAssistant or MQTT.
|
* Instant feedback of command changes via RF Remote to HomeAssistant or MQTT.
|
||||||
@ -26,7 +25,8 @@ work with this library. The [HeatPump
|
|||||||
wiki](https://github.com/SwiCago/HeatPump/wiki/Supported-models) has a more
|
wiki](https://github.com/SwiCago/HeatPump/wiki/Supported-models) has a more
|
||||||
exhaustive list.
|
exhaustive list.
|
||||||
|
|
||||||
The same `CN105` connector is used by the Mitsubishi Kumocloud remotes, which have a
|
The same `CN105` connector is used by the Mitsubishi KumoCloud remotes, which
|
||||||
|
have a
|
||||||
[compatibility list](https://www.mitsubishicomfort.com/kumocloud/compatibility)
|
[compatibility list](https://www.mitsubishicomfort.com/kumocloud/compatibility)
|
||||||
available.
|
available.
|
||||||
|
|
||||||
@ -42,7 +42,7 @@ Build a control circuit with your MCU as detailed in the [SwiCago/HeatPump
|
|||||||
README](https://github.com/SwiCago/HeatPump/blob/master/README.md).
|
README](https://github.com/SwiCago/HeatPump/blob/master/README.md).
|
||||||
You can use either an ESP8266 or an ESP32 for this.
|
You can use either an ESP8266 or an ESP32 for this.
|
||||||
|
|
||||||
Note that several users have reported that they've been able to get away with
|
Note: several users have reported that they've been able to get away with
|
||||||
not using the pull-up resistors, and just [directly connecting a Wemos D1 mini
|
not using the pull-up resistors, and just [directly connecting a Wemos D1 mini
|
||||||
to the control
|
to the control
|
||||||
board](https://github.com/SwiCago/HeatPump/issues/13#issuecomment-457897457)
|
board](https://github.com/SwiCago/HeatPump/issues/13#issuecomment-457897457)
|
||||||
@ -63,15 +63,6 @@ On Hass.IO, you'll want to do something like:
|
|||||||
|
|
||||||
### Step 3: Configure your ESPHome device with YAML
|
### Step 3: Configure your ESPHome device with YAML
|
||||||
|
|
||||||
Note: this component DOES NOT use the ESPHome `uart` component, as it requires
|
|
||||||
direct access to a hardware UART via the Arduino `HardwareSerial` class. The
|
|
||||||
Mitsubishi Heatpump units use an atypical serial port setting ("even parity").
|
|
||||||
Parity bit support is not implemented in any of the existing software serial
|
|
||||||
libraries, including the one in ESPHome.
|
|
||||||
|
|
||||||
There's currently no way to guarantee access to a hardware UART nor retrieve
|
|
||||||
the `HardwareSerial` handle within the ESPHome framework.
|
|
||||||
|
|
||||||
Create an ESPHome YAML configuration with the following sections:
|
Create an ESPHome YAML configuration with the following sections:
|
||||||
* `esphome: libraries: [https://github.com/geoffdavis/HeatPump#init_fix]`
|
* `esphome: libraries: [https://github.com/geoffdavis/HeatPump#init_fix]`
|
||||||
* `esphome: includes: [src/esphome-mitsubishiheatpump]`
|
* `esphome: includes: [src/esphome-mitsubishiheatpump]`
|
||||||
@ -100,6 +91,14 @@ climate:
|
|||||||
- name: "My Heat Pump"
|
- name: "My Heat Pump"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note: this component DOES NOT use the ESPHome `uart` component, as it requires
|
||||||
|
direct access to a hardware UART via the Arduino `HardwareSerial` class. The
|
||||||
|
Mitsubishi Heatpump units use an atypical serial port setting ("even parity").
|
||||||
|
Parity bit support is not implemented in any of the existing software serial
|
||||||
|
libraries, including the one in ESPHome. There's currently no way to guarantee
|
||||||
|
access to a hardware UART nor retrieve the `HardwareSerial` handle from the
|
||||||
|
`uart` component within the ESPHome framework.
|
||||||
|
|
||||||
# Example configuration
|
# Example configuration
|
||||||
|
|
||||||
Below is an example configuration which will include wireless strength
|
Below is an example configuration which will include wireless strength
|
||||||
|
Loading…
Reference in New Issue
Block a user