227 enhancement glance info cachingprevious results instead of unconfigured (#228)

Not as the issue requested, but instead pulling the settings from
persistent storage before checking the URL status, preventing
"Unconfigured" being initially displayed when it should be "Checking..."
as coded.

HISTORY.md

@@ -37,3 +37,6 @@
 |   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. |
+|   2.27  | Trivial bug fix for the glance view to prevent the "Unconfigured" result being erroneously displayed because the settings were not yet pulled from persistent storage. |

TroubleShooting.md

@@ -120,6 +120,32 @@ There's an online way of testing the API URL too, thanks to [REQBIN](https://req
 
 ![API Test REQBIN](images/api_test_online.png)
 
+#### SSL Certificate Chain
+
+With thanks to [@ziceva](https://github.com/ziceva) for solving this problem. The symptoms are:
+1. Using an API URL with SSL (HTTPS), the [web-based editor](https://house-of-abbey.github.io/GarminHomeAssistant/web/) running in a browser on the same phone running Garmin Connect works well.
+2. The exact same configuration is set in the Garmin Home Assistant application.
+3. The Garmin Home Assistant application reports:
+```
+API: not available
+Menu: not available
+```
+
+**Solution: Make sure you use a _full chain_ certificate in your HTTPS proxy as some watches might be unable to validate the site certificate alone.**
+
+Most web browsers and OSes probably have the latest Certificate Authorities (CAs) trusted out-of-the-box and so they do not need the full chain to verify the certificates. Garmin watches may not have the latest CAs and that is why the Troubleshooting web page does not catch this problem. E.g. It turns out some Garmin watches do not have the LetsEncrypt CA marked as trusted.
+
+To verify if you have this issue you can use a tool like [SSL Shoppers's SSL Checker](https://www.sslshopper.com/ssl-checker.html), which will catch this issue. The following two screen captures illustrate the difference between partial and full chain certificates respectively.
+
+##### Partial Chain Certificate
+
+![Partial Chain Certificate](images/HTTPS_partial_chain.png)
+
+##### Full Chain Certificate
+
+![Full Chain Certificate](images/HTTPS_full_chain.png)
+
+
 ### Top Problems
 
 1. Failure to copy & paste keys and URLs leading to minor and hard to see errors in strings, even with protestations they are the same! (No they weren't...)

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:
@@ -212,7 +212,7 @@ class HomeAssistantApp extends Application.AppBase {
     // asynchronous and affects how the views are managed.
     (:glance)
     function fetchMenuConfig() as Lang.Boolean {
-        // System.println("URL = " + Settings.getConfigUrl());
+        // System.println("Menu URL = " + Settings.getConfigUrl());
         if (Settings.getConfigUrl().equals("")) {
             mMenuStatus = WatchUi.loadResource($.Rez.Strings.Unconfigured) as Lang.String;
             WatchUi.requestUpdate();
@@ -266,7 +266,9 @@ class HomeAssistantApp extends Application.AppBase {
     private function buildMenu(menu as Lang.Dictionary) {
         mHaMenu = new HomeAssistantView(menu, null);
         mQuitTimer.begin();
-        startUpdates();
+        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() {
@@ -466,6 +468,7 @@ class HomeAssistantApp extends Application.AppBase {
 
     (:glance)
     function fetchApiStatus() as Void {
+        // System.println("API URL = " + Settings.getApiUrl());
         if (Settings.getApiUrl().equals("")) {
             mApiStatus = WatchUi.loadResource($.Rez.Strings.Unconfigured) as Lang.String;
             WatchUi.requestUpdate();
@@ -544,8 +547,8 @@ class HomeAssistantApp extends Application.AppBase {
         mIsGlance   = true;
         mApiStatus  = WatchUi.loadResource($.Rez.Strings.Checking) as Lang.String;
         mMenuStatus = WatchUi.loadResource($.Rez.Strings.Checking) as Lang.String;
-        updateStatus();
         Settings.update();
+        updateStatus();
         mGlanceTimer = new Timer.Timer();
         mGlanceTimer.start(method(:updateStatus), Globals.scApiBackoff, true);
         return [new HomeAssistantGlanceView(self)];

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,48 +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.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, a number can be either integer or float and hence 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,53 +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.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, a number can be either integer or float and hence 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;
         }
@@ -74,19 +80,26 @@ class HomeAssistantToggleMenuItem extends WatchUi.ToggleMenuItem {
             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("HomeAsistantToggleMenuItem updateState() data = " + data);
+            // System.println("HomeAssistantToggleMenuItem 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, a number can be either integer or float and hence cannot be formatted locally without error.
+            // 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 updateToggleState(data as Lang.String or Lang.Dictionary or Null) as Void {
         if (data == null) {
             setUiToggle("off");
@@ -96,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:

web/index.html

@@ -7,13 +7,13 @@
     <link
       rel="stylesheet"
       data-name="vs/editor/editor.main"
-      href="https://unpkg.com/monaco-editor@0.45.0/min/vs/editor/editor.main.css" />
+      href="https://www.unpkg.com/monaco-editor@0.45.0/min/vs/editor/editor.main.css" />
     <link
       rel="stylesheet"
       type="text/css"
-      href="https://unpkg.com/toastify-js@1.12.0/src/toastify.css" />
+      href="https://www.unpkg.com/toastify-js@1.12.0/src/toastify.css" />
     <style>
-      @import url('https://unpkg.com/@catppuccin/palette/css/catppuccin.css');
+      @import url('https://www.unpkg.com/@catppuccin/palette/css/catppuccin.css');
 
       body {
         display: flex;
@@ -441,9 +441,9 @@ http:
       </div>
     </dialog>
 
-    <script src="https://unpkg.com/monaco-editor@0.45.0/min/vs/loader.js"></script>
-    <script src="https://unpkg.com/json-ast-comments@1.1.1/lib/json.js"></script>
-    <script src="https://unpkg.com/toastify-js@1.12.0/src/toastify.js"></script>
+    <script src="https://www.unpkg.com/monaco-editor@0.45.0/min/vs/loader.js"></script>
+    <script src="https://www.unpkg.com/json-ast-comments@1.1.1/lib/json.js"></script>
+    <script src="https://www.unpkg.com/toastify-js@1.12.0/src/toastify.js"></script>
     <script type="module" src="./main.js"></script>
   </body>
 </html>

web/main.js

@@ -451,7 +451,7 @@ loadSchema();
 // require is provided by loader.min.js.
 require.config({
   paths: {
-    vs: 'https://unpkg.com/monaco-editor@0.45.0/min/vs',
+    vs: 'https://www.unpkg.com/monaco-editor@0.45.0/min/vs',
   },
 });
 require(['vs/editor/editor.main'], async () => {