Home APIs برنامه اندروید نمونه

برنامه نمونه قابلیت‌های اساسی APIهای Google Home را به نمایش می‌گذارد.

پیش نیازها

برای ساخت، نصب و آزمایش برنامه، باید چند پیش نیاز را رعایت کنید:

  • Android Studio ، نسخه 2024.2.1 ("لیدی باگ") یا جدیدتر. توجه داشته باشید که نسخه‌های قبل از این ممکن است به درستی با Home APIs SDK کار نکنند.

    اندروید استودیو را دانلود کنید

  • دیباگر اندروید ( adb ).

    adb رو نصب کن

    این را می توان با مدیر SDK انجام داد.

و برای آزمایش APIهای Home، به موارد زیر نیاز دارید:

  • دستگاه Android دارای Android 10 یا جدیدتر با یک حساب Google راه‌اندازی شده است که می‌خواهید از آن برای توسعه استفاده کنید. مطمئن شوید که نسخه به‌روز Android Studio نصب شده و با این حساب توسعه وارد شده است.
  • یک شبکه وای فای
  • یک مرکز Google که از APIهای Home پشتیبانی می کند .

  • حداقل یک دستگاه پشتیبانی شده در خانه. اگر این دستگاه (یا هر دستگاه دیگری که می خواهید آزمایش کنید) از Thread استفاده می کند، هاب نیز باید یک روتر مرزی Thread باشد. انواع دستگاه و ویژگی‌های زیر توسط برنامه نمونه Android پشتیبانی می‌شوند:

    • نور دمای رنگ (روشن و خاموش، روشنایی)
    • سنسور تماس (حالت بولی)
    • نور قابل کاهش (روشن و خاموش، روشنایی)
    • نور رنگی گسترده (روشن و خاموش، روشنایی)
    • سوئیچ عمومی
    • سنسور اشغال (حسگر اشغال)
    • چراغ روشن/خاموش (روشن و خاموش، روشنایی)
    • کلید روشن/خاموش نور
    • واحد پلاگین روشن/خاموش (روشن و خاموش)
    • سنسور روشن/خاموش

  1. در کنسول Google Cloud، به داشبورد انتخابگر پروژه بروید و پروژه ای را که می خواهید برای ایجاد اعتبار OAuth استفاده کنید، انتخاب کنید.
  2. به صفحه APIs and Services بروید و روی Credentials در منوی پیمایش کلیک کنید.

  3. اگر هنوز صفحه رضایت خود را برای این پروژه Google Cloud پیکربندی نکرده‌اید، دکمه پیکربندی صفحه رضایت ظاهر می‌شود. در این صورت، صفحه رضایت خود را با استفاده از روش زیر پیکربندی کنید. در غیر این صورت به بخش بعدی بروید.

    1. روی پیکربندی صفحه رضایت کلیک کنید. صفحه رضایت OAuth نمایش داده می شود.
    2. بسته به مورد استفاده خود، Internal یا External را انتخاب کنید و سپس روی ایجاد کلیک کنید. صفحه نمایش رضایت OAuth نمایش داده می شود.
    3. اطلاعات را در صفحه اطلاعات برنامه مطابق دستورالعمل های روی صفحه وارد کنید و سپس روی ذخیره کلیک کنید و ادامه دهید . صفحه Scopes نمایش داده می شود.
    4. نیازی به اضافه کردن هیچ محدوده ای ندارید، بنابراین روی ذخیره کلیک کنید و ادامه دهید . صفحه کاربران تست نمایش داده می شود.
    5. اگر می‌خواهید کاربرانی را برای دسترسی آزمایشی به برنامه خود اضافه کنید، روی افزودن کاربران کلیک کنید. صفحه افزودن کاربران نمایش داده می شود. کاربران آزمایشی این امتیاز را دارند که به برنامه شما مجوز بدهند.
    6. در فیلد خالی، یک یا چند آدرس ایمیل حساب Google اضافه کنید و سپس روی افزودن کلیک کنید.
    7. روی ذخیره کلیک کنید و ادامه دهید . پنجره Summary نمایش داده می شود.
    8. اطلاعات صفحه رضایت OAuth خود را مرور کنید و سپس روی بازگشت به داشبورد کلیک کنید.

برای جزئیات کامل به تنظیم صفحه رضایت OAuth در سایت راهنمای Google Cloud Console مراجعه کنید.

کد منبع را دانلود کنید

کد منبع برای برنامه نمونه در Github موجود است.

به جایی که می خواهید پروژه را ذخیره کنید بروید، سپس آن را شبیه سازی کنید:

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

SDK را تنظیم کنید

APIهای Home در این بتا باز هنوز بخشی از کتابخانه‌های استاندارد ارائه‌شده توسط Google برای توسعه نیستند. برای توسعه برنامه های کاربردی با API های Home، باید کتابخانه ها را به صورت محلی دانلود و میزبانی کنید.

برای دانلود Home APIs Android SDK، ابتدا باید وارد Google Home Developers شوید.

اکنون وارد شوید!

بسازید و اجرا کنید

  1. Android Studio را باز کنید، سپس پوشه google-home-api-sample-app-android project را که شما در دستگاه محلی کلون شده است، باز کنید.
  2. در طول اولین راه‌اندازی، Android Studio ممکن است ۱۰ دقیقه طول بکشد تا همه وابستگی‌های پروژه را دانلود کند و ساخت Gradle را تکمیل کند.
    • اگر در طول این مرحله با خطایی مواجه شدید، مانند Gradle Sync Failed ، روی Try Again کلیک کنید تا همگام‌سازی دوباره شروع شود.
  3. نام بسته برای برنامه نمونه را به یک نام جدید که قبلاً ثبت نشده است تغییر دهید، مانند نامی که بر اساس نام سازمان شما باشد:
    1. پروژه را باز کنید.
    2. سلسله مراتب منبع را گسترش دهید.
    3. بخشی از بسته را که می خواهید تغییر دهید انتخاب کنید - به عبارت دیگر، com.example .
    4. روی بسته کلیک راست کرده و Refactor > Rename...
    5. روی همه فهرست ها کلیک کنید.
    6. نام جدید را وارد کرده و روی Refactor کلیک کنید.
    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. با دنبال کردن دستورالعمل‌های مشروح در راه‌اندازی OAuth 2.0 / Native applications / Android در سایت راهنمای Google Cloud Console، اثرانگشت SHA-1 گواهی OAuth را دریافت کنید.

  6. برنامه نمونه را برای OAuth 2.0 ثبت کنید و با دنبال کردن دستورالعمل های ارائه شده در راه اندازی OAuth 2.0، اعتبارنامه OAuth را ایجاد کنید.

    1. نوع برنامه را مشخص کنید که بومی/برنامه اندروید است.
    2. با دنبال کردن دستورالعمل‌های راه‌اندازی OAuth 2.0 / Native applications / Android در سایت راهنمای Google Cloud Console، اثر انگشت SHA-1 را به مشتری OAuth اضافه کنید. شما باید کلید SHA-1 را از کلید پیش فرض Android Studio در طول فرآیند توسعه تولید کنید.
    3. کاربران آزمایشی را اضافه کنید. کاربران آزمایشی این امتیاز را دارند که در برنامه نمونه مجوز اعطا کنند.

  7. هنگامی که دستگاه تلفن همراه خود به دستگاه محلی خود متصل است، دوباره روی اجرای پروژه کلیک کنید تا برنامه نمونه در دستگاه تلفن همراه خود اجرا شود.

پس از نصب، برنامه در دستگاه همراه شما به عنوان Home API Sample App در دسترس است.