Przykładowa aplikacja na Androida Home APIs

Przykładowa aplikacja prezentuje podstawowe możliwości interfejsów Google Home API na Androida.

Wymagania wstępne

Aby utworzyć, zainstalować i przetestować aplikację, musisz spełnić kilka wymagań wstępnych:

• Android Studio w wersji 2024.2.1 ("Ladybug") lub nowszej. Pamiętaj, że wersje wcześniejsze mogą nie działać prawidłowo z pakietem SDK Home APIs.

  Pobierz Android Studio

• Debugger Androida (adb).

  Zainstaluj adb.

  Możesz to zrobić za pomocą Menedżera SDK.

Aby przetestować interfejsy Home API, musisz mieć:

• Urządzenie z Androidem w wersji 10 lub nowszej skonfigurowane za pomocą konta Google, którego chcesz używać do programowania. Upewnij się, że masz zainstalowaną aktualną wersję Android Studio i że jesteś zalogowany(-a) na to konto dewelopera.
• Sieć Wi-Fi.
• Aby uzyskać dostęp do urządzeń Matter i nimi sterować, potrzebujesz też huba Google, który obsługuje interfejsy Home API. Więcej informacji znajdziesz w artykule Łączność na Androidzie .

• Co najmniej 1 obsługiwane urządzenie w domu. Jeśli to urządzenie (lub inne, które chcesz przetestować) korzysta z protokołu Thread, hub musi być też Thread Border Router (TBR). Aplikacja próbna na Androida obsługuje te typy urządzeń i cechy:

  • Światło o regulowanej temperaturze barwowej (włączanie i wyłączanie, jasność)
  • Czujnik kontaktu (stan logiczny)
  • Światło z możliwością ściemniania (włączanie i wyłączanie, jasność)
  • Zamek do drzwi
  • Światło o rozszerzonej palecie barw (włączanie i wyłączanie, jasność)
  • Przełącznik ogólny
  • Router graniczny Google
  • Aparat Google
  • Dzwonek Google
  • Czujnik obecności (wykrywanie obecności)
  • Światło włączane i wyłączane (włączanie i wyłączanie, jasność)
  • Włącznik światła
  • Włącznik (włączanie i wyłączanie)
  • Czujnik włączania i wyłączania

Pobieranie kodu źródłowego

Kod źródłowy aplikacji próbnej jest dostępny na GitHubie.

Przejdź do miejsca, w którym chcesz zapisać projekt, a następnie go skopiuj:

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

Konfigurowanie pakietu SDK

Interfejsy Home API na Androida w tej otwartej wersji beta nie są jeszcze częścią standardowych bibliotek udostępnianych przez Google dla deweloperów. Aby tworzyć aplikacje na Androida za pomocą interfejsów Home API, musisz pobrać i hostować biblioteki lokalnie.

Aby pobrać pakiet SDK Home APIs na Androida, musisz najpierw zalogować się w Google Home Developers.

Zaloguj się teraz

Tworzenie aplikacji

1. Otwórz Android Studio, a następnie otwórz folder projektu google-home-api-sample-app-android, który został skopiowany na Twój komputer.

2. Podczas pierwszej konfiguracji Android Studiopobranie wszystkich zależności projektu i ukończenie kompilacji Gradle może potrwać do 10 minut.

3. Podłącz komputer do fizycznego telefonu z Androidem za pomocą kabla USB i włącz ADB w opcjach dla programistów. Upewnij się, że Android Studio może połączyć się z telefonem z Androidem przez ADB.

4. Zmień nazwę pakietu przykładowej aplikacji na nową, która nie została jeszcze zarejestrowana, np. na podstawie nazwy organizacji:

   1. Otwórz projekt.
   2. Rozwiń hierarchię źródeł.
   3. Wybierz część pakietu, którą chcesz zmienić, czyli com.example.
   4. Kliknij pakiet prawym przyciskiem myszy i wybierz Refactor > Rename...
   5. Wpisz nową nazwę i kliknij Refactor.
   6. Edytuj plik build.gradle.kts, zmieniając android namespace i applicationId na nową nazwę pakietu.

5. Skonfiguruj zakres OAuth w HomeModule.kt. Domyślnie kod źródłowy przykładowej aplikacji używa zakresu https://www.googleapis.com/auth/home.platform.v2. Wiele funkcji przykładowej aplikacji jest ograniczonych zakresem home.platform.v2 i wymaga zatwierdzenia przez partnera. Aby uruchomić przykładową aplikację ze standardowym zakresem https://www.googleapis.com/auth/home.platform.selected.devices, otwórz HomeModule.kt i zmień homePlatformScope w HomeConfig na HOME_PLATFORM_SCOPE_VERSION_1:

   val homeConfig = HomeConfig(
     coroutineContext = Dispatchers.IO,
     factoryRegistryProvider = {
       FactoryConstants.factoryRegistryAllTraitsAllTypes
     },
     homePlatformScope =
       HomeConfig.HomePlatformScope.HOME_PLATFORM_SCOPE_VERSION_1
   )
   

Zaktualizuj też homePlatformScope na HOME_PLATFORM_SCOPE_VERSION_1 w switchAccount() w HomeClientProvider.kt. W przeciwnym razie wybranie ikony profilu w celu przełączenia konta spowoduje przywrócenie w aplikacji zakresu HOME_PLATFORM_SCOPE_VERSION_2.

1. Gdy wszystkie wymagane biblioteki zostaną pobrane i synchronizacja Gradle się zakończy, kliknij przycisk Uruchom , aby utworzyć i uruchomić aplikację. Gdy aplikacja będzie działać prawidłowo na telefonie, zobaczysz stronę główną przykładowej aplikacji.

Tworzenie certyfikatu podpisywania

Gdy uruchamiasz lub debugujesz aplikację w Android Studio, automatycznie generuje ona certyfikat debugowania przeznaczony do programowania i debugowania. Pełne wyjaśnienie znajdziesz w artykule Android Studio: Sign your debug build.

1. Wygeneruj certyfikat podpisywania aplikacji do debugowania, uruchamiając aplikację w Android Studio. Gdy uruchamiasz lub debugujesz aplikację w Android Studio, Android Studio automatycznie generuje certyfikat podpisywania aplikacji przeznaczony do programowania i debugowania. Pełne wyjaśnienie znajdziesz w artykule Android Studio: Sign your debug build.

   Podłącz urządzenie mobilne do komputera. Android Studio wyświetli listę podłączonych urządzeń według numeru modelu. Wybierz urządzenie z listy, a następnie kliknij Uruchom projekt. Spowoduje to utworzenie i zainstalowanie przykładowej aplikacji na urządzeniu mobilnym.

   Bardziej szczegółowe instrukcje znajdziesz w artykule Uruchamianie aplikacji na urządzeniu fizycznym na stronie dla deweloperów aplikacji na Androida.

   Teraz zatrzymaj uruchomioną aplikację.

2. Pobierz odcisk palca SHA-1 certyfikatu debugowania, postępując zgodnie z instrukcjami podanymi w Zarządzanie klientami OAuth / Typy aplikacji / Aplikacje natywne / Android na stronie pomocy konsoli Google Cloud.

Konfigurowanie zgody OAuth

1. W konsoli Google Cloud otwórz panel wyboru projektu i wybierz projekt, którego chcesz użyć do utworzenia danych logowania OAuth.
2. Otwórz stronę Interfejsy API i usługi i w menu nawigacyjnym kliknij Dane logowania.

3. Jeśli nie masz jeszcze skonfigurowanego ekranu zgody dla tego projektu Google Cloud, pojawi się przycisk Skonfiguruj ekran zgody. W takim przypadku skonfiguruj ekran zgody, wykonując te czynności. W przeciwnym razie przejdź do następnej sekcji.

   1. Kliknij Skonfiguruj ekran zgody. Wyświetli się strona Ekran zgody OAuth.
   2. W zależności od przypadku użycia wybierz Wewnętrzny lub Zewnętrzny, a następnie kliknij Utwórz. Wyświetli się panel Ekran zgody OAuth.
   3. Wpisz informacje na stronie informacji o aplikacji zgodnie z instrukcjami wyświetlanymi na ekranie, a następnie kliknij Zapisz i kontynuuj. Wyświetli się panel Zakresy.
   4. Nie musisz dodawać żadnych zakresów, więc kliknij Zapisz i kontynuuj. Wyświetli się panel Użytkownicy testowi.
   5. Kliknij Odbiorcy , a potem przycisk + DODAJ UŻYTKOWNIKÓW.
   6. Wpisz adres e-mail użytkownika testowego i kliknij przycisk ZAPISZ.
   7. Kliknij Zapisz i kontynuuj. Wyświetli się panel Podsumowanie.
   8. Sprawdź informacje na ekranie zgody OAuth, a następnie kliknij Wróć do panelu.

Pełne informacje znajdziesz w artykule Konfigurowanie ekranu zgody OAuth na stronie pomocy konsoli Google Cloud. Zanim przejdziesz dalej, dodaj co najmniej 1 użytkownika testowego.

Konfigurowanie danych logowania OAuth

1. Zarejestruj przykładową aplikację w protokole OAuth 2.0 i utwórz dane logowania OAuth, postępując zgodnie z instrukcjami podanymi w Konfigurowanie protokołu OAuth 2.0.
   1. Wskaż typ aplikacji, czyli aplikacja natywna/na Androida.
   2. Dodaj odcisk palca SHA-1 do klienta OAuth, postępując zgodnie z instrukcjami podanymi w artykule Konfigurowanie OAuth 2.0 / Aplikacje natywne / Android na stronie pomocy konsoli Google Cloud. Podczas całego procesu programowania należy generować klucz SHA-1 z domyślnego klucza Androida Studio.

Uruchamianie aplikacji

1. Gdy urządzenie mobilne jest podłączone do komputera, kliknij ponownie Uruchom projekt , aby uruchomić przykładową aplikację na urządzeniu mobilnym.

Po zainstalowaniu aplikacja jest dostępna na urządzeniu mobilnym jako Home API Sample App.