GarminHomeAssistant (Widget)

Warning! Those who fail to read the copious documentation provided tend to look really silly when making a bad review. This widget is now in "maintenance only mode" hence will not receive new features. Widgets have half the memory available to them over full applications, and we've run out! NB. The application (& glance) version of this widget is available as a separate item in the App Store at https://apps.garmin.com/en-US/apps/61c91d28-ec5e-438d-9f83-39e9f45b199d . A Garmin widget to provide a "dashboard" to control your devices via Home Assistant, https://www.home-assistant.io/ . The widget will never be as fully fledged as a Home Assistant dashboard, so it is designed to be good enough for the simple and essential things. Those things that can be activated via an on/off toggle or a tap. That should cover lights, switches, and anything requiring a single press such as an automation. For anything more complicated, e.g. thermostat, it would always be quicker and simpler to reach for your phone or tablet... or the device's own remote control! The widget is designed around a simple scrollable menu where menu items have been extended to interface with the Home Assistant API (https://developers.home-assistant.io/docs/api/rest/ ), e.g. to get the status of switches or lights for display on the toggle menu item. It is possible to nest menus, so there is a menu item to open a sub-menu. This can be arbitrarily deep and nested in the format of a tree of items, although you need to consider if reaching for your phone becomes quicker to select the device what you want to control. Please also note that widgets are more limited by working memory than applications. If your menu configuration is large, you will crash the widget but the application will probably still work. We cannot anticipate when you will run out of memory and code protectively for that event. It is important to note that your HomeAssistant instance will need to be accessible via HTTPS with public SSL or all requests from the Garmin will not work. This cannot be a self-signed certificate, it must be a public certificate (You can get one for free from Let's Encrypt or you can pay for homeassistant cloud). Configuration instructions are provided via the GitHub repository at https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/README.md . This is essential reading due to the need to configure a "dashboard" via a JSON definition file served from your Home Assistant instance. Discussion and support will be offered via the Home Assistant Community at https://community.home-assistant.io/t/home-assistant-app-for-garmin/637348 . Need Help? 1. Read the instructions 2. Did you copy & paste the settings? Don't re-type its too error prone! 3. Read the known issues, https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/README.md#known-issues 4. Self help from the the trouble shooting guide ,https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/TroubleShooting.md 5. Community help from Home Assistant Forums, https://community.home-assistant.io/t/home-assistant-app-for-garmin/637348 6. Double check your settings for copy & paste errors, and your JSON passes both formatting and schema checks. 7. Contact the authors, but be prepared to be embarrassed if its something in the instructions ;-) More fully thought out bug reports and feature requests best go via the GitHub project (https://github.com/house-of-abbey/GarminHomeAssistant/issues) please, after you have checked previous posts on the forum and previously closed issues. Discussion and support will be offered via the Home Assistant Community at https://community.home-assistant.io/t/home-assistant-app-for-garmin/637348. More fully thought out bug reports and feature requests best go via the GitHub project please. This widget is offered FREE to the community in order to give back to it when we have personally taken so much from the contribution of others. Please be kind and helpful with your fee

2.16 Adding support for 24 new devices: approachs50, descentg2, descentmk1, descentmk343mm, descentmk351mm, edge1050, enduro3, fenix843mm, fenix847mm, fenix8solar47mm, fenix8solar51mm, fenixe, fr165, fr165m, fr57042mm, fr57047mm, fr970, gpsmap66, instinct3amoled45mm, instinct3amoled50mm, instinct3solar45mm, instincte40mm, instincte45mm, & vivoactive6. 2.15 Templates returning anything other than a string get an error message rather than the value being discarded. Bug fix for reporting activity metrics that might be `null` sometimes. This is unsimulatable situation, so this version is a change based on an informed guess. 2.14 Bug fix for lack of phone connection when starting the widget. 2.13 Better support for templates by isolating erroneous returns and marking the menu item. Prevented the application crashing when settings are amended at run time. 2.12 Moved the template status queries to Webhooks in order to fix the situation where an account is a non-privileged user. Added telemetry update on activity completion to make automations more timely at the end of an activity. 2.11 Re-enabled Edge 540 and Edge 840 devices which we are unable to support due to simulator issues, but the Edge 840 device has been confirmed as working by a @Petucky. 2.10 Bug fix release for menu caching being turned on with auto start and also being turned off, and language corrections (Czech & Slovenian). 2.9 Amended the settings text for a previously Widget only option, and fixed a bug with dereferencing Null. 2.8 Separation release. The application and widget are no longer joined and now have separate source code repositories. The widget version has gained a 5% memory saving and is now in "maintenance only mode" hence will not receive new features, whilst the application version can now take advantage of not being constrained by the widget's memory limitation, which should allow new features to be added in the future. 2.7 Bug fix release: 1. Handling a settings change, 2. Avoid caching a bad menu, 3. Managing bad JSON in menu definitions. 2.6 Added more information reporting to the background service, in addition to the device battery level and charging status, we now include location, location accuracy, and (if supported by your device) the activity information. Note the updates are sent periodically and are not event driven. 2.5 A small memory efficiency of about 1kB by inlining one of the classes. This will aid widgets on old watches that only have 60kB available to an application and are using about 45kB before the menu is fetched, hence 1kB is more significant to those devices. 2.4 Sensor status reporting via Home Assistant 'templates'. This provides a generalised way of viewing the status of any entity as long as the result can be rendered as text, e.g. 'uncovered', 'open', '76%', '21 °C'. Removal of the menu style option. The original style was kept after the introduction of the icon style solely to keep the code for a possible re-use for sensor statuses. This version delivers that new feature, hence the style option has been removed. The new JSON configuration file format allows for the old style to be replicated if you are desperate! Added a feature to provide parameters to actions ('tap' or 'template'). Added a feature to confirm 'toggle' menu items. 2.3 Fix for battery level updates where previously the function only worked for administrator accounts. The new solution is based on Webhooks and is simpler to implement on Home Assistant. Language support fix where an automatic translation produced an inappropriate word, possibly in more than one language. For anything older please visit https://github.com/house-of-abbey/GarminHomeAssistantWidget/blob/main/HISTORY.md.