Add restore_mode to output switch (#3016)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
This commit is contained in:
Joshua Spence 2022-01-10 05:47:00 +11:00 committed by GitHub
parent e4555f6997
commit 15fe049a99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 53 additions and 9 deletions

View file

@ -1,15 +1,28 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import output, switch from esphome.components import output, switch
from esphome.const import CONF_ID, CONF_OUTPUT from esphome.const import CONF_ID, CONF_OUTPUT, CONF_RESTORE_MODE
from .. import output_ns from .. import output_ns
OutputSwitch = output_ns.class_("OutputSwitch", switch.Switch, cg.Component) OutputSwitch = output_ns.class_("OutputSwitch", switch.Switch, cg.Component)
OutputSwitchRestoreMode = output_ns.enum("OutputSwitchRestoreMode")
RESTORE_MODES = {
"RESTORE_DEFAULT_OFF": OutputSwitchRestoreMode.OUTPUT_SWITCH_RESTORE_DEFAULT_OFF,
"RESTORE_DEFAULT_ON": OutputSwitchRestoreMode.OUTPUT_SWITCH_RESTORE_DEFAULT_ON,
"ALWAYS_OFF": OutputSwitchRestoreMode.OUTPUT_SWITCH_ALWAYS_OFF,
"ALWAYS_ON": OutputSwitchRestoreMode.OUTPUT_SWITCH_ALWAYS_ON,
"RESTORE_INVERTED_DEFAULT_OFF": OutputSwitchRestoreMode.OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_OFF,
"RESTORE_INVERTED_DEFAULT_ON": OutputSwitchRestoreMode.OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_ON,
}
CONFIG_SCHEMA = switch.SWITCH_SCHEMA.extend( CONFIG_SCHEMA = switch.SWITCH_SCHEMA.extend(
{ {
cv.GenerateID(): cv.declare_id(OutputSwitch), cv.GenerateID(): cv.declare_id(OutputSwitch),
cv.Required(CONF_OUTPUT): cv.use_id(output.BinaryOutput), cv.Required(CONF_OUTPUT): cv.use_id(output.BinaryOutput),
cv.Optional(CONF_RESTORE_MODE, default="RESTORE_DEFAULT_OFF"): cv.enum(
RESTORE_MODES, upper=True, space="_"
),
} }
).extend(cv.COMPONENT_SCHEMA) ).extend(cv.COMPONENT_SCHEMA)
@ -21,3 +34,5 @@ async def to_code(config):
output_ = await cg.get_variable(config[CONF_OUTPUT]) output_ = await cg.get_variable(config[CONF_OUTPUT])
cg.add(var.set_output(output_)) cg.add(var.set_output(output_))
cg.add(var.set_restore_mode(config[CONF_RESTORE_MODE]))

View file

@ -8,15 +8,32 @@ static const char *const TAG = "output.switch";
void OutputSwitch::dump_config() { LOG_SWITCH("", "Output Switch", this); } void OutputSwitch::dump_config() { LOG_SWITCH("", "Output Switch", this); }
void OutputSwitch::setup() { void OutputSwitch::setup() {
auto restored = this->get_initial_state(); bool initial_state = false;
if (!restored.has_value()) switch (this->restore_mode_) {
return; case OUTPUT_SWITCH_RESTORE_DEFAULT_OFF:
initial_state = this->get_initial_state().value_or(false);
if (*restored) { break;
this->turn_on(); case OUTPUT_SWITCH_RESTORE_DEFAULT_ON:
} else { initial_state = this->get_initial_state().value_or(true);
this->turn_off(); break;
case OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_OFF:
initial_state = !this->get_initial_state().value_or(true);
break;
case OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_ON:
initial_state = !this->get_initial_state().value_or(false);
break;
case OUTPUT_SWITCH_ALWAYS_OFF:
initial_state = false;
break;
case OUTPUT_SWITCH_ALWAYS_ON:
initial_state = true;
break;
} }
if (initial_state)
this->turn_on();
else
this->turn_off();
} }
void OutputSwitch::write_state(bool state) { void OutputSwitch::write_state(bool state) {
if (state) { if (state) {

View file

@ -7,10 +7,21 @@
namespace esphome { namespace esphome {
namespace output { namespace output {
enum OutputSwitchRestoreMode {
OUTPUT_SWITCH_RESTORE_DEFAULT_OFF,
OUTPUT_SWITCH_RESTORE_DEFAULT_ON,
OUTPUT_SWITCH_ALWAYS_OFF,
OUTPUT_SWITCH_ALWAYS_ON,
OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_OFF,
OUTPUT_SWITCH_RESTORE_INVERTED_DEFAULT_ON,
};
class OutputSwitch : public switch_::Switch, public Component { class OutputSwitch : public switch_::Switch, public Component {
public: public:
void set_output(BinaryOutput *output) { output_ = output; } void set_output(BinaryOutput *output) { output_ = output; }
void set_restore_mode(OutputSwitchRestoreMode restore_mode) { restore_mode_ = restore_mode; }
void setup() override; void setup() override;
float get_setup_priority() const override { return setup_priority::HARDWARE - 1.0f; } float get_setup_priority() const override { return setup_priority::HARDWARE - 1.0f; }
void dump_config() override; void dump_config() override;
@ -19,6 +30,7 @@ class OutputSwitch : public switch_::Switch, public Component {
void write_state(bool state) override; void write_state(bool state) override;
output::BinaryOutput *output_; output::BinaryOutput *output_;
OutputSwitchRestoreMode restore_mode_;
}; };
} // namespace output } // namespace output