⌚ WatchOS Quick Start
Add Intelligent Screen Rotation to Your Apple Watch App in 5 Minutes
Swift 5.7+
watchOS 9.0+
Version 1.0.0
-
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 watchOS App"
- Type: Developer (free for testing) or Production
- Platform: WatchOS
- Copy your API key (starts with
rk_dev_watchos_orrk_live_watchos_)
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 ⏱ 1 minute
Option A: Swift Package Manager (Xcode)
- Open your Xcode project
- File → Add Package Dependencies
- Enter:
https://github.com/rotationkit/RotationKit.git - Click "Add Package"
- Select your watchOS target
Option B: Package.swift
Swift
dependencies: [
.package(url: "https://github.com/rotationkit/RotationKit.git", from: "1.0.0")
]
Step 3: Initialize RotationKit ⏱ 2 minutes
In your main watch view:
Swift
import SwiftUI
import RotationKit
struct MyWatchApp: App {
var body: some Scene {
WindowGroup {
ContentView()
}
}
}
struct ContentView: View {
// Initialize RotationKit (paste your API key here)
@StateObject private var rotationEngine = RotationEngine(
configuration: RotationConfiguration(
apiKey: "rk_dev_watchos_YOUR_KEY_HERE", // ← Your API key
enableQuickToggle: true
)
)
var body: some View {
RotationHUD(rotationEngine: rotationEngine) {
// Your app content here - stays upright automatically!
MyAppScreen()
}
}
}
struct MyAppScreen: View {
var body: some View {
VStack {
Text("My Fitness App")
.font(.headline)
Text("Always Readable!")
.font(.body)
}
.foregroundColor(.white)
}
}
🎉 That's It!
Your app now features:
✅ Intelligent auto-rotation keeps interface upright at any wrist angle
✅ Quick mode toggle with long press
✅ Digital Crown control for manual rotation
✅ Three rotation modes: Auto, Manual, Standard
✅ Analytics automatically sent to your portal
View Your Analytics
- Go to rotationkit.com/portal
- See real-time usage:
- Total sessions
- Rotation events
- Mode preferences
- Device distribution
User Controls
Three Rotation Modes:
- Auto-Rotation 🌐: Gravity-based intelligent rotation (default)
- Manual Rotation 👑: Precision control with Digital Crown
- Standard 🔒: Fixed orientation, no rotation
Mode Toggle:
- Long press the watch face → Cycles through modes
- Digital Crown in Manual mode → Rotate interface
- Visual indicators show current mode and angle
Activity-Based Presets
Choose the best config for your app type:
Swift
// Fitness apps (dynamic sports)
RotationEngine(configuration: .forActivity(.fitness))
// Navigation apps (maps, directions)
RotationEngine(configuration: .forActivity(.navigation))
// Reading apps (gentle rotation)
RotationEngine(configuration: .forActivity(.reading))
Add Positioned Widgets
Make your data always readable with RotationKit's widget system:
Swift
RotationHUD(rotationEngine: rotationEngine) {
WidgetBuilder.mixedWidgets([
// Time at top
AnyHUDWidget(TextWidget(
data: "27:32",
position: 0
)),
// Heart rate at 3 o'clock
AnyHUDWidget(IconTextWidget(
data: IconTextWidget.IconTextData(
iconName: "heart.fill",
text: "142 bpm",
iconColor: .red
),
position: 2
)),
// Speed at bottom
AnyHUDWidget(SpeedWidget(
data: SpeedWidget.SpeedData(speed: 7.2, unit: .mph),
position: 4
))
], rotationEngine: rotationEngine)
}
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 watchOS version
No personal data is ever collected (no names, emails, health data).
How does auto-rotation work?
RotationKit uses patented sensor fusion technology:
- Reads device gravity sensor
- Calculates optimal interface orientation
- Smoothly rotates to keep content upright
- Works at any wrist angle, any activity
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
- Submit to App Store!
Next Steps
Explore Advanced Features:
- Read the full documentation for complete API reference
- View integration examples for fitness and navigation apps
- Learn about custom widgets for your own UI
Optimize User Experience:
- Add visual mode indicators
- Include onboarding for rotation controls
- Customize rotation sensitivity for your use case
- Test on physical Apple Watch devices
Support
Need help? We're here for you:
- 📧 Email: support@rotationkit.com
- 💬 Discord: discord.gg/rotationkit
- 📚 Docs: Full Documentation
Built for watchOS developers who want their apps to shine ✨
© 2025 RotationKit. All rights reserved.