2019-04-17 12:06:00 +02:00
|
|
|
import esphome.codegen as cg
|
2019-04-22 21:56:30 +02:00
|
|
|
import esphome.config_validation as cv
|
|
|
|
from esphome import automation
|
|
|
|
from esphome.automation import maybe_simple_id
|
2019-04-17 12:06:00 +02:00
|
|
|
from esphome.components import mqtt
|
2021-03-07 20:03:16 +01:00
|
|
|
from esphome.const import (
|
2021-08-10 03:45:31 +02:00
|
|
|
CONF_DISABLED_BY_DEFAULT,
|
2021-03-07 20:03:16 +01:00
|
|
|
CONF_ID,
|
|
|
|
CONF_INTERNAL,
|
|
|
|
CONF_MQTT_ID,
|
|
|
|
CONF_OSCILLATING,
|
|
|
|
CONF_OSCILLATION_COMMAND_TOPIC,
|
|
|
|
CONF_OSCILLATION_STATE_TOPIC,
|
|
|
|
CONF_SPEED,
|
|
|
|
CONF_SPEED_COMMAND_TOPIC,
|
|
|
|
CONF_SPEED_STATE_TOPIC,
|
|
|
|
CONF_NAME,
|
2021-05-19 06:12:43 +02:00
|
|
|
CONF_ON_TURN_OFF,
|
|
|
|
CONF_ON_TURN_ON,
|
|
|
|
CONF_TRIGGER_ID,
|
2021-08-26 00:25:24 +02:00
|
|
|
CONF_DIRECTION,
|
2021-03-07 20:03:16 +01:00
|
|
|
)
|
2021-05-23 22:10:30 +02:00
|
|
|
from esphome.core import CORE, coroutine_with_priority
|
2018-04-07 01:23:03 +02:00
|
|
|
|
2019-04-17 12:06:00 +02:00
|
|
|
IS_PLATFORM_COMPONENT = True
|
2018-05-20 12:41:52 +02:00
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
fan_ns = cg.esphome_ns.namespace("fan")
|
|
|
|
FanState = fan_ns.class_("FanState", cg.Nameable, cg.Component)
|
|
|
|
MakeFan = cg.Application.struct("MakeFan")
|
2018-11-12 23:30:31 +01:00
|
|
|
|
2021-08-26 00:25:24 +02:00
|
|
|
FanDirection = fan_ns.enum("FanDirection")
|
|
|
|
FAN_DIRECTION_ENUM = {
|
|
|
|
"FORWARD": FanDirection.FAN_DIRECTION_FORWARD,
|
|
|
|
"REVERSE": FanDirection.FAN_DIRECTION_REVERSE,
|
|
|
|
}
|
|
|
|
|
2018-11-12 23:30:31 +01:00
|
|
|
# Actions
|
2021-03-07 20:03:16 +01:00
|
|
|
TurnOnAction = fan_ns.class_("TurnOnAction", automation.Action)
|
|
|
|
TurnOffAction = fan_ns.class_("TurnOffAction", automation.Action)
|
|
|
|
ToggleAction = fan_ns.class_("ToggleAction", automation.Action)
|
2018-11-12 23:30:31 +01:00
|
|
|
|
2021-05-19 06:12:43 +02:00
|
|
|
FanTurnOnTrigger = fan_ns.class_("FanTurnOnTrigger", automation.Trigger.template())
|
|
|
|
FanTurnOffTrigger = fan_ns.class_("FanTurnOffTrigger", automation.Trigger.template())
|
|
|
|
|
2021-08-10 03:45:31 +02:00
|
|
|
FAN_SCHEMA = cv.NAMEABLE_SCHEMA.extend(cv.MQTT_COMMAND_COMPONENT_SCHEMA).extend(
|
2021-03-07 20:03:16 +01:00
|
|
|
{
|
|
|
|
cv.GenerateID(): cv.declare_id(FanState),
|
|
|
|
cv.OnlyWith(CONF_MQTT_ID, "mqtt"): cv.declare_id(mqtt.MQTTFanComponent),
|
|
|
|
cv.Optional(CONF_OSCILLATION_STATE_TOPIC): cv.All(
|
|
|
|
cv.requires_component("mqtt"), cv.publish_topic
|
|
|
|
),
|
|
|
|
cv.Optional(CONF_OSCILLATION_COMMAND_TOPIC): cv.All(
|
|
|
|
cv.requires_component("mqtt"), cv.subscribe_topic
|
|
|
|
),
|
|
|
|
cv.Optional(CONF_SPEED_STATE_TOPIC): cv.All(
|
|
|
|
cv.requires_component("mqtt"), cv.publish_topic
|
|
|
|
),
|
|
|
|
cv.Optional(CONF_SPEED_COMMAND_TOPIC): cv.All(
|
|
|
|
cv.requires_component("mqtt"), cv.subscribe_topic
|
|
|
|
),
|
2021-05-19 06:12:43 +02:00
|
|
|
cv.Optional(CONF_ON_TURN_ON): automation.validate_automation(
|
|
|
|
{
|
|
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(FanTurnOnTrigger),
|
|
|
|
}
|
|
|
|
),
|
|
|
|
cv.Optional(CONF_ON_TURN_OFF): automation.validate_automation(
|
|
|
|
{
|
|
|
|
cv.GenerateID(CONF_TRIGGER_ID): cv.declare_id(FanTurnOffTrigger),
|
|
|
|
}
|
|
|
|
),
|
2021-03-07 20:03:16 +01:00
|
|
|
}
|
|
|
|
)
|
2018-06-02 22:22:20 +02:00
|
|
|
|
2018-06-11 10:01:54 +02:00
|
|
|
|
2021-05-23 22:10:30 +02:00
|
|
|
async def setup_fan_core_(var, config):
|
2019-04-22 21:56:30 +02:00
|
|
|
cg.add(var.set_name(config[CONF_NAME]))
|
2021-08-10 03:45:31 +02:00
|
|
|
cg.add(var.set_disabled_by_default(config[CONF_DISABLED_BY_DEFAULT]))
|
2019-04-17 12:06:00 +02:00
|
|
|
if CONF_INTERNAL in config:
|
|
|
|
cg.add(var.set_internal(config[CONF_INTERNAL]))
|
2018-05-21 17:01:47 +02:00
|
|
|
|
2019-04-17 12:06:00 +02:00
|
|
|
if CONF_MQTT_ID in config:
|
|
|
|
mqtt_ = cg.new_Pvariable(config[CONF_MQTT_ID], var)
|
2021-05-23 22:10:30 +02:00
|
|
|
await mqtt.register_mqtt_component(mqtt_, config)
|
2018-05-21 17:01:47 +02:00
|
|
|
|
2019-04-17 12:06:00 +02:00
|
|
|
if CONF_OSCILLATION_STATE_TOPIC in config:
|
2021-03-07 20:03:16 +01:00
|
|
|
cg.add(
|
|
|
|
mqtt_.set_custom_oscillation_state_topic(
|
|
|
|
config[CONF_OSCILLATION_STATE_TOPIC]
|
|
|
|
)
|
|
|
|
)
|
2019-04-17 12:06:00 +02:00
|
|
|
if CONF_OSCILLATION_COMMAND_TOPIC in config:
|
2021-03-07 20:03:16 +01:00
|
|
|
cg.add(
|
|
|
|
mqtt_.set_custom_oscillation_command_topic(
|
|
|
|
config[CONF_OSCILLATION_COMMAND_TOPIC]
|
|
|
|
)
|
|
|
|
)
|
2019-04-17 12:06:00 +02:00
|
|
|
if CONF_SPEED_STATE_TOPIC in config:
|
|
|
|
cg.add(mqtt_.set_custom_speed_state_topic(config[CONF_SPEED_STATE_TOPIC]))
|
|
|
|
if CONF_SPEED_COMMAND_TOPIC in config:
|
2021-03-07 20:03:16 +01:00
|
|
|
cg.add(
|
|
|
|
mqtt_.set_custom_speed_command_topic(config[CONF_SPEED_COMMAND_TOPIC])
|
|
|
|
)
|
2018-06-11 10:01:54 +02:00
|
|
|
|
2021-05-19 06:12:43 +02:00
|
|
|
for conf in config.get(CONF_ON_TURN_ON, []):
|
|
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
2021-05-23 22:10:30 +02:00
|
|
|
await automation.build_automation(trigger, [], conf)
|
2021-05-19 06:12:43 +02:00
|
|
|
for conf in config.get(CONF_ON_TURN_OFF, []):
|
|
|
|
trigger = cg.new_Pvariable(conf[CONF_TRIGGER_ID], var)
|
2021-05-23 22:10:30 +02:00
|
|
|
await automation.build_automation(trigger, [], conf)
|
2021-05-19 06:12:43 +02:00
|
|
|
|
2018-05-20 12:41:52 +02:00
|
|
|
|
2021-05-23 22:10:30 +02:00
|
|
|
async def register_fan(var, config):
|
2019-04-17 12:06:00 +02:00
|
|
|
if not CORE.has_id(config[CONF_ID]):
|
|
|
|
var = cg.Pvariable(config[CONF_ID], var)
|
|
|
|
cg.add(cg.App.register_fan(var))
|
2021-05-23 22:10:30 +02:00
|
|
|
await cg.register_component(var, config)
|
|
|
|
await setup_fan_core_(var, config)
|
2018-05-20 12:41:52 +02:00
|
|
|
|
2018-04-18 18:43:13 +02:00
|
|
|
|
2021-05-23 22:10:30 +02:00
|
|
|
async def create_fan_state(config):
|
2019-04-22 21:56:30 +02:00
|
|
|
var = cg.new_Pvariable(config[CONF_ID])
|
2021-05-23 22:10:30 +02:00
|
|
|
await register_fan(var, config)
|
|
|
|
return var
|
2018-04-18 18:43:13 +02:00
|
|
|
|
2018-10-16 23:16:06 +02:00
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
FAN_ACTION_SCHEMA = maybe_simple_id(
|
|
|
|
{
|
|
|
|
cv.Required(CONF_ID): cv.use_id(FanState),
|
|
|
|
}
|
|
|
|
)
|
2018-10-16 23:16:06 +02:00
|
|
|
|
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
@automation.register_action("fan.toggle", ToggleAction, FAN_ACTION_SCHEMA)
|
2021-05-23 22:10:30 +02:00
|
|
|
async def fan_toggle_to_code(config, action_id, template_arg, args):
|
|
|
|
paren = await cg.get_variable(config[CONF_ID])
|
|
|
|
return cg.new_Pvariable(action_id, template_arg, paren)
|
2018-10-16 23:16:06 +02:00
|
|
|
|
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
@automation.register_action("fan.turn_off", TurnOffAction, FAN_ACTION_SCHEMA)
|
2021-05-23 22:10:30 +02:00
|
|
|
async def fan_turn_off_to_code(config, action_id, template_arg, args):
|
|
|
|
paren = await cg.get_variable(config[CONF_ID])
|
|
|
|
return cg.new_Pvariable(action_id, template_arg, paren)
|
2018-10-16 23:16:06 +02:00
|
|
|
|
|
|
|
|
2021-03-07 20:03:16 +01:00
|
|
|
@automation.register_action(
|
|
|
|
"fan.turn_on",
|
|
|
|
TurnOnAction,
|
|
|
|
maybe_simple_id(
|
|
|
|
{
|
|
|
|
cv.Required(CONF_ID): cv.use_id(FanState),
|
|
|
|
cv.Optional(CONF_OSCILLATING): cv.templatable(cv.boolean),
|
2021-03-17 14:40:02 +01:00
|
|
|
cv.Optional(CONF_SPEED): cv.templatable(cv.int_range(1)),
|
2021-08-26 00:25:24 +02:00
|
|
|
cv.Optional(CONF_DIRECTION): cv.templatable(
|
|
|
|
cv.enum(FAN_DIRECTION_ENUM, upper=True)
|
|
|
|
),
|
2021-03-07 20:03:16 +01:00
|
|
|
}
|
|
|
|
),
|
|
|
|
)
|
2021-05-23 22:10:30 +02:00
|
|
|
async def fan_turn_on_to_code(config, action_id, template_arg, args):
|
|
|
|
paren = await cg.get_variable(config[CONF_ID])
|
2019-04-22 21:56:30 +02:00
|
|
|
var = cg.new_Pvariable(action_id, template_arg, paren)
|
2018-10-16 23:16:06 +02:00
|
|
|
if CONF_OSCILLATING in config:
|
2021-05-23 22:10:30 +02:00
|
|
|
template_ = await cg.templatable(config[CONF_OSCILLATING], args, bool)
|
2019-04-22 21:56:30 +02:00
|
|
|
cg.add(var.set_oscillating(template_))
|
2018-10-16 23:16:06 +02:00
|
|
|
if CONF_SPEED in config:
|
2021-05-23 22:10:30 +02:00
|
|
|
template_ = await cg.templatable(config[CONF_SPEED], args, int)
|
2019-04-22 21:56:30 +02:00
|
|
|
cg.add(var.set_speed(template_))
|
2021-08-26 00:25:24 +02:00
|
|
|
if CONF_DIRECTION in config:
|
|
|
|
template_ = await cg.templatable(config[CONF_DIRECTION], args, FanDirection)
|
|
|
|
cg.add(var.set_direction(template_))
|
2021-05-23 22:10:30 +02:00
|
|
|
return var
|
2019-04-17 12:06:00 +02:00
|
|
|
|
|
|
|
|
2019-04-24 23:49:02 +02:00
|
|
|
@coroutine_with_priority(100.0)
|
2021-05-23 22:10:30 +02:00
|
|
|
async def to_code(config):
|
2021-03-07 20:03:16 +01:00
|
|
|
cg.add_define("USE_FAN")
|
2019-04-17 12:06:00 +02:00
|
|
|
cg.add_global(fan_ns.using)
|