Mulai Menggunakan

Pemasangan

Anda dapat menggunakan Setup Bantuan AI untuk menginstal plugin. Tambahkan Capgo kemampuan ke alat AI Anda menggunakan perintah berikut:

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

Kemudian gunakan prompt berikut:

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-watch` plugin in my project.

Jika Anda lebih suka Setup Manual, instal plugin dengan menjalankan perintah-perintah berikut dan ikuti instruksi spesifik platform di bawah ini:

1. Install the package

   bun add @capgo/capacitor-watch

2. Sinkronisasi dengan proyek asli

   bunx cap sync

3. Konfigurasi plugin

   Contoh Penggunaan Dasar:

   import { CapgoWatch } from '@capgo/capacitor-watch';
   
   // Check watch connectivity status
   const info = await CapgoWatch.getInfo();
   console.log('Watch paired:', info.isPaired);
   console.log('Watch reachable:', info.isReachable);
   
   // Listen for messages from watch
   await CapgoWatch.addListener('messageReceived', (event) => {
     console.log('Message from watch:', event.message);
   });

   Kirim Pesan ke Watch:

   // Check if watch is reachable first
   const info = await CapgoWatch.getInfo();
   if (info.isReachable) {
     await CapgoWatch.sendMessage({
       data: { action: 'refresh', timestamp: Date.now() }
     });
   }

   iOS

   Pengaturan iOS yang Diperlukan:

   1. Tambahkan kemampuan WatchConnectivity ke aplikasi iOS Anda di Xcode
   2. Buat target aplikasi watchOS di proyek Xcode Anda
   3. Implementasikan WatchConnectivity di aplikasi watchOS Anda (lihat Implementasi Aplikasi Watch di bawah)

   Plugin ini secara otomatis mengaktifkan WCSession ketika plugin dimuat.

   Android

   Pengaturan Wear OS yang Diperlukan:

   1. Tambahkan __CAPGO_KEEP_0__ ke Android project (sama applicationId dan tanda tangan sebagai aplikasi ponsel).
   2. Mengumumkan capgo_watch Membuat aplikasi Wear OS Membuat Aplikasi Wear OS).
   3. Implementkan Pemangku Pendengar Data pada jam tangan menggunakan jalur plugin ("/capgo/message, /capgo/contextdan lain-lain.

   Pengguna plugin ponsel mendaftarkan pendengar Wearable API ketika plugin dimuat. Gunakan getInfo() Periksa node yang terhubung dan apakah aplikasi watch terdeteksi.

   Full steps: Membuat Aplikasi Wear OS.

4. Balas pesan yang memerlukan jawaban

   // Listen for messages that need a response
   await CapgoWatch.addListener('messageReceivedWithReply', async (event) => {
     console.log('Request from watch:', event.message);
   
     // Process the request
     const result = await processWatchRequest(event.message);
   
     // Send reply back to watch (include requestId for Wear OS correlation)
     await CapgoWatch.replyToMessage({
       callbackId: event.callbackId,
       data: {
         requestId: event.message.requestId,
         result,
       },
     });
   });

5. Sinkronkan status aplikasi

   // Update application context (latest value only)
   await CapgoWatch.updateApplicationContext({
     context: {
       theme: 'dark',
       userId: '123',
       lastSync: Date.now()
     }
   });
   
   // Listen for context updates from watch
   await CapgoWatch.addListener('applicationContextReceived', (event) => {
     console.log('Context from watch:', event.context);
   });

6. Transfer informasi pengguna secara andal

   // Queue data for reliable delivery (even when watch is offline)
   await CapgoWatch.transferUserInfo({
     userInfo: {
       recordId: '456',
       action: 'created',
       data: { name: 'Item 1' }
     }
   });
   
   // Listen for user info transfers
   await CapgoWatch.addListener('userInfoReceived', (event) => {
     console.log('User info from watch:', event.userInfo);
   });

7. Pantau koneksi

   // Track reachability changes
   await CapgoWatch.addListener('reachabilityChanged', (event) => {
     console.log('Watch reachable:', event.isReachable);
     if (event.isReachable) {
       // Watch is now available for interactive messaging
     }
   });
   
   // Track session activation state
   await CapgoWatch.addListener('activationStateChanged', (event) => {
     // 0 = notActivated, 1 = inactive, 2 = activated
     console.log('Session state:', event.state);
   });

Implementasi Aplikasi Jam Tangan

Aplikasi jam tangan Anda perlu mengimplementasikan WatchConnectivity. Berikut adalah contoh SwiftUI:

import SwiftUI
import WatchConnectivity

@main
struct MyWatchApp: App {
    init() {
        WatchViewModel.shared.activate()
    }

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

class WatchViewModel: NSObject, ObservableObject, WCSessionDelegate {
    static let shared = WatchViewModel()

    @Published var lastMessage: [String: Any] = [:]

    func activate() {
        guard WCSession.isSupported() else { return }
        WCSession.default.delegate = self
        WCSession.default.activate()
    }

    // Send message to iPhone
    func sendToPhone(_ data: [String: Any]) {
        guard WCSession.default.isReachable else {
            print("iPhone not reachable")
            return
        }
        WCSession.default.sendMessage(data, replyHandler: nil)
    }

    // Send message with reply
    func sendToPhoneWithReply(_ data: [String: Any], completion: @escaping ([String: Any]) -> Void) {
        guard WCSession.default.isReachable else { return }
        WCSession.default.sendMessage(data, replyHandler: completion)
    }

    // Receive message from iPhone
    func session(_ session: WCSession, didReceiveMessage message: [String: Any]) {
        DispatchQueue.main.async {
            self.lastMessage = message
        }
    }

    // Receive application context
    func session(_ session: WCSession, didReceiveApplicationContext applicationContext: [String: Any]) {
        DispatchQueue.main.async {
            self.lastMessage = applicationContext
        }
    }

    // Required delegate methods
    func session(_ session: WCSession, activationDidCompleteWith activationState: WCSessionActivationState, error: Error?) {
        print("Watch session activated: \(activationState.rawValue)")
    }
}

API Referensi

Metode

sendMessage(options: SendMessageOptions)

Kirim pesan interaktif ke jam tangan. Memerlukan jam tangan untuk dapat diakses.

Parameter:

• data: Objek - Data yang dikirim ke jam tangan

updateApplicationContext(options: UpdateContextOptions)

Perbarui konteks aplikasi. Hanya nilai terbaru yang disimpan.

Parameter:

• context: Objek - Data konteks untuk disinkronisasi

transferUserInfo(options: TransferUserInfoOptions)

Queue user info for reliable delivery.

Parameter:

• userInfo: Objek - Informasi pengguna untuk ditransfer

replyToMessage(options: ReplyMessageOptions)

Balas pesan yang meminta tanggapan.

Parameter:

• callbackId: string - ID panggilan balik dari event messageReceivedWithReply
• data: Objek - Data balasan

getInfo()

Dapatkan status koneksi watch.

Kembali: WatchInfo objek dengan:

• isSupported: boolean - Apakah API watch tersedia di platform ini
• isPaired: boolean - Apple Watch terpasang (iOS) atau setidaknya satu node Wear OS terhubung (Android)
• isWatchAppInstalled: boolean - Aplikasi watch kompani terinstal (iOS) atau capgo_watch : boolean - Kemampuan terdeteksi (Android)
• isReachable: boolean - Apakah watch dapat diakses untuk pesan instan
• activationState: number - Status sesi (iOS WCSession; Android 2 ketika node terhubung, 0 lainnya)

getPluginVersion()

Untuk mendapatkan versi plugin native.

Acara

Acara	Pengenalan
messageReceived	Pesan sederhana dari watch
messageReceivedWithReply	Pesan yang menunggu balasan (termasuk callbackId)
applicationContextReceived	Pembaruan konteks dari watch
userInfoReceived	Pengiriman informasi pengguna dari watch
reachabilityChanged	Koneksi watch berubah (hanya iOS)
activationStateChanged	Status aktivasi sesi berubah (hanya iOS)

Poligami Komunikasi

Pengiriman Pesan Langsung (sendMessage)

• Diperlukan watch untuk dapat dijangkau
• Paling cocok untuk komunikasi interaktif dan sensitif waktu
• Jika pengawasan tidak tersedia, maka gagal segera

Context Aplikasi (updateApplicationContext)

• Hanya nilai terbaru - nilai sebelumnya dihapus
• Terbaik untuk sinkronisasi status aplikasi saat ini
• Diterima ketika pengawasan tersedia

Transfer Informasi Pengguna (transferUserInfo)

• Ditambahkan ke dalam antrian dan diterima dalam urutan
• Paling baik untuk data penting yang harus diterima
• Kerja bahkan ketika pengawasan sementara tidak dapat dijangkau

Catatan Platform

Lihat Tabel Dukungan Platform untuk melihat gambaran umum plugin untuk matriks metode demi metode.

Catatan iOS (Apple Watch)

• Menggunakan framework WatchConnectivity
• Menggunakan framework WatchConnectivity
• Sesi ini akan aktif secara otomatis ketika plugin dimuat.
• Mendukung pengiriman latar belakang untuk konteks dan informasi pengguna
• dan reachabilityChanged dan activationStateChanged

Android (OS Wear)

• Memerlukan Google Play services dengan Layer Data OS Wear (play-services-wearableInklusi dengan plugin)
• APK ponsel dan jam harus memiliki yang sama applicationId dan Kunci Tanda Tangan
• Aplikasi Watch harus menawarkan kemampuan capgo_watch
• Does Apakah Tidak Emit reachabilityChanged atau activationStateChanged; survei getInfo() ketika dibutuhkan
• Petunjuk pengaturan: Membuat aplikasi Wear OS

Web

• Pesan watch tidak didukung di browser
• getInfo() terselesaikan dengan isSupported: false dan bidang lainnya pada nilai default yang aman
• getPluginVersion() terselesaikan dengan { version: "web" }
• sendMessage, updateApplicationContext, transferUserInfo, dan replyToMessage tolak dengan kesalahan tidak tersedia
• addListener mengatasi sebuah handle melalui Capacitor WebPlugin, tetapi acara jam tangan tidak didukung di browser (callback tidak pernah dijalankan)

Penggunaan Umum

1. Sinkron Data: Sinkronkan data jam tangan dan ponsel
2. Pengendali Jarak: Kendalikan fitur ponsel dari jam tangan
3. NotifikasiKirimkan pemberitahuan kustom ke watch
4. Data Kesehatan: Bagikan metrik kesehatan dan olahraga
5. Media Kontrol: Kontrol pemutaran musik dari jam tangan
6. Rumah Cerdas: Kontrol perangkat dari lenganmu

Troubleshooting

Troubleshooting

• : Bagikan metrik kesehatan dan olahraga
• Jam Tangan Tidak Terhubung:
• Pastikan jam tangan berada dalam jangkauan Bluetooth

Pesan tidak diterima:

• Periksa apakah pemangku jawab telah terdaftar sebelum mengirim
• Verifikasi aplikasi jam tangan telah menerapkan WCSessionDelegate
• Pilih transferUserInfo untuk pengiriman yang dijamin

Sesi tidak aktif:

• Pastikan kemampuan WatchConnectivity telah ditambahkan di Xcode
• Periksa apakah aplikasi jam tangan memiliki ID paket kompanen
• Verifikasi kedua aplikasi targetkan versi OS yang kompatibel

Teruskan dari Getting Started

Jika Anda menggunakan Mulai Menggunakan untuk merencanakan pekerjaan plugin native, hubungkannya dengan Menggunakan @capgo/capacitor-watch untuk kemampuan native di Menggunakan @capgo/capacitor-watch, Daftar Direktori Plugin Capgo untuk alur kerja produk di Daftar Direktori Plugin Capgo, Plugin-Plugin Capacitor oleh Capgo untuk detail implementasi di Plugin-Plugin Capacitor oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.