Wristify - REST api access for Garmin watches
· v0.4.7
About
A widget for Garmin watches to access custom online services through an easy to implement REST API.
--- Full documentation ---
Please checkout https://github.com/schnoellm/wristify-docs-and-api for the full documentation on this watch app.
--- What it is ---
Wristify is a app/widget for Garmin watches and can be downloaded here in the Garmin Store.
It can be installed on supported garmin watches and allows the user to access custom implemented APIs directly from their Garmin smart watch.
--- Possible use cases ---
Possible use cases for Writisfy include:
- Retrieving the shipment status of a parcel
- Requesting the current weather report and forecast
- Checking out gas prices and find the cheapest gas station
- Trigger custom actions for your home automation
- Display current news interpreted from an RSS feed
- Show current webcam images (e.g. for checking weather conditions in the mountains)
The list of use cases is literally endless, as any custom logic can be implemented in the online service and any custom actions may be triggered.
--- How does it work ---
Wristify works in the following way:
- The app needs an appropriate online service, which is implemented by the user and provides a REST API following a certain API specification.
- This online services can be implemented with the help of any programming language, framework or software application.
- The online service can implement any custom logic the user want to offer for the Garmin app to be accessible.
- In order for the app to access the functionality of the online service, the app requires an active network connection to the online service.
--- How to test it ---
There is a sample implementation hosted on vercel.app. The code of this sample is available on GitHub for reference and for starting your own online service (https://github.com/schnoellm/wristify-javascript-sample).
However, you can use the following configuration in your Connect IQ mobile app to test out the Wristify widget on your own:
- Endpoint url: "https://wristify-javascript-sample.vercel.app/api/v1/endpoints"
- Username: "username"
- Password: "password"
Save the configuration and restart the Wristify widget on your watch. You can then try out the sample implementation and check out the possibilities of the Wristify widget.
--- Features ---
Wristify can handle the following responses to be displayed and interacted with:
- Regular text responses to be displayed on the watch
- XY, TY charts and bar charts to be displayed (incl. legend)
- Images to be displayed on the watch or opened on the smartphone
- Custom action responses to select from and trigger custom actions on the online service
--- Limited functionality on watch models ---
Depending on the actual watch model and the available system memory of that particular model, features like the "XY/TY diagrams" and the display of imagesare disabled due to limited system memory. This affects the following models:
- Vivoactive 3
- Venu Square
- Forerunner 55, 245, 645, 935
- Fenix 5, 5s, 6, 6s, chronos
- Instinct crossover, 2, 2s, 2x
--- Trial mode and License key ---
The Wristify app requires a license key to provide all the features and to not be restricted in the count of usable endpoints and response objects.
If run in Trial mode, the available endpoints are limited to a maximum of 2 groups and 3 endpoints each, randomly chosen at every start. Also the response objects of the endpoints is limited to a single randomly chosen object which each call.
You are welcomed to run the app in trial mode or reach out to obtain an license key.
You will find the required device identifier in the Garmin Connect IQ app, when you open the app settings.
Contact me together with the identifier and a short description of your automation ideas and I will be happy to provide you with a license key.
*Especially in the initial phase I'm happy to provide license keys for free, as I don't know yet how the whole project turns out.*