Плагин Google Home для Android Studio

Matter ; Home APIs

Google Home Plugin for Android Studio предназначен для разработчиков платформы Google Home. Этот плагин предоставляет доступ к Google Assistant Simulator, Cloud Logging и другим инструментам, которые упрощают разработку умного дома.

Примечание о безопасности

Чтобы запретить Android Studio хранить секреты и пароли, выполните следующие действия:

1. Нажмите Файл > Настройки….
2. В разделе Внешний вид и поведение разверните Системные настройки и нажмите Пароли.
3. Выберите Не сохранять, забывать пароли после перезапуска.

Функции

Симулятор Ассистента

Чтобы проверить, правильно ли работают ваши устройства умного дома с экосистемой Google Home, вы можете в любой момент взаимодействовать с Assistant Simulator, не покидая Android Studio.

С помощью значка Assistant Simulator вы можете управлять устройствами, вводя запросы, например Включи свет. В приложении Android Studio помощник Assistant Simulator отвечает на ваши команды текстовыми сообщениями, например Хорошо, включаю свет.

Как посмотреть журналы Cloud Logging

Google Cloud Logging предоставляет сведения для отладки и ключевые показатели, которые помогут вам понять, как используется ваше действие. Чтобы упростить разработку, Google Home Plugin показывает сообщения Cloud Logging в реальном времени прямо рядом с кодом во время устранения неполадок.

Вы можете посмотреть журналы в реальном времени или выбрать диапазон дат.

Пакетные высказывания

Assistant Simulator ответов на одну и ту же фразу не являются детерминированными. Например, ответ может быть таким:

• Хорошо, включаю два светильника.
• Хорошо, включаю два светильника.
• Хорошо, включаю два светильника.
• Хорошо, включаю два светильника.

Чтобы запустить автоматические тесты и проверить, как интеграции с Google работают с разными ответами, вы можете отправить пакеты фраз в Assistant Simulator, выполнив скрипты фраз. После сохранения скрипта вы можете собирать ответы и проводить несколько тестов для своих запросов.

Home Graph Viewer

Home Graph Viewer позволяет просматривать состояние устройств и запускать Google Home Test Suite в браузере.

Журнал Android Debug Bridge (adb)

Adb Log Viewer – это инструмент для просмотра и анализа файлов журналов, например файлов журналов устройств Matter, журналов Google Home и журналов Android.

Установить

Чтобы установить Google Home Plugin в Android Studio, выполните следующие действия:

1. Скачайте или обновите приложение "Android Studio". Скачать Android Studio
2. Выберите Файл > Настройки (Android Studio > Настройки в macOS).
3. В разделе Плагины перейдите в Marketplace и выполните поиск по запросу google home.
4. Установите инструмент и перезапустите Android Studio.

Вы также можете скачать плагин напрямую из JetBrains Marketplace.

Настройка

После установки плагина необходимо выполнить следующие действия, чтобы использовать Assistant Simulator и просматривать данные Cloud Logging:

• Функция "Войти с аккаунтом Google"
• Выберите облачный проект

Войти с аккаунтом Google

Вы можете войти в аккаунт разработчика на панели умного дома Google Home, разрешив Android Studio взаимодействовать с сервисами Google от вашего имени.

1. Нажмите на вкладку Google Home в столбце вкладок слева от окна Android Studio.

2. В разделе Войти с помощью нажмите Google, чтобы запустить браузер.

   

3. Выберите аккаунт, связанный с устройствами умного дома.

4. На странице авторизации Войти с аккаунтом Google нажмите Разрешить.

5. Закройте окно браузера и вернитесь к Android Studio.

Теперь вы должны быть вошедшим в аккаунт, с возможностью Выйти.

Как выбрать облачный проект

Войдите в аккаунт и выберите проект в раскрывающемся списке. Чтобы отфильтровать список проектов, введите выражение Фильтр, например matter, а затем нажмите Enter.

В раскрывающемся списке Проект загружаются первые 100 проектов на основе выбранного фильтра. Выбранные настройки сохраняются после выхода из Android Studio.

Справочную информацию о фильтрах проектов можно найти в разделе Параметры запросов Справочного центра Google Cloud.

Как использовать симулятор Ассистента

Чтобы открыть Assistant Simulator в Android Studio, на панели Google Home Plugin нажмите Панель фраз.

Запросы к Assistant Simulator можно отправлять несколькими способами. Далее мы рассмотрим каждый из этих вариантов.

Как вводить запросы и получать ответы

Чтобы взаимодействовать с Assistant Simulator, введите запрос и нажмите клавишу Ввод.

Вы можете отправить запрос повторно, нажав на значок cached в конце запроса.

После отправки одного или нескольких запросов нажмите cached Повторить, чтобы снова выполнить запросы и проверить ответы. На панели Utterances (Реплики) отслеживаются ваши запросы и ответы в сохраненном кеше. Повторить добавляет в этот внутренний кеш только новые ответы и не дублирует запросы каждый раз, когда вы нажимаете кнопку.

Нажмите save Сохранить, чтобы сохранить запросы и ответы, введенные на панели Реплики. Ваши взаимодействия преобразуются в JSON в следующем формате:

• ask – ваш запрос.
• answers: массив возможных ответов Assistant Simulator.

Вы можете отредактировать этот JSON-файл в Android Studio.

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

Как собирать ответы на пакетные запросы

На панели Google Home Plugin нажмите Файл фраз, чтобы открыть сохраненные файлы JSON в новой вкладке. В поле Выберите путь можно указать файл или папку. Если вы выберете папку, функции Сбор и Тестирование будут работать со всеми файлами .json в этой папке.

Вы можете открыть несколько вкладок для одного или разных файлов, например lights, lights(1) и plug.

На панели статуса отображается результат последнего тестирования (если оно проводилось), желтая или зеленая точка, указывающая, был ли собран файл, и путь к файлу .json. После того как вы нажмете tocСобрать, Assistant Simulator выполнит ваши запросы. Когда будет получен новый ответ, вы получите уведомление, а в строке состояния появится счетчик.

Когда Сбор будет завершен, на панели статуса появится зеленая галочка рядом с путем к файлу .json, а в файлах высказываний будут указаны возможные ответы.

{
  "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."
      ]
    }
  ]
}

Если вы остановите сбор раньше времени, путь .json не будет отмечен как собранный.

Тестовые пакеты фраз

После того как вы соберете ответы, нажмите switch_left Тест, чтобы воспроизвести запросы и проверить ответы и журналы. При тестировании пакетных высказываний Assistant Simulator ожидает ответы, сохраненные в вашем JSON-файле. Если в результате тестирования будет получен ответ, который не был собран, вы получите уведомление, похожее на следующее:

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

Этот сценарий указывает на неудачное тестирование. В противном случае метод Assistant Simulator выполнит каждый из ваших запросов и вернет ответ. Если проверка прошла успешно, в строке состояния появится значок check.

Как посмотреть журналы Cloud Logging

Чтобы открыть вкладку проекта в окне инструментов "Журналы облака", нажмите Журналы облака на панели Google Home Plugin. Вы можете открыть отдельные вкладки журнала облачных сервисов для каждого из своих проектов.

Поисковые запросы

Для выбранного проекта можно отфильтровать журналы с помощью поля Запрос. Например, чтобы отфильтровать журналы по ключевому слову light, выполните следующие действия:

Выберите Использовать язык запросов, чтобы использовать язык запросов к журналам.

Вот несколько примеров запросов QL, которые помогут вам начать работу:

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"

Запросы о дате и времени

Запрашивать журналы по дате также необязательно. Чтобы включить эту функцию, нажмите После и До. Вы можете ввести формат даты и времени в текстовое поле, например 5/11/22, 12:37 PM, или выбрать дату с помощью окна выбора даты calendar_month, а затем ввести время в текстовое поле.

• Чтобы выбрать дату после 5/1/22, нажмите После и значок календаря calendar_month.
• Чтобы выбрать дату до 5/1/22, нажмите До и выберите значок даты calendar_month.
• Чтобы выбрать дату в диапазоне от 5/1/22 до 6/30/22, нажмите До и После и выберите даты, нажав на значок календаря calendar_month.

Выберите В реальном времени, чтобы получить журналы проекта в режиме реального времени. Нажмите Остановить, чтобы завершить фид в реальном времени.

Уровень серьезности

Вы также можете выбрать минимальную степень серьезности в раскрывающемся меню.

Результаты запросов

Нажмите cached Получить, чтобы отправить параметры запроса.

После загрузки журналов нажмите на любую записьchevron_right, чтобы развернуть полный полезный JSON-контент. Нажмите на значок chevron_left ещё раз, чтобы посмотреть сообщение полностью.

Чтобы отфильтровать результаты, введите ключевое слово в поле Фильтр. Нажмите на значок x, чтобы удалить фильтр и вернуться к исходным результатам.

Просмотр базы данных Home Graph и запуск тестов

Чтобы посмотреть список устройств, на панели Google Home Plugin выберите Home Graph.

Нажмите cached Обновить, чтобы посмотреть название устройства, идентификатор устройства и тип устройства для устройств, связанных с выбранным проектом. Вы можете открыть несколько панелей Google Home Graph для разных проектов.

После загрузки устройств нажмите на любую записьchevron_right, чтобы развернуть полный полезный JSON-контент.

Вы также можете использовать кнопки Развернуть и Свернуть, чтобы показать или скрыть полезные данные JSON для устройств.

Чтобы запустить набор тестов для определенного устройства, нажмите Проверить. В браузере откроется набор тестов с выбранным устройством, готовым к тестированию. Нажмите Начать и дождитесь результатов тестирования.

После завершения тестирования вы сможете посмотреть его результаты и журналы.

Журнал Android Debug Bridge (adb)

Чтобы открыть вкладку проекта в окне инструмента Adb Log, нажмите команду Adb Log на панели инструментов плагина Google Home (слева). Вы можете открыть отдельные вкладки Adb Log для каждого файла журнала. Чтобы удалить вкладку, нажмите на значок clear.

В поле Выбрать можно указать, какой компонент журнала нужно посмотреть, а в раскрывающемся списке Серьезность – выбрать, записи с каким уровнем серьезности будут показываться.

Для выбранного журнала adb можно отфильтровать записи журнала, используя поле Фильтр с необязательными модификаторами С учетом регистра или Регулярное выражение.

Кроме того, вы можете:

• Чтобы найти определенные записи, используйте поле Найти и команды Найти далее (значок arrow_downward) и Найти предыдущее (значок arrow_upward).
• Используйте необязательные модификаторы С учетом регистра или Регулярное выражение.
• Перейти к строке – перейти к указанной строке в журнале.

Выберите Нумерованный, чтобы посмотреть строки журнала с номерами. Выберите Необработанные, чтобы посмотреть необработанные записи журнала.

Где ещё можно найти информацию по теме и как связаться с нами

Нажмите Ресурсы, чтобы посмотреть список инструментов и ресурсов для разработчиков.

Чтобы поделиться своим мнением о том, как мы можем улучшить процесс разработки с помощью Google Home Plugin, нажмите Отзыв.