223 code refactoring (#224)

Code refactoring and amended fix for responsive menu that was removed by
bug fix in v2.25.

HISTORY.md

@@ -37,3 +37,5 @@
 |   2.22  | Major feature release adding an optional PIN to menu items. This significant new feature has been provided by [moesterheld](https://github.com/moesterheld). Please do not rely on this application for security. Use at your own risk! |
 |   2.23  | Added "info" menu item for displaying information via a template without a tap or toggle. Essentially like the old 'template' type that was deprecated when all items were amended to display evaluated templates. That action removed the display only items too hastily. Added 5 new devices in the model range Instinct 3 and Instinct E. |
 |   2.24  | Experiment to prevent new Webhook IDs being created unnecessarily. Reduced the latency for the first menu update. Added 4 new devices: approachs50, descentg2, descentmk1, and gpsmap66. |
+|   2.25  | 2 Bug fixes. First time startup issues caused by v2.24 change and a fix for pure numbers in returned templates. |
+|   2.26  | Retry responsive menu fix failed in v2.24. Cosmetic internal class changes. |

source/Globals.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:

source/HomeAssistantApp.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:
@@ -266,6 +266,9 @@ class HomeAssistantApp extends Application.AppBase {
     private function buildMenu(menu as Lang.Dictionary) {
         mHaMenu = new HomeAssistantView(menu, null);
         mQuitTimer.begin();
+        if (!Settings.getWebhookId().equals("")) {
+            startUpdates();
+        } // If not, this will be done via a chain in Settings.webhook() and mWebhookManager.requestWebhookId() that registers the sensors.
     }
 
     function startUpdates() {

source/HomeAssistantGroupMenuItem.mc

@@ -22,8 +22,7 @@
 using Toybox.Lang;
 using Toybox.WatchUi;
 
-class HomeAssistantGroupMenuItem extends WatchUi.IconMenuItem {
-    private var mTemplate as Lang.String or Null;
+class HomeAssistantGroupMenuItem extends HomeAssistantMenuItem {
     private var mMenu as HomeAssistantView;
 
     function initialize(
@@ -34,54 +33,23 @@ class HomeAssistantGroupMenuItem extends WatchUi.IconMenuItem {
             :alignment as WatchUi.MenuItem.Alignment
         } or Null
     ) {
+        if (options != null) {
+            options.put(:icon, icon);
+        } else {
+            options = { :icon => icon };
+        }
 
-        WatchUi.IconMenuItem.initialize(
+        HomeAssistantMenuItem.initialize(
             definition.get("name") as Lang.String,
-            null,
-            null,
-            icon,
+            template,
             options
         );
 
-        mTemplate = template;
         mMenu = new HomeAssistantView(definition, null);
     }
 
-    function buildTemplate() as Lang.String or Null {
-        return mTemplate;
-    }
-
-    function updateState(data as Lang.String or Lang.Dictionary or Null) as Void {
-        if (data == null) {
-            setSubLabel(null);
-        } else if(data instanceof Lang.String) {
-            setSubLabel(data);
-        } else if(data instanceof Lang.Number) {
-            var d = data as Lang.Number;
-            setSubLabel(d.format("%d"));
-        } else if(data instanceof Lang.Float) {
-            var f = data as Lang.Float;
-            setSubLabel(f.format("%f"));
-        } else if(data instanceof Lang.Dictionary) {
-            // System.println("HomeAsistantGroupMenuItem updateState() data = " + data);
-            if (data.get("error") != null) {
-                setSubLabel($.Rez.Strings.TemplateError);
-            } else {
-                setSubLabel($.Rez.Strings.PotentialError);
-            }
-        } else {
-            // The template must return a Lang.String, Number or Float, or the item cannot be formatted locally without error.
-            setSubLabel(WatchUi.loadResource($.Rez.Strings.TemplateError) as Lang.String);
-        }
-        WatchUi.requestUpdate();
-    }
-
     function getMenuView() as HomeAssistantView {
         return mMenu;
     }
 
-    function hasTemplate() as Lang.Boolean {
-        return mTemplate != null;
-    }
-
 }

source/HomeAssistantMenuItem.mc

@@ -0,0 +1,79 @@
+//-----------------------------------------------------------------------------------
+//
+// Distributed under MIT Licence
+//   See https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/LICENSE.
+//
+//-----------------------------------------------------------------------------------
+//
+// GarminHomeAssistant is a Garmin IQ application written in Monkey C and routinely
+// tested on a Venu 2 device. The source code is provided at:
+//            https://github.com/house-of-abbey/GarminHomeAssistant.
+//
+// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+//
+//
+// Description:
+//
+// Generic menu button with an icon that optionally renders a Home Assistant Template.
+//
+//-----------------------------------------------------------------------------------
+
+using Toybox.Lang;
+using Toybox.WatchUi;
+using Toybox.Graphics;
+
+class HomeAssistantMenuItem extends WatchUi.IconMenuItem {
+    private var mTemplate as Lang.String or Null;
+
+    function initialize(
+        label    as Lang.String or Lang.Symbol,
+        template as Lang.String,
+        options  as {
+            :alignment as WatchUi.MenuItem.Alignment,
+            :icon      as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol
+        } or Null
+    ) {
+        WatchUi.IconMenuItem.initialize(
+            label,
+            null,
+            null,
+            options.get(:icon),
+            options
+        );
+        mTemplate = template;
+    }
+
+    function hasTemplate() as Lang.Boolean {
+        return mTemplate != null;
+    }
+
+    function buildTemplate() as Lang.String or Null {
+        return mTemplate;
+    }
+
+    function updateState(data as Lang.String or Lang.Dictionary or Null) as Void {
+        if (data == null) {
+            setSubLabel($.Rez.Strings.Empty);
+        } else if(data instanceof Lang.String) {
+            setSubLabel(data);
+        } else if(data instanceof Lang.Number) {
+            var d = data as Lang.Number;
+            setSubLabel(d.format("%d"));
+        } else if(data instanceof Lang.Float) {
+            var f = data as Lang.Float;
+            setSubLabel(f.format("%f"));
+        } else if(data instanceof Lang.Dictionary) {
+            // System.println("HomeAssistantMenuItem updateState() data = " + data);
+            if (data.get("error") != null) {
+                setSubLabel($.Rez.Strings.TemplateError);
+            } else {
+                setSubLabel($.Rez.Strings.PotentialError);
+            }
+        } else {
+            // The template must return a Lang.String, Number or Float, or the item cannot be formatted locally without error.
+            setSubLabel(WatchUi.loadResource($.Rez.Strings.TemplateError) as Lang.String);
+        }
+        WatchUi.requestUpdate();
+    }
+
+}

source/HomeAssistantPinConfirmation.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:

source/HomeAssistantTapMenuItem.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:
@@ -22,9 +22,8 @@ using Toybox.Lang;
 using Toybox.WatchUi;
 using Toybox.Graphics;
 
-class HomeAssistantTapMenuItem extends WatchUi.IconMenuItem {
+class HomeAssistantTapMenuItem extends HomeAssistantMenuItem {
     private var mHomeAssistantService as HomeAssistantService;
-    private var mTemplate             as Lang.String;
     private var mService              as Lang.String or Null;
     private var mConfirm              as Lang.Boolean;
     private var mPin                  as Lang.Boolean;
@@ -39,59 +38,30 @@ class HomeAssistantTapMenuItem extends WatchUi.IconMenuItem {
         data      as Lang.Dictionary or Null,
         icon      as Graphics.BitmapType or WatchUi.Drawable,
         options   as {
-            :alignment as WatchUi.MenuItem.Alignment
+            :alignment as WatchUi.MenuItem.Alignment,
+            :icon      as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol
         } or Null,
         haService as HomeAssistantService
     ) {
-        WatchUi.IconMenuItem.initialize(
+        if (options != null) {
+            options.put(:icon, icon);
+        } else {
+            options = { :icon => icon };
+        }
+
+        HomeAssistantMenuItem.initialize(
             label,
-            null,
-            null,
-            icon,
+            template,
             options
         );
 
         mHomeAssistantService = haService;
-        mTemplate             = template;
         mService              = service;
         mConfirm              = confirm;
         mPin                  = pin;
         mData                 = data;
     }
 
-    function hasTemplate() as Lang.Boolean {
-        return mTemplate != null;
-    }
-
-    function buildTemplate() as Lang.String or Null {
-        return mTemplate;
-    }
-
-    function updateState(data as Lang.String or Lang.Dictionary or Null) as Void {
-        if (data == null) {
-            setSubLabel($.Rez.Strings.Empty);
-        } else if(data instanceof Lang.String) {
-            setSubLabel(data);
-        } else if(data instanceof Lang.Number) {
-            var d = data as Lang.Number;
-            setSubLabel(d.format("%d"));
-        } else if(data instanceof Lang.Float) {
-            var f = data as Lang.Float;
-            setSubLabel(f.format("%f"));
-        } else if(data instanceof Lang.Dictionary) {
-            // System.println("HomeAsistantTemplateMenuItem updateState() data = " + data);
-            if (data.get("error") != null) {
-                setSubLabel($.Rez.Strings.TemplateError);
-            } else {
-                setSubLabel($.Rez.Strings.PotentialError);
-            }
-        } else {
-            // The template must return a Lang.String, Number or Float, or the item cannot be formatted locally without error.
-            setSubLabel(WatchUi.loadResource($.Rez.Strings.TemplateError) as Lang.String);
-        }
-        WatchUi.requestUpdate();
-    }
-
     function callService() as Void {
         var hasTouchScreen = System.getDeviceSettings().isTouchScreen;
         if (mPin && hasTouchScreen) {

source/HomeAssistantToggleMenuItem.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:
@@ -42,7 +42,13 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
             :icon      as Graphics.BitmapType or WatchUi.Drawable or Lang.Symbol
         } or Null
     ) {
-        WatchUi.ToggleMenuItem.initialize(label, null, null, false, options);
+        WatchUi.ToggleMenuItem.initialize(
+            label,
+            null,
+            null,
+            false,
+            options
+        );
         if (Attention has :vibrate) {
             mHasVibrate = true;
         }
@@ -81,7 +87,7 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
             var f = data as Lang.Float;
             setSubLabel(f.format("%f"));
         } else if(data instanceof Lang.Dictionary) {
-            // System.println("HomeAsistantToggleMenuItem updateState() data = " + data);
+            // System.println("HomeAssistantToggleMenuItem updateState() data = " + data);
             if (data.get("error") != null) {
                 setSubLabel($.Rez.Strings.TemplateError);
             } else {
@@ -93,6 +99,7 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
         }
         WatchUi.requestUpdate();
     }
+
     function updateToggleState(data as Lang.String or Lang.Dictionary or Null) as Void {
         if (data == null) {
             setUiToggle("off");
@@ -102,7 +109,7 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
                 setSubLabel($.Rez.Strings.Unavailable);
             }
         } else if(data instanceof Lang.Dictionary) {
-            // System.println("HomeAsistantToggleMenuItem updateState() data = " + data);
+            // System.println("HomeAssistantToggleMenuItem updateState() data = " + data);
             if (mTemplate == null) {
                 if (data.get("error") != null) {
                     setSubLabel($.Rez.Strings.TemplateError);

source/HomeAssistantView.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey & Someone0nEarth, 31 October 2023
+// P A Abbey & J D Abbey & Someone0nEarth & moesterheld, 31 October 2023
 //
 //
 // Description:

source/Settings.mc

@@ -9,7 +9,7 @@
 // tested on a Venu 2 device. The source code is provided at:
 //            https://github.com/house-of-abbey/GarminHomeAssistant.
 //
-// P A Abbey & J D Abbey, SomeoneOnEarth, 23 November 2023
+// P A Abbey & J D Abbey, SomeoneOnEarth & moesterheld, 23 November 2023
 //
 //
 // Description: