Créer une application watchOS

Ce guide vous guide à travers la création d'une application de compagnon watchOS à partir de zéro, y compris la configuration du projet dans Xcode, l'intégration de l' SDK CapgoWatch et la création d'une application watch fonctionnelle avec SwiftUI.

Prérequis

Avant de commencer, assurez-vous d'avoir :

• Xcode 15 ou ultérieur (télécharger depuis l'App Store Mac)
• macOS Sonoma ou ultérieur (pour le dernier watchOS SDK)
• Un projet iOS existant Capacitor (exécutez npx cap add ios si vous n’avez pas encore)
• compte Apple Developer (un compte gratuit fonctionne pour le développement)

Vue d’ensemble de la structure du projet

Après avoir terminé ce guide, votre projet aura cette structure :

• Répertoireios/

  • RépertoireApp/

    • RépertoireApp/ (votre application iOS principale)

      • …
    • App.xcodeproj
    • App.xcworkspace (utilisez cela pour ouvrir le projet)
    • Podfile
  • RépertoireMyWatch/ (nouvelle application horlogère)

    • RépertoireMyWatch/ (source de l'application horlogère)

      • MyWatchApp.swift
      • ContentView.swift
      • RépertoireAssets.xcassets/

        • …
    • MyWatch.xcodeproj

Étape 1 : Ouvrez votre projet iOS dans Xcode

1. Naviguez jusqu'à votre projet Capacitor pour lequel vous souhaitez créer une application d'extension de montre ios/App dossier
2. Ouvrez (pas App.xcworkspace ) en double-cliquant dessus .xcodeprojAttendez que Xcode indexe le projet
3. Attendez que Xcode ait terminé l'indexation du projet

Attention

Ouvrez toujours le .xcworkspace fichier, et non .xcodeprojLe workspace inclut les dépendances CocoaPods dont votre projet a besoin.

Étape 2 : Ajoutez un cible watchOS

1. Dans Xcode, allez dans Fichier → Nouveau → Cible…

2. Dans le choix de modèle :

   • Sélectionnez watchOS barre en haut
   • Choisissez Application
   • Cliquez Suivant

3. Configurez votre application horlogère :

   • Nom du produit: MyWatch (ou votre nom préféré)
   • Équipe: Sélectionnez votre équipe Apple Developer
   • Identifiant de l'organisation: Correspond à votre application iOS (par exemple, app.capgo)
   • Identifiant de l'application: sera généré automatiquement (par exemple, app.capgo.myapp.watchkitapp)
   • Langue: Swift
   • Interface utilisateur: SwiftUI
   • Type d'application Watch: Application (pas Application pour l'application iOS existante)
   • Désactiver Inclure la scène de notification (sauf si vous en avez besoin)
   • Désactiver Inclure Complication (sauf si vous en avez besoin)

4. Cliquez Terminer

5. Lorsque vous êtes invité à activer le schéma ‘MyWatch’ : cliquez Activer

Étape 3 : Configurer les paramètres de l’application de montre

1. Dans le navigateur de projet (barre latérale gauche), sélectionnez votre projet (l’icône bleue en haut)

2. Sélectionnez votre cible de montre (par exemple, ‘MyWatch’) dans la liste des cibles

3. Allez à la Général tab:

   • Nom d'affichage: Le nom affiché sous l'icône de l'application (par exemple, « Mon application »)
   • Identifiant de l'application: Doit se terminer par .watchkitapp
   • Version: Correspond à la version de votre application iOS
   • Numéro de construction: Correspond au numéro de construction de votre application iOS

4. Allez à Signature et capacités tab:

   • Activer Gérer automatiquement la signature
   • Sélectionnez votre Équipe
   • Xcode créera automatiquement les profils de provisioning

5. Définir Informations de déploiement:

   • Déploiements minimums: watchOS 9.0 ou ultérieur

Étape 4 : Ajouter CapgoWatchSDK via Swift Package Manager

Le CapgoWatchSDK fournit un module prêt à l'emploi WatchConnector classe pour la communication.

1. Dans Xcode, allez à Fichier → Ajouter des dépendances de package…

2. Dans le champ de recherche, saisissez :

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

3. Appuyez sur Entrée et attendez que Xcode récupère le package

4. Configurez le package :

   • Règle de dépendance: 'Mise à jour jusqu'à la prochaine version majeure' avec '8.0.0'
   • Cliquez Ajouter un package

5. Choisissez les produits à ajouter :

   • IMPORTANT: Sélectionnez uniquement CapgoWatchSDK
   • Assurez-vous qu'il est ajouté à votre watch cible (par exemple, « MonWatch »), et non l'application iOS
   • Cliquez Ajouter le package

Conseil

Le CapgoWatchSDK est spécifiquement conçu pour les applications watchOS. Il fournit WatchConnector, un ObservableObject qui gère toutes les complexités de WatchConnectivity pour vous.

Étape 5 : Implémenter l'application de montre

Créons maintenant l'application de montre code. Remplacez les fichiers générés automatiquement par les suivants :

5.1 Créez le point d'entrée de l'application

Modifier 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 Créez la vue principale

Modifier 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()
}

Étape 6 : Configurer l'application iOS pour WatchConnectivity

Votre application iOS nécessite également la capacité WatchConnectivity.

1. Dans le navigateur de projet, sélectionnez votre projet

2. Sélectionnez votre cible d'application iOS (pas la cible de montre)

3. Allez à Signature et capacités Onglet

4. Cliquez sur Ajouter une capacité

5. Recherchez et ajoutez Connectivité de l'horloge (si disponible) ou il peut être ajouté automatiquement

6. Le plugin Capacitor gère automatiquement le côté iOS, mais assurez-vous que votre fichier Info.plist contient :

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

Étape 7 : Construire et exécuter

Exécuter sur le simulateur

1. Sélectionnez votre schéma d'horloge à partir du sélecteur de schéma (haut de la fenêtre Xcode)

2. Choisissez un simulateur d'horloge :

   • Cliquez sur le sélecteur de périphérique à côté du schéma
   • Sélectionnez un simulateur d'Apple Watch (par exemple, « Apple Watch Series 9 (45mm) »)

3. Cliquez sur le bouton Exécuter ou appuyez sur Cmd + R

4. L'émulateur iOS lancera avec les iPhone et Apple Watch

Exécuter sur appareil physique

1. Connectez votre iPhone via USB

2. Vérifiez que votre Apple Watch est pairé avec cet iPhone

3. Sélectionnez votre schéma de montre

4. Sélectionnez votre Apple Watch physique dans la liste des appareils

5. Cliquez Exécuter

6. Première fois : Vous devrez peut-être faire confiance à votre ordinateur sur les deux appareils

Conseil

Pour déboguer les deux applications simultanément :

1. Exécutez l'application iOS en premier
2. Ensuite, exécutez l'application montre avec « Déboguer → Attacher au processus » pour la montre

Étape 8 : Tester la communication

De l'iPhone (Capacitor) à la montre

Dans votre application 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!' }
  });
}

De Montre à iPhone

L'application de montre utilise 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)")
}

Gérer les messages sur 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'] }
  });
});

Avancé : Délegué personnalisé pour plus de contrôle

Si vous avez besoin de plus de contrôle, implémentez 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()

Dépannage

L'application ne s'affiche pas sur l'horloge

1. Assurez-vous que les identifiants de bundle sont correctement liés (l'identifiant de bundle de l'application horloge doit être l'identifiant de bundle de l'application iOS + .watchkitapp)
2. Vérifiez que les deux applications sont signées avec le même équipe
3. Sur appareil physique : Ouvrez l'application horloge sur l'iPhone → Mon horloge → défilez pour trouver votre application → activez

Les messages ne sont pas reçus

1. Vérifiez que les deux applications ont WCSession activé
2. Vérifiez isReachable avant d'envoyer les messages
3. Pour une livraison garantie, utilisez transferUserInfo au lieu de sendMessage
4. Vérifiez que les écouteurs sont enregistrés avant que l'autre appareil n'envoie des messages

Erreur : « Session Non Activée »

1. Appeler WatchConnector.shared.activate() tôt dans le cycle de vie de l'application
2. Sur iOS, le plugin s'active automatiquement - assurez-vous que le plugin est importé
3. Vérifiez que la capacité WatchConnectivity est ajoutée à la cible iOS

Erreurs de construction avec CapgoWatchSDK

1. Vérifiez que le package est ajouté à la cible de montre, pas cible iOS
2. Nettoyer le dossier de build : Produit → Nettoyer le dossier de build (Cmd + Maj + K)
3. Réinitialiser les caches de packages : Fichier → Packages → Réinitialiser les caches de packages

Problèmes de simulateur

1. Réinitialiser les simulateurs : Appareil → Effacer tout le contenu et les paramètres
2. S'assurer que les simulateurs iOS et watchOS sont des paires compatibles
3. Les deux simulateurs doivent être en cours d'exécution pour que la communication fonctionne

Étapes suivantes

• API Reference - Documentation complète de API
• Modèles de communication - Utiliser chaque méthode
• Application d'exemple - Exemple de travail fonctionnel