GarminWatchfaces/README.md

21 lines
1.9 KiB
Markdown
Raw Normal View History

2024-11-15 14:02:03 +01:00
# My Garmin Watchfaces
This repository contains a few Garmin watchface apps I made for personal use. They are very specific and not very customizable, so I highly recommend the excellent [Watchface Builder](https://garmin.watchfacebuilder.com/) app instead.
However, I wanted some customizations that the Watchface Builder could not provide, as well as some experience developing for the watch myself. I'm sharing the code as a starting point or reference for your own versions.
If you want to use this code, do note that I did not include some of the assets used (such as background images) for privacy reasons. They are listed in .gitignore.
## Notes for NixOS
I created the included shell.nix to be able to run the Garmin Connect SDK on NixOS. At the time of writing the most recent SDK is Connect IQ 7.3.1 (September 2024). Newer versions may require tweaks to the library dependencies.
You will need to have ```programs.nix-ld.enable = true;``` in your configuration.nix somewhere. Run ```nix-shell``` in this folder to get a shell to be able to run the ```sdkmanager``` which you can download from the [Garmin developer site](https://developer.garmin.com/connect-iq/sdk/).
Note: at least on my KDE Plasma 6 Wayland environment, the login form you need to fill when running for the first time does not size properly. With a bit of effort (I recommend just tabbing on the keyboard) you can get focus to the username and password fields. They were practically zero width for me so you can't see what you are entering and I recommend pasting the values, hoping for the best and pressing Enter.
For debugging I have not yet been able (nor really tried that hard) to get VS Code to start the simulator succesfully. An easy workaround is to open a separate nix-shell to run it beforehand, the VS Code debugger will connect to it just fine.
```nix-shell --run ~/.Garmin/ConnectIQ/Sdks/connectiq-sdk-lin-7.3.1-2024-09-23-df7b5816a/bin/simulator```