From 9cc1c4e081a9c4f6bed85f9a44802e121eadffcc Mon Sep 17 00:00:00 2001 From: Geoff Davis Date: Wed, 11 Mar 2020 16:54:51 -0700 Subject: [PATCH] Even more doc tweaks. --- README.md | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 86878d3..7635f24 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,7 @@ # esphome-mitsubishiheatpump -ESPHome Climate Component for Mitsubishi Heatpumps using direct serial connection -Wirelessly control your Mitsubishi Comfort HeatPump with an ESP8266 or ESP32 -using the [ESPHome](https://esphome.io) framework. +Wirelessly control your Mitsubishi Comfort HVAC equipment with an ESP8266 or +ESP32 using the [ESPHome](https://esphome.io) framework. ## Features * 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 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) 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). 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 to the control 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 -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: * `esphome: libraries: [https://github.com/geoffdavis/HeatPump#init_fix]` * `esphome: includes: [src/esphome-mitsubishiheatpump]` @@ -100,6 +91,14 @@ climate: - 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 Below is an example configuration which will include wireless strength