Add ability to specify initial state on power-on

Fixes #22

Author: rojer

fs/index.html

@@ -80,8 +80,13 @@ <h1 class="" id="sw1_name">SW1 Name</h1>
             </select>
           </div>
           <div class="form-control">
-            <label for="sw1_persist">Persist state:</label>
-            <input type="checkbox" id="sw1_persist">
+            <label for="sw1_initial">Initial state:</label>
+            <select id="sw1_initial">
+              <option id="sw1_initial_0" value="0">Off</option>
+              <option id="sw1_initial_1" value="1">On</option>
+              <option id="sw1_initial_2" value="2">Last</option>
+              <option id="sw1_initial_3" value="3">Input</option>
+            </select>
           </div>
           <div class="form-control">
             <label for="sw1_auto_off">Auto off:</label>
@@ -130,8 +135,13 @@ <h1 class="" id="sw2_name">SW2 Name</h1>
             </select>
           </div>
           <div class="form-control">
-            <label for="sw2_persist">Persist state:</label>
-            <input type="checkbox" id="sw2_persist">
+            <label for="sw2_initial">Initial state:</label>
+            <select id="sw2_initial">
+              <option id="sw2_initial_0" value="0">Off</option>
+              <option id="sw2_initial_1" value="1">On</option>
+              <option id="sw2_initial_2" value="2">Last</option>
+              <option id="sw2_initial_3" value="3">Input</option>
+            </select>
           </div>
           <div class="form-control">
             <label for="sw2_auto_off">Auto off:</label>
@@ -361,7 +371,7 @@ <h1 class="">Firmware</h1>
   );
 }
 
-function sw_save_common(cfg_key, in_mode, persist, auto_off, auto_off_delay, spinner) {
+function sw_save_common(cfg_key, in_mode, initial_state, auto_off, auto_off_delay, spinner) {
   spinner.className = "spin";
   var data = {
     config: {},
@@ -370,7 +380,7 @@ <h1 class="">Firmware</h1>
   };
   data.config[cfg_key] = {
     in_mode: parseInt(in_mode),
-    persist_state: persist,
+    initial_state: parseInt(initial_state),
     auto_off: auto_off,
     auto_off_delay: dateStringToSeconds(auto_off_delay)
   };
@@ -410,15 +420,15 @@ <h1 class="">Firmware</h1>
 }
 
 function twoDigitString(num) {
-	return num.toLocaleString(undefined, {minimumIntegerDigits: 2})
+  return num.toLocaleString(undefined, {minimumIntegerDigits: 2})
 }
 
 el("sw1_save_btn").onclick = function() {
   if (isValid("sw1")){
     sw_save_common(
         "sw1",
         el("sw1_in_mode").value,
-        el("sw1_persist").checked,
+        el("sw1_initial").value,
         el("sw1_auto_off").checked,
         el("sw1_auto_off_delay").value,
         el("sw1_save_spinner"),
@@ -431,7 +441,7 @@ <h1 class="">Firmware</h1>
     sw_save_common(
         "sw2",
         el("sw2_in_mode").value,
-        el("sw2_persist").checked,
+        el("sw2_initial").value,
         el("sw2_auto_off").checked,
         el("sw2_auto_off_delay").value,
         el("sw2_save_spinner"),
@@ -473,7 +483,7 @@ <h1 class="">Firmware</h1>
       }
       el("sw1_btn_label").innerText = "Turn " + (res.data.sw1.state ? "Off" : "On");
       el("sw1_in_mode_" + res.data.sw1.in_mode).selected = true;
-      el("sw1_persist").checked = res.data.sw1.persist;
+      el("sw1_initial_" + res.data.sw1.initial).selected = true;
       el("sw1_auto_off").checked = res.data.sw1.auto_off;
       el("sw1_auto_off_delay").disabled = !res.data.sw1.auto_off;
       el("sw1_auto_off_delay").value = secondsToDateString(res.data.sw1.auto_off_delay);
@@ -490,7 +500,7 @@ <h1 class="">Firmware</h1>
       }
       el("sw2_btn_label").innerText = "Turn " + (res.data.sw2.state ? "Off" : "On");
       el("sw2_in_mode_" + res.data.sw2.in_mode).selected = true;
-      el("sw2_persist").checked = res.data.sw2.persist;
+      el("sw2_initial_" + res.data.sw2.initial).selected = true;
       el("sw2_auto_off").checked = res.data.sw2.auto_off;
       el("sw2_auto_off_delay").disabled = !res.data.sw2.auto_off;
       el("sw2_auto_off_delay").value = secondsToDateString(res.data.sw2.auto_off_delay);

mos.yml

@@ -28,10 +28,14 @@ config_schema:
   - ["sw.in_gpio", "i", -1, {"Input sensing pin"}]
   - ["sw.in_mode", "i", 1, {"0 - Momentary, 1 - Toggle, 2 - Edge, 3 - Detached"}]
   - ["sw.state", "b", false, {"State of the switch"}]
-  - ["sw.persist_state", "b", false, {"Whether state of the switch should be persisted across reboots."}]
+  - ["sw.initial_state", "i", 3, {"Initial state on power-on: 0 - off, 1 - on, 2 - restore last state, 3 - matches input if in toggle mode, otherwise off"}]
   - ["sw.auto_off", "b", false, {"Whether the switch should automatically turn OFF after turning ON"}]
   - ["sw.auto_off_delay", "i", -1, {"Delay for automatically turning OFF, in seconds"}]
 
+  - ["shelly.cfg_version", "i", 0, {"Configuration version"}]
+  # Deprecated settings, only kept to enable migration.
+  - ["sw.persist_state", "b", false, {"Deprecated"}]  # Since cfg v1
+
 
 build_vars:
   # Enables storing setup info in the config and a simple RPC service to configure it.

src/shelly_main.c

@@ -304,16 +304,16 @@ static void shelly_get_info_handler(struct mg_rpc_request_info *ri,
       ri,
       "{id: %Q, app: %Q, host: %Q, version: %Q, fw_build: %Q, uptime: %d, "
 #ifdef MGOS_CONFIG_HAVE_SW1
-      "sw1: {id: %d, name: %Q, in_mode: %d, persist: %B, state: %B, auto_off: "
-      "%B, auto_off_delay: %d"
+      "sw1: {id: %d, name: %Q, in_mode: %d, initial: %d, "
+      "state: %B, auto_off: %B, auto_off_delay: %d"
 #ifdef SHELLY_HAVE_PM
       ", apower: %.3f, aenergy: %.3f"
 #endif
       "},"
 #endif
 #ifdef MGOS_CONFIG_HAVE_SW2
-      "sw2: {id: %d, name: %Q, in_mode: %d, persist: %B, state: %B, auto_off: "
-      "%B, auto_off_delay: %d"
+      "sw2: {id: %d, name: %Q, in_mode: %d, initial: %d, "
+      "state: %B, auto_off: %B, auto_off_delay: %d"
 #ifdef SHELLY_HAVE_PM
       ", apower: %.3f, aenergy: %.3f"
 #endif
@@ -327,7 +327,7 @@ static void shelly_get_info_handler(struct mg_rpc_request_info *ri,
 #ifdef MGOS_CONFIG_HAVE_SW1
       mgos_sys_config_get_sw1_id(), mgos_sys_config_get_sw1_name(),
       mgos_sys_config_get_sw1_in_mode(),
-      mgos_sys_config_get_sw1_persist_state(), sw1.state,
+      mgos_sys_config_get_sw1_initial_state(), sw1.state,
       mgos_sys_config_get_sw1_auto_off(),
       mgos_sys_config_get_sw1_auto_off_delay(),
 #ifdef SHELLY_HAVE_PM
@@ -337,7 +337,7 @@ static void shelly_get_info_handler(struct mg_rpc_request_info *ri,
 #ifdef MGOS_CONFIG_HAVE_SW2
       mgos_sys_config_get_sw2_id(), mgos_sys_config_get_sw2_name(),
       mgos_sys_config_get_sw2_in_mode(),
-      mgos_sys_config_get_sw2_persist_state(), sw2.state,
+      mgos_sys_config_get_sw2_initial_state(), sw2.state,
       mgos_sys_config_get_sw2_auto_off(),
       mgos_sys_config_get_sw2_auto_off_delay(),
 #ifdef SHELLY_HAVE_PM
@@ -370,6 +370,25 @@ static void shelly_set_switch_handler(struct mg_rpc_request_info *ri,
   (void) fi;
 }
 
+static bool shelly_cfg_migrate(void) {
+  bool changed = false;
+  if (mgos_sys_config_get_shelly_cfg_version() == 0) {
+#ifdef MGOS_CONFIG_HAVE_SW1
+    if (mgos_sys_config_get_sw1_persist_state()) {
+      mgos_sys_config_set_sw1_initial_state(SHELLY_SW_INITIAL_STATE_LAST);
+    }
+#endif
+#ifdef MGOS_CONFIG_HAVE_SW2
+    if (mgos_sys_config_get_sw2_persist_state()) {
+      mgos_sys_config_set_sw2_initial_state(SHELLY_SW_INITIAL_STATE_LAST);
+    }
+#endif
+    mgos_sys_config_set_shelly_cfg_version(1);
+    changed = true;
+  }
+  return changed;
+}
+
 enum mgos_app_init_result mgos_app_init(void) {
 #ifdef MGOS_HAVE_OTA_COMMON
   if (mgos_ota_is_first_boot()) {
@@ -382,6 +401,11 @@ enum mgos_app_init_result mgos_app_init(void) {
   }
 #endif
 
+  if (shelly_cfg_migrate()) {
+    mgos_sys_config_save(&mgos_sys_config, false /* try_once */,
+                         NULL /* msg */);
+  }
+
 #ifdef MGOS_HAVE_ADE7953
   const struct mgos_ade7953_config ade7953_cfg = {
       .voltage_scale = .0000382602,

src/shelly_sw_service.c

@@ -27,13 +27,6 @@
 #define IID_BASE 0x100
 #define IID_STEP 4
 
-enum shelly_sw_in_mode {
-  SHELLY_SW_IN_MODE_MOMENTARY = 0,
-  SHELLY_SW_IN_MODE_TOGGLE = 1,
-  SHELLY_SW_IN_MODE_EDGE = 2,
-  SHELLY_SW_IN_MODE_DETACHED = 3,
-};
-
 struct shelly_sw_service_ctx {
   const struct mgos_config_sw *cfg;
   HAPAccessoryServerRef *hap_server;
@@ -43,6 +36,7 @@ struct shelly_sw_service_ctx {
   bool pb_state;
   int change_cnt;         // State change counter for reset.
   double last_change_ts;  // Timestamp of last change (uptime).
+  mgos_timer_id auto_off_timer_id;
 #ifdef MGOS_HAVE_ADE7953
   struct mgos_ade7953 *ade7953;
   int ade7953_channel;
@@ -51,8 +45,6 @@ struct shelly_sw_service_ctx {
 
 static struct shelly_sw_service_ctx s_ctx[NUM_SWITCHES];
 
-static int s_auto_off_timer_id = MGOS_INVALID_TIMER_ID;
-
 static void do_auto_off(void *arg);
 
 #ifdef SHELLY_HAVE_PM
@@ -73,11 +65,12 @@ static void do_reset(void *arg) {
 
 static void handle_auto_off(struct shelly_sw_service_ctx *ctx,
                             const char *source, bool new_state) {
-  if (s_auto_off_timer_id != MGOS_INVALID_TIMER_ID) {
+  if (ctx->auto_off_timer_id != MGOS_INVALID_TIMER_ID) {
     // Cancel timer if state changes so that only the last timer is triggered if
     // state changes multiple times
-    mgos_clear_timer(s_auto_off_timer_id);
-    s_auto_off_timer_id = MGOS_INVALID_TIMER_ID;
+    mgos_clear_timer(ctx->auto_off_timer_id);
+    ctx->auto_off_timer_id = MGOS_INVALID_TIMER_ID;
+    LOG(LL_INFO, ("%d: Cleared auto-off timer", ctx->cfg->id));
   }
 
   const struct mgos_config_sw *cfg = ctx->cfg;
@@ -88,16 +81,17 @@ static void handle_auto_off(struct shelly_sw_service_ctx *ctx,
 
   if (!new_state) return;
 
-  s_auto_off_timer_id =
+  ctx->auto_off_timer_id =
       mgos_set_timer(cfg->auto_off_delay * 1000, 0, do_auto_off, ctx);
+  LOG(LL_INFO, ("%d: Set auto-off timer for %d", cfg->id, cfg->auto_off_delay));
 }
 
 static void shelly_sw_set_state_ctx(struct shelly_sw_service_ctx *ctx,
                                     bool new_state, const char *source) {
   const struct mgos_config_sw *cfg = ctx->cfg;
-  if (new_state == ctx->info.state) return;
   int out_value = (new_state ? cfg->out_on_value : !cfg->out_on_value);
-  mgos_gpio_write(cfg->out_gpio, out_value);
+  mgos_gpio_setup_output(cfg->out_gpio, out_value);
+  if (new_state == ctx->info.state) return;
   LOG(LL_INFO, ("%s: %d -> %d (%s) %d", cfg->name, ctx->info.state, new_state,
                 source, out_value));
   ctx->info.state = new_state;
@@ -106,10 +100,12 @@ static void shelly_sw_set_state_ctx(struct shelly_sw_service_ctx *ctx,
                                  ctx->hap_service->characteristics[1],
                                  ctx->hap_service, ctx->hap_accessory);
   }
-  if (cfg->persist_state) {
+  if (cfg->state != new_state) {
     ((struct mgos_config_sw *) cfg)->state = new_state;
-    mgos_sys_config_save(&mgos_sys_config, false /* try_once */,
-                         NULL /* msg */);
+    if (cfg->initial_state == SHELLY_SW_INITIAL_STATE_LAST) {
+      mgos_sys_config_save(&mgos_sys_config, false /* try_once */,
+                           NULL /* msg */);
+    }
   }
 
   double now = mgos_uptime();
@@ -131,9 +127,10 @@ static void shelly_sw_set_state_ctx(struct shelly_sw_service_ctx *ctx,
 }
 
 static void do_auto_off(void *arg) {
-  s_auto_off_timer_id = MGOS_INVALID_TIMER_ID;
   struct shelly_sw_service_ctx *ctx = arg;
   const struct mgos_config_sw *cfg = ctx->cfg;
+  ctx->auto_off_timer_id = MGOS_INVALID_TIMER_ID;
+  LOG(LL_INFO, ("%d: Auto-off timer fired", cfg->id));
   if (cfg->auto_off) {
     // Don't set state if auto off has been disabled during timer run
     shelly_sw_set_state_ctx(ctx, false, "auto_off");
@@ -329,21 +326,28 @@ HAPService *shelly_sw_service_create(
   struct shelly_sw_service_ctx *ctx = &s_ctx[cfg->id];
   ctx->cfg = cfg;
   ctx->hap_service = svc;
-  if (cfg->persist_state) {
-    ctx->info.state = cfg->state;
-  } else {
-    ctx->info.state = 0;
-  }
+  ctx->auto_off_timer_id = MGOS_INVALID_TIMER_ID;
   LOG(LL_INFO, ("Exporting '%s' (GPIO out: %d, in: %d, state: %d)", cfg->name,
                 cfg->out_gpio, cfg->in_gpio, ctx->info.state));
-  mgos_gpio_setup_output(cfg->out_gpio, (ctx->info.state ? cfg->out_on_value
-                                                         : !cfg->out_on_value));
+
+  switch ((enum shelly_sw_initial_state) cfg->initial_state) {
+    case SHELLY_SW_INITIAL_STATE_OFF:
+      shelly_sw_set_state_ctx(ctx, false, "init");
+      break;
+    case SHELLY_SW_INITIAL_STATE_ON:
+      shelly_sw_set_state_ctx(ctx, true, "init");
+      break;
+    case SHELLY_SW_INITIAL_STATE_LAST:
+      shelly_sw_set_state_ctx(ctx, cfg->state, "init");
+      break;
+    case SHELLY_SW_INITIAL_STATE_INPUT:
+      if (cfg->in_mode == SHELLY_SW_IN_MODE_TOGGLE) {
+        shelly_sw_in_cb(cfg->in_gpio, ctx);
+      }
+  }
   mgos_gpio_set_button_handler(cfg->in_gpio, MGOS_GPIO_PULL_NONE,
                                MGOS_GPIO_INT_EDGE_ANY, 20, shelly_sw_in_cb,
                                ctx);
-  if (ctx->cfg->in_mode == SHELLY_SW_IN_MODE_TOGGLE) {
-    shelly_sw_in_cb(cfg->in_gpio, ctx);
-  }
 #ifdef SHELLY_HAVE_PM
 #ifdef MGOS_HAVE_ADE7953
   ctx->ade7953 = ade7953;

src/shelly_sw_service.h

@@ -22,6 +22,20 @@
 struct mgos_ade7953;
 #endif
 
+enum shelly_sw_in_mode {
+  SHELLY_SW_IN_MODE_MOMENTARY = 0,
+  SHELLY_SW_IN_MODE_TOGGLE = 1,
+  SHELLY_SW_IN_MODE_EDGE = 2,
+  SHELLY_SW_IN_MODE_DETACHED = 3,
+};
+
+enum shelly_sw_initial_state {
+  SHELLY_SW_INITIAL_STATE_OFF = 0,
+  SHELLY_SW_INITIAL_STATE_ON = 1,
+  SHELLY_SW_INITIAL_STATE_LAST = 2,
+  SHELLY_SW_INITIAL_STATE_INPUT = 3,
+};
+
 HAPService *shelly_sw_service_create(
 #ifdef MGOS_HAVE_ADE7953
     struct mgos_ade7953 *ade7953, int ade7953_channel,