Garmin Watch Face Template

A simple template for kickstarting a watch face project for products supporting Garmin System 4 (Connect IQ API level 3.2.0) and above.

This template provides a good starting point for easy creation of feature-rich watch faces with support for rendering data in a multitude of different styles. It also enables support for user-selectable settings by provides an easy way of creating an on-device settings menu.

📔 Table of Contents

• 📔 Table of Contents
• 🌟 About the Project
  • 📷 Screenshots
  • 💡 Highlights
• ⚙️ Getting Started
  • 0️⃣ Prerequisites
  • 1️⃣ Install the Connect IQ SDK
    • Quick Reference
      • Linux
      • macOS
      • Windows
  • 2️⃣ Install the Monkey C Visual Studio Code Extension
  • 3️⃣ Create a Garmin Developer Key
  • 4️⃣ Configure and Run the Project
• 👷 Build the Watch Face for a Product
• 📝 License
• 👋 Contributing
• 🚧 Maintainers

🌟 About the Project

📷 Screenshots

💡 Highlights

• A familiar MVC-like architecture
  • The Connect IQ API can be thought of as the model.
  • The components in /source/components/ function as the views.
  • The controllers in /source/controllers/ function as the controllers.
• Easy way of managing user-selectable on-device settings.
• Ability to set a custom updateInterval parameter for components that are not required to be updated on every View.onUpdate() call.

⚙️ Getting Started

0️⃣ Prerequisites

This template is written in Garmin's Monkey C programming language using the Connect IQ API.

1️⃣ Install the Connect IQ SDK

Download and install the Connect IQ SDK manager using instructions from Garmin's Developer Portal. Install the simulator for at least one product that supports System 4 or greater (i.e. fēnix 6 and later).

If you wish to run monkeyc commands from the command line you need to add the Garmin ConnectIQ SDK to your path. You cand find the instructions from Garmin's Monkey C Command Line Setup documentation.

Quick Reference

Linux

export PATH=$PATH:`cat $HOME/.Garmin/ConnectIQ/current-sdk.cfg`/bin

macOS

export PATH=$PATH:`cat $HOME/Library/Application\ Support/Garmin/ConnectIQ/current-sdk.cfg`/bin

Windows

for /f usebackq %i in (%APPDATA%\Garmin\ConnectIQ\current-sdk.cfg) do set CIQ_HOME=%~pi
set PATH=%PATH%;%CIQ_HOME%\bin

2️⃣ Install the Monkey C Visual Studio Code Extension

You can install Monkey C support for Visual Studio Code either from the Visual Studio Marketplace or using the command line.

  code --install-extension Garmin.monkey-c

3️⃣ Create a Garmin Developer Key

Before being able to compile and package applications using the Connect IQ compiler, you must generate a developer key to sign the complied app packages. The key can be generated by opening up Visual Studio Code's Command Palette ⌃ Ctrl/⌘ Command + ⇧ Shift + P and running Monkey C: Generate a Developer Key.

Note: Once prompted to save the developer key, be sure to choose a directory outside of your working directory.

4️⃣ Configure and Run the Project

Clone the project and open it in Visual Studio Code.

  git clone https://github.com/aurpelai/garmin-watchface-template.git
  cd garmin-watchface-template
  code .

Configure manifest.xml to match your requirements for product, language, etc. support.

To run or debug the project, choose either Start Debugging or Run Without Debugging from Visual Studio Code's Run menu.

👷 Build the Watch Face for a Product

🚧 UNDER CONSTRUCTION 🚧

📝 License

Distributed under the MIT License. See LICENSE.txt for more information.

👋 Contributing

Contributions are always welcome! See CONTRIBUTING.md for ways to get started.

🚧 Maintainers

Project Link: https://github.com/aurpelai/garmin-watchface-template

• Antti Urpelainen - @aurpelai
• Juuso Elo-Rauta - @eloraju