Google Home-Plug-in für Android Studio

Matter ; Home APIs

Das Google Home Plugin for Android Studio wurde speziell für Entwickler der Google Home-Plattform entwickelt. Mit diesem Plug-in haben Sie Zugriff auf Google Assistant Simulator, Cloud Logging und andere Tools, die den Entwicklungsprozess für Ihr Smart Home vereinfachen.

Sicherheitshinweis

So verhindern Sie, dass Android Studio Secrets und Passwörter speichert:

1. Klicken Sie auf Datei und dann auf Einstellungen.
2. Maximieren Sie unter Darstellung und Verhalten die Systemeinstellungen und klicken Sie dann auf Passwörter.
3. Wählen Sie Nicht speichern, Passwörter nach dem Neustart vergessen aus.

Funktionen

Assistant-Simulator

Wenn Sie testen möchten, ob Ihre Smart-Home-Geräte ordnungsgemäß mit dem Google Home Ökosystem funktionieren, können Sie jederzeit mit Assistant Simulator interagieren, ohne Android Studio zu verlassen.

Mit dem Assistant Simulator können Sie Ihre Geräte ganz einfach steuern, indem Sie Ihre Abfragen eingeben, z. B. „Schalte das Licht ein“. In Android Studio, Assistant Simulator antwortet mit Textnachrichten auf Ihre Befehle, z. B. „Okay, ich schalte das Licht ein“

Cloud Logging ansehen

Google Cloud Logging bietet Debugging-Informationen und wichtige Messwerte, mit denen Sie Einblicke in die Nutzung Ihrer Action erhalten. Um die Entwicklung zu vereinfachen, zeigt das Google Home Plugin während der Fehlerbehebung Cloud Logging Nachrichten in Echtzeit direkt neben Ihrem Code an.

Sie können Echtzeit-Logs anzeigen oder einen Zeitraum auswählen.

Batch-Äußerungen

Assistant Simulator Antworten auf eine einzelne Äußerung sind nicht deterministisch. Eine Antwort kann beispielsweise eine der folgenden Formulierungen sein:

• Okay, ich schalte zwei Lichter ein.
• Ich schalte zwei Lichter ein.
• Okay, ich schalte zwei Lichter ein.
• Ich schalte zwei Lichter ein.

Wenn Sie automatisierte Tests ausführen und prüfen möchten, wie Ihre Google-Integrationen mit diesen verschiedenen Antworten funktionieren, können Sie Batch-Äußerungen an den Assistant Simulator senden, indem Sie Äußerungsskripts ausführen. Sobald ein Skript gespeichert ist, können Sie Antworten erfassen und mehrere Tests für Ihre Abfragen ausführen.

Home Graph-Betrachter

Mit dem Home Graph-Betrachter können Sie den Status Ihrer Geräte anzeigen und die Google Home Test Suite in Ihrem Browser starten.

Android Debug Bridge (adb)-Logbetrachter

Der adb-Logbetrachter ist ein Tool zum Ansehen und Analysieren von Logdateien, z. B. Matter Gerätelogdateien, Google Home-Logs und Android Logs.

Installieren

So installieren Sie das Google Home Plugin in Android Studio, gehen Sie wie folgt vor:

1. Laden Sie Android Studio herunter oder aktualisieren Sie es. Android Studio herunterladen
2. Gehen Sie zu Datei > Einstellungen (Android Studio > Einstellungen unter MacOS).
3. Gehen Sie im Bereich Plug-ins zu Marketplace und suchen Sie nach google home.
4. Installieren Sie das Tool und starten Sie Android Studio neu.

Sie können das Plug-in auch direkt im JetBrains Marketplace herunterladen.

Einrichtung

Nachdem Sie das Plug-in installiert haben, müssen Sie die folgenden Schritte ausführen, bevor Sie Assistant Simulator verwenden und Cloud Logging ansehen können:

• Über Google anmelden
• Cloud-Projekt auswählen

Über Google anmelden

Sie können sich über das Google Home-Feld in Ihrem Entwicklerkonto anmelden, autorisieren Sie Android Studio, mit Google Diensten in Ihrem Namen zu kommunizieren.

1. Klicken Sie in der vertikalen Spalte mit den Tabs auf der linken Seite des Android Studio Fensters auf den Tab Google Home.

2. Klicken Sie unter Anmelden mit auf Google, um Ihren Browser zu starten.

   

3. Wählen Sie das Konto aus, das mit Ihren Smart-Home-Geräten verknüpft ist.

4. Klicken Sie auf der Autorisierungsseite Über Google anmelden auf Zulassen.

5. Schließen Sie das Browserfenster und kehren Sie zu Android Studio zurück.

Sie sollten jetzt angemeldet sein und die Option Abmelden sehen.

Cloud-Projekt auswählen

Wählen Sie nach der Anmeldung im Drop-down-Menü ein Projekt aus. Wenn Sie die Projektliste filtern möchten, geben Sie einen Filter -Ausdruck ein, z. B. matter, und drücken Sie Enter.

Im Drop-down-Menü Projekt werden die ersten 100 Projekte basierend auf Ihrem Filter geladen. Ihre Auswahl bleibt erhalten, wenn Sie Android Studio beenden.

Weitere Informationen zu Projektfiltern finden Sie unter Abfrageparameter in der Google Cloud-Referenz.

Assistant-Simulator verwenden

Wenn Sie den Assistant Simulator in Android Studio, klicken Sie im Bereich des Google Home Plugin auf Äußerungsbereich.

Es gibt mehrere Möglichkeiten, Abfragen an den Assistant Simulator zu senden. Im Folgenden werden die einzelnen Optionen beschrieben.

Abfragen eingeben und Antworten erfassen

Wenn Sie mit dem Assistant Simulator interagieren möchten, geben Sie Ihre Abfrage ein und drücken Sie die Eingabetaste.

Sie können eine Abfrage noch einmal senden, indem Sie am Ende der Abfrage auf das cached Symbol für das erneute Senden klicken.

Nachdem Sie eine oder mehrere Abfragen gesendet haben, klicken Sie auf cached Wiederholen, um die Abfragen noch einmal auszuführen und die Antworten zu prüfen. Im Bereich Äußerungen werden Ihre Abfragen und Antworten in einem gespeicherten Cache erfasst. Mit Wiederholen werden diesem internen Cache nur neue Antworten hinzugefügt. Ihre Abfragen werden nicht jedes Mal dupliziert, wenn Sie auf die Schaltfläche klicken.

Klicken Sie auf save Speichern , um die Abfragen und Antworten zu speichern, die Sie im Bereich Äußerungen eingegeben haben. Ihre Interaktionen werden im folgenden Format in JSON konvertiert:

• ask: Ihre Abfrage.
• answers: Ein Array möglicher Assistant Simulator Antworten.

Sie können diese JSON-Datei in Android Studio bearbeiten.

{
  "collected": false,
  "lines": [
    {
      "ask": "turn lights on",
      "answers": [
        "OK, turning 2 lights on.",
        "Sure, turning on 2 lights."
      ]
    }
  ]
}

Batch-Antworten erfassen

Klicken Sie im Bereich Google Home Plugin auf Äußerungsdatei, um Ihre gespeicherten JSON-Dateien auf einem neuen Tab zu öffnen. Unter Pfad auswählen können Sie eine Datei oder einen Ordner auswählen. Wenn Sie einen Ordner auswählen, werden die Funktionen Erfassen und Testen für alle .json-Dateien mit Äußerungen in diesem Ordner ausgeführt.

Sie können mehrere Tabs für dieselbe Datei oder für verschiedene Dateien öffnen, z. B. lights, lights(1), und plug.

In der Statusleiste werden das Ergebnis des letzten Tests (falls zutreffend), ein gelber oder grüner Punkt, der angibt, ob die Datei erfasst wurde, und der Pfad zur .json-Datei mit den Äußerungen angezeigt. Wenn Sie auf tocErfassen klicken, führt der Assistant Simulator Ihre Abfragen aus. Sie werden benachrichtigt, wenn eine neue Antwort erfasst wurde. In der Statusleiste wird ein Zähler angezeigt, während Ihre Abfragen verarbeitet werden.

Wenn Erfassen abgeschlossen ist, wird die Statusleiste aktualisiert. Vor dem .json-Pfad wird ein grünes Häkchen angezeigt und die Äußerungsdateien werden mit möglichen Antworten gefüllt.

{
  "collected": true,
  "lines": [
    {
      "ask": "turn lights on",
      "answers": [
        "OK, turning 2 lights on.",
        "Sure, turning on 2 lights.",
        "Sure, turning 2 lights on.",
        "Got it, turning 2 lights on.",
        "Alright, turning on 2 lights.",
        "OK, turning on 2 lights.",
        "Got it, turning on 2 lights.",
        "Alright, turning 2 lights on."
      ]
    }
  ]
}

Wenn Sie die Erfassung vorzeitig beenden, wird Ihr .json-Pfad nicht als erfasst markiert.

Batch-Äußerungen testen

Nachdem Sie Ihre Antworten erfasst haben, klicken Sie auf switch_left Testen , um die Abfragen noch einmal auszuführen und die Antworten und Logs zu prüfen. Wenn Sie Batch-Äußerungen testen, erwartet der Assistant Simulator die Antworten, die in Ihrer JSON Datei gespeichert sind. Wenn der Test eine Antwort zurückgibt, die nicht erfasst wurde, erhalten Sie eine Benachrichtigung ähnlich der folgenden Antwort:

error Expected one of: "Got it, turning on 2 lights."

Dieses Szenario weist auf einen nicht erfolgreichen Test hin. Andernfalls führt der Assistant Simulator jede Ihrer Abfragen aus und gibt eine Antwort zurück. Wenn der Test erfolgreich war, wird in der Statusleiste ein check Häkchen angezeigt.

Cloud Logging ansehen

Wenn Sie einen Projekttab im Toolfenster „Cloud-Logs“ öffnen möchten, klicken Sie auf Cloud-Logs im Bereich Google Home Plugin. Sie können für jedes Ihrer Projekte separate Cloud-Log-Tabs öffnen.

Suchbegriffe

Für das ausgewählte Projekt können Sie Logs auch über das Feld Abfrage filtern. So filtern Sie beispielsweise Logs nach dem Keyword light:

Wählen Sie QL verwenden aus, um die Logging-Abfragesprache zu verwenden.

Hier sind einige Beispiele für QL-Abfragen, die Ihnen den Einstieg erleichtern:

severity = (DEBUG OR INFO OR NOTICE OR WARNING OR ERROR OR CRITICAL OR ALERT OR EMERGENCY) AND resource.type="assistant_action_project" AND timestamp > "2022-04-07T00:40:18Z"

jsonPayload.executionLog.executionResults.actionResults.action.trait = "TRAIT_ON_OFF"

jsonPayload.executionLog.executionResults.actionResults.action.actionType = "ONOFF_ON"

Abfragen nach Datum und Uhrzeit

Sie können Logs auch optional nach Datum abfragen. Klicken Sie dazu auf Nach und Vor. Sie können das Datums- und Zeitformat in das Text feld eingeben, z. B. 5/11/22, 12:37 PM, oder Sie können die Datumsauswahl calendar_month verwenden, um das Datum auszuwählen, und dann die Uhrzeit in das Textfeld eingeben.

• Wenn Sie ein Datum nach dem 5/1/22 auswählen möchten, wählen Sie Nach aus und klicken Sie auf das Datumssymbol calendar_month.
• Wenn Sie ein Datum vor dem 5/1/22 auswählen möchten, wählen Sie Vor aus und klicken Sie auf das Datumssymbol calendar_month.
• Wenn Sie ein Datum zwischen 5/1/22 und 6/30/22 auswählen möchten, wählen Sie Vor und Nach aus und wählen Sie die Daten über das Datumssymbol calendar_month aus.

Wählen Sie Echtzeit aus, um Live-Projektlogs abzurufen. Klicken Sie auf Beenden , um einen Echtzeit-Feed zu beenden.

Wichtigkeitsstufe

Sie können auch eine Mindestwichtigkeitsstufe aus dem Drop-down-Menü auswählen.

Abfrageergebnisse

Klicken Sie auf cached Abrufen, um Ihre Abfrageparameter zu senden.

Sobald die Logs geladen sind, klicken Sie auf einen beliebigen Datensatz chevron_right, um die vollständige JSON-Nutzlast zu maximieren. Klicken Sie noch einmal auf chevron_left , um die vollständige Nachricht anzuzeigen.

Optional können Sie ein Keyword in das Feld Filter eingeben, um die Logergebnisse einzugrenzen. Klicken Sie auf das x, um den Filter zu entfernen und zu den ursprünglichen Abrufergebnissen zurückzukehren.

Home Graph ansehen und Tests ausführen

Wenn Sie Ihre Geräte auflisten möchten, wählen Sie im Bereich Google Home Plugin Home Graph aus.

Klicken Sie auf cached Aktualisieren, um den Gerätenamen, die Geräte-ID und den Gerätetyp für Ihre Geräte anzuzeigen, die mit dem ausgewählten Projekt verknüpft sind. Sie können mehrere Google Home Graph Bereiche für separate Projekte öffnen.

Sobald Ihre Geräte geladen sind, klicken Sie auf einen beliebigen Datensatz chevron_right, um die vollständige JSON-Nutzlast zu maximieren.

Sie können auch Maximieren und Minimieren verwenden, um die JSON-Nutzlasten für Ihre Geräte ein- und auszublenden.

Wenn Sie die Test Suite für ein bestimmtes Gerät starten möchten, klicken Sie auf Testen. Dadurch wird die Test Suite in Ihrem Browser mit dem ausgewählten Gerät gestartet, das jetzt getestet werden kann. Klicken Sie auf Starten und warten Sie auf die Testergebnisse.

Nach Abschluss der Tests können Sie die Testdetails prüfen und die Logs ansehen.

Android Debug Bridge (adb)-Logbetrachter

Wenn Sie einen Projekttab im Toolfenster „adb-Log“ öffnen möchten, klicken Sie in der Symbolleiste des Google Home-Plug-ins (links) auf den Befehl adb-Log. Sie können für jede Ihrer Logdateien separate Tabs für das adb-Log öffnen. Wenn Sie einen Tab löschen möchten, klicken Sie auf das clear Symbol.

Wählen Sie im Feld Auswählen eine bestimmte Logging-Komponente aus, die angezeigt werden soll, und wählen Sie im Drop-down-Menü Wichtigkeitsstufe aus, um nur Einträge mit der entsprechenden Logwichtigkeitsstufe anzuzeigen.

Für das ausgewählte adb-Log können Sie Logeinträge über das Feld Filter mit den optionalen Modifikatoren Groß-/Kleinschreibung beachten oder Regex filtern.

Sie können auch regelmäßiger Leser eines Blogs oder einer URL

• Bestimmte Einträge über das Feld Suchen und die Befehle Nächsten suchen (arrow_downward Symbol) und Vorherigen suchen (arrow_upward Symbol) finden.
• Optionale Modifikatoren für Groß-/Kleinschreibung beachten oder Regex verwenden.
• Mit Zu Zeile springen zu einer bestimmten Zeile (nach Nummer) im Log springen.

Wählen Sie Nummeriert aus, um Logzeilen mit hinzugefügten Zeilennummern anzuzeigen. Wählen Sie Roh aus, um rohe Logeinträge anzuzeigen.

Ressourcen und Feedback

Klicken Sie auf Ressourcen , um eine Liste mit Entwicklertools und -ressourcen aufzurufen.

Wenn Sie uns Ihre Gedanken oder Ihr Feedback dazu mitteilen möchten, wie wir die Entwicklung mit dem Google Home Plugin verbessern können, klicken Sie auf Feedback.