AV & Custom Systems (HTTP)

Материал из iRidium Mobile Wiki
Перейти к: навигация, поиск

iRidium для AV & Custom Systems (HTTP) позволяет управлять оборудованием, оснащенным Ethernet-интерфейсом или Wi-Fi модулем. Управление производится по TCP/IP, локально и через Интернет, с использованием протокола HTTP (HTTPs).


Условия работы с драйвером:

  • возможность управления выбранным оборудованием по HTTP (HTTPs)
  • наличие команд управления оборудованием по HTTP (HTTPs) и описания протокола
  • возможность самостоятельного создания скриптов, если протокол предполагает авторизацию и обязательный обмен данными с панелью управления


Описание работы драйвера:

Драйвер "AV & Custom Systems (HTTP)" открывает сессию соединения с оборудованием для отправки команды. Список команд для отправки оборудованию формируется пользователем в процессе создания проекта. Обратная связь от оборудования реализуется за счет обработки входящих данных посредством скрипта, созданного в проекте iRidium (см. iRidium DDK и iRidium Script API).


Attention.png Эта инструкция не описывает создание скриптов для обработки приходящих от оборудования данных. Получение обратной связи от оборудования описано в разделе iRidium DDK.


Принцип работы AV & Custom Systems (HTTP)

В iRidium вы можете использовать драйвер "AV & Custom Systems (HTTP)" для подключения к вашему аудио-видео и другому оборудованию. Схема связи iRidium с оборудованием:

HowItWorksHTTP.png

Протокол передачи данных: HTTP, HTTPs.

Поддерживаемые методы: GET, POST, PUT.

Формат записи команд: ASCII.

Обратная связь от оборудования: в базовом варианте отсутствует. Реализуется через iRidium Script, cм. iRidium DDK.

Необходимая лицензия: Device License Pro для AV & Custom Systems (см. Лицензирование). Подходит для любого оборудования, управляемого с помощью "AV & Custom Systems". Позволяет использовать в проекте любые скрипты.

Создание и настройка драйвера AV & Custom Systems (HTTP)

Выберите в окне DEVICE BASE редактора iRidium GUI Editor вкладку AV & Custom Systems, разверните ее и найдите "AV & Custom Systems (HTTP)". Перетащите драйвер в окно PROJECT DEVICE PANEL:

AV-HTTP-AddDriver.png

Параметры подключения к оборудованию через AV & Custom Systems (HTTP):

  • Host - IP адрес устройства в сети
  • Port - TCP порт подключения к устройству
  • Login - логин для подключения к устройству
  • Password - пароль для подключения к устройству
  • SSL - криптографический протокол, который обеспечивает установление безопасного соединения между клиентом и сервером.
  • User Agent - часть HTTP запроса, включающая название и версию приложения/браузера, через который производиться доступ к web-интерфейсу.
  • Script Mode - режим отправки команд и взаимодействия со скриптами в проекте iRidium
    • Direct & Script - данные из команды будут отправлены напрямую оборудованию и обработаны скриптовой системой
    • Script Only - команды, созданные внутри драйвера, не уходят оборудованию непосредственно, а обрабатываются скриптовой системой, которая производит целевые действия.


Для подключения к оборудованию через Интернет:

1. в строке Host укажите публичный IP-адрес вашего интернет-маршрутизатора
2. На маршрутизаторе настройте проброс портов (Port Forwarding) для возможности удаленного управления оборудованием.
Узнать публичный IP-адрес своего маршрутизатора Вы можете при помощи интернет-сервисов, например Яндекс.Интернет


Для переключения между локальным соединением и работой через Интернет:

Используйте пример, представленный далее.

↑ К оглавлению

Структура драйвера AV & Custom Systems

Драйвер AV & Custom Systems в проекте iRidium состоит из 3х частей:

  • Driver Tokens - список переменных, которые хранят информацию о подключении к оборудованию.
  • Commands - список команд, которые можно отправить оборудованию (или в скрипт) по нажатию кнопки интерфейса
  • Feedbacks - список имен каналов обратной связи, куда могут записываться данные от управляемого оборудования, обработанные скриптовой системой iRidium.

Параметры и назначение частей драйвера:


Driver Tokens

Driver Tokens - переменные, в которых хранится статус подключения к оборудованию. Эти параметры можно только прочитать.

Для использования переменной драйвера, перетащите ее на графический элемент (значение можно вывести в текстовое поле элемента или повлиять им на состояние элемента)


GUI Descr Tokens.png
Online состояние подключения к оборудованию (Online/Offline = 1/0)
Status статус подключения к оборудованию (Offline/Connecting/Online/Waiting = 0...3)
Host доменное имя удаленной системы
HostPort порт на удаленной системе, к которому подключается iRidium App
IP IP-адрес панели управления
HostIP IP-адрес удаленной системы, к которой подключен iRidium
Port локальный порт панели управления, через который осуществляется связь с удаленной системой


Commands и Feedbacks

Commands - список команд, которые можно отправить оборудованию (или в скрипт) по нажатию кнопки интерфейса. Заполняется свободно. Число команд не ограничено.

Feedbacks - список имен каналов обратной связи, куда могут записываться данные от управляемого оборудования, обработанные скриптовой системой iRidium. Данные, записанные в поле Data канала Feedback, можно прочитать через скрипт.

AV-HTTP-CommandFeedback.png

Команды (Commands)

  • Name - произвольное имя команды
  • Type - метод, определяющий действие над данными
    • GET - получить (передать строку запроса - URI)
    • POST - добавить, изменить, удалить (передать блок данных)
    • PUT - добавить, заменить (передать блок данных)
  • URI - уникальный идентификатор ресурса
  • Data - данные в теле запроса


Обратная связь (Feedback)

  • Name - имя канала обратной связи. По имени можно обратиться к каналу из скрипта для записи данных


Чтобы привязать команду к графическому элементу:
перетащите ее на графический элемент и выберите, по какому событию отправлять команду:

  • Press - нажатие на элемент
  • Release - отпускание элемента
  • Hold - удержание элемента
  • Move - перемещение по элементу (в основном используется для элементов Level)


Чтобы привязать обратную связь к графическому элементу:
перетащите ее на графический элемент и выберите, на что должна влиять обратная связь:

  • In Value - при получении любого значения, не равного нулю, элемент изменит свое состояние (State 1/State 2). Используется для визуализации изменений за счет смены внешнего вида элемента.
  • In Text - при получении каналом любых данных, они будут записаны в текстовое поле элемента
  • More... - полученные данные могут влиять на любой другой параметр элемента (см. доступные параметры в диалоге привязки)

↑ К оглавлению

↑ К оглавлению

Отправка команд AV оборудованию

Выберите команды для оборудования, которые нужно добавить в список драйвера AV & Custom Systems (HTTP). Они могут быть переданы одним из методов:

  • GET - получить (передать идентификатор ресурса - URI)
  • POST - добавить, изменить, удалить (передать блок данных)
  • PUT - добавить, заменить (передать блок данных)

Оформление запросов представлено далее.


Метод GET

Внесите GET запрос окно URI: 

* удалите часть запроса, где хранится IP адрес ресурса и порт обращения к ресурсу
* добавьте в URI тело запроса, включая обратный слеш в его начале
  • Красным цветом выделена часть GET-запроса, которую необходимо внести в окно URI
  • IP-адрес и порт подключения к управляемому через web-интерфейс устройству указываются в параметрах драйвера


Исходная команда
(в документации): 		httр://192.168.0.100:81/cgi-bin/do?cmd=ir_code=B748BF00
В iRidium
(поле URI): 		/cgi-bin/do?cmd=ir_code=B748BF00
Исходная команда
(в документации): 		httр://<ip address>:<port>/<command_body>
В iRidium
(поле URI): 		/<command_body>

GETrequestinGUI.png

↑ К оглавлению

Методы POST и PUT

Внесите части запроса в окна URI и Data: 

* выделите и добавьте в окно URI идентификатор ресурса
* выделите и добавьте в окно Data тело запроса
* обособьте одинарными кавычками тело запроса в окне Data


  • Зеленым цветом выделена часть POST-запроса, которую необходимо внести в окно URI
  • Красным цветом выделена часть POST-запроса, которую необходимо внести в окно Data, взяв в одинарные кавычки.


POST-запрос:

POST /YamahaRemoteControl/ctrl HTTP/1.1
Accept: */*
Accept-Language: ru
Referer: http://192.168.10.102/
Content-Type: text/xml; charset=UTF-8
Accept-Encoding: gzip, deflate
User-Agent: Mozilla/4.0 (compatible; MSIE 8.0; Windows NT 6.1; WOW64; Trident/4.0; SLCC2; .NET
CLR 2.0.50727; .NET CLR 3.5.30729; .NET CLR 3.0.30729; Media Center PC 6.0; BRI/2)
Host: 192.168.10.100
Content-Length: 105
Connection: Keep-Alive
Cache-Control: no-cache
Cookie: mstnc=1

<YAMAHA_AV cmd="PUT"><System><Power_Control><Power>Standby</Power></Power_Control></System></YAMAHA_AV>

URI:
/YamahaRemoteControl/ctrl

Data:
'<YAMAHA_AV cmd="PUT"><System><Power_Control><Power>Standby</Power></Power_Control></System></YAMAHA_AV>'

POST-запрос:
POST /WAN/dvdr/dvdr_ctrl.cgi? HTTP/1.1

User-Agent: MEI-LAN-REMOTE-CALL
Host: 192.168.1.105
Content-Length: 39

cCMD_RC_POWER.x=100&cCMD_RC_POWER.y=100

URI:
/WAN/dvdr/dvdr_ctrl.cgi?

Data:
'cCMD_RC_POWER.x=100&cCMD_RC_POWER.y=100'

POSTrequestinGUI.png

↑ К оглавлению

Работа с командами AV & Custom Systems (HTTP)

Пример использования команды для AV & Custom Systems (HTTP):

AV-HTTP Command steps.png

1. Добавьте драйвер AV & Custom Systems (HTTP) в проект iRidium. Настройте параметры подключения к оборудованию.
2. Создайте команду для отправки оборудованию
3. Настройте кнопку, которая будет отвечать за отправку команды.
Type: Button
Feedback: Momentary
4. Перетяните команду на кнопку
5. Выберите, по какому событию отправить команду:
Press - нажатие на элемент
Release - отпускание элемента
Hold - удержание элемента
Move - перемещение по элементу (в основном используется для элементов Level)


Attention.png Нельзя изменить команду в поле Data, когда проект уже загружен на панель управления. Это значит, что если команда отвечает за установку громкости, например, на 50%, то ее нельзя привязать к уровню для плавного регулирования громкости. Она будет работать только с кнопкой (Button) и при каждом нажатии устанавливать громкость на 50%.

Attention.png Чтобы отправить значение (например, громкость) с уровня, вам необходимо формировать команду не в дереве проекта, а с помощью скрипта (см. iRidium Script API и iRidium DDK)


↑ К оглавлению

Создание своей базы команд AV & Custom Systems (HTTP)

Чтобы использовать устройство AV & Custom Systems (HTTP) в любом проекте iRidium, сохраните его в базу данных iRidium.

Для добавления устройства в базу iRidium используйте DB Editor - редактор баз данных. Добавить новое устройство Вы можете только в свою базу данных, т.к. стандартные базы закрыты для изменения.


Attention.png Создание базы - не единственный способ переноса команд между проектами iRidium. Если вы создали устройство с командами в проекте iRidium, то можете импортировать его в другой проект с помощью File > Import > *.irpz

↑ К оглавлению

Создание базы данных

Используйте для хранения своих устройств пользовательские базы данных. Они создаются в DB Editor. При создании базы укажите ее имя и директорию для сохранения

AV Database New.png


Новое HTTP устройство:

Тип создаваемого устройства - HTTP (HTTP Device), определяет его транспортную часть и характеристики.

HTTP 1.png


Настройка HTTP устройства

Настройте описание, чтобы легче идентифицировать устройство:

HTTP 2.png

  • Device Type - тип управляемого устройства (TV, DVD, Blu Ray, ...)
  • Manufacturer - наименование производителя устройства
  • Description - описание устройства, может включать гиперссылки
  • Date - дата создания драйвера


Параметры подключения:

  • Host - IP адрес устройства в вашей сети
  • Port - порт по которому устройство работает


Необязательные параметры:

  • Login - логин для подключения к устройству
  • Password - пароль для подключения к устройству
  • SSL - криптографический протокол, который обеспечивает установление безопасного соединения между клиентом и сервером.
  • User Agent - часть HTTP запроса, обычно включающая такую информацию, как название и версию приложения, операционную систему компьютера и язык.

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

HTTP 3.png


Добавление команд в список устройства

Перейдите во вкладку Commands & Feedback и воспользуйтесь инструментами редактора:

HTTP 4.png


По умолчанию команда создается пустая. Инструкция которую должна отправить команда на устройство задается в окне Comand Properties. Щелкните два раза по созданной команде, что бы открыть окно Comand Properties.

HTTP 5.png

  • В поле Command добавьте инструкцию для команды. В нашем случае, для команды Play есть инструкция '/cgi-bin/do?cmd=ir_code&ir_code=B748BF00' - обращение к устройству и NEC код команды.
  • Поставьте галочку в поле Name Read Only если не хотите, что бы имя команды можно было изменить (полезно, когда к команде обращается скрипт)
  • В поле Descriptions задайте описание команды.


Команду можно проверить прямо через окно браузера, как GET-запрос она имеет вид: 

http://192.168.0.100/cgi-bin/do?cmd=B748BF00


Когда все команды будут добавлены, закончим работу с DB Editor.


↑ К оглавлению

Переключение между Локальным и Интернет-соединением

Если панель управления не должна терять возможность соединения с системой, когда перемещается за пределы её Wi-Fi сети, то нужно настроить в проекте переключение интернет-локальная сеть.

Удаленный режим работы подразумевает подключение к системе через Интернет. При этом используется внешний IP адрес или доменное имя системы, к которой нужно подключаться.


Attention.png В iRidium переключение Wi-Fi/3G автоматически НЕ производится. Для переключения интернет-локальная сеть, в вашем проекте должны быть специально настроенные кнопки. Настройки см. далее.
Attention.png Чтобы управление системой работало удаленно, нужно открыть систему для внешнего доступа -
настроить службу Port Forwarding.
Attention.png Чтобы обезопасить оборудование от стороннего вмешательства, рекомендуем использовать защищенное соединение с удаленной системой (VPN)


Настроим переключение Wi-Fi/3G в проекте iRidium:

Scripts PpenTemplate.png

1. Откройте редактор скриптов в iRidium GUI Editor.

2. Скачайте и добавьте в проект шаблон переключения Wi-Fi/3G (Add Script from file):
скачать шаблон переключения Wi-Fi/3G

Переключение Wi-Fi/3G производится с помощью скриптовой функции SetParameters

Настроим параметры переключения Wi-Fi/3G:

function Internal_1() // Function name
{
IR.GetDevice('AV & Custom Systems (HTTP)').SetParameters({Host: "192.168.0.21",Port: "12004",SSL: "1",Login: "admin",Password: "12345"}); // Driver Name + Parameters
}
function External_1()
{
IR.GetDevice('AV & Custom Systems (HTTP)').SetParameters({Host: "192.168.0.21",Port: "12004",SSL: "1",Login: "admin",Password: "12345"});
}

В настройках команд укажем:

  • Function name – имя функции (команды) переключения. Две функции в одном проекте не должны называться одинаково
  • Driver Name – имя драйвера, у которого меняем параметры
  • Parameters – набор параметров подключения, который нужно применить к драйверу


Привяжем команды к кнопкам:

  1. Выберите кнопку, которая будет отвечать за переключение Wi-Fi/3G.
    Откройте свойства этой кнопки: Object Properties > Programming
  2. Откройте Macros Editor кнопки для события Press или Release
  3. Выберите команду Script Call и двойным кликом добавьте ее
  4. В выпадающем списке выберите имя функции, которую нужно вызвать. Создайте команду

Script call internal-external.png


Настроим доступ к оборудованию из Интернета:

Для этого откроем порты оборудования для удаленного доступа.


Загрузить пример переключения Wi-Fi/3G (проект) >>

↑ К оглавлению

Загрузки

Загрузить: пример переключения Wi-Fi/Internet для AV & Custom Systems

↑ К оглавлению

Источник — «http://wiki2.iridiummobile.ru/index.php?title=AV_%26_Custom_Systems_(HTTP)&oldid=9006»