Aplikacja przykładowa interfejsów API Home na Androida

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

Wymagania wstępne

Aby skompilować, zainstalować i przetestować aplikację, musisz spełnić kilka warunków wstępnych:

  • Android Studio, wersja 2024.2.1 („Ladybug”) lub nowsza. Pamiętaj, że starsze wersje mogą nie działać prawidłowo z Home APIs SDK.

    Pobierz Android Studio

  • Debuger Androida (adb).

    Zainstaluj adb.

    Można to zrobić za pomocą menedżera pakietu SDK.

Aby przetestować interfejsy API Home, musisz mieć:

  • Urządzenie z Androidem 10 lub nowszym z kontem Google, którego chcesz używać do tworzenia aplikacji. Upewnij się, że zainstalowana jest aktualna wersja aplikacji Android Studio i że zalogowano się na to konto deweloperskie.
  • sieć Wi-Fi,
  • Centrum Google, które obsługuje interfejsy API Home.

  • co najmniej 1 obsługiwane urządzenie w domu; Jeśli to urządzenie (lub inne, które chcesz przetestować) korzysta z Thread, koncentrator musi też być routerem brzegowym Thread. Przykładowa aplikacja na Androida obsługuje te typy i cechy urządzeń:

    • Temperatura barwy światła (włączanie i wyłączanie, jasność)
    • Czujnik kontaktowy (stan logiczny)
    • Regulacja jasności światła (włączanie i wyłączanie, jasność)
    • Extended Color Light (włączanie i wyłączanie, jasność)
    • Przełącznik ogólny
    • Czujnik obecności (wykrywanie obecności)
    • Włączanie i wyłączanie światła (włączanie i wyłączanie, jasność)
    • Włącznik światła włącz/wyłącz
    • Włącznik (włączanie i wyłączanie)
    • Czujnik włączania i wyłączania

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

  3. Jeśli nie masz jeszcze skonfigurowanego ekranu zgody w tym projekcie Google Cloud, pojawi się przycisk Skonfiguruj ekran zgody. W takim przypadku skonfiguruj ekran zgody, korzystając z tej procedury. W przeciwnym razie przejdź do następnej sekcji.

    1. Kliknij Skonfiguruj ekran zgody. Wyświetla 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. Pojawi się panel Ekran zgody OAuth.
    3. Wpisz informacje na stronie z informacjami o aplikacji zgodnie z instrukcjami wyświetlanymi na ekranie, a potem kliknij Zapisz i kontynuuj. Pojawi się panel Zakresy.
    4. Nie musisz dodawać żadnych zakresów, więc kliknij Zapisz i kontynuuj. Wyświetli się panel Użytkownicy testowi.
    5. Jeśli chcesz dodać użytkowników, którzy będą testować dostęp do aplikacji, kliknij Dodaj użytkowników. Pojawi się panel Dodaj użytkowników. Użytkownicy testowi mają uprawnienia do przyznawania uprawnień w aplikacji.
    6. W pustym polu dodaj co najmniej 1 adres e-mail konta Google, a następnie kliknij Dodaj.
    7. Kliknij Zapisz i kontynuuj. Pojawi się panel Podsumowanie.
    8. Zapoznaj się z informacjami na ekranie zgody OAuth, a potem kliknij Wróć do panelu.

Więcej informacji znajdziesz w artykule Konfigurowanie ekranu zgody OAuth w Centrum pomocy konsoli Google Cloud.

Pobieranie kodu źródłowego

Kod źródłowy przykładowej aplikacji jest dostępny na GitHubie.

Przejdź do miejsca, w którym chcesz zapisać projekt, a potem go sklonuj:

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

Konfigurowanie pakietu SDK

Interfejsy API Home w ramach otwartych testów beta nie są jeszcze częścią standardowych bibliotek udostępnianych przez Google na potrzeby programowania. Aby tworzyć aplikacje korzystające z interfejsów API Home, musisz pobrać biblioteki i hostować je lokalnie.

Aby pobrać pakiet Android SDK interfejsów API Home, musisz najpierw zalogować się w Google jako deweloper Home.

Zaloguj się teraz

Tworzenie i uruchamianie

  1. Otwórz Android Studio, a następnie folder projektu google-home-api-sample-app-android, który został sklonowany na komputer lokalny.
  2. Podczas pierwszej konfiguracji Android Studio może potrzebować do 10 minut na pobranie wszystkich zależności projektu i ukończenie kompilacji Gradle.
    • Jeśli podczas tego kroku wystąpi błąd, np. Gradle Sync Failed, kliknij Spróbuj ponownie, aby rozpocząć synchronizację od nowa.
  3. Zmień nazwę pakietu przykładowej aplikacji na nową, która nie była wcześniej rejestrowana, np. na nazwę 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 > Zmień nazwę.
    5. Kliknij Wszystkie katalogi.
    6. Wpisz nową nazwę i kliknij Refactor (Refaktoryzacja).
    7. Zmień plik build.gradle.kts, zastępując android namespace i applicationId nową nazwą pakietu.
    8. Zmień nazwę pakietu na nową w pliku AndroidManifest.xml, w każdym miejscu, w którym występuje w tym pliku.

  4. Wygeneruj klucz OAuth, uruchamiając aplikację w trybie Android Studio. Gdy uruchamiasz aplikację lub debugujesz ją w Android Studio, Android Studio automatycznie generuje klucz OAuth przeznaczony do tworzenia i debugowania. Pełne wyjaśnienia znajdziesz w artykule Android Studio: podpisywanie wersji debugowania.

    Połącz urządzenie mobilne z komputerem lokalnym. Android Studio wyświetli listę połączonych urządzeń według numeru modelu. Wybierz urządzenie z listy i kliknij Uruchom projekt. Spowoduje to skompilowanie i zainstalowanie przykładowej aplikacji na urządzeniu mobilnym.

    Szczegółowe instrukcje znajdziesz w artykule Uruchamianie aplikacji na urządzeniu z Androidem na stronie dla deweloperów aplikacji na Androida.

    Zatrzymaj uruchomioną aplikację.

  5. Aby uzyskać odcisk cyfrowy SHA-1 certyfikatu OAuth, postępuj zgodnie z instrukcjami podanymi w artykule Konfigurowanie OAuth 2.0 / Aplikacje natywne / Android w Centrum pomocy Konsoli Google Cloud.

  6. Zarejestruj przykładową aplikację do OAuth 2.0 i utwórz dane logowania OAuth, wykonując instrukcje podane w artykule Konfigurowanie OAuth 2.0.

    1. Wskazać typ aplikacji, czyli natywna aplikacja na Androida.
    2. Dodaj odcisk cyfrowy SHA-1 do klienta OAuth, wykonując instrukcje podane w artykule Konfigurowanie OAuth 2.0 / Aplikacje natywne / Android w Centrum pomocy Google Cloud Console. W trakcie procesu tworzenia aplikacji należy wygenerować klucz SHA-1 z domyślnego klucza Androida Studio.
    3. Dodaj użytkowników testowych. Użytkownicy testowi mają uprawnienia do przyznawania uprawnień w próbnej aplikacji.

  7. Po podłączeniu urządzenia mobilnego do komputera lokalnego kliknij Uruchom projekt, aby uruchomić przykładową aplikację na urządzeniu mobilnym.

Po zainstalowaniu aplikacja będzie dostępna na urządzeniu mobilnym jako próbna aplikacja interfejsu Home API.