Fix for numeric menu items over Wi-Fi/LTE (#318)

Turns out the sync service will not run unless the picker has not only
been popped but the display also updated.

v3.7 needs a swift turnaround as its a bug reported by a user.

HISTORY.md

@@ -51,4 +51,5 @@
 |   3.3   | Providing automatic detection for menu definition updates, but still requires an application restart. |
 |   3.4   | Fixed a bug where templates failed to display in toggle menu items (at least on some devices). Fixed a bug where a menu item requesting to exit on completion appeared to indicate failure when using Wi-Fi or LTE. The fix uses a delay in exiting the application modelled as sufficient for a Venu 2 device, so this might need tweaking for other devices. Attempt to fixed an "Out of Memory" bug caused by v3.3 by making automatic checking for menu updates both optional and automatically turned off when insufficient memory is available. This last bug is device dependent and may require another attempt. Internationalisation improvements with thanks to [@krzys_h](https://github.com/krzys-h) for a new automated translations script. |
 |   3.5   | Added support for Edge 550, 850 & MTB, Fenix 8 Pro 47mm, GPSMAP H1, Instinct Crossover AMOLED, Venu 4 41mm & 45mm, & Venu X1 devices which also required an SDK update to 8.3.0. The simulation of the Edge 850 device was off, as it failed to update the display and text was the wrong colour, but the buttons menu items operated HA correctly. The assumption is the simulation model is buggy until someone [reports](https://github.com/house-of-abbey/GarminHomeAssistant/issues) otherwise. |
-|   3.6   | Added `numeric` menu item type thanks to [@thmichel](https://github.com/thmichel). This allows you to select a numeric value to set for an entity. Confirmations can now display a user supplied message. [Schema update](README.md#old-deprecated-formats) to keep pace with HomeAssistant and correct a previous decision. |
+|   3.6   | Added `numeric` menu item type thanks to [@thmichel](https://github.com/thmichel). This allows you to select a numeric value to set for an entity. Confirmations can now display a user supplied message. [Schema update](README.md#old-deprecated-formats) to keep pace with HomeAssistant and correct a previous decision. Schema changes for consistency. |
+|   3.7   | Bug fix for `numeric` menu items not working over Wi-Fi & LTE. |

source/HomeAssistantNumericMenuItem.mc

@@ -35,7 +35,7 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
     //!
     //! @param label     Menu item label.
     //! @param template  Menu item template.
-    //! @param action   Menu item action.
+    //! @param action    Menu item action.
     //! @param data      Data to supply to the action call.
     //! @param exit      Should the action call complete and then exit?
     //! @param confirm   Should the action call be confirmed to avoid accidental invocation?
@@ -48,7 +48,7 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
     function initialize(
         label     as Lang.String or Lang.Symbol,
         template  as Lang.String,
-        action   as Lang.String?,
+        action    as Lang.String?,
         data      as Lang.Dictionary?,
         picker    as Lang.Dictionary,
         options   as {
@@ -120,10 +120,10 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
                 WatchUi.pushView(
                     dialog,
                     new WifiLteExecutionConfirmDelegate({
-                        :type    => "action",
+                        :type   => "action",
                         :action => mAction,
-                        :data    => mData,
+                        :data   => mData,
-                        :exit    => mExit,
+                        :exit   => mExit,
                     }, dialog),
                     WatchUi.SLIDE_LEFT
                 );
@@ -154,27 +154,25 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
     //! @param b Ignored. It is included in order to match the expected function prototype of the callback method.
     //
     function onConfirm(b as Lang.Boolean) as Void {
-        var dataAttribute = mPicker["data_attribute"];
+        var dataAttribute = mPicker["data_attribute"] as Lang.String?;
-        if (dataAttribute == null) {
+        var entity_id     = mData["entity_id"]        as Lang.String?;
-            //return without call action if no data attribute is set to avoid crash
+
-            WatchUi.popView(WatchUi.SLIDE_RIGHT);
-            return;
-        }
-        var entity_id = mData["entity_id"];
-        if (entity_id == null) {
-            //return without call action if no entity_id is set to avoid crash
-            WatchUi.popView(WatchUi.SLIDE_RIGHT);
-            return;
-        }
-        mHomeAssistantService.call(
-            mAction,
-            {
-                "entity_id"              => entity_id.toString(),
-                dataAttribute.toString() => mValue
-            },
-            mExit
-        );
         WatchUi.popView(WatchUi.SLIDE_RIGHT);
+        WatchUi.requestUpdate();
+        if (dataAttribute == null or entity_id == null) {
+            // Return without service call if no data attribute or entity ID is set to avoid crash.
+            return;
+        }
+        if (mAction != null) {
+            mHomeAssistantService.call(
+                mAction,
+                {
+                    "entity_id"              => entity_id.toString(),
+                    dataAttribute.toString() => mValue
+                },
+                mExit
+            );
+        }
     }
 
     //! Return a numeric menu item's fetch state template.
@@ -182,8 +180,9 @@ class HomeAssistantNumericMenuItem extends HomeAssistantMenuItem {
     //! @return A string with the menu item's template definition (or null).
     //
     function getNumericTemplate() as Lang.String? {
-        var entity_id = mData["entity_id"];
+        var entity_id = mData["entity_id"]   as Lang.String?;
         var attribute = mPicker["attribute"] as Lang.String?;
+
         if (entity_id == null) {
             return null;
         } else {

source/HomeAssistantService.mc

@@ -121,7 +121,7 @@ class HomeAssistantService {
     //! Invoke a action call for a menu item.
     //!
     //! @param action The Home Assistant action to be run, e.g. from the JSON `action` field.
-    //! @param data    Data to be supplied to the action call.
+    //! @param data   Data to be supplied to the action call.
     //
     function call(
         action as Lang.String,
@@ -136,10 +136,10 @@ class HomeAssistantService {
             WatchUi.pushView(
                 dialog,
                 new WifiLteExecutionConfirmDelegate({
-                    :type    => "action",
+                    :type   => "action",
                     :action => action,
-                    :data    => data,
+                    :data   => data,
-                    :exit    => exit,
+                    :exit   => exit,
                 }, dialog),
                 WatchUi.SLIDE_LEFT
             );

source/HomeAssistantTapMenuItem.mc

@@ -31,7 +31,7 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
     //!
     //! @param label     Menu item label.
     //! @param template  Menu item template.
-    //! @param action   Menu item action.
+    //! @param action    Menu item action.
     //! @param data      Data to supply to the action call.
     //! @param exit      Should the action call complete and then exit?
     //! @param confirm   Should the action call be confirmed to avoid accidental invocation?
@@ -44,7 +44,7 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
     function initialize(
         label     as Lang.String or Lang.Symbol,
         template  as Lang.String,
-        action   as Lang.String?,
+        action    as Lang.String?,
         data      as Lang.Dictionary?,
         options   as {
             :alignment as WatchUi.MenuItem.Alignment,
@@ -83,10 +83,10 @@ class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
                 WatchUi.pushView(
                     pinConfirmationView,
                     new HomeAssistantPinConfirmationDelegate({
-                        :callback    => method(:onConfirm),
+                        :callback => method(:onConfirm),
-                        :pin         => pin, 
+                        :pin      => pin, 
-                        :state       => false,
+                        :state    => false,
-                        :view        => pinConfirmationView,
+                        :view     => pinConfirmationView,
                     }),
                     WatchUi.SLIDE_IMMEDIATE
                 );

source/HomeAssistantView.mc

@@ -47,7 +47,7 @@ class HomeAssistantView extends WatchUi.Menu2 {
                 var content    = items[i].get("content")    as Lang.String?;
                 var entity     = items[i].get("entity")     as Lang.String?;
                 var tap_action = items[i].get("tap_action") as Lang.Dictionary?;
-                var action    = items[i].get("service")    as Lang.String?; // Deprecated schema
+                var action     = items[i].get("service")    as Lang.String?; // Deprecated schema
                 var confirm    = false                      as Lang.Boolean or Lang.String or Null;
                 var pin        = false                      as Lang.Boolean?;
                 var data       = null                       as Lang.Dictionary?;

source/WifiLteExecutionConfirmDelegate.mc

@@ -24,12 +24,12 @@ using Toybox.Timer;
 //
 class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
     public static var mCommandData as {
-        :type    as Lang.String,
+        :type   as Lang.String,
         :action as Lang.String?,
-        :data    as Lang.Dictionary?,
+        :data   as Lang.Dictionary?,
-        :url     as Lang.String?,
+        :url    as Lang.String?,
-        :id      as Lang.Number?,
+        :id     as Lang.Number?,
-        :exit    as Lang.Boolean
+        :exit   as Lang.Boolean
     }?;
 
     private static var mTimer     as Timer.Timer?;
@@ -52,7 +52,7 @@ class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
     function initialize(
         cOptions as {
             :type     as Lang.String,
-            :action  as Lang.String?,
+            :action   as Lang.String?,
             :data     as Lang.Dictionary?,
             :url      as Lang.String?,
             :callback as Lang.Method?,
@@ -73,7 +73,7 @@ class WifiLteExecutionConfirmDelegate extends WatchUi.ConfirmationDelegate {
         mConfirmationView = view;
         mCommandData = {
             :type     => cOptions[:type],
-            :action  => cOptions[:action],
+            :action   => cOptions[:action],
             :data     => cOptions[:data],
             :url      => cOptions[:url],
             :callback => cOptions[:callback],