Google is committed to advancing racial equity for Black communities. See how.

Exposing data to watch face complications on Wear OS

This codelab will teach you how to build a complication data provider.

Concepts and setup

At the end of the codelab, you will understand how to provide your data to watch face complications on Wear OS.

Concepts

A complication is a feature of a watch face beyond hours and minutes. As an example, the watch face on the image below contains four complications.

a88ce76afbff6504.jpeg

The Complications API is meant for both watch faces and data provider apps:

  • Complication data providers supply data, e.g., battery-level, weather, step-count, etc.
  • Watch face developers can display that data in a complication on their watch face
  • The user selects which data providers they want for their complications

Screen Shot 2016-05-17 at 5.14.50 PM.png

In this code lab, we cover creating a complication data provider. If you are also interested in adding complications to a watch face, check out our other code lab, " Adding Complications to your Watch Face".

Let's get started!

Clone the starter project repo

To help you get started quickly, we have prepared a project for you to build on. It contains some basic code and application settings necessary for the code lab.

If you have Git installed, run the command below. (You can check if Git is installed by typing git --version in the terminal / command line and verify that it executes correctly.):

 git clone https://github.com/googlecodelabs/data-providers.git

If you do not have Git, you can download the project as a zip file:

Download Zip

Import the project

Start Android Studio and select "Open an existing Android Studio project" from the Welcome screen. Open the project directory and double-click the build.gradle file in the data-providers directory:

f7a69f8811ca2f2f.png

After the project has loaded, you may see an alert saying, "Unregistered VCS root detected". Click "Ignore" or the "X" in the upper-right corner. (You won't be pushing any changes back to the Git repo.)

In the upper-left corner of the project window, if you are in the Android view, you should see a set of folder icons similar to those in the screenshot below. (If you are in the Project view, expand the data-provider project to see the set of folder icons.)

f1340e45b0c24a4b.png

There are two folder icons. They both represent a module. Please note that Android Studio might take several seconds to compile the project in the background for the first time. During this time you will see a spinner in the status bar at the bottom of Android Studio:

27f04b5598a2f95e.png

Wait until the processes have finished before making code changes, to allow Android Studio to pull in all the necessary components. In addition, if you get a prompt saying, "Reload for language changes to take effect?" or something similar, select "Yes".

Understand the starter project

You're set up and ready to start exposing your data to complications. We'll begin with the base module. You will add code from each step to base.

You can use the complete module in the codelab as a reference point to check your work (or as a reference if you encounter an issue).

Overview of key components for data providers

  • ComplicationTapBroadcastReceiver - The class used to update our complication data through a PendingIntent.
  • CustomComplicationProviderService - The class used to expose our data to complications. The file is in the directory base/java/com/example/android/wearable/complicationsdataprovider. In Android Studio, this is located under base/java/com.example.android.wearable.complicationsdataprovider. Within the class, we will mainly work on three methods:
  • onComplicationActivated - Called when a complication has been activated with your data.
  • onComplicationUpdate - The majority of our work will be in this method. This method is called whenever an active complication needs updated data from your provider.
  • onComplicationDeactivated - Called when the complication has been deactivated.

Emulator setup

If you need help setting up a Wear OS emulator, please refer to the "Launch the emulator and run your Wear app" section of the "Creating and Running a Wearable App" page.

Run the starter project

Let's run the app on a watch.

  • Connect your Wear OS device or start an emulator.
  • In the toolbar, select the "base" configuration from the drop-down selector and click the green triangle (Run) button next to it:

691529d65aa5e2d6.png

  • If you get an error like the one below (Error Launching activity), change the default launch Activity (instructions below). 6ea74bcba8278349.png

Conversely, if prompted for the Activity to use when launching the app, choose "Do not launch Activity".

  • To change the default launch Activity (if necessary, from previous step), click the drop-down selector to the left of the green arrow and click "edit configurations".

1e3e1dc73655ccd8.png

Select "base" and you will see a window similar to the one below. Select "Nothing" under the Launch Options section and click Run. Later, if you want to try launching the other module, you will need to do this as well.

c3985e3bb68cf5f0.png

  • Select your Android device or emulator and click OK. This will install the service on the Wear OS device or emulator.
  • After a couple of seconds, your service is built and ready to deploy. You will see a spinner in the status bar at the bottom of Android Studio.
  • If it is not already at the "Build" tab at the bottom-left of Android Studio, select that tab and you can see the installation progress. At the end of the installation process, you should see the message "Build: completed successfully".

5ea92276833c0446.png

Please note, since this is the first time you are running this watch face, you will need to select it from "Add more watch faces". After it has been selected once, it will show up as one of the options alongside this option.

  • Choose a watch face that lets you select a complication. In our case, we chose Elements Digital but that might not be available on your watch.

a5cf2c605206efe2.png

  • Now you should be centered on your chosen watch face in the Favorite menu (see image below). Click on the gear icon at the bottom.

f17fb6b4cfe06182.png

  • Select Data.

aef4fca32751a15a.png

  • Select any position, that is, any "+" (complication).

461f8a704fbc6496.png

  • Finally, scroll down and select the service Complications Data Provider Codelab. (After you select it, you may need to swipe left several times or palm the device to exit.)

b0992ba176d86c3b.png

  • In your output, you should see both "onComplicationActivated()" and "onComplicationUpdate()" log messages (though nothing will show in the complication location).
  • If you do not see the log messages, try deploying the watch face again by pressing the green triangle button in the toolbar.
  • If you aren't familiar with how to see Log data, click the tab at the bottom of Android Studio labeled "6: Logcat". Set the dropdowns to your device/emulator and the package name, com.example.android.wearable.complicationsdataprovider (a screenshot is below).

android-monitor-help.png

"But wait! Nothing is being displayed in the data slot I selected!" Don't worry, we aren't supplying any data yet. We will add this in the next step.

On some watches, the Elements Watch Face has complications enabled, so you might see a populated complication on your watch. Also, don't worry if your emulator has a cloud with a strikethrough in place of the airplane icon. We will not need a connection to a phone or the internet for this code lab.

52da39817e329e7a.png

Summary

In this step you've learned about:

  • Wear OS and the concepts behind exposing data to complications
  • The basics of our starting point (base module)
  • Deploy and run a watch face

Next up

Let's start exposing some data.

Code step 2

In this step, we will start exposing data. Complications accept several types of data. In this step, we will return the Short Text data type.

If at any point you are confused by the concepts discussed here, please refer to the complete module and see how these steps may be implemented.

Specifying the data types your provider supports

Open the AndroidManifest.xml file and look at the service CustomComplicationProviderService. Notice the intent-filter:

<action android:name=
    "android.support.wearable.complications.ACTION_COMPLICATION_UPDATE_REQUEST"/>

This tells the system that your service extends ComplicationProviderService and can send data for complications.

Next is the meta-data element specifying the data type(s) we support. In this case, we support SMALL_IMAGE, but for this step, change that to SHORT_TEXT. Change your first meta-data element to the following:

<meta-data
    android:name="android.support.wearable.complications.SUPPORTED_TYPES"
    android:value="SHORT_TEXT"/>

Exposing your data

As stated earlier, onComplicationActivated() is called when your data provider is activated. This is a good place/time to perform any basic setup that needs to be done once per activation.

However, onComplicationUpdate()is where the active complication requests updated data.

The method onComplicationUpdate() is triggered for various reasons:

  • An active watch face complication is changed to use this provider
  • A complication using this provider becomes active
  • You triggered an update from your own class via the ProviderUpdateRequester.requestUpdate() method
  • The period of time you specified in the manifest has elapsed

Open CustomComplicationProviderService.kt and move the cursor down to the onComplicationUpdate() method. Copy and paste the code below under the initial Log.d() call:

// Used to create a unique key to use with SharedPreferences for this complication.
val thisProvider = ComponentName(this, javaClass)

// Retrieves your data, in this case, we grab an incrementing number from SharedPrefs.
val preferences = getSharedPreferences(
   ComplicationTapBroadcastReceiver.COMPLICATION_PROVIDER_PREFERENCES_FILE_KEY,
   0
)
val number = preferences.getInt(
   ComplicationTapBroadcastReceiver
       .getPreferenceKey(thisProvider, complicationId), 0
)
val numberText = String.format(Locale.getDefault(), "%d!", number)

In this case, we are getting a stored int in a SharedPreference that represents our data. This could easily be a call to your database.

We also convert it to a simple string in preparation for converting it to a ComplicationData object.

Next we need to convert the data into a type the complication understands. In this case, we are converting it into the SHORT_TEXT data type.

A given data type may include different sets of fields. For example, SHORT_TEXT may be just a single piece of text, or a title and text, or an icon and text.

For our case, we are only setting the required field and no optional fields. To learn more about these types and fields, review our documentation.

Copy and paste the code below under the new code you added earlier to retrieve our integer in the same method.

val complicationData = when (dataType) {
   ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
       .Builder(ComplicationData.TYPE_SHORT_TEXT)
       .setShortText(ComplicationText.plainText(numberText))
       .build()
   else -> {
       if (Log.isLoggable(TAG, Log.WARN)) {
           Log.w(TAG, "Unexpected complication type $dataType")
       }
       null
   }
}

You may ask why we are using a when statement to create the data. Later, we will support various forms of the data based on the type the system is requesting. By using a when statement now, we can easily add new data types (LONG_TEXT, RANGED_VALUE, etc.) later.

Finally, now that we have the data in the right format, we must send the new data to the system. Copy and paste the following code after the code above.

if (complicationData != null) {
   complicationManager.updateComplicationData(complicationId, complicationData)
} else {
   // If no data is sent, we still need to inform the ComplicationManager, so the update
   // job can finish and the wake lock isn't held any longer than necessary.
   complicationManager.noUpdateRequired(complicationId)
}

Your final method should look like this:

override fun onComplicationUpdate(
   complicationId: Int,
   dataType: Int,
   complicationManager: ComplicationManager
) {
   Log.d(TAG, "onComplicationUpdate() id: $complicationId")

   // Used to create a unique key to use with SharedPreferences for this complication.
   val thisProvider = ComponentName(this, javaClass)

   // Retrieves your data, in this case, we grab an incrementing number from SharedPrefs.
   val preferences = getSharedPreferences(
       ComplicationTapBroadcastReceiver.COMPLICATION_PROVIDER_PREFERENCES_FILE_KEY,
       0
   )
   val number = preferences.getInt(
       ComplicationTapBroadcastReceiver
           .getPreferenceKey(thisProvider, complicationId), 0
   )
   val numberText = String.format(Locale.getDefault(), "%d!", number)
   val complicationData = when (dataType) {
       ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
           .Builder(ComplicationData.TYPE_SHORT_TEXT)
           .setShortText(ComplicationText.plainText(numberText))
           .build()
       else -> {
           if (Log.isLoggable(TAG, Log.WARN)) {
               Log.w(TAG, "Unexpected complication type $dataType")
           }
           null
       }
   }
   if (complicationData != null) {
       complicationManager.updateComplicationData(complicationId, complicationData)
   } else {
       // If no data is sent, we still need to inform the ComplicationManager, so the update
       // job can finish and the wake lock isn't held any longer than necessary.
       complicationManager.noUpdateRequired(complicationId)
   }
}

Run the app again

In the first step, you learned to install your complication data service on your device or emulator. Now it's time to do that again! Install your app and reselect the complication, i.e., swipe the watch face, select the gear, navigate to the same complication, and select the Complications Data Provider Codelab. You should see something like this:

caae484f1f2508fd.png

Summary

In this step you've learned:

  • How to specify the data types your provider can support
  • How often your data should be requested when an active complication is using it
  • Where to expose your data to Wear OS

Next up

Let's try supporting a different data type.

Code step 3

In this step, we will trigger updates in the data when the user taps our complication.

If at any point you are confused by the concepts discussed here, please refer to the complete module and see how these steps may be implemented.

Specifying how often the complication should refresh your data

Open the AndroidManifest.xml file and look again at the service CustomComplicationProviderService.

Notice an UPDATE_PERIOD_SECONDS field in the meta-data element. This specifies how often you want the system to check for updates to the data when your data provider is active.

Right now, it is set to 600 seconds (10 minutes). If you are using UPDATE_PERIOD_SECONDS, we recommend setting updates in order of minutes. Note that this value is only guidance for the system. Wear OS may update less frequently.

A better approach is a "push style" where we tell the system only when the data has changed.

Change the update frequency from 600 to 0, since we will be telling the system only when data has changed. Note that the meta-data is a requirement.

<meta-data
    android:name="android.support.wearable.complications.UPDATE_PERIOD_SECONDS"
    android:value="0"/>

Informing the system that new complication data is available

Open ComplicationTapBroadcastReceiver.kt. This BroadcastReceiver class updates our complication data when it's triggered. (Remember we are just saving the data to a SharedPreference.)

The class also offers several helper methods that construct a PendingIntent (triggers it as a BroadcastReceiver) and create unique preference keys for our complication (used with SharedPreference).

Right now, it only updates the integer in SharedPreference. We need to tell our complication that the data has been updated.

Move to the bottom of the onReceive() method. Copy and paste the code below the edit() call.

// Request an update for the complication that has just been tapped.
val requester = ProviderUpdateRequester(context, provider)
requester.requestUpdate(complicationId)

This instructs Wear OS that our complication's data has been updated. We need three pieces of data for this to work:

  • context - Context is available as an argument for this method: onReceive().
  • provider - The ComponentName of your complication is passed in as an Extra from the PendingIntent that triggers this BroadcastReceiver.
  • complicationId - The unique integer assigned by a watch face for the complication location. The int is passed in as an Extra from the PendingIntent that triggers this BroadcastReceiver.

We are done with this step and your final method should look like this:

override fun onReceive(context: Context, intent: Intent) {
   val extras = intent.extras ?: return
   val provider = extras.getParcelable<ComponentName>(EXTRA_PROVIDER_COMPONENT) ?: return
   val complicationId = extras.getInt(EXTRA_COMPLICATION_ID)

   // Retrieve data via SharedPreferences.
   val preferenceKey = getPreferenceKey(provider, complicationId)
   val sharedPreferences =
       context.getSharedPreferences(COMPLICATION_PROVIDER_PREFERENCES_FILE_KEY, 0)
   var value = sharedPreferences.getInt(preferenceKey, 0)

   // Update data for complication.
   value = (value + 1) % MAX_NUMBER
   sharedPreferences.edit { putInt(preferenceKey, value) }

   // Request an update for the complication that has just been tapped.
   val requester = ProviderUpdateRequester(context, provider)
   requester.requestUpdate(complicationId)
}

Adding a tap action to our complication

Our BroadcastReceiver not only updates the data but also informs the system that new data is available (see the previous step). We need to add a tap action to our complication to trigger the BroadcastReceiver.

Open CustomComplicationProviderService.kt and move down to the onComplicationUpdate() method.

Find this line of code (the first couple of lines of the onComplicationUpdate() method).

val thisProvider = ComponentName(this, javaClass)

Recall from the previous step that this was one of the pieces of data our BroadcastReceiver needed to inform the system that our complication had new data. The other piece of data is the complication ID, which is passed into this method. We need to create a PendingIntent that passes both those values along an Extra.

Luckily, ComplicationTapBroadcastReceiver provides this as a helper method.

Copy and paste the code below under the line of code you found earlier:

// We pass the complication id, so we can only update the specific complication tapped.
val complicationPendingIntent =
   ComplicationTapBroadcastReceiver.getToggleIntent(
       this, thisProvider, complicationId
   )

Next we need to assign the PendingIntent to the tap event for our complication.

Find the when statement and replace the case for ComplicationData.TYPE_SHORT_TEXT with the code below.

ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
   .Builder(ComplicationData.TYPE_SHORT_TEXT)
   .setShortText(ComplicationText.plainText(numberText))
   .setTapAction(complicationPendingIntent)
   .build()

This only adds one line, the .setTapAction() method which assigns our new PendingIntent to the tap action for the complication.

We are done with this step. Your final method should look like this:

override fun onComplicationUpdate(
   complicationId: Int,
   dataType: Int,
   complicationManager: ComplicationManager
) {
   Log.d(TAG, "onComplicationUpdate() id: $complicationId")

   // Create Tap Action so that the user can trigger an update by tapping the complication.
   val thisProvider = ComponentName(this, javaClass)
   // We pass the complication id, so we can only update the specific complication tapped.
   val complicationPendingIntent =
       ComplicationTapBroadcastReceiver.getToggleIntent(
           this, thisProvider, complicationId
       )

   // Retrieves your data, in this case, we grab an incrementing number from SharedPrefs.
   val preferences = getSharedPreferences(
       ComplicationTapBroadcastReceiver.COMPLICATION_PROVIDER_PREFERENCES_FILE_KEY,
       0
   )
   val number = preferences.getInt(
       ComplicationTapBroadcastReceiver
           .getPreferenceKey(thisProvider, complicationId), 0
   )
   val numberText = String.format(Locale.getDefault(), "%d!", number)
   val complicationData = when (dataType) {
       ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
           .Builder(ComplicationData.TYPE_SHORT_TEXT)
           .setShortText(ComplicationText.plainText(numberText))
           .setTapAction(complicationPendingIntent)
           .build()
       else -> {
           if (Log.isLoggable(TAG, Log.WARN)) {
               Log.w(TAG, "Unexpected complication type $dataType")
           }
           null
       }
   }
   if (complicationData != null) {
       complicationManager.updateComplicationData(complicationId, complicationData)
   } else {
       // If no data is sent, we still need to inform the ComplicationManager, so the update
       // job can finish and the wake lock isn't held any longer than necessary.
       complicationManager.noUpdateRequired(complicationId)
   }
}

Run the app again

Install your app and reselect the complication, i.e., swipe the watch face, select the gear, navigate to the same complication, and select the Complications Data Provider Codelab provider. You should see the same thing as you saw before. However, now you can tap the complication and the data will be updated.

a9d767e37161e609.png

Summary

In this step you've learned:

  • How to inform the system that your complication data has been updated
  • How to tie a PendingIntent to a tap action on your complication

Next up

Let's try supporting a different data type.

Code step 4

As we expose our data to complications, it might be nice to support more types of data, and to see what different data types look like in complications.

Specifying a different supported data type

Open the AndroidManifest.xml file again and look at the declaration of the service CustomComplicationProviderService.

Change the meta-data element SUPPORTED_TYPES from SHORT_TEXT to LONG_TEXT. Your change should look like this:

<meta-data
    android:name="android.support.wearable.complications.SUPPORTED_TYPES"
    android:value="LONG_TEXT"/>

Adding support for LONG TEXT

Open CustomComplicationProviderService.kt, move down to the when statement in the onComplicationUpdate() method, and add the following code below the end of the TYPE_SHORT_TEXT case and above the default case.

ComplicationData.TYPE_LONG_TEXT -> ComplicationData
   .Builder(ComplicationData.TYPE_LONG_TEXT)
   .setLongText(ComplicationText.plainText("Number: $numberText"))
   .setTapAction(complicationPendingIntent)
   .build()

The when statement should look something like this:

val complicationData = when (dataType) {
   ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
       .Builder(ComplicationData.TYPE_SHORT_TEXT)
       .setShortText(ComplicationText.plainText(numberText))
       .setTapAction(complicationPendingIntent)
       .build()
   ComplicationData.TYPE_LONG_TEXT -> ComplicationData
       .Builder(ComplicationData.TYPE_LONG_TEXT)
       .setLongText(ComplicationText.plainText("Number: $numberText"))
       .setTapAction(complicationPendingIntent)
       .build()
   else -> {
       if (Log.isLoggable(TAG, Log.WARN)) {
           Log.w(TAG, "Unexpected complication type $dataType")
       }
       null
   }
}

You may have noticed that we are simply repackaging the same data in a new format. Let's see how it looks.

How to check your progress and debug

Install your service, but this time choose the bottom slot complication before choosing your complication service provider:

518b646d3c3f3305.png

You should see something like the image below. Note that each complication is stored under a separate key, so you might see different values if you have set the complication in multiple locations:

17ec0506f1412676.png

Summary

In this step you've learned about:

  • Changing and supporting different complication data types

Next up

We want to support one extra data type before putting it all together.

Code step 5

While we expose our data to complications, let's continue exploring how to support more types of data.

Specifying a different supported data type

Open the AndroidManifest.xml file again and take a look at the service CustomComplicationProviderService.

Change the meta-data element SUPPORTED_TYPES to RANGED_VALUE. Your change should should look like this:

<meta-data
    android:name="android.support.wearable.complications.SUPPORTED_TYPES"
    android:value="RANGED_VALUE"/>

Adding support for RANGED VALUES

Ranged values can not only show text but also display a visual showing how far your value is between the minimum and maximum value. This type of complications is good for showing how much battery is left on the device or how many steps you have left to meet your goal.

1fe1943a5ad29076.png

Open CustomComplicationProviderService.kt, move your cursor down to the when statement in the onComplicationUpdate() method, and add this code under the TYPE_LONG_TEXT case and above the default case:

ComplicationData.TYPE_RANGED_VALUE -> ComplicationData
   .Builder(ComplicationData.TYPE_RANGED_VALUE)
   .setValue(number.toFloat())
   .setMinValue(0f)
   .setMaxValue(ComplicationTapBroadcastReceiver.MAX_NUMBER.toFloat())
   .setShortText(ComplicationText.plainText(numberText))
   .setTapAction(complicationPendingIntent)
   .build()

Your when statement should look like this:

val complicationData = when (dataType) {
   ComplicationData.TYPE_SHORT_TEXT -> ComplicationData
       .Builder(ComplicationData.TYPE_SHORT_TEXT)
       .setShortText(ComplicationText.plainText(numberText))
       .setTapAction(complicationPendingIntent)
       .build()
   ComplicationData.TYPE_LONG_TEXT -> ComplicationData
       .Builder(ComplicationData.TYPE_LONG_TEXT)
       .setLongText(ComplicationText.plainText("Number: $numberText"))
       .setTapAction(complicationPendingIntent)
       .build()
   ComplicationData.TYPE_RANGED_VALUE -> ComplicationData
       .Builder(ComplicationData.TYPE_RANGED_VALUE)
       .setValue(number.toFloat())
       .setMinValue(0f)
       .setMaxValue(ComplicationTapBroadcastReceiver.MAX_NUMBER.toFloat())
       .setShortText(ComplicationText.plainText(numberText))
       .setTapAction(complicationPendingIntent)
       .build()
   else -> {
       if (Log.isLoggable(TAG, Log.WARN)) {
           Log.w(TAG, "Unexpected complication type $dataType")
       }
       null
   }
}

Again, we are just repackaging the same data in a new format. Let's see how it looks.

How to check your progress and debug

Install your service, and choose another location.

461f8a704fbc6496.png

You should now see something like this:

ffa6ea8f2ed3eb2a.png

You can see a radial circle around the number that highlights the equivalent of 5/20.

Summary

In this step you've learned about:

  • Changing and supporting different complication data types

Next up

We wrap up the code lab by enabling all the data type variations.

Code step 6

Now our complication data provider supports three variations of our data (RANGED_VALUE, SHORT_TEXT, and LONG_TEXT).

In this last step, we will inform the system we support all three variations.

Specifying multiple supported data types

Open the AndroidManifest.xml file again and look at the service CustomComplicationProviderService.

Change the meta-data element SUPPORTED_TYPES to RANGED_VALUE,SHORT_TEXT,LONG_TEXT. Your change should now look like this:

<meta-data
    android:name="android.support.wearable.complications.SUPPORTED_TYPES"
    android:value="RANGED_VALUE,SHORT_TEXT,LONG_TEXT"/>

Check your progress

Install your service.

b3a7c0c8063c2f60.png

In this case, the watch face prefers the ranged data type over the short and long types, but if the complication only supported the short text type, the data would still show up because the watch face supports all three data types. Keep in mind the watch face itself specifies the data types that a complication supports, and the order of preference of those types.

Summary

In this step you've learned about:

  • Supporting multiple complication data types

There are many more data types you can support in complications (including small images, large images, and icons). Try to extend this code lab by implementing some of those types on your own.

For more details on developing complications for watch faces and creating complication data providers, visit Watch Face Complications

For more details about developing Wear OS watch faces, visit https://developer.android.com/training/wearables/watch-faces/index.html

Also watch these great videos: