查看 watchOS 仓库

GitHub

复制一个包含安装步骤和本插件完整Markdown指南的设置提示。

本指南将指导您从零开始创建一个 watchOS 陪伴应用，包括在 Xcode 中设置项目、集成 CapgoWatchSDK 和使用 SwiftUI 构建一个功能性的 watch 应用。

前提条件

在开始之前，请确保您有:

Xcode 15 或更高版本 (从 Mac App Store 下载)
macOS Sonoma 或更高版本 (for latest watchOS SDK)
一个现有的 Capacitor iOS 项目 (运行 npx cap add ios 如果你还没有)
Apple Developer账户 (免费账户适用于开发)

项目结构概览

完成本指南后，项目将具有以下结构：

目录ios/
- 目录App/
  - 目录App/ (您的主 iOS 应用)
    …
  - App.xcodeproj
  - App.xcworkspace (用来打开项目的)
  - Podfile
- 目录MyWatch/ (新手表应用)
  - 目录MyWatch/ (手表应用源码)
    MyWatchApp.swift
    ContentView.swift
    目录Assets.xcassets/
    …
  - MyWatch.xcodeproj

步骤 1：打开您的 iOS 项目在 Xcode

Navigate to your Capacitor project’s ios/App 文件夹
打开 App.xcworkspace (不是 .xcodeproj)通过双击它
等待 Xcode 索引项目

您的项目需要的工作区包含了CocoaPods依赖项。

步骤2：添加watchOS目标 在Xcode中，转到
文件→新建→目标…
- 在模板选择器中： 选择watchOS 顶部选项卡
- 选择应用
- 点击 下一步
配置您的手表应用：
- 产品名称: MyWatch (或您的偏好名称)
- 团队: 选择您的Apple Developer团队
- 组织标识符: 应该与您的iOS应用程序匹配（例如， app.capgo)
- 应用程序标识符: 将自动生成 (例如, app.capgo.myapp.watchkitapp)
- 语言: Swift
- 用户界面: SwiftUI
- 手表应用类型: 应用程序 (不是现有 iOS 应用程序)
- 取消 包含通知场景 (除非您需要它)
- 取消 包含复杂功能 (除非你需要)
点击完成
当提示“激活‘MyWatch’方案？”时，点击激活

步骤 3：配置手表应用设置

在项目导航器（左侧边栏）中，选择您的项目（顶部蓝色图标)
从目标列表中选择您的手表目标（例如，“MyWatch”）
前往通用 tab:
- 显示名称显示名称：应用图标下方显示的名称（例如，“我的应用”）
- 包标识符：应以 .watchkitapp
- 版本：匹配iOS应用版本
- 构建：匹配iOS应用构建号
前往 签名与功能 tab:
- 启用 自动管理签名
- 选择您的团队
- Xcode将自动创建签名配置文件
设置 部署信息:
- 最小部署: watchOS 9.0 或更高

步骤 4:通过 Swift Package Manager 添加 CapgoWatchSDK

CapgoWatchSDK 提供一个可用的 WatchConnector 用于通信的类。

In Xcode 中，转到 File → 添加包依赖项…

在搜索字段中输入：

https://github.com/Cap-go/capacitor-watch.git

按 Enter 并等待 Xcode 获取包
配置包：
- 依赖规则: “到下一个主要版本”与“8.0.0”
- 点击 添加包
选择要添加的产品：
- 重要提示: 仅选择 CapgoWatchSDK
- 确保它已添加到您的 watch目标 (例如，“MyWatch”），而不是 iOS 应用
- 点击 添加包

第 5 步：实现手表应用

现在让我们创建手表应用 code。将以下自动生成的文件替换为以下内容：

5.1 创建应用入口点

编辑 MyWatch/MyWatchApp.swift:

import SwiftUI
import CapgoWatchSDK

@main
struct MyWatchApp: App {
    init() {
        // Activate WatchConnectivity when app launches
        WatchConnector.shared.activate()
    }

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

5.2 创建主视图

编辑 MyWatch/ContentView.swift:

import SwiftUI
import CapgoWatchSDK

struct ContentView: View {
    // Observe the WatchConnector for automatic UI updates
    @ObservedObject var connector = WatchConnector.shared

    // Local state
    @State private var messageText = ""
    @State private var statusMessage = "Ready"

    var body: some View {
        ScrollView {
            VStack(spacing: 16) {
                // Connection Status
                ConnectionStatusView(connector: connector)

                Divider()

                // Message Input
                TextField("Message", text: $messageText)
                    .textFieldStyle(.roundedBorder)

                // Send Buttons
                HStack {
                    Button("Send") {
                        sendMessage()
                    }
                    .disabled(!connector.isReachable || messageText.isEmpty)

                    Button("Request") {
                        sendWithReply()
                    }
                    .disabled(!connector.isReachable || messageText.isEmpty)
                }

                Divider()

                // Status
                Text(statusMessage)
                    .font(.caption)
                    .foregroundColor(.secondary)

                // Last Received Message
                if !connector.lastMessage.isEmpty {
                    VStack(alignment: .leading) {
                        Text("Last Message:")
                            .font(.caption)
                            .foregroundColor(.secondary)
                        Text(formatMessage(connector.lastMessage))
                            .font(.caption2)
                    }
                    .frame(maxWidth: .infinity, alignment: .leading)
                }
            }
            .padding()
        }
    }

    private func sendMessage() {
        connector.sendMessage(["text": messageText, "timestamp": Date().timeIntervalSince1970])
        statusMessage = "Message sent"
        messageText = ""
    }

    private func sendWithReply() {
        connector.sendMessage(["text": messageText, "needsReply": true]) { reply in
            DispatchQueue.main.async {
                statusMessage = "Reply: \(formatMessage(reply))"
            }
        }
        messageText = ""
    }

    private func formatMessage(_ message: [String: Any]) -> String {
        message.map { "\($0.key): \($0.value)" }.joined(separator: ", ")
    }
}

// Separate view for connection status
struct ConnectionStatusView: View {
    @ObservedObject var connector: WatchConnector

    var body: some View {
        HStack {
            Circle()
                .fill(connector.isReachable ? Color.green : Color.red)
                .frame(width: 12, height: 12)

            Text(connector.isReachable ? "Connected" : "Disconnected")
                .font(.headline)

            Spacer()

            if connector.isActivated {
                Image(systemName: "checkmark.circle.fill")
                    .foregroundColor(.green)
            }
        }
    }
}

#Preview {
    ContentView()
}

第 6 步：配置 iOS 应用以支持 WatchConnectivity

您的 iOS 应用还需要 WatchConnectivity 能力。

在 Project Navigator 中，选择您的项目
选择您的 iOS 应用目标 （不是 watch 目标）
转到 签名和功能 选项卡
点击 添加功能
搜索并添加 WatchConnectivity (如果可用) 或者它可能会自动添加

Capacitor 插件会自动处理 iOS 方面，但确保您的 Info.plist 有：

<key>WKCompanionAppBundleIdentifier</key>
<string>app.capgo.myapp.watchkitapp</string>

第 7 步：构建和运行

在模拟器上运行

从 Xcode 窗口顶部的方案选择器中选择您的 watch 方案
选择一个 Apple Watch 模拟器（例如：‘Apple Watch Series 9 (45mm)’）
- 点击方案下方的设备选择器
- 选择一个 Apple Watch 模拟器（例如：‘Apple Watch Series 9 (45mm)’）
点击运行按钮 (▶️) 或按 Cmd + R
iPhone 和 Apple Watch 将在 iOS 模拟器中启动

在物理设备上运行

通过 USB 连接您的 iPhone
确保您的 Apple Watch 与该 iPhonePair
选择您的 watch 方案
从设备列表中选择您的物理 Apple Watch
点击运行
首次使用：您可能需要在两台设备上信任您的计算机

步骤8：测试通信

从iPhone(Capacitor)到手表

在您的Capacitor应用中：

import { CapgoWatch } from '@capgo/capacitor-watch';

// Check connection
const info = await CapgoWatch.getInfo();
console.log('Watch reachable:', info.isReachable);

// Send a message
if (info.isReachable) {
  await CapgoWatch.sendMessage({
    data: { action: 'update', value: 'Hello from iPhone!' }
  });
}

从手表到iPhone

手表应用使用 WatchConnector:

// Send message (fire and forget)
WatchConnector.shared.sendMessage(["action": "buttonTapped"])

// Send message with reply
WatchConnector.shared.sendMessage(["request": "getData"]) { reply in
    print("Got reply: \(reply)")
}

在iPhone上处理消息

// Listen for messages from watch
await CapgoWatch.addListener('messageReceived', (event) => {
  console.log('Message from watch:', event.message);
  // { action: 'buttonTapped' }
});

// Handle messages that need a reply
await CapgoWatch.addListener('messageReceivedWithReply', async (event) => {
  console.log('Request from watch:', event.message);

  // Send reply back
  await CapgoWatch.replyToMessage({
    callbackId: event.callbackId,
    data: { status: 'success', items: ['item1', 'item2'] }
  });
});

高级：自定义委托以获得更多控制

如果您需要更多控制，请实现 WatchConnectorDelegate:

import SwiftUI
import CapgoWatchSDK

class WatchHandler: WatchConnectorDelegate {
    func didReceiveMessage(_ message: [String: Any]) {
        print("Received: \(message)")
        // Handle incoming message
    }

    func didReceiveMessageWithReply(_ message: [String: Any],
                                     replyHandler: @escaping ([String: Any]) -> Void) {
        print("Received request: \(message)")
        // Process and send reply
        replyHandler(["status": "processed"])
    }

    func didReceiveApplicationContext(_ context: [String: Any]) {
        print("Context updated: \(context)")
    }

    func didReceiveUserInfo(_ userInfo: [String: Any]) {
        print("User info received: \(userInfo)")
    }

    func reachabilityDidChange(_ isReachable: Bool) {
        print("Reachability changed: \(isReachable)")
    }

    func activationDidComplete(with state: WCSessionActivationState) {
        print("Activation completed: \(state.rawValue)")
    }
}

// In your app setup:
let handler = WatchHandler()
WatchConnector.shared.delegate = handler
WatchConnector.shared.activate()

故障排除

手表应用未在手表上显示

确保包ID正确关联（手表应用包ID应为iOS应用包ID+ .watchkitapp)
检查两应用都使用同一团队签名
在物理设备上：在iPhone上打开手表应用→我的手表→滚动找到您的应用→切换开关

未接收到消息

检查
在发送消息之前 isReachable 为了保证消息的可靠传递，使用
WCSession transferUserInfo 取而代之 sendMessage
确保监听器在其他设备发送消息之前注册

“会话未激活”错误

调用 WatchConnector.shared.activate() 早期在应用生命周期
在 iOS 上，插件会自动激活 - 确保插件已导入
检查 iOS 目标中是否添加了 WatchConnectivity 能力

CapgoWatchSDK 构建错误

确保包添加到 手表目标，不支持iOS目标
清理构建文件夹： 产品 → 清理构建文件夹 (Cmd + Shift + K)
重置包缓存： 文件 → 包 → 重置包缓存

模拟器问题

重置模拟器： 设备 → 擦除所有内容和设置
确保 iOS 和 watchOS 模拟器是兼容的对
两台模拟器都需要运行，才能进行通信

下一步

API 参考 API 文档
通信模式 - 使用每种方法的时机
示例应用 - 全功能工作示例

继续从创建 watchOS 应用

如果您正在使用 创建 watchOS 应用 为native插件工作做出计划，连接它使用@capgo/capacitor-watch 在使用@capgo/capacitor-watch中 Capgo插件目录在Capgo插件目录中 Capacitor插件由Capgo 在Capacitor插件由Capgo中添加或更新插件在添加或更新插件中 Ionic企业插件替代品在Ionic企业插件替代品中