mirror of
https://github.com/geoffdavis/esphome-mitsubishiheatpump
synced 2024-08-30 18:12:13 +00:00
Make this component work as a climate platform
I didn't understand initially how this was meant to be done. It makes sense in hindsight.
This commit is contained in:
Simon Knopp
parent
cad0aee55e
commit
cc4022babb
51
README.md
51
README.md
@ -69,14 +69,15 @@ external_components:
|
||||
Add a `mitsubishi_heatpump` to your ESPHome config:
|
||||
|
||||
```yaml
|
||||
mitsubishi_heatpump:
|
||||
name: "My Heat Pump"
|
||||
climate:
|
||||
- platform: mitsubishi_heatpump
|
||||
name: "My Heat Pump"
|
||||
|
||||
# Optional
|
||||
hardware_uart: UART0
|
||||
# Optional
|
||||
hardware_uart: UART0
|
||||
|
||||
# Optional
|
||||
update_period: 500ms
|
||||
# Optional
|
||||
update_period: 500ms
|
||||
```
|
||||
|
||||
On ESP8266 you'll need to disable logging to serial because it conflicts with
|
||||
@ -171,13 +172,14 @@ sensor:
|
||||
external_components:
|
||||
- source: github://geoffdavis/esphome-mitsubishiheatpump
|
||||
|
||||
mitsubishi_heatpump:
|
||||
name: "Den Heat Pump"
|
||||
climate:
|
||||
- platform: mitsubishi_heatpump
|
||||
name: "Den Heat Pump"
|
||||
|
||||
# ESP32 only - change UART0 to UART1 or UART2 and remove the
|
||||
# logging:baud_rate above to allow the built-in UART0 to function for
|
||||
# logging.
|
||||
hardware_uart: UART0
|
||||
# ESP32 only - change UART0 to UART1 or UART2 and remove the
|
||||
# logging:baud_rate above to allow the built-in UART0 to function for
|
||||
# logging.
|
||||
hardware_uart: UART0
|
||||
```
|
||||
|
||||
# Advanced
|
||||
@ -187,18 +189,19 @@ possible modes of operation. You can configure pretty much everything in YAML
|
||||
to match what your hardware supports. For example:
|
||||
|
||||
```yaml
|
||||
mitsubishi_heatpump:
|
||||
name: "My heat pump"
|
||||
hardware_uart: UART2
|
||||
baud_rate: 9600
|
||||
supports:
|
||||
mode: [AUTO, COOL, HEAT, FAN_ONLY]
|
||||
fan_mode: [AUTO, LOW, MEDIUM, HIGH]
|
||||
swing_mode: [OFF, VERTICAL]
|
||||
visual:
|
||||
min_temperature: 16
|
||||
max_temperature: 31
|
||||
temperature_step: 1.0
|
||||
climate:
|
||||
- platform: mitsubishi_heatpump
|
||||
name: "My heat pump"
|
||||
hardware_uart: UART2
|
||||
baud_rate: 9600
|
||||
supports:
|
||||
mode: [AUTO, COOL, HEAT, FAN_ONLY]
|
||||
fan_mode: [AUTO, LOW, MEDIUM, HIGH]
|
||||
swing_mode: [OFF, VERTICAL]
|
||||
visual:
|
||||
min_temperature: 16
|
||||
max_temperature: 31
|
||||
temperature_step: 1.0
|
||||
```
|
||||
|
||||
# See Also
|
||||
|
||||
@ -1,88 +0,0 @@
|
||||
import esphome.codegen as cg
|
||||
import esphome.config_validation as cv
|
||||
from esphome.components import climate
|
||||
from esphome.components.logger import HARDWARE_UART_TO_SERIAL
|
||||
from esphome.const import (
|
||||
CONF_ID,
|
||||
CONF_HARDWARE_UART,
|
||||
CONF_BAUD_RATE,
|
||||
CONF_UPDATE_INTERVAL,
|
||||
CONF_MODE,
|
||||
CONF_FAN_MODE,
|
||||
CONF_SWING_MODE,
|
||||
)
|
||||
from esphome.core import CORE, coroutine
|
||||
|
||||
AUTO_LOAD = ["climate"]
|
||||
|
||||
CONF_SUPPORTS = "supports"
|
||||
DEFAULT_CLIMATE_MODES = ['AUTO', 'COOL', 'HEAT', 'DRY', 'FAN_ONLY']
|
||||
DEFAULT_FAN_MODES = ['AUTO', 'DIFFUSE', 'LOW', 'MEDIUM', 'MIDDLE', 'HIGH']
|
||||
DEFAULT_SWING_MODES = ['OFF', 'VERTICAL']
|
||||
|
||||
MitsubishiHeatPump = cg.global_ns.class_("MitsubishiHeatPump", climate.Climate, cg.PollingComponent)
|
||||
|
||||
|
||||
def valid_uart(uart):
|
||||
if CORE.is_esp8266:
|
||||
uarts = ["UART0"] # UART1 is tx-only
|
||||
elif CORE.is_esp32:
|
||||
uarts = ["UART0", "UART1", "UART2"]
|
||||
else:
|
||||
raise NotImplementedError
|
||||
|
||||
return cv.one_of(*uarts, upper=True)(uart)
|
||||
|
||||
|
||||
CONFIG_SCHEMA = climate.CLIMATE_SCHEMA.extend(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(MitsubishiHeatPump),
|
||||
cv.Optional(CONF_HARDWARE_UART, default="UART0"): valid_uart,
|
||||
cv.Optional(CONF_BAUD_RATE): cv.positive_int,
|
||||
|
||||
# If polling interval is greater than 9 seconds, the HeatPump library
|
||||
# reconnects, but doesn't then follow up with our data request.
|
||||
cv.Optional(CONF_UPDATE_INTERVAL, default="500ms"): cv.All(
|
||||
cv.update_interval,
|
||||
cv.Range(max=cv.TimePeriod(milliseconds=9000))
|
||||
),
|
||||
|
||||
# Optionally override the supported ClimateTraits.
|
||||
cv.Optional(CONF_SUPPORTS, default={}): cv.Schema(
|
||||
{
|
||||
cv.Optional(CONF_MODE, default=DEFAULT_CLIMATE_MODES):
|
||||
cv.ensure_list(climate.validate_climate_mode),
|
||||
cv.Optional(CONF_FAN_MODE, default=DEFAULT_FAN_MODES):
|
||||
cv.ensure_list(climate.validate_climate_fan_mode),
|
||||
cv.Optional(CONF_SWING_MODE, default=DEFAULT_SWING_MODES):
|
||||
cv.ensure_list(climate.validate_climate_swing_mode),
|
||||
}
|
||||
),
|
||||
}
|
||||
).extend(cv.COMPONENT_SCHEMA)
|
||||
|
||||
|
||||
@coroutine
|
||||
def to_code(config):
|
||||
serial = HARDWARE_UART_TO_SERIAL[config[CONF_HARDWARE_UART]]
|
||||
var = cg.new_Pvariable(config[CONF_ID], cg.RawExpression(f'&{serial}'))
|
||||
|
||||
if CONF_BAUD_RATE in config:
|
||||
cg.add(var.set_baud_rate(config[CONF_BAUD_RATE]))
|
||||
|
||||
traits = []
|
||||
for mode in config[CONF_SUPPORTS][CONF_MODE]:
|
||||
if mode == 'OFF':
|
||||
continue
|
||||
traits.append(f'set_supports_{mode.lower()}_mode')
|
||||
for mode in config[CONF_SUPPORTS][CONF_FAN_MODE]:
|
||||
traits.append(f'set_supports_fan_mode_{mode.lower()}')
|
||||
for mode in config[CONF_SUPPORTS][CONF_SWING_MODE]:
|
||||
traits.append(f'set_supports_swing_mode_{mode.lower()}')
|
||||
for trait in traits:
|
||||
cg.add(getattr(var.config_traits(), trait)(True))
|
||||
|
||||
yield cg.register_component(var, config)
|
||||
yield climate.register_climate(var, config)
|
||||
cg.add_library("https://github.com/SwiCago/HeatPump", None)
|
||||
|
||||
88
components/mitsubishi_heatpump/climate.py
Normal file
88
components/mitsubishi_heatpump/climate.py
Normal file
@ -0,0 +1,88 @@
|
||||
import esphome.codegen as cg
|
||||
import esphome.config_validation as cv
|
||||
from esphome.components import climate
|
||||
from esphome.components.logger import HARDWARE_UART_TO_SERIAL
|
||||
from esphome.const import (
|
||||
CONF_ID,
|
||||
CONF_HARDWARE_UART,
|
||||
CONF_BAUD_RATE,
|
||||
CONF_UPDATE_INTERVAL,
|
||||
CONF_MODE,
|
||||
CONF_FAN_MODE,
|
||||
CONF_SWING_MODE,
|
||||
)
|
||||
from esphome.core import CORE, coroutine
|
||||
|
||||
AUTO_LOAD = ["climate"]
|
||||
|
||||
CONF_SUPPORTS = "supports"
|
||||
DEFAULT_CLIMATE_MODES = ['AUTO', 'COOL', 'HEAT', 'DRY', 'FAN_ONLY']
|
||||
DEFAULT_FAN_MODES = ['AUTO', 'DIFFUSE', 'LOW', 'MEDIUM', 'MIDDLE', 'HIGH']
|
||||
DEFAULT_SWING_MODES = ['OFF', 'VERTICAL']
|
||||
|
||||
MitsubishiHeatPump = cg.global_ns.class_("MitsubishiHeatPump", climate.Climate, cg.PollingComponent)
|
||||
|
||||
|
||||
def valid_uart(uart):
|
||||
if CORE.is_esp8266:
|
||||
uarts = ["UART0"] # UART1 is tx-only
|
||||
elif CORE.is_esp32:
|
||||
uarts = ["UART0", "UART1", "UART2"]
|
||||
else:
|
||||
raise NotImplementedError
|
||||
|
||||
return cv.one_of(*uarts, upper=True)(uart)
|
||||
|
||||
|
||||
CONFIG_SCHEMA = climate.CLIMATE_SCHEMA.extend(
|
||||
{
|
||||
cv.GenerateID(): cv.declare_id(MitsubishiHeatPump),
|
||||
cv.Optional(CONF_HARDWARE_UART, default="UART0"): valid_uart,
|
||||
cv.Optional(CONF_BAUD_RATE): cv.positive_int,
|
||||
|
||||
# If polling interval is greater than 9 seconds, the HeatPump library
|
||||
# reconnects, but doesn't then follow up with our data request.
|
||||
cv.Optional(CONF_UPDATE_INTERVAL, default="500ms"): cv.All(
|
||||
cv.update_interval,
|
||||
cv.Range(max=cv.TimePeriod(milliseconds=9000))
|
||||
),
|
||||
|
||||
# Optionally override the supported ClimateTraits.
|
||||
cv.Optional(CONF_SUPPORTS, default={}): cv.Schema(
|
||||
{
|
||||
cv.Optional(CONF_MODE, default=DEFAULT_CLIMATE_MODES):
|
||||
cv.ensure_list(climate.validate_climate_mode),
|
||||
cv.Optional(CONF_FAN_MODE, default=DEFAULT_FAN_MODES):
|
||||
cv.ensure_list(climate.validate_climate_fan_mode),
|
||||
cv.Optional(CONF_SWING_MODE, default=DEFAULT_SWING_MODES):
|
||||
cv.ensure_list(climate.validate_climate_swing_mode),
|
||||
}
|
||||
),
|
||||
}
|
||||
).extend(cv.COMPONENT_SCHEMA)
|
||||
|
||||
|
||||
@coroutine
|
||||
def to_code(config):
|
||||
serial = HARDWARE_UART_TO_SERIAL[config[CONF_HARDWARE_UART]]
|
||||
var = cg.new_Pvariable(config[CONF_ID], cg.RawExpression(f'&{serial}'))
|
||||
|
||||
if CONF_BAUD_RATE in config:
|
||||
cg.add(var.set_baud_rate(config[CONF_BAUD_RATE]))
|
||||
|
||||
traits = []
|
||||
for mode in config[CONF_SUPPORTS][CONF_MODE]:
|
||||
if mode == 'OFF':
|
||||
continue
|
||||
traits.append(f'set_supports_{mode.lower()}_mode')
|
||||
for mode in config[CONF_SUPPORTS][CONF_FAN_MODE]:
|
||||
traits.append(f'set_supports_fan_mode_{mode.lower()}')
|
||||
for mode in config[CONF_SUPPORTS][CONF_SWING_MODE]:
|
||||
traits.append(f'set_supports_swing_mode_{mode.lower()}')
|
||||
for trait in traits:
|
||||
cg.add(getattr(var.config_traits(), trait)(True))
|
||||
|
||||
yield cg.register_component(var, config)
|
||||
yield climate.register_climate(var, config)
|
||||
cg.add_library("https://github.com/SwiCago/HeatPump", None)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user