Elgato Key Light API

Elgato Key Light API

Введение

Elgato Key Light и Key Light Air — это светодиодные видеолампы с боковой подсветкой, которые популярны среди стримеров на таких платформах, как Twitch. Эти фонари являются устройствами Интернета вещей и обычно управляются с помощью приложения Elgato «Control Center» или с помощью одного из устройств Stream Deck (также производимых Elgato). Устройства Key Light изначально не поддерживают стороннюю интеграцию, но ими можно управлять путем прямого взаимодействия со встроенным API источников света.

API-обнаружение

Приложение «Центр управления» отправляет команды на устройства Key Light, с которыми оно связано, через HTTP. Запросы API, определенные в этом документе, были найдены с помощью Wireshark и эталонной версии 1.1.2 приложения Elgato «Центр управления» (Windows 10).

Конечные точки

IP-адрес устройства

После добавления в сеть устройства Key Light, скорее всего, получают IP-адреса от маршрутизатора через DHCP. Конкретные IP-адреса можно получить с DHCP-сервера/сетевого маршрутизатора, но они также легко доступны в приложении «Центр управления». Для этого:

1. Запустите/откройте приложение «Центр управления».
2. Нажмите на значок Accessory settings (в форме ползунка) рядом с именем устройства.
3. Разверните раздел Advanced . IP-адрес будет указан в разделе «Поведение при включении питания» и «Версия прошивки».

Порт устройства

Устройства Key Light прослушивают команды на порту 9123 .

Базовый URL

Все запросы следует отправлять в /elgato .

Пример

Получите текущие настройки устройства:

 curl --location --request GET 'http://192.168.1.61:9123/elgato/lights' --header 'Accept: application/json'

Аутентификация

Устройства Key Light не требуют аутентификации.

Ответы

Устройства Key Light возвращают только два кода состояния HTTP:

• 200 OK Запрос выполнен успешно.
• 400 Bad Request Запрос не был понят устройством (вероятно, из-за неправильного синтаксиса).

Кроме того, любые данные, возвращаемые устройством, будут в формате JSON.

Ресурсы

API Key Light реализует только три ресурса.

• объекты lights содержат информацию, связанную с текущим состоянием, яркостью и цветовой температурой устройства Key Light.
• Объекты accessory-info аксессуар-информации содержат информацию, относящуюся к физическим характеристикам оборудования устройства Key Light.
• Объекты settings настроек содержат информацию, связанную с поведением устройства Key Light.

Функции

API Key Light реализует одно «действие»:

• identify что отправка запроса HTTP POST на эту конечную точку приведет к тому, что данный индикатор мигнет несколько раз