אפליקציית דוגמה ל-Home APIs ל-Android

באפליקציית הדוגמה מוצגות היכולות הבסיסיות של ממשקי ה-API של Google Home ל-Android.

דרישות מוקדמות

כדי ליצור, להתקין ולבדוק את האפליקציה, צריך לעמוד בכמה תנאים מוקדמים:

  • Android Studio, גרסה 2024.2.1 ("Ladybug") ואילך. לתשומת ליבכם, יכול להיות שגרסאות ישנות יותר לא יפעלו כמו שצריך עם Home APIs SDK.

    הורדת Android Studio

  • תכונת ניפוי הבאגים של Android‏ (adb).

    מתקינים את adb.

    אפשר לעשות זאת באמצעות מנהל ה-SDK.

כדי לבדוק את ממשקי ה-API של Home, תצטרכו:

  • מכשיר Android עם מערכת Android מגרסה 10 ואילך, שמוגדרת בו חשבון Google שבו אתם מתכוונים להשתמש לפיתוח. מוודאים שגרסה עדכנית של Android Studio מותקנת ונכנסים אליה באמצעות חשבון הפיתוח הזה.
  • רשת Wi-Fi.
  • מרכז Google שתומך בממשקי Home API.

  • מכשיר נתמך אחד לפחות בבית. אם המכשיר הזה (או כל מכשיר אחר שרוצים לבדוק) משתמש ב-Thread, גם הרכז צריך להיות נתב גבולות ל-Thread. סוגי המכשירים והמאפיינים הבאים נתמכים באפליקציית הדוגמה ל-Android:

    • תאורת טמפרטורת צבע (הפעלה והשבתה, בהירות)
    • חיישן מגע (מצב בוליאני)
    • תאורה ניתנת לעמעום (הפעלה וכיבוי, בהירות)
    • תאורת צבעים מורחבת (הפעלה והשבתה, בהירות)
    • Generic Switch
    • חיישן נוכחות (חישת תפוסה)
    • הפעלה/השבתה של התאורה (הפעלה והשבתה, בהירות)
    • מתג תאורה להפעלה/כיבוי
    • יחידה עם מתג הפעלה/כיבוי (הפעלה וכיבוי)
    • חיישן הפעלה/כיבוי

  1. במסוף Google Cloud, נכנסים למרכז הבקרה לבחירת פרויקט ובוחרים את הפרויקט שבו רוצים להשתמש כדי ליצור פרטי כניסה ל-OAuth.
  2. עוברים לדף APIs and Services ולוחצים על Credentials בתפריט הניווט.

  3. אם עדיין לא הגדרתם את מסך ההסכמה לפרויקט הזה ב-Google Cloud, יופיע הלחצן Configure consent screen (הגדרת מסך ההסכמה). במקרה כזה, צריך להגדיר את מסך ההסכמה לפי התהליך הבא. אחרת, עוברים לקטע הבא.

    1. לוחצים על Configure consent screen (הגדרת מסך ההסכמה). הדף מסך ההסכמה ל-OAuth יוצג.
    2. בהתאם לתרחיש לדוגמה, בוחרים באפשרות פנימי או חיצוני ולוחצים על Create. החלונית מסך הסכמה ל-OAuth תוצג.
    3. מזינים את הפרטים בדף פרטי האפליקציה לפי ההוראות במסך, ואז לוחצים על שמירה והמשך. החלונית Scopes תוצג.
    4. אין צורך להוסיף היקפי גישה, לכן לוחצים על Save and continue (שמירה והמשך). החלונית משתמשי בדיקה תוצג.
    5. אם רוצים להוסיף משתמשים כדי לבדוק את הגישה לאפליקציה, לוחצים על הוספת משתמשים. החלונית Add users תופיע. למשתמשים לבדיקה יש הרשאה להעניק הרשאות באפליקציה.
    6. בשדה הריק, מוסיפים כתובת אימייל אחת או יותר של חשבון Google ולוחצים על Add.
    7. לוחצים על שמירה והמשך. החלונית Summary תופיע.
    8. בודקים את המידע במסך ההסכמה ל-OAuth ולוחצים על Back to dashboard.

פרטים מלאים זמינים במאמר הגדרת מסך הסכמה ל-OAuth באתר העזרה של מסוף Google Cloud.

איך מורידים את קוד המקור

קוד המקור של האפליקציה לדוגמה זמין ב-GitHub.

עוברים למיקום שבו רוצים לשמור את הפרויקט ומשכפלים אותו:

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

הגדרת ה-SDK

ממשקי ה-API של Home ל-Android בגרסת הבטא הפתוחה הזו עדיין לא נכללים בספריות הרגילות ש-Google מספקת לפיתוח. כדי לפתח אפליקציות ל-Android באמצעות ממשקי ה-API של Home, צריך להוריד את הספריות לאתר המקומי שלכם ולארח אותן.

כדי להוריד את ה-SDK של Home APIs ל-Android, תחילה צריך להיכנס לחשבון Google Home Developers.

כניסה לחשבון

פיתוח והרצה

  1. פותחים את Android Studio ואז את תיקיית הפרויקט google-home-api-sample-app-android שהועתק למכונה המקומית.
  2. במהלך ההגדרה הראשונה, יכול להיות שיחלפו עד 10 דקות עד ש-Android Studio תוריד את כל יחסי התלות בפרויקט ותשלים את ה-build של Gradle.
    • אם מופיעה שגיאה בשלב הזה, למשל Gradle Sync Failed, לוחצים על ניסיון חוזר כדי להתחיל את הסנכרון מחדש.
  3. משנים את שם החבילה של אפליקציית הדוגמה לשם חדש שלא נרשם בעבר, למשל שם שמבוסס על שם הארגון:
    1. פותחים את הפרויקט.
    2. מרחיבים את היררכיית המקורות.
    3. בוחרים את החלק בחבילה שרוצים לשנות – כלומר, com.example.
    4. לוחצים לחיצה ימנית על החבילה ובוחרים באפשרות Refactor‏ > Rename…
    5. לוחצים על All Directories (כל הספריות).
    6. מזינים את השם החדש ולוחצים על Refactor.
    7. עורכים את הקובץ build.gradle.kts, ומחליפים את הערכים של android namespace ו-applicationId בשם החבילה החדש.
    8. עורכים את הקובץ AndroidManifest.xml ומשנים את השם של החבילה לשם החדש בכל מקום שבו הוא מופיע בקובץ.

  4. מריצים את האפליקציה ב-Android Studio כדי ליצור אישור חתימת אפליקציה לצורכי ניפוי באגים. כשמריצים או מאתרים באגים באפליקציה ב-Android Studio, Android Studio יוצר באופן אוטומטי אישור לחתימה על אפליקציות שמיועד לפיתוח ולניפוי באגים. הסבר מלא זמין במאמר Android Studio: חתימה על build לניפוי באגים.

    מחברים את המכשיר הנייד למחשב המקומי. Android Studio תציג את המכשירים המקושרים לפי מספר הדגם. בוחרים את המכשיר מהרשימה ולוחצים על הפעלת הפרויקט. הפקודה הזו יוצרת ומתקינה את אפליקציית הדוגמה במכשיר הנייד.

    הוראות מפורטות יותר זמינות במאמר הפעלת אפליקציות במכשיר חומרה באתר למפתחי Android.

    עכשיו עוצרים את האפליקציה שפועלת.

  5. כדי לקבל את טביעת האצבע של SHA-1 של אישור ניפוי הבאגים, פועלים לפי ההוראות שמפורטות במאמר הגדרת OAuth 2.0 / אפליקציות מקוריות / Android באתר העזרה של מסוף Google Cloud.

  6. רושמים את האפליקציה לדוגמה ל-OAuth 2.0 ויוצרים את פרטי הכניסה ל-OAuth לפי ההוראות שמפורטות במאמר הגדרת OAuth 2.0.

    1. מציינים את סוג האפליקציה, שהוא native/Android app.
    2. מוסיפים את טביעת האצבע של SHA-1 ללקוח OAuth לפי ההוראות במאמר הגדרת OAuth 2.0 / אפליקציות מקוריות / Android באתר העזרה של מסוף Google Cloud. לאורך תהליך הפיתוח, צריך ליצור את מפתח ה-SHA-1 ממפתח ברירת המחדל של Android Studio.
    3. מוסיפים משתמשי בדיקה. למשתמשי הבדיקה יש הרשאה להקצות הרשאות באפליקציית הדוגמה.

  7. כשהמכשיר הנייד מחובר למכונה המקומית, לוחצים שוב על הפעלת הפרויקט כדי להריץ את האפליקציה לדוגמה במכשיר הנייד.

אחרי ההתקנה, האפליקציה תהיה זמינה במכשיר הנייד בתור Home API Sample App.