Description
** When contacting for support, you must include an email address, or we can't reply. **
Warning! Those who fail to read the copious documentation provided tend to look really silly when making a bad review (and we call you out by reply).
NB. The widget version of this application is available as a separate item in the App Store at https://apps.garmin.com/en-US/apps/559f5174-177f-4f46-b170-f31c7e74dea3 .
A Garmin application to provide a "dashboard" to control your devices via Home Assistant, https://www.home-assistant.io/. The application 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 some things it will always be quicker and simpler to reach for your phone or tablet... or the device's own remote control!
The application 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.
The intended audience for this application are those comfortable with configuring a HomeAssistant (e.g. editing the YAML configuration files) and debugging why URLs don't work. It does not require programming skills, but the menu is configured via JSON which feels like "coding".
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, https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/README.md
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. Check for known issues at https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/README.md#known-issues.
This application 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. Comes with a full money back guarantee ;-) Please be kind and helpful with your feedback! Or better still offer code contributions to the project.
What is new
See https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/HISTORY.md for the full application history.
3.18 Added support for new devices, approachs7243mm, approachs7247mm, enduro4, and marq3.
3.17 Added an option to hide the menu type icons and provide more space for any text to be displayed. With thanks to @KostaMadorsky for this contribution.
3.16 New feature for "select menu" items by @abstractionnl. With this version, any device with ≤ 98,304 bytes of working memory will be unable to take advantage of new features. 5 devices will not get this additional feature, 'descentg1', 'instinct2', 'instinct2s', 'instinct2x', 'instinctcrossover'. Code is being conditionally compiled depending on the device. **Please note: It may prove necessary to drop support for older smaller devices in the future.** Added support for 7 new Fenix 9 devices and an older device, 'descentmk1', who's simulation previously failed.
3.15 The prevention of PIN enabled menu items on non-touch screen devices was improperly implemented, this version provides a bug fix. Added an error message to catch empty responses with insecure HTTP usage.
3.14 Numeric items now support `tap_action.data` fields so service call options like `transition` are catered for. See the documentation on Additional Action Data at https://github.com/house-of-abbey/GarminHomeAssistant/blob/main/examples/Numeric.md#additional-action-data. This features has been provided by @StumblingGamer. Now prevent PIN enabled menu items from being enabled on non-touch screen devices. The PIN must be removed for the menu item to function. Fix for initialising numeric pickers with no user defined template.
3.13 Added support for new devices: d2mach2pro, fr170, fr170m, fr70.
3.12 Amended GPS accuracy values used by the background service.
3.11 Better handling of menus larger than the Glance view can handle. As a result the Glance can no longer verify the availability of the JSON menu as fetching it might cause an "Error: Out Of Memory Error". Provide two user supplied HTTP Headers. Bug fix for the numeric picker.
3.10 Bug avoidance for a fatal "out of memory error" in the glance when caching the menu to Storage. This is now delayed until the main application is opened. Added support for two new devices, D2 Mach 2 and eTrex Touch.
3.9 Small update to warn users with empty menu definitions to read the instructions!
3.8 Added icon for 'numeric' menu items and revised icons in general.
3.7 Bug fix for 'numeric' menu items not working over Wi-Fi & LTE.
3.6 Added 'numeric' menu item type thanks to @thmichel. This allows you to select a numeric value to set for an entity. Confirmations can now display a user supplied message. Schema update to keep pace with HomeAssistant and correct a previous decision.
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 otherwise.
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 for a new automated translations script.
Screenshots
Supported language (1)
Compatible devices (250)
Approach® S50
Approach® S70 (42mm)
Approach® S70 (47mm)
Approach® S72 - 43 mm
Approach® S72 - 47 mm
Captain Marvel
Captain Marvel
D2™ Air
D2™ Air X10
D2™ Air X15
D2™ Delta
D2™ Delta PX
D2™ Delta S
D2™ Mach 1
D2™ Mach 1 Pro
D2™ Mach 2
D2™ Mach 2 Pro
Darth Vader™
Darth Vader™
Descent™ G1
Descent™ G1
Descent™ G2
Descent™ Mk1
Descent™ Mk1
Descent™ MK2
Descent™ MK2
Descent™ Mk2S
Descent™ Mk2S
Descent™ MK3 - 43mm
Descent™ MK3i - 51mm
Edge® 1030
Edge® 1030
Edge® 1030 Plus
Edge® 1030 Plus
Edge® 1030, Bontrager
Edge® 1040
Edge® 1040
Edge® 1050
Edge® 520 Plus
Edge® 520 Plus
Edge® 530
Edge® 530
Edge® 540
Edge® 550
Edge® 820
Edge® 830
Edge® 830
Edge® 840
Edge® 850
Edge® Explore
Edge® Explore 2
Edge® Explore 820
Edge® MTB
Enduro™
Enduro™
Enduro™ 2
Enduro™ 3
Enduro™ 4
epix™ (Gen 2)
epix™ (Gen 2)
epix™ Pro (42mm)
epix™ Pro (47mm)
epix™ Pro (51mm)
eTrex® Touch
fēnix® 5
fēnix® 5
fēnix® 5 Plus
fēnix® 5 Plus
fēnix® 5S
fēnix® 5S
fēnix® 5S Plus
fēnix® 5S Plus
fēnix® 5X
fēnix® 5X
fēnix® 5X Plus
fēnix® 5X Plus
fēnix® 6
fēnix® 6
fēnix® 6 Dual Power
fēnix® 6 Pro
fēnix® 6 Pro
fēnix® 6 Pro Dual Power
fēnix® 6 Pro Solar
fēnix® 6 Solar
fēnix® 6S
fēnix® 6S
fēnix® 6S Dual Power
fēnix® 6S Pro
fēnix® 6S Pro
fēnix® 6S Pro Dual Power
fēnix® 6S Pro Solar
fēnix® 6S Solar
fēnix® 6X Pro
fēnix® 6X Pro
fēnix® 7
fēnix® 7
fēnix® 7 Pro
fēnix® 7 Pro – Solar Edition (No Wi-Fi®)
fēnix® 7S
fēnix® 7S
fēnix® 7S Pro
fēnix® 7X
fēnix® 7X
fēnix® 7X Pro
fēnix® 7X Pro No Wi-Fi
fēnix® 8 AMOLED (43mm)
fēnix® 8 AMOLED (47mm/51mm)
fēnix® 8 Pro
fēnix® 8 Solar (47mm)
fēnix® 8 Solar (51mm)
fenix® 9 - 43 mm
fenix® 9 – 47 mm
fenix® 9 Pro - 43 mm
fenix® 9 Pro - 47 mm
fenix® 9 Pro - 51 mm
fenix® 9 Pro - Solar 47 mm
fenix® 9 Pro - Solar 51 mm
fēnix® Chronos
fēnix® Chronos
fēnix® E
First Avenger
First Avenger
ForeAthlete 245
ForeAthlete 245 Music
ForeAthlete 55
ForeAthlete 645
ForeAthlete 645 Music
ForeAthlete 745
ForeAthlete 935
Forerunner® 165
Forerunner® 165 Music
Forerunner® 170
Forerunner® 170 Music
Forerunner® 245
Forerunner® 245
Forerunner® 245 Music
Forerunner® 245 Music
Forerunner® 255
Forerunner® 255 Music
Forerunner® 255S
Forerunner® 255S Music
Forerunner® 265
Forerunner® 265S
Forerunner® 55
Forerunner® 55
Forerunner® 570 - 42mm
Forerunner® 570 - 47mm
Forerunner® 645
Forerunner® 645 Music
Forerunner® 70
Forerunner® 70
Forerunner® 745
Forerunner® 935
Forerunner® 945
Forerunner® 945
Forerunner® 945 LTE
Forerunner® 955 Dual Power
Forerunner® 965
Forerunner® 970
GPSMAP® 66i
GPSMAP® 66i
GPSMAP® 66s / 66st
GPSMAP® 66sr
GPSMAP® 67
GPSMAP® 67
GPSMAP® H1
Instinct® 2
Instinct® 2
Instinct® 2S
Instinct® 2S
Instinct® 2X
Instinct® 3 – 45 mm, AMOLED
Instinct® 3 – 45 mm, Solar
Instinct® 3 – 50 mm, AMOLED
Instinct® 3 – 50 mm, Solar
Instinct® Crossover
Instinct® Crossover AMOLED
Instinct® E – 40 mm
Instinct® E – 45 mm
MARQ® (Gen 2)
MARQ® Adventurer (Gen 3)
MARQ® Commander (Gen 2) – Carbon Edition
MARQ™ Adventurer
MARQ™ Adventurer
MARQ™ Athlete
MARQ™ Athlete
MARQ™ Aviator
MARQ™ Aviator
MARQ™ Aviator (Gen 2)
MARQ™ Captain
MARQ™ Captain
MARQ™ Commander
MARQ™ Commander
MARQ™ Driver
MARQ™ Driver
MARQ™ Expedition
MARQ™ Expedition
MARQ™ Golfer
MARQ™ Golfer
Mercedes-Benz Venu®
Mercedes-Benz Venu®
Mercedes-Benz Venu® 2
Mercedes-Benz Venu® 2
Mercedes-Benz Venu® 2S
Mercedes-Benz Venu® 2S
Montana 700
Montana® 700
Montana® 710
quatix® 6
quatix® 6X
Rey™
Rey™
tactix® 7
tactix® 7 – AMOLED Edition
tactix® 8 – 47 mm, AMOLED
tactix® 8 – 51 mm, Solar
Venu®
Venu®
Venu® 2
Venu® 2
Venu® 2 Plus
Venu® 2 Plus
Venu® 2S
Venu® 2S
Venu® 3
Venu® 3S
Venu® 4 – 41 mm
Venu® 4 – 45 mm
Venu® Sq.
Venu® Sq.
Venu® Sq.
Venu® Sq.
Venu® Sq. 2
Venu® Sq. 2 Music
Venu® Sq. Music
Venu® Sq. Music
Venu® Sq. Music
Venu® Sq. Music
Venu® X1
vívoactive® 3
vívoactive® 3
vívoactive® 3 Music
vívoactive® 3 Music
vívoactive® 3 Music
vívoactive® 4
vívoactive® 4
vívoactive® 4S
vívoactive® 4S
vívoactive® 5
vívoactive® 6