🤖 WearOS Quick Start
Add Professional Rotation to Your WearOS App in 5 Minutes
-
1Get API Key
-
2Install SDK
-
3Initialize
Step 1: Get Your API Key ⏱ 2 minutes
- Visit rotationkit.com/portal
- Sign up with your email
- Click "Create API Key"
- Choose:
- Name: "My WearOS App"
- Type: Developer (free for testing) or Production
- Platform: WearOS
- Copy your API key (starts with
rk_dev_wearos_orrk_live_wearos_)
Developer API keys never expire and have no usage limits. Perfect for prototyping and testing!
Step 2: Add RotationKit to Your Project ⏱ 2 minutes
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:
- Go to: https://github.com/settings/tokens
- Click "Generate new token (classic)"
- Select permission:
read:packages - Copy your token:
ghp_xxxx...
2. Add credentials to ~/.gradle/gradle.properties:
gpr.user=YOUR_GITHUB_USERNAME
gpr.key=ghp_xxxxxxxxxxxxxxxxxxxx
Add Repository & Dependency
Add to your project root build.gradle.kts:
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:
dependencies {
implementation("com.rotationkit.wearos:sdk-unified:1.0.0")
}
Step 3: Initialize RotationKit ⏱ 2 minutes
In your MainActivity:
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:
View Your Analytics
- Go to rotationkit.com/portal
- See real-time usage:
- Total sessions
- Rotation events
- Mode preferences
- Device distribution
User Controls
Rotation Modes:
- Manual Live: Touch & drag in circular motion to rotate
- Manual Locked: Rotation fixed in place
- Auto: Standard fixed orientation
Mode Toggle:
- Long press (600ms) anywhere → Cycles through modes
- Visual ring appears during adjustment
Preset Configurations
Choose the best config for your app:
// 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:
- Usage analytics in your portal
- License validation for production
- Telemetry and error tracking
Development keys are free and never expire.
What data is collected?
Only anonymous usage analytics:
- Session duration
- Rotation mode changes
- Rotation angle changes
- Device model and OS version
No personal data is ever collected.
How do I upgrade to production?
- Get a production license at rotationkit.com/pricing
- Create a new Production API key in the portal
- Replace your dev key with the production key
- Deploy!
Next Steps
Customize Your Integration:
- Read the full documentation for advanced features
- View API reference for all configuration options
- Join our Discord for support
Optimize User Experience:
- Add haptic feedback on mode change
- Show current rotation angle in UI
- Add settings for wrist side selection
- Display mode indicator
Support
Need help? We're here for you:
- 📧 Email: support@rotationkit.com
- 💬 Discord: discord.gg/rotationkit
- 📚 Docs: Full Documentation
Built for WearOS developers who value simplicity ⚡
© 2025 RotationKit. All rights reserved.