iOS सैंपल ऐप्लिकेशन बनाना

iOS के लिए बने इस सैंपल ऐप्लिकेशन में, Google Home के एपीआई का इस्तेमाल किया गया है. पहली बार ऐप्लिकेशन बनाने और उसे चलाने के लिए, इस गाइड का इस्तेमाल करें.

ज़रूरी शर्तें

पक्का करें कि आपके पास iOS के लिए Home के एपीआई इस्तेमाल करने की ज़रूरी शर्तें पूरी हों.

सैंपल ऐप्लिकेशन बनाने और इंस्टॉल करने के लिए, आपको Xcode के 15.3 या इसके बाद के वर्शन वाला कंप्यूटर चाहिए.

Xcode डाउनलोड करें

ऐप्लिकेशन की जांच करने के लिए, आपको इनकी ज़रूरत होगी:

  1. एक Google खाता.
  2. Apple ID, जो Apple Developer Program में रजिस्टर हो. इससे, फ़िज़िकल डिवाइस कॉन्फ़िगरेशन फ़ाइलें जनरेट की जा सकती हैं. अगर इसे पहले से नहीं बनाया गया है, तो इसके लिए आपको अलग से शुल्क देना होगा. साथ ही, इसमें 48 घंटे तक लग सकते हैं.
  3. iOS 16.4 या इसके बाद के वर्शन वाला iOS डिवाइस (सिमुलेटर नहीं), जो टेस्ट खाते के साथ सेट अप किया गया हो.
  4. एक वाई-फ़ाई नेटवर्क.
  5. Google Hub, जो Home के एपीआई के साथ काम करता हो.
  6. Thread बॉर्डर राऊटर, अगर आपके डिवाइस के लिए Thread की ज़रूरत है और आपके हब में यह सुविधा नहीं है.
  7. कम से कम एक ऐसा डिवाइस टाइप जो काम करता हो.

डेवलपमेंट के लिए, आपको ऐसे Mac की ज़रूरत होगी जो ये शर्तें पूरी करता हो:

  • macOS Sonoma या इसके बाद का वर्शन
  • Xcode 15.3 या इसके बाद का वर्शन

Apple के लिए डिप्लॉयमेंट कॉन्फ़िगरेशन फ़ाइलें बनाना

सबसे पहले, किसी ऐप्लिकेशन के लिए App Attest सुविधा चालू होनी चाहिए. इसलिए, इसे सिमुलेटर डिवाइसों पर डिप्लॉय नहीं किया जा सकता. इसके लिए, आपको App Attest एनटाइटलमेंट के साथ एक प्रोविज़निंग प्रोफ़ाइल बनानी होगी.

दूसरी बात, ऐप्लिकेशन और MatterExtension के बीच कम्यूनिकेशन के लिए, App Groups चालू होने चाहिए. इसके लिए, आपको ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर रजिस्टर करना होगा.

ज़्यादा जानकारी के लिए, Apple की डेवलपमेंट प्रोविज़निंग प्रोफ़ाइल बनाना प्रोविज़निंग प्रोफ़ाइल पर लेख पढ़ें.

किसी ऐप्लिकेशन को डिप्लॉय करने के लिए, कम से कम ये चरण पूरे करने होंगे:

  1. MatterExtension के साथ कम्यूनिकेट करने के लिए, अपने ऐप्लिकेशन के लिए एक ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर बनाएं.
    1. Apple Developer Portal में साइन इन करें.
    2. एक ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर जोड़ें. उदाहरण के लिए, इसे group.com.company.commissioning के तौर पर फ़ॉर्मैट किया जा सकता है.
  2. डेवलपर खाते में, अपना टेस्ट के लिए डिवाइस रजिस्टर करें.

  3. अपने ऐप्लिकेशन के टारगेट के लिए एक प्रोफ़ाइल बनाएं.

    1. अपने ऐप्लिकेशन के लिए, ऐप्लिकेशन बंडल आइडेंटिफ़ायर तय करें. आइडेंटिफ़ायर यूनीक और जानकारी देने वाला होना चाहिए. उदाहरण के लिए, इसे com.company.HomeApiSample के तौर पर फ़ॉर्मैट किया जा सकता है. इस आइडेंटिफ़ायर का इस्तेमाल, इस सेक्शन के बाकी हिस्सों में किया जाएगा.
    2. अपना ऐप्लिकेशन आईडी रजिस्टर करें. कहे जाने पर, App Attest और App Groups सुविधा जोड़ें.

    3. नए बनाए गए ऐप्लिकेशन आईडी में बदलाव करें और रजिस्टर किए गए ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर को जोड़ने के लिए, App Groups सुविधा को कॉन्फ़िगर करें.

    4. अपने ऐप्लिकेशन के डेवलपमेंट के लिए, डेवलपमेंट प्रोविज़निंग प्रोफ़ाइल बनाएं. इसे अपने नए बनाए गए ऐप्लिकेशन आईडी और चुने गए टेस्ट डिवाइसों से जोड़ें. पक्का करें कि आपके पास ऐप्लिकेशन पर हस्ताक्षर करने के लिए, डेवलपर सर्टिफ़िकेट हो.

  4. अपने MatterExtension टारगेट के लिए एक प्रोफ़ाइल बनाएं.

    1. अपने MatterExtension के लिए, ऐप्लिकेशन बंडल आइडेंटिफ़ायर तय करें. आइडेंटिफ़ायर, ऐप्लिकेशन आइडेंटिफ़ायर से इनहेरिट किया जाना चाहिए. उदाहरण के लिए, इसे com.company.HomeApiSample.MatterExtension के तौर पर फ़ॉर्मैट किया जा सकता है.
    2. अपना ऐप्लिकेशन आईडी रजिस्टर करें. कहे जाने पर, App Group सुविधा जोड़ें.
    3. नए बनाए गए ऐप्लिकेशन आईडी में बदलाव करें और पिछले चरणों में बनाए गए रजिस्टर किए गए ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर को जोड़ने के लिए, App Groups सुविधा को कॉन्फ़िगर करें.
    4. डेवलपमेंट प्रोविज़निंग प्रोफ़ाइल बनाएं MatterExtension के लिए.

OAuth क्लाइंट आईडी जनरेट करना और Home के एपीआई चालू करना

आपके ऐप्लिकेशन को, Google के ऑथेंटिकेशन बैकएंड पर अपनी पहचान बताने के लिए, OAuth क्लाइंट आईडी की ज़रूरत होती है. iOS और ऐप्लिकेशन के लिए, OAuth क्लाइंट आईडी ऐप्लिकेशन टाइप को iOS के तौर पर कॉन्फ़िगर किया जाना चाहिए. ऐप्लिकेशन, Home के एपीआई को भी कॉल करेगा. इस सुविधा को चालू करने के लिए, Google Cloud प्रोजेक्ट में एपीआई चालू करना होगा.

OAuth क्लाइंट आईडी जनरेट करना

  1. Google Cloud Console में, प्रोजेक्ट चुनने वाले डैशबोर्ड पर जाएं और वह प्रोजेक्ट चुनें जिसका इस्तेमाल आपको OAuth क्रेडेंशियल बनाने के लिए करना है.
  2. सबसे ऊपर बाईं ओर मौजूद, मेन्यू बटन > सभी प्रॉडक्ट देखें > एपीआई और सेवाएं पर क्लिक करके, एपीआई और सेवाएं पेज पर जाएं.
  3. नेविगेशन मेन्यू में, क्रेडेंशियल पर क्लिक करें.

  4. अगर आपने अब तक इस Google Cloud प्रोजेक्ट के लिए, सहमति स्क्रीन को कॉन्फ़िगर नहीं किया है, तो सहमति स्क्रीन कॉन्फ़िगर करें बटन दिखेगा. ऐसे में, सहमति स्क्रीन को कॉन्फ़िगर करने के लिए, यह तरीका अपनाएं. अगर OAuth सहमति स्क्रीन पहले से कॉन्फ़िगर की गई है और उसकी पब्लिशिंग स्थिति टेस्टिंग है, तो पक्का करें कि जिन टेस्ट खातों का इस्तेमाल किया जाएगा उन्हें टेस्ट उपयोगकर्ता ग्रुप में जोड़ा गया हो. अगर ऐसा नहीं है, तो अगले चरण पर जाएं.

    1. अपने इस्तेमाल के उदाहरण के हिसाब से, इंटरनल या एक्सटर्नल चुनें. और इसके बाद, बनाएं पर क्लिक करें. OAuth की सहमति स्क्रीन पैनल दिखता है.
    2. ऐप्लिकेशन की जानकारी वाले पेज पर, स्क्रीन पर दिए गए निर्देशों के मुताबिक जानकारी डालें. इसके बाद, सेव करें और जारी रखें पर क्लिक करें. स्कोप पैनल दिखता है.
    3. आपको कोई स्कोप जोड़ने की ज़रूरत नहीं है. इसलिए, सेव करें और जारी रखें पर क्लिक करें. टेस्ट उपयोगकर्ता पैनल दिखता है.
    4. अगर आपने इंटरनल ऐसी स्क्रीन जहां OAuth के लिए सहमति दी जाती है बनाने का विकल्प चुना है, तो आपको अपने ऐप्लिकेशन को ऐक्सेस करने की जांच करने के लिए, उपयोगकर्ताओं को जोड़ना होगा. उपयोगकर्ता जोड़ें पर क्लिक करें. उपयोगकर्ता जोड़ें पैनल दिखता है. टेस्ट उपयोगकर्ताओं के पास, आपके ऐप्लिकेशन में अनुमतियां देने का अधिकार होता है. खाली फ़ील्ड में, एक या उससे ज़्यादा Google खाते के ईमेल पते जोड़ें. इसके बाद, जोड़ें पर क्लिक करें.
    5. सेव करें और जारी रखें पर क्लिक करें. खास जानकारी पैनल दिखता है.
    6. OAuth की सहमति स्क्रीन की जानकारी देखें. इसके बाद, डैशबोर्ड पर वापस जाएं पर क्लिक करें.

  5. OAuth क्लाइंट आईडी बनाने के लिए, बाएं मेन्यू पैनल में क्रेडेंशियल पर क्लिक करें.

    OAuth स्क्रीन सेट अप करना

    1. क्रेडेंशियल बनाएं बटन पर क्लिक करें और OAuth क्लाइंट आईडी चुनें.
      1. **ऐप्लिकेशन टाइप** में, **iOS** चुनें.
    2. बंडल आईडी में, अपने ऐप्लिकेशन आइडेंटिफ़ायर और Apple Developer Team ID डालें. दूसरे फ़ील्ड ज़रूरी नहीं हैं. इन्हें खाली छोड़ा जा सकता है.
    3. बनाएं पर क्लिक करें और बनाए गए क्लाइंट आईडी को नोट करें या PLIST डाउनलोड करें पर क्लिक करें. इसका इस्तेमाल, अनुमतियों के फ़्लो की सुविधा को चालू करने के लिए किया जाएगा. ज़्यादा जानकारी के लिए, अनुमति के क्रेडेंशियल बनाना सेक्शन देखें.

Home के एपीआई चालू करना

Home के एपीआई को ऐक्सेस करने की अनुमति दें.

  1. एपीआई और सेवाएं टैब में, चालू एपीआई और सेवाएं पर क्लिक करें.
  2. पेज पर सबसे ऊपर मौजूद, एपीआई और सेवाएं चालू करें पर क्लिक करें.
  3. HOME API खोजें और उसे चुनें.
  4. Home API के जानकारी वाले पेज पर, चालू करें पर क्लिक करें.

सोर्स कोड डाउनलोड करना

सैंपल ऐप्लिकेशन का सोर्स कोड GitHub पर उपलब्ध है.

उस जगह पर जाएं जहां आपको प्रोजेक्ट सेव करना है. इसके बाद, उसे क्लोन करें:

git clone https://github.com/google-home/google-home-api-sample-app-ios.git

Xcode पर प्रोजेक्ट लोड करने के लिए, फ़ाइल > खोलें पर क्लिक करें. इसके बाद, क्लोन की गई रिपॉज़िटरी की रूट में मौजूद, GoogleHomeAPISampleIOS.xcodeproj को चुनें.

प्रोजेक्ट में SDK टूल जोड़ना

सैंपल ऐप्लिकेशन प्रोजेक्ट को बनाने के लिए, कुछ और जानकारी की ज़रूरत होती है. इसमें, SDK फ़्रेमवर्क फ़ाइलों को स्थानीय तौर पर जोड़ना, डेवलपर खाते के आइडेंटिफ़ायर की जानकारी डालना, और OAuth क्लाइंट आईडी डालना शामिल है.

ऐप्लिकेशन बनाना

Home के एपीआई का iOS SDK डाउनलोड करने के लिए, आपको पहले Google Home के डेवलपर में साइन इन करना होगा.

अभी साइन इन करें!

सैंपल ऐप्लिकेशन के लिए, अपना Xcode प्रोजेक्ट कॉन्फ़िगर करें:

  1. डाउनलोड किए गए SDK को, प्रोजेक्ट की रूट डायरेक्ट्री के मुकाबले ThirdParty/GoogleHomeSDK डायरेक्ट्री में अनपैक करें.
  2. डेवलपर और OAuth क्लाइंट आईडी कॉन्फ़िगर करना:
    1. नेविगेशन पैन में, GoogleHomeAPISampleIOS फ़ोल्डर ढूंढें और बदलाव करने के लिए, Info.plist फ़ाइल खोलें.

  3. Info.plist फ़ाइल में, GIDClientID में अपना OAuth क्लाइंट आईडी (OAuth के लिए सहमति सेट अप करना सेक्शन देखें), Cloud Project Number में अपने क्लाउड प्रोजेक्ट से जुड़ा नंबर, और GIDTeamID में OAuth रजिस्ट्रेशन की प्रोसेस के दौरान इस्तेमाल किए गए डेवलबर खाते का Apple Developer Team ID डालें.

  4. App Attest सुविधा जोड़ना:

    1. प्रोजेक्ट कॉन्फ़िगरेशन में बदलाव करने के लिए, Xcode के नेविगेशन पैन में, GoogleHomeAPISampleIOS प्रोजेक्ट फ़ाइल चुनें.
    2. सबसे ऊपर मौजूद, Signing and Capabilities टैब पर क्लिक करें. इसके बाद, TARGETS सेक्शन में बाईं ओर मौजूद, GoogleHomeAPISampleIOS टारगेट चुनें.
    3. Signing and Capabilities टैब के ठीक नीचे, + Capability पर क्लिक करें और App Attest खोजें.
    4. जोड़ने के लिए, App Attest पर क्लिक करें. अगर खोज में यह सुविधा नहीं दिखती है, तो हो सकता है कि प्रोजेक्ट में इसे पहले ही जोड़ा गया हो.

  5. App Groups सुविधा जोड़ें.

    ऐप्लिकेशन ग्रुप जोड़ना

    1. GoogleHomeAPISampleIOS प्रोजेक्ट > GoogleHomeAPISampleIOS टारगेट पर जाएं.
    2. Signing & Capabilities > + Capability पर क्लिक करें.
    3. App Groups सुविधा चुनें.
    4. App Groups में मौजूद, + आइकॉन पर क्लिक करें. इसके बाद, अपने ऐप्लिकेशन के लिए वह App Groups आइडेंटिफ़ायर जोड़ें जिसे आपने Apple Developer Portal में जोड़ा था.
    5. MatterAddDeviceExtension टारगेट के लिए भी ये चरण दोहराएं, ताकि इसे App Groups में जोड़ा जा सके.

  6. बंडल आइडेंटिफ़ायर अपडेट करना

    1. अपने डेवलपर सर्टिफ़िकेट और प्रोविज़निंग प्रोफ़ाइल का इस्तेमाल करके, हार्डवेयर पर सैंपल ऐप्लिकेशन को सही तरीके से चलाने और डिप्लॉय करने के लिए, आपको एक यूनीक बंडल आइडेंटिफ़ायर देना होगा. यह वही आइडेंटिफ़ायर होना चाहिए जो आपके OAuth क्लाइंट क्रेडेंशियल से जुड़ा है (ऊपर देखें).
    2. प्रोजेक्ट कॉन्फ़िगरेशन में बदलाव करने के लिए, Xcode के नेविगेशन पैन में, GoogleHomeAPISampleIOS प्रोजेक्ट फ़ाइल चुनें.
    3. सबसे ऊपर मौजूद, Signing and Capabilities टैब पर क्लिक करें. इसके बाद, TARGETS सेक्शन में बाईं ओर मौजूद, GoogleHomeAPISampleIOS टारगेट चुनें.
    4. Signing सेक्शन में, बंडल आइडेंटिफ़ायर फ़ील्ड चुनें और ऐप्लिकेशन के लिए यूनीक आइडेंटिफ़ायर डालें.
    5. ज़रूरी एनटाइटलमेंट के साथ, उस बंडल से जुड़ी प्रोविज़निंग प्रोफ़ाइल चुनें या इंस्टॉल करें.
    6. MatterAddDeviceExtension टारगेट के लिए भी ये चरण दोहराएं, ताकि एक्सटेंशन के लिए बंडल आइडेंटिफ़ायर डाला जा सके और उसकी रजिस्टर की गई प्रोविज़निंग प्रोफ़ाइल इंपोर्ट की जा सके.

  7. कोड में, रजिस्टर किए गए ऐप्लिकेशन ग्रुप आइडेंटिफ़ायर को अपडेट करना.

    1. ऐप्लिकेशन को, SDK इंस्टेंस को कॉन्फ़िगर करना ज़रूरी है, ताकि डिवाइस कमीशनिंग जैसी सुविधाओं के लिए, App Group आइडेंटिफ़ायर का इस्तेमाल किया जा सके. Apple Developer Portal में रजिस्टर किए गए App Group ID का इस्तेमाल करने के लिए, ऐप्लिकेशन को अपडेट करें. इसके लिए, HOME_API_TODO_ADD_APP_GROUP स्ट्रिंग खोजें और हर इंस्टेंस को इससे बदलें.

    ये कॉन्फ़िगरेशन, इन फ़ाइलों में किए जाते हैं:

    • SDK को शुरू करने पर, GoogleHomeAPISampleIOS.swift.
    • RequestHandler.swift
    • CommissioningManager.swift