UNA Watch SDK

The UNA Watch SDK provides a comprehensive suite of tools, libraries, and interfaces for building high-performance wearable applications. This SDK enables developers to create apps for the UNA Watch platform with support for sensor data, GUI interfaces, file systems, and inter-process communication.

For full setup instructions (Linux/Windows, toolchain, environment variables, and a buildable example), see Docs/sdk-setup.md.

Table of Contents

1. Overview
2. Prerequisites
3. Opening SDK in VSCode
4. Compiling Projects
5. Compiling Examples

Overview

Key Components

• Core Interfaces: Type-safe APIs for system services, communication, and hardware access
• Message System: High-performance inter-process communication (IPC) framework
• Sensor APIs: Simplified access to PPG, IMU, and GNSS sensors
• File System: Multi-volume storage management (Flash, USB, External)
• Build Tools: Automated scripts for compilation and .uapp packaging
• Simulator: Desktop-based environment for rapid prototyping and testing

SDK Project Structure

una-sdk/
├── Libs/
│   ├── Header/SDK/         # Public SDK headers (Interfaces, Messages, Kernel, Simulator, Port, ...)
│   └── Source/             # SDK implementation (incl. Port/TouchGFX and Simulator)
├── ThirdParty/             # Vendored dependencies (TouchGFX, coreJSON, FitSDK, tinycbor)
├── Utilities/Scripts/      # Build, packaging, and tooling scripts
├── Examples/               # Sample reference applications
├── cmake/                  # CMake toolchain and helpers
└── Docs/                   # Documentation and tutorials

High-Level Utilities

The SDK includes several utilities for common tasks:

• GSModel & GSBridge: Type-safe GUI-Service communication
• Glance UI System: Lightweight UI for 240x60 notification area
• SDK::Fit: Native FIT-format file generation
• TrackMapBuilder: GPS track visualization
• Serialization: CBOR and JSON stream readers/writers
• Signal Processing: Filters, queues, timers

Prerequisites

Keep this README high-level; detailed prerequisites, toolchain notes, and environment variables are documented in Docs/sdk-setup.md.

Opening SDK in VSCode

1. Launch VSCode
2. Open the SDK folder: File > Open Folder... and select the SDK directory
3. The workspace will automatically load with the correct configuration
4. VSCode extensions for C/C++, CMake, and ARM development are recommended

Compiling Projects

The SDK supports multiple build systems for different development workflows.

CMake-Based Builds

Recommended for command-line control and flexibility.

Prerequisites

See Docs/sdk-setup.md for the exact toolchain requirements and how to set UNA_SDK.

Building a Project

1. Navigate to the project's CMake directory (e.g., MyApp/Software/Apps/MyApp-CMake/)

2. Configure the build:

   cmake -G "Unix Makefiles" -S . -B build

3. Build the project:

   cmake --build build

4. Clean rebuild:

   rm -rf build
   cmake -S . -B build
   cmake --build build

TouchGFX GUI Builds

For applications with graphical user interfaces.

Prerequisites

• TouchGFX Designer installed
• ARM GCC toolchain
• CMake (for integrated builds)

Building TouchGFX Projects

1. Open TouchGFX Designer and load the .touchgfx project file

2. Generate code:

   • Click Generate Code in TouchGFX Designer
   • This creates C++ files in the generated/ directory

3. Build using CMake (integrated):

   cd TouchGFX-GUI/
   cmake -G "Unix Makefiles" -S . -B build
   cmake --build build

4. Or build directly in TouchGFX Designer:

   • Use the built-in simulator for testing
   • Export for target hardware

Compiling Examples

The SDK includes several example applications demonstrating different features, all built with CMake.

Available Examples

• Alarm: Basic alarm functionality
• Cycling: Activity tracking with GPS
• GlanceARHR: Glance interface for heart rate
• GlanceHR: Simple heart rate display
• GlanceSteps: Step counter glance
• Hiking: Full activity app with TouchGFX GUI
• HRMonitor: Heart rate monitoring
• Running: Running activity tracker

Compiling Examples with CMake

Each example is built from its *-CMake directory. For a complete walkthrough, follow the Alarm CMake example in Docs/sdk-setup.md.

Compiling TouchGFX Examples

For examples with GUI components like Hiking:

1. Open TouchGFX Designer:

   cd SDK/Examples/Apps/Hiking/Software/Apps/TouchGFX-GUI
   # Launch TouchGFX Designer and open HikingGUI.touchgfx

2. Generate code in TouchGFX Designer

3. Build the complete app (service + GUI) with CMake:

   cd SDK/Examples/Apps/Hiking/Software/Apps/Hiking-CMake
   cmake -G "Unix Makefiles" -S . -B build
   cmake --build build

   The .uapp package is produced automatically via post-build scripts.

Common Build Issues

• Missing UNA_SDK: Ensure the environment variable is set
• Toolchain not found: Verify ARM GCC is in PATH
• CMake errors: Clean build directory and reconfigure
• TouchGFX issues: Regenerate code after Designer changes
• Merge failures: Check icon files exist and APP_ID is unique

Next Steps

• Explore the SDK Setup Guide for detailed workflows
• Read the Platform Overview for architecture details
• Try building the Alarm App Tutorial
• Read Host Unit Testing for SDK/app host-side tests
• Join the community at UNAWatch/una-sdk

For additional support, see the Community Support guide.

License

UNA Watch Ltd's own source code in this repository is released under the MIT License — see LICENSE.

Third-party components vendored under ThirdParty/ (TouchGFX, coreJSON, tinycbor) are licensed separately under their own terms and are not covered by the MIT license — see THIRD-PARTY-LICENSES.md.

Trademark

"UNA", "UNA Watch", and the UNA logo are trademarks of UNA Watch Ltd. The MIT license covers the source code only and grants no rights to the UNA name or logos — see TRADEMARK.md.