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

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

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

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

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

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

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

    ثبِّت adb.

    يمكن إجراء ذلك باستخدام SDK Manager.

لاختبار واجهات برمجة التطبيقات الخاصة بالمنزل الذكي، ستحتاج إلى ما يلي:

  • جهاز Android يعمل بالإصدار 10 أو الإصدارات الأحدث تم إعداده باستخدام حساب Google تنوي استخدامه في عملية التطوير تأكَّد من تثبيت إصدار حديث من Android Studio وتسجيل الدخول إليه باستخدام حساب المطوّر هذا.
  • شبكة Wi-Fi
  • للوصول إلى أجهزة Matter والتحكّم فيها، يجب أن يكون لديك أيضًا مركز تحكّم من Google متوافق مع واجهات برمجة التطبيقات Home. لمزيد من التفاصيل، يُرجى الاطّلاع على الاتصال على أجهزة Android .

  • جهاز واحد على الأقل متوافق في المنزل إذا كان هذا الجهاز (أو أي جهاز آخر تريد اختباره) يستخدم Thread، يجب أن يكون المحور أيضًا جهاز توجيه حدود شبكة Thread. يتوافق تطبيق Android النموذجي مع أنواع الأجهزة وسماتها التالية:

    • مصباح درجة حرارة اللون (تشغيل وإيقاف، السطوع)
    • مستشعر الاتصال (حالة منطقية)
    • مصباح قابل للتعتيم (تشغيل وإيقاف، درجة السطوع)
    • ضوء الألوان الممتد (تشغيل وإيقاف، السطوع)
    • Generic Switch
    • مستشعر إشغال المنزل (استشعار إشغال المنزل)
    • تشغيل/إيقاف الإضاءة (تشغيل وإيقاف، السطوع)
    • مفتاح تشغيل/إيقاف الإضاءة
    • وحدة التوصيل والتشغيل/الإيقاف (تشغيل وإيقاف)
    • مستشعر التشغيل/الإيقاف

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

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

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

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

إعداد حزمة تطوير البرامج (SDK)

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

لتنزيل حزمة تطوير البرامج (SDK) لنظام التشغيل Android الخاصة بواجهات برمجة التطبيقات في Home، يجب أولاً تسجيل الدخول إلى حسابك في "منصة مطوّري Google Home".

تسجيل الدخول الآن

إنشاء التطبيق

  1. افتح Android Studio، ثم افتح مجلد المشروع google-home-api-sample-app-android الذي تم استنساخه إلى جهازك المحلي.

  2. أثناء عملية الإعداد الأولى، قد يستغرق تنزيل جميع التبعيات الخاصة بالمشروع وإكمال عملية إنشاء Gradle مدة تصل إلى 10 دقائق.Android Studio

  3. وصِّل الكمبيوتر بهاتف Android حقيقي باستخدام كابل USB وفعِّل تصحيح أخطاء ADB في خيارات المطوّرين. تأكَّد من أنّ Android Studio يمكنه الاتصال بهاتف Android من خلال ADB.

  4. غيِّر اسم حزمة التطبيق النموذجي إلى اسم جديد لم يتم تسجيله من قبل، مثل اسم يستند إلى اسم مؤسستك:

    1. افتح المشروع.
    2. وسِّع التسلسل الهرمي للمصدر.
    3. اختَر جزء الحزمة الذي تريد تغييره، أي com.example.
    4. انقر بزر الماوس الأيمن على الحزمة واختَر Refactor (إعادة تصميم) > Rename... (إعادة تسمية...) Refactor > Rename menu
    5. أدخِل الاسم الجديد وانقر على إعادة تصميم.
    6. عدِّل الملف build.gradle.kts، وغيِّر android namespace وapplicationId إلى اسم الحزمة الجديد.

  5. بعد تنزيل جميع المكتبات المطلوبة واكتمال عملية المزامنة في Gradle، انقر على الزر تشغيل لإنشاء التطبيق وتشغيله. وعند تشغيل التطبيق بنجاح على هاتفك، ستظهر لك الصفحة الرئيسية لـ "التطبيق التجريبي".

إنشاء شهادة توقيع

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

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

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

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

    أوقِف التطبيق الذي يتم تشغيله.

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

  1. في Google Cloud Console، انتقِل إلى لوحة بيانات اختيار المشروع واختَر المشروع الذي تريد استخدامه لإنشاء بيانات اعتماد OAuth.
  2. انتقِل إلى صفحة واجهات برمجة التطبيقات والخدمات، ثم انقر على بيانات الاعتماد في قائمة التنقّل.

  3. إذا لم تكن قد ضبطت شاشة الموافقة لمشروع Google Cloud هذا، سيظهر الزر ضبط شاشة الموافقة. في هذه الحالة، اضبط شاشة طلب الموافقة باتّباع الإجراء التالي. بخلاف ذلك، انتقِل إلى القسم التالي.

    1. انقر على إعداد شاشة الموافقة. تظهر صفحة شاشة موافقة OAuth.
    2. استنادًا إلى حالة الاستخدام، اختَر داخلي أو خارجي، ثم انقر على إنشاء. يظهر جزء شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth.
    3. أدخِل المعلومات في صفحة معلومات التطبيق وفقًا للتعليمات الظاهرة على الشاشة، ثم انقر على حفظ ومتابعة. يتم عرض جزء نطاقات.
    4. لست بحاجة إلى إضافة أي نطاقات، لذا انقر على حفظ ومتابعة. يتم عرض لوحة المستخدمون التجريبيون.
    5. انقر على شريحة الجمهور، ثمّ انقر على الزر + إضافة مستخدمين.
    6. أدخِل عنوان البريد الإلكتروني للمستخدم التجريبي وانقر على الزر حفظ.
    7. انقر على حفظ ومتابعة. يظهر جزء الملخّص.
    8. راجِع معلومات شاشة طلب الموافقة المتعلّقة ببروتوكول OAuth، ثم انقر على الرجوع إلى لوحة البيانات.

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

إعداد بيانات اعتماد OAuth

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

تشغيل التطبيق

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

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