Adds watch face support using Watch Face Push #105

garanj · 2025-08-27T12:54:22Z

Adds watch face support using Watch Face Push

This PR adds watch face support using Watch Face Push (WFP). This allows the user to create a customized watch face using their generated bot and transfer it to their watch.

Operation

Owing to the way in which Watch Face Push works, this solution requires a Wear OS app: The Watch Face Push API exists only on the watch, and is the only mechanism for adding dynamically-created watch faces to the watch. Outside of WFP, all watch faces must be published through Play.

Compatibility

The watch face feature requires:

Min SDK version 28: Some of the libraries used (notably validation) require this
A connected Wear OS watch
watchface_feature_enabled remote config flag set to true

If these conditions are met, then on the Customize screen, an additional icon is shown bottom-right, for watch faces. If they are not met, then Androidify simply does not show the feature.

Watch face installation

On the watch face customization modal screen, the details of the connected device is shown. If Androidify is not installed on the watch, then the button launches the Play Store to install it (if it were there, which it isn't right now).

Once installed, the user has the ability to select the watch face they want, and then send to the watch:

The app on the watch automatically starts and received the watch face, which is then installed:

What happens next depends on a few factors:

If Androidify already controls the active watch face, then it can simply replace it with the new one.
If the app has not asked permission before to set the active watch face, then it can do so, and if granted, the new watch face will be set.
Otherwise, the user will need to manually set the watch face, through long-pressing the watch face.

Note: This logic is all WAI as part of Watch Face Push - apps can only call the API to set the active watch face once.

Architecture

Watch Face Creation

For Watch Face Creation, template Watch Face Format watch faces are included in the assets of the app. These templates all reference a bot drawable, which is the image from Androidify. The template resources and the bot image are packaged together into an APK using the Pack library.

Signing and validation

The built APK must be both signed and then validated using the Watch Face Push validation library. This takes place before transmission.

Transfer

The Wear OS Data Layer APIs are used for transferring the APK for installation using Watch Face Push. Notably:

The NodeClient is used to detect connected watches.
The CapabilityClient is used to detect presence or absence of Androidify app on the connected devices.
The MessageClient is used to initiate transfer requests - only one active transfer can take place at a time. MessageClient is used to request go-ahead to send the APK.
The ChannelClient is used to transfer APKs.

The implementation only supports having one connected device. If more than one device is connected to the phone, only one is shown in the Androidify app, prioritizing any that already have the Wear OS Androidify app installed.

Installation

A WearableListenerService-based class is used on the watch to receive and install the watch face using Watch Face Push. This launches any required supporting Activity, to guide the user.

Implementation

:watchface module:
- transfer:
  - WearDeviceRepository - this provides information on:
    - Whether there is a connected Wear OS device
    - Whether that Wear OS device has the Androidify App installed (which is a pre-requisite for watch face transfer)
  - WearAssetTransmitter - this performs the actual transmission of the watch face APK, including:
    - Transmission set up - getting the green light from the receiver to transmit a watch face
    - Actual transmission of the APK file
  - WatchFaceInstallationRepository:
    - Combines:
      - Packaging up the APK in advance, using WatchFaceCreator
      - WearDeviceRepository
      - WearAssetTransmitter
    - Into a single repository for use in the main Androidify app to handle the end-to-end journey of sending a watch face.
- creator:
  - Contains WatchFaceCreator for creating and signing watch face APKs
  - Contains the template watch face, in assets as exported from Watch Face Designer
:wear module
- Contains the Wear app itself, including AndroidifyDataListenerService which receives requests to initiate watch face transfer over the data layer.
:wear:watchface module
- This is the default watch face included in the Wear OS app: If no watch face has been transferred yet, this is the watch face that will be present as it is installed at the time of Wear OS app installation (and provides another launch point into Androidify on the phone)

Versioning

The PR also proposes a single source for versionCode in Androidify: The Wear OS implementation requires a separate app, with the same package name. This needs to have a separate version code, and ideally a separate version code "space". The single source for versionCode in Versions.kt ensures that both apps increment their version code but do not clash.

gemini-code-assist

Summary of Changes

Hello @garanj, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces comprehensive watch face support to the Androidify application, enabling users to create and transfer personalized watch faces featuring their generated bots directly to Wear OS devices. The implementation integrates with the Watch Face Push API, necessitating a companion Wear OS app to manage the creation, signing, validation, and transfer of watch face APKs. This new functionality enhances user customization options and streamlines the process of applying unique designs to smartwatches.

Highlights

Watch Face Customization: The Androidify app now supports creating and transferring customized watch faces to Wear OS devices, allowing users to personalize their smartwatches with their unique bot creations.
Watch Face Push API Integration: The integration leverages the Watch Face Push API, enabling dynamic installation of watch faces directly to the device without requiring separate Play Store publication for each custom design.
Wear OS Companion App: A dedicated Wear OS companion app is now required, as the Watch Face Push API operates directly on the watch. This ensures seamless communication and functionality between the phone and the smartwatch.
Compatibility and Feature Flagging: The feature includes compatibility checks, requiring a minimum SDK version 28, a connected Wear OS watch, and an enabled remote configuration flag (watchface_feature_enabled) to ensure proper operation.
Technical Architecture and Data Transfer: The architecture for watch face creation involves using Watch Face Format templates, the Pack library for APK packaging, and robust signing and validation processes before transfer. Data transfer is handled efficiently via Wear OS Data Layer APIs, including NodeClient, CapabilityClient, MessageClient, and ChannelClient.
Modular Codebase: New modules (:watchface, :wear, :wear:watchface, :wear:common) have been introduced to modularize the codebase, separating concerns related to watch face generation, Wear OS app logic, and common data structures.
Centralized Versioning: A unified versioning strategy has been implemented using Versions.kt to provide a single source of truth for versionCode and versionName, ensuring consistent versioning across both the main Androidify application and its new Wear OS counterpart.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

buildSrc/src/main/kotlin/com/android/developers/androidify/Versions.kt

core/network/src/main/res/xml/remote_config_defaults.xml

gemini-code-assist

Code Review

This pull request adds comprehensive support for creating and transferring custom watch faces to a Wear OS device using Watch Face Push. The changes are well-structured, introducing new modules for watch face creation, data transfer, and the Wear OS app itself. The implementation correctly uses feature flags for the new functionality and centralizes versioning, which is great for maintainability. I have a few suggestions to enhance code safety and maintainability.

...ure/results/src/main/java/com/android/developers/androidify/customize/WatchFaceModalSheet.kt

settings.gradle.kts

riggaroo · 2025-09-01T13:13:07Z

This looks so lovely Garan 👏🏻 Great great job! ❤️

riggaroo · 2025-09-01T13:14:45Z

riggaroo · 2025-09-01T13:15:51Z

Nit: When picking a watch face, can you remove the left and right padding and change it to contentPadding instead so that when you scroll its not visible on each side - it scrolls away?

data/build.gradle.kts

watchface/build.gradle.kts

garanj · 2025-09-02T12:04:41Z

Nit: When picking a watch face, can you remove the left and right padding and change it to contentPadding instead so that when you scroll its not visible on each side - it scrolls away?

Done - that looks much better thanks!

# Conflicts: # feature/results/src/main/java/com/android/developers/androidify/customize/CustomizeExportScreen.kt # feature/results/src/main/java/com/android/developers/androidify/customize/CustomizeExportViewModel.kt # feature/results/src/test/kotlin/com/android/developers/androidify/customize/CustomizeViewModelTest.kt

# Conflicts: # app/build.gradle.kts # feature/results/src/main/java/com/android/developers/androidify/customize/CustomizeExportScreen.kt # feature/results/src/main/java/com/android/developers/androidify/customize/CustomizeExportViewModel.kt # feature/results/src/test/kotlin/com/android/developers/androidify/customize/CustomizeViewModelTest.kt

garanj added 24 commits July 18, 2025 15:39

Moves watch device handling code to the Customize screen

7b8ee69

Moves watch device handling code to the Customize screen

f752870

Merge branch 'android:main' into main

ca1d47a

Adds watch face generation

5c13c97

Merge remote-tracking branch 'upstream/main'

e50c375

Updates for changes in Androidify, plus some refactoring

5b99f9d

Adds watch face generation test

98fb2ba

Merge remote-tracking branch 'upstream/main'

d743027

Moves logo to PNG format

2df44b7

Remove debug statements

d15ef05

Adds comments

eb860dc

Updates strings

6f9c9bb

Remove unused assets

fdf0469

Update standalone flag

d8670d4

Refactors watch face module

ab8e198

Moves Wear activity launch to earlier in receive process

643b89c

Add multiple watch faces

6091986

Updates watch face README

6fcd924

Adds check for timed-out messages

314c61f

Updates watch face transfer UI

78725ee

Update previews

42f20a5

Removes unnecessary text in UI

04f45cd

Adds watch face to remote config

6f990ac

Sets watch face default config to false

ea1cca4

garanj requested review from riggaroo and tiwiz as code owners August 27, 2025 12:54

gemini-code-assist bot reviewed Aug 27, 2025

View reviewed changes

riggaroo reviewed Aug 27, 2025

View reviewed changes

buildSrc/src/main/kotlin/com/android/developers/androidify/Versions.kt Outdated Show resolved Hide resolved

riggaroo reviewed Aug 27, 2025

View reviewed changes

core/network/src/main/res/xml/remote_config_defaults.xml Show resolved Hide resolved

gemini-code-assist bot reviewed Aug 27, 2025

View reviewed changes

...ure/results/src/main/java/com/android/developers/androidify/customize/WatchFaceModalSheet.kt Outdated Show resolved Hide resolved

settings.gradle.kts Show resolved Hide resolved

garanj added 9 commits August 28, 2025 16:17

Fix tests and address comments

b6129ed

Addresses comments, fixes tests

2dedaec

Fix tests

96c559d

Addresses comments

b2275c6

Adds x86 Pack lib

aefdbd6

Sets .so compatibility to API 26

3ab4afc

Update instrumented tests for watch face creation

2ca4699

Update R8 rules

206a42a

Fix dependencies

6ee6f14

riggaroo reviewed Sep 1, 2025

View reviewed changes

data/build.gradle.kts Outdated Show resolved Hide resolved

riggaroo reviewed Sep 1, 2025

View reviewed changes

watchface/build.gradle.kts Outdated Show resolved Hide resolved

garanj added 5 commits September 2, 2025 11:27

Merge remote-tracking branch 'upstream/main'

f9aaa5f

Move bot image to WebP to reduce watch face size

a2ee7e7

Apply spotless

97a3fa0

Addresses comments

77c9e5a

Update to stable Wear Compose

cf4dc2e

garanj added 8 commits September 3, 2025 13:53

Updates padding for watch face screens

cf8ff70

Merge branch 'android:main' into main

348fba7

Apply spotless

45844d5

Fixes test in CustomizeViewModelTest

a786e88

Sync repo and fix tests

efe5c56

Merge remote-tracking branch 'upstream/main'

b3f773a

riggaroo approved these changes Sep 8, 2025

View reviewed changes

garanj merged commit 2dacd90 into android:main Sep 8, 2025
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adds watch face support using Watch Face Push #105

Adds watch face support using Watch Face Push #105

Uh oh!

garanj commented Aug 27, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

Uh oh!

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

Uh oh!

Uh oh!

garanj commented Sep 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Adds watch face support using Watch Face Push #105

Adds watch face support using Watch Face Push #105

Uh oh!

Conversation

garanj commented Aug 27, 2025

Adds watch face support using Watch Face Push

Operation

Compatibility

Watch face installation

Architecture

Watch Face Creation

Signing and validation

Transfer

Installation

Implementation

Versioning

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Footnotes

Uh oh!

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

riggaroo commented Sep 1, 2025

Uh oh!

Uh oh!

Uh oh!

garanj commented Sep 2, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants