Home APIs का Android सैंपल ऐप्लिकेशन

सैंपल ऐप्लिकेशन में, Google Home API की बुनियादी सुविधाएं दिखाई गई हैं.

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

ऐप्लिकेशन बनाने, इंस्टॉल करने, और उसकी जांच करने के लिए, आपको कुछ ज़रूरी शर्तें पूरी करनी होंगी:

  • Android Studio, वर्शन 2024.2.1 ("Ladybug") या इसके बाद का वर्शन. ध्यान दें कि इससे पहले के वर्शन, होम एपीआई SDK टूल के साथ ठीक से काम नहीं कर सकते.

    Android Studio डाउनलोड करना

  • Android डीबगर (adb).

    adb इंस्टॉल करें.

    ऐसा SDK मैनेजर की मदद से किया जा सकता है.

Home के एपीआई की जांच करने के लिए, आपको ये चीज़ें चाहिए:

  • Android 10 या इसके बाद के वर्शन पर काम करने वाला Android डिवाइस, जिस पर उस Google खाते से साइन इन किया गया हो जिसका इस्तेमाल आपको ऐप्लिकेशन डेवलप करने के लिए करना है. पक्का करें कि Android Studio का अप-टू-डेट वर्शन इंस्टॉल हो और उसमें इस डेवलपमेंट खाते से साइन इन किया गया हो.
  • वाई-फ़ाई नेटवर्क.
  • Google का ऐसा हब जो Home API के साथ काम करता है.

  • होम में कम से कम एक ऐसा डिवाइस हो जिस पर यह सुविधा काम करती हो. अगर यह डिवाइस (या कोई अन्य डिवाइस) Thread का इस्तेमाल करता है, तो हब भी Thread बॉर्डर राऊटर होना चाहिए. Android सैंपल ऐप्लिकेशन में, डिवाइस के इन टाइप और ट्रैट का इस्तेमाल किया जा सकता है:

    • कलर टेंपरेचर लाइट (चालू और बंद करना, चमक)
    • संपर्क सेंसर (बुलियन स्टेटस)
    • रोशनी को कम या ज़्यादा करने की सुविधा (चालू और बंद करना, रोशनी की चमक)
    • एक्सटेंडेड कलर लाइट (चालू और बंद करना, रोशनी)
    • सामान्य स्विच
    • ऑक्युपेंसी सेंसर (ऑक्युपेंसी सेंसिंग)
    • लाइट चालू/बंद करना (चालू और बंद करना, रोशनी)
    • लाइट स्विच को चालू/बंद करना
    • प्लग-इन यूनिट को चालू/बंद करना (चालू और बंद)
    • चालू/बंद सेंसर

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

  3. अगर आपने अब तक इस Google Cloud प्रोजेक्ट के लिए सहमति स्क्रीन को कॉन्फ़िगर नहीं किया है, तो सहमति स्क्रीन कॉन्फ़िगर करें बटन दिखेगा. ऐसे में, यहां दिए गए तरीके का इस्तेमाल करके सहमति वाली स्क्रीन को कॉन्फ़िगर करें. अगर ऐसा नहीं है, तो अगले सेक्शन पर जाएं.

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

पूरी जानकारी के लिए, Google Cloud Console की सहायता साइट पर OAuth की सहमति वाली स्क्रीन सेट अप करना लेख पढ़ें.

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

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

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

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

SDK टूल सेट अप करना

इस ओपन बीटा में मौजूद Home API, अब तक डेवलपमेंट के लिए Google की दी गई स्टैंडर्ड लाइब्रेरी का हिस्सा नहीं हैं. Home के एपीआई का इस्तेमाल करके ऐप्लिकेशन बनाने के लिए, आपको लाइब्रेरी को डाउनलोड करके स्थानीय तौर पर होस्ट करना होगा.

Home APIs Android SDK टूल डाउनलोड करने के लिए, आपको पहले Google Home Developers में साइन इन करना होगा.

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

बिल्ड और चलाना

  1. Android Studio खोलें. इसके बाद, google-home-api-sample-app-android प्रोजेक्ट फ़ोल्डर खोलें, जिसे आपकी लोकल मशीन पर क्लोन किया गया था.
  2. पहली बार सेटअप करने के दौरान, Android Studio को प्रोजेक्ट की सभी डिपेंडेंसी डाउनलोड करने और Gradle बिल्ड पूरा करने में 10 मिनट लग सकते हैं.
    • अगर इस चरण के दौरान आपको कोई गड़बड़ी मिलती है, जैसे कि Gradle Sync Failed, तो सिंक करने की प्रोसेस फिर से शुरू करने के लिए, फिर से कोशिश करें पर क्लिक करें.
  3. सैंपल ऐप्लिकेशन के पैकेज का नाम बदलकर कोई ऐसा नया नाम रखें जिसे पहले रजिस्टर न किया गया हो. जैसे, आपके संगठन के नाम पर कोई नाम:
    1. प्रोजेक्ट खोलें.
    2. सोर्स की हैरारकी को बड़ा करें.
    3. पैकेज का वह हिस्सा चुनें जिसमें बदलाव करना है - दूसरे शब्दों में, com.example.
    4. पैकेज पर दायां क्लिक करें और Refactor > Rename... चुनें
    5. सभी डायरेक्ट्री पर क्लिक करें.
    6. नया नाम डालें और फिर से फ़ैक्टर करें पर क्लिक करें.
    7. build.gradle.kts फ़ाइल में बदलाव करें. इसके लिए, android namespace और applicationId को पैकेज के नए नाम से बदलें.
    8. AndroidManifest.xml फ़ाइल में बदलाव करें और पैकेज को फ़ाइल में जहां भी दिखता है वहां नए पैकेज के नाम से बदलें.

  4. Android Studio में ऐप्लिकेशन चलाकर, OAuth पासकोड जनरेट करें. Android Studio में किसी ऐप्लिकेशन को चलाने या डीबग करने पर, Android Studio अपने-आप एक OAuth पासकोड जनरेट करता है. यह पासकोड, ऐप्लिकेशन को डेवलप करने और डीबग करने के लिए होता है. पूरी जानकारी के लिए, Android Studio: अपने डीबग बिल्ड पर हस्ताक्षर करना लेख पढ़ें.

    अपने मोबाइल डिवाइस को लोकल मशीन से कनेक्ट करें. Android Studio, कनेक्ट किए गए डिवाइसों की सूची, मॉडल नंबर के हिसाब से दिखाएगा. सूची में से अपना डिवाइस चुनें. इसके बाद, प्रोजेक्ट चलाएं पर क्लिक करें. इससे, आपके मोबाइल डिवाइस पर सैंपल ऐप्लिकेशन बनता है और इंस्टॉल होता है.

    ज़्यादा जानकारी के लिए, Android Developers साइट पर हार्डवेयर डिवाइस पर ऐप्लिकेशन चलाना लेख पढ़ें.

    अब चल रहे ऐप्लिकेशन को बंद करें.

  5. Google Cloud Console की सहायता साइट पर, OAuth 2.0 / नेटिव ऐप्लिकेशन / Android सेट अप करना में दिए गए निर्देशों का पालन करके, OAuth सर्टिफ़िकेट का SHA-1 फ़िंगरप्रिंट पाएं.

  6. OAuth 2.0 के लिए सैंपल ऐप्लिकेशन रजिस्टर करें और OAuth 2.0 सेट अप करना में दिए गए निर्देशों का पालन करके, OAuth क्रेडेंशियल बनाएं.

    1. ऐप्लिकेशन का टाइप बताएं, जो नेटिव/Android ऐप्लिकेशन है.
    2. Google Cloud Console की सहायता साइट पर, OAuth 2.0 / नेटिव ऐप्लिकेशन / Android सेट अप करना में दिए गए निर्देशों का पालन करके, OAuth क्लाइंट में SHA-1 फ़िंगरप्रिंट जोड़ें. आपको डेवलपमेंट की पूरी प्रोसेस के दौरान, डिफ़ॉल्ट Android Studio कुंजी से SHA-1 कुंजी जनरेट करनी चाहिए.
    3. टेस्टर जोड़ें. टेस्टर के पास सैंपल ऐप्लिकेशन में अनुमतियां देने का विशेषाधिकार होता है.

  7. अपने मोबाइल डिवाइस को लोकल मशीन से कनेक्ट करके, मोबाइल डिवाइस पर सैंपल ऐप्लिकेशन चलाने के लिए, फिर से प्रोजेक्ट चलाएं पर क्लिक करें.

इंस्टॉल होने के बाद, यह ऐप्लिकेशन आपके मोबाइल डिवाइस पर Home API का सैंपल ऐप्लिकेशन के तौर पर उपलब्ध होता है.