mirror of
https://github.com/geoffdavis/esphome-mitsubishiheatpump
synced 2024-08-30 18:12:13 +00:00
Update README
This commit is contained in:
parent
b9061043a5
commit
32ff547c7b
33
README.md
33
README.md
@ -13,6 +13,17 @@ Wirelessly control your Mitsubishi Comfort HeatPump with an ESP8266 or ESP32 usi
|
||||
### Build a control circuit as detailed in the SwiCago/HeatPump README.
|
||||
You can use either an ESP8266 or an ESP32.
|
||||
|
||||
### Clone this repository into your ESPHome configuration directory
|
||||
|
||||
This repository needs to live in your ESPHome configuration directory, as it doesn't work correctly when used as a Platform.IO library, and there doesn't seem to be an analog for that functionality for esphome code.
|
||||
|
||||
On Hass.IO, you'll want to do something like:
|
||||
|
||||
* Change directories to your esphome configuration directory.
|
||||
* `mkdir -p src`
|
||||
* `cd src`
|
||||
* `git clone https://github.com/geoffdavis/esphome-mitsubishiheatpump.git`
|
||||
|
||||
### Configure your ESPHome device with YAML
|
||||
|
||||
Note: this component DOES NOT use the ESPHome `uart` component, as it requires
|
||||
@ -26,30 +37,32 @@ the `HardwareSerial` handle within the ESPHome framework.
|
||||
Create an ESPHome YAML configuration with the following sections:
|
||||
* `esphome: libraries:`
|
||||
* `climate:` - set up a custom climate, change the Serial port as needed.
|
||||
* ESP8266 only: `logger: baud\_rate: 0` - disables serial port logging on sole hardware UART
|
||||
* ESP8266 only: `logger: baud\_rate: 0` - disables serial port logging on the
|
||||
sole ESP8266 hardware UART
|
||||
|
||||
```yaml
|
||||
esphome:
|
||||
libraries:
|
||||
#- SwiCago/HeatPump
|
||||
- https://github.com/geoffdavis/HeatPump#init_fix
|
||||
- https://github.com/geoffdavis/esphome-mitsubishiheatpump
|
||||
includes:
|
||||
- src/esphome-mitsubishiheatpump
|
||||
|
||||
# Enable logging
|
||||
logger:
|
||||
# ESP8266 ONLY:
|
||||
# disable serial port logging, as the HeatPump component needs
|
||||
# the sole hardware UART on the ESP8266
|
||||
baud_rate: 0
|
||||
# ESP8266 only - disable serial port logging, as the HeatPump component
|
||||
# needs the sole hardware UART on the ESP8266
|
||||
baud_rate: 0
|
||||
|
||||
climate:
|
||||
- platform: custom
|
||||
# ESP32 only - change &Serial to &Serial1 or &Serial2 and remove the
|
||||
# logging:baud_rate above to allow the built-in UART0 to function for
|
||||
# logging.
|
||||
lambda: |-
|
||||
auto my_heatpump = new MitsubishiHeatPump(&Serial);
|
||||
App.register_component(my_heatpump);
|
||||
return {my_heatpump};
|
||||
|
||||
climates:
|
||||
- name: "My Heat Pump"
|
||||
- name: "Den Mini-Split Heat Pump"
|
||||
```
|
||||
|
||||
Note that you can change the &
|
||||
|
Loading…
Reference in New Issue
Block a user