Add Factory Reset button and switch (#3724)

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

esphome/components/factory_reset/__init__.py

@@ -0,0 +1,5 @@
+import esphome.codegen as cg
+
+CODEOWNERS = ["@anatoly-savchenkov"]
+
+factory_reset_ns = cg.esphome_ns.namespace("factory_reset")

esphome/components/factory_reset/button/__init__.py

@@ -0,0 +1,30 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import button
+from esphome.const import (
+    CONF_ID,
+    DEVICE_CLASS_RESTART,
+    ENTITY_CATEGORY_CONFIG,
+    ICON_RESTART_ALERT,
+)
+from .. import factory_reset_ns
+
+FactoryResetButton = factory_reset_ns.class_(
+    "FactoryResetButton", button.Button, cg.Component
+)
+
+CONFIG_SCHEMA = (
+    button.button_schema(
+        device_class=DEVICE_CLASS_RESTART,
+        entity_category=ENTITY_CATEGORY_CONFIG,
+        icon=ICON_RESTART_ALERT,
+    )
+    .extend({cv.GenerateID(): cv.declare_id(FactoryResetButton)})
+    .extend(cv.COMPONENT_SCHEMA)
+)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await button.register_button(var, config)

esphome/components/factory_reset/button/factory_reset_button.cpp

@@ -0,0 +1,21 @@
+#include "factory_reset_button.h"
+#include "esphome/core/hal.h"
+#include "esphome/core/log.h"
+#include "esphome/core/application.h"
+
+namespace esphome {
+namespace factory_reset {
+
+static const char *const TAG = "factory_reset.button";
+
+void FactoryResetButton::dump_config() { LOG_BUTTON("", "Factory Reset Button", this); }
+void FactoryResetButton::press_action() {
+  ESP_LOGI(TAG, "Resetting to factory defaults...");
+  // Let MQTT settle a bit
+  delay(100);  // NOLINT
+  global_preferences->reset();
+  App.safe_reboot();
+}
+
+}  // namespace factory_reset
+}  // namespace esphome

esphome/components/factory_reset/button/factory_reset_button.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/button/button.h"
+
+namespace esphome {
+namespace factory_reset {
+
+class FactoryResetButton : public button::Button, public Component {
+ public:
+  void dump_config() override;
+
+ protected:
+  void press_action() override;
+};
+
+}  // namespace factory_reset
+}  // namespace esphome

esphome/components/factory_reset/switch/__init__.py

@@ -0,0 +1,35 @@
+import esphome.codegen as cg
+import esphome.config_validation as cv
+from esphome.components import switch
+from esphome.const import (
+    CONF_ENTITY_CATEGORY,
+    CONF_ID,
+    CONF_INVERTED,
+    CONF_ICON,
+    ENTITY_CATEGORY_CONFIG,
+    ICON_RESTART_ALERT,
+)
+from .. import factory_reset_ns
+
+FactoryResetSwitch = factory_reset_ns.class_(
+    "FactoryResetSwitch", switch.Switch, cg.Component
+)
+
+CONFIG_SCHEMA = switch.SWITCH_SCHEMA.extend(
+    {
+        cv.GenerateID(): cv.declare_id(FactoryResetSwitch),
+        cv.Optional(CONF_INVERTED): cv.invalid(
+            "Factory Reset switches do not support inverted mode!"
+        ),
+        cv.Optional(CONF_ICON, default=ICON_RESTART_ALERT): cv.icon,
+        cv.Optional(
+            CONF_ENTITY_CATEGORY, default=ENTITY_CATEGORY_CONFIG
+        ): cv.entity_category,
+    }
+).extend(cv.COMPONENT_SCHEMA)
+
+
+async def to_code(config):
+    var = cg.new_Pvariable(config[CONF_ID])
+    await cg.register_component(var, config)
+    await switch.register_switch(var, config)

esphome/components/factory_reset/switch/factory_reset_switch.cpp

@@ -0,0 +1,26 @@
+#include "factory_reset_switch.h"
+#include "esphome/core/hal.h"
+#include "esphome/core/log.h"
+#include "esphome/core/application.h"
+
+namespace esphome {
+namespace factory_reset {
+
+static const char *const TAG = "factory_reset.switch";
+
+void FactoryResetSwitch::dump_config() { LOG_SWITCH("", "Factory Reset Switch", this); }
+void FactoryResetSwitch::write_state(bool state) {
+  // Acknowledge
+  this->publish_state(false);
+
+  if (state) {
+    ESP_LOGI(TAG, "Resetting to factory defaults...");
+    // Let MQTT settle a bit
+    delay(100);  // NOLINT
+    global_preferences->reset();
+    App.safe_reboot();
+  }
+}
+
+}  // namespace factory_reset
+}  // namespace esphome

esphome/components/factory_reset/switch/factory_reset_switch.h

@@ -0,0 +1,18 @@
+#pragma once
+
+#include "esphome/core/component.h"
+#include "esphome/components/switch/switch.h"
+
+namespace esphome {
+namespace factory_reset {
+
+class FactoryResetSwitch : public switch_::Switch, public Component {
+ public:
+  void dump_config() override;
+
+ protected:
+  void write_state(bool state) override;
+};
+
+}  // namespace factory_reset
+}  // namespace esphome