نموذج تطبيق Android لواجهات برمجة التطبيقات Home APIs

يعرض نموذج التطبيق الإمكانات الأساسية لواجهات برمجة تطبيقات Google Home.

المتطلبات الأساسية

لإنشاء التطبيق وتثبيته واختباره، عليك استيفاء بعض المتطلبات الأساسية:

  • Android Studio، الإصدار 2024.2.1 ("Ladybug") أو إصدار أحدث يُرجى العِلم أنّ الإصدارات الأقدم من هذا قد لا تعمل بشكل صحيح مع حزمة تطوير البرامج (SDK) لـ Home APIs.

    تنزيل "استوديو Android"

  • أداة تصحيح أخطاء Android (adb)

    ثبِّت adb.

    ويمكن إجراء ذلك باستخدام مدير حِزم SDK.

ولاختبار واجهات برمجة التطبيقات في Home، ستحتاج إلى ما يلي:

  • جهاز Android يعمل بالإصدار 10 أو إصدار أحدث تم إعداده باستخدام حساب Google تنوي استخدامه لتطوير التطبيقات تأكَّد من تثبيت أحدث إصدار من IDE Android Studio وتسجيل الدخول إليه باستخدام حساب التطوير هذا.
  • شبكة Wi-Fi
  • مركز 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، ثم انقر على الرجوع إلى لوحة البيانات.

اطّلِع على مقالة إعداد شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth على موقع مركز مساعدة Google Cloud Console الإلكتروني للحصول على التفاصيل الكاملة.

تنزيل رمز المصدر

يتوفّر رمز المصدر للتطبيق النموذجي على Github.

انتقِل إلى المكان الذي تريد حفظ المشروع فيه، ثم انشِئه من جديد:

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

إعداد حزمة SDK

لا تُعد واجهات برمجة التطبيقات Home APIs في الإصدار التجريبي المفتوح هذا جزءًا من المكتبات العادية التي تقدّمها Google للتطوير. لتطوير التطبيقات باستخدام واجهة برمجة التطبيقات Home APIs، عليك تنزيل المكتبات واستضافتها محليًا.

لتنزيل حزمة تطوير البرامج (SDK) لـ Home APIs على Android، يجب أولاً تسجيل الدخول إلى Google Home Developers.

عليك تسجيل الدخول الآن.

الإنشاء والتشغيل

  1. افتح Android Studio، ثم افتح مجلد المشروع google-home-api-sample-app-android الذي تم نسخه إلى جهازك المحلي.
  2. أثناء عملية الإعداد الأولى، قد يستغرق Android Studio ما يصل إلى 10 دقائق لتنزيل جميع تبعيات المشروع وإكمال عملية إنشاء Gradle.
    • إذا ظهر لك خطأ أثناء هذه الخطوة، مثل Gradle Sync Failed، انقر على إعادة المحاولة لبدء المزامنة مرة أخرى.
  3. غيِّر اسم حزمة نموذج التطبيق إلى اسم جديد لم يتم تسجيله من قبل، مثل اسم يستند إلى اسم مؤسستك:
    1. افتح المشروع.
    2. وسِّع التسلسل الهرمي للمصدر.
    3. اختَر الجزء من الحزمة الذي تريد تغييره، أي com.example.
    4. انقر بزر الماوس الأيمن على الحزمة واختَر إعادة صياغة > إعادة تسمية...
    5. انقر على كل الأدلة.
    6. أدخِل الاسم الجديد وانقر على إعادة التشكيل.
    7. عدِّل ملف build.gradle.kts، وغيِّر android namespace وapplicationId إلى اسم الحزمة الجديد.
    8. عدِّل ملف AndroidManifest.xml وغيِّر الحزمة إلى اسم الحزمة الجديد أينما يظهر في الملف.

  4. أنشئ مفتاح OAuth من خلال تشغيل التطبيق في Android Studio. عند تشغيل تطبيق أو تصحيح أخطاءه في Android Studio، Android Studio ينشئ تلقائيًا مفتاح OAuth مخصّصًا للتطوير وتصحيح الأخطاء. اطّلِع على مقالة Android Studio: توقيع إصدار تصحيح الأخطاء للحصول على شرح كامل.

    وصِّل جهازك الجوّال بجهاز الكمبيوتر. ستعرض Android Studio الأجهزة المتصلة حسب الرقم الطراز. اختَر جهازك من القائمة، ثم انقر على تشغيل المشروع. يؤدي ذلك إلى إنشاء نموذج التطبيق وتثبيته على جهازك الجوّال.

    للحصول على تعليمات أكثر تفصيلاً، يُرجى الاطّلاع على مقالة تشغيل التطبيقات على جهاز برمجي على موقع "مطوّرو تطبيقات Android" الإلكتروني.

    الآن أوقِف التطبيق الذي يعمل.

  5. احصل على الملف المرجعي SHA-1 لشهادة OAuth من خلال اتّباع التعليمات المفصّلة في مقالة إعداد OAuth 2.0 / التطبيقات الأصلية / Android على موقع مساعدة Google Cloud Console الإلكتروني.

  6. سجِّل نموذج التطبيق لاستخدام بروتوكول OAuth 2.0 وأنشئ بيانات اعتماد OAuth من خلال اتّباع التعليمات الواردة في إعداد بروتوكول OAuth 2.0.

    1. حدِّد نوع التطبيق، وهو تطبيق أصلي/تطبيق Android.
    2. أضِف بصمة SHA-1 إلى مزوّد خدمة OAuth من خلال اتّباع تعليمات إعداد OAuth 2.0 / التطبيقات الأصلية / Android على موقع مساعدة Google Cloud Console الإلكتروني. يجب إنشاء مفتاح SHA-1 من مفتاح Android Studio التلقائي طوال عملية التطوير.
    3. أضِف مستخدمين تجريبيين. يحصل المستخدمون التجريبيون على امتياز منح الأذونات في التطبيق التجريبي.

  7. مع توصيل جهازك الجوّال بجهاز الكمبيوتر، انقر على تشغيل المشروع مرة أخرى لتشغيل نموذج التطبيق على جهازك الجوّال.

بعد التثبيت، يتوفّر التطبيق على جهازك الجوّال باسم Home API Sample App.