Dashboard →

🤖 WearOS Quick Start

Add Professional Rotation to Your WearOS App in 5 Minutes

Wear OS 3.0+ Version 1.0.0 Kotlin 1.9+
  1. 1
    Get API Key
  2. 2
    Install SDK
  3. 3
    Initialize

Step 1: Get Your API Key ⏱ 2 minutes

  1. Visit rotationkit.com/portal
  2. Sign up with your email
  3. Click "Create API Key"
  4. Choose:
    • Name: "My WearOS App"
    • Type: Developer (free for testing) or Production
    • Platform: WearOS
  5. Copy your API key (starts with rk_dev_wearos_ or rk_live_wearos_)
Development Keys Are Free Forever

Developer API keys never expire and have no usage limits. Perfect for prototyping and testing!

Step 2: Add RotationKit to Your Project ⏱ 2 minutes

Private Beta Access Required

RotationKit WearOS is currently in private beta. You'll need GitHub access credentials.

Get GitHub Access (One-Time Setup)

1. Create GitHub Personal Access Token:

2. Add credentials to ~/.gradle/gradle.properties:

Properties
gpr.user=YOUR_GITHUB_USERNAME
gpr.key=ghp_xxxxxxxxxxxxxxxxxxxx

Add Repository & Dependency

Add to your project root build.gradle.kts:

Kotlin
allprojects {
    repositories {
        google()
        mavenCentral()

        // RotationKit private repository
        maven {
            name = "GitHubPackages"
            url = uri("https://maven.pkg.github.com/joe-corcoran/rotationkit-wearos-sdk")
            credentials {
                username = project.findProperty("gpr.user") as String?
                password = project.findProperty("gpr.key") as String?
            }
        }
    }
}

Add to your app module's build.gradle.kts:

Kotlin
dependencies {
    implementation("com.rotationkit.wearos:sdk-unified:1.0.0")
}

Step 3: Initialize RotationKit ⏱ 2 minutes

In your MainActivity:

Kotlin
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.compose.foundation.layout.*
import androidx.compose.ui.Modifier
import com.rotationkit.wearos.RotationKit
import com.rotationkit.wearos.core.RotationContainer
import com.rotationkit.wearos.core.RotationEngine

class MainActivity : ComponentActivity() {
    private lateinit var rotationEngine: RotationEngine

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        // Initialize RotationKit (paste your API key here)
        rotationEngine = RotationKit.createEngine(
            ctx = this,
            cfg = RotationKit.navigationConfig(),
            deps = RotationKit.Deps(
                telemetryProvider = RotationKit.telemetryProvider(
                    apiKey = "rk_dev_wearos_YOUR_KEY_HERE" // ← Your API key
                )
            )
        )

        setContent {
            MaterialTheme {
                RotationContainer(
                    rotationEngine = rotationEngine,
                    modifier = Modifier.fillMaxSize()
                ) {
                    // Your app content here - users can now rotate it!
                    MyAppScreen()
                }
            }
        }
    }

    override fun onResume() {
        super.onResume()
        rotationEngine.startTracking()
    }

    override fun onPause() {
        super.onPause()
        rotationEngine.stopTracking()
    }
}

🎉 That's It!

Your app now supports:

Manual rotation with circular swipe gestures
Mode switching with long press (600ms)
Three rotation modes: Manual Live, Manual Locked, Auto
Analytics automatically sent to your portal

View Your Analytics

  1. Go to rotationkit.com/portal
  2. See real-time usage:
    • Total sessions
    • Rotation events
    • Mode preferences
    • Device distribution

User Controls

Rotation Modes:

Mode Toggle:

Preset Configurations

Choose the best config for your app:

Kotlin
// Navigation apps (smooth, balanced)
RotationKit.navigationConfig()

// Responsive apps (fast, immediate)
RotationKit.responsiveConfig()

// Stable apps (heavy smoothing)
RotationKit.stableConfig()

// General purpose
RotationKit.defaultConfig()

Common Questions

Do I need an API key?

Yes - API keys enable:

Development keys are free and never expire.

What data is collected?

Only anonymous usage analytics:

No personal data is ever collected.

How do I upgrade to production?

  1. Get a production license at rotationkit.com/pricing
  2. Create a new Production API key in the portal
  3. Replace your dev key with the production key
  4. Deploy!

Next Steps

Customize Your Integration:

Optimize User Experience:

  • Add haptic feedback on mode change
  • Show current rotation angle in UI
  • Add settings for wrist side selection
  • Display mode indicator
Read Full Documentation →

Support

Need help? We're here for you:

Built for WearOS developers who value simplicity

© 2025 RotationKit. All rights reserved.