Материал из for iRidium developers
Перейти к: навигация, поиск
Эта страница является переводом страницы AMX. Перевод выполнен на 100%.

Other languages:

документация обновлена 06.4.2017


iRidium для AMX – набор инструментов для визуализации управления AMX с iOS, Android, Windows, Mac. iRidium позволяет загрузить на любое устройство интерфейс, созданный в редакторе TPDesign4 (AMX). Вы сможете добавить к визуализации AMX управление сторонним оборудованием или управлять сразу несколькими AMX контроллерами.

iRidium воспринимается контроллером как одна из AMX TouchPanels и требует уникального Device ID. Подготавливать TP4 для загрузки в iRidium не требуется.


Поддерживаются контроллеры AMX серий NI и NX, проекты AMX TPDesign4 в формате *.TP4


Поддерживаются команды:

@PPM-, @PPN-, @PPF-, @PPX, @PPA, @PPK-, @PPG-, PPON-, PPOF-, PPOG-

@APG-, @CPG-, @DPG-, @SSL-, @SST-, @SWK-, @AKP-, @AKR, @PKP-, AKEYB-, AKEYP-, AKEYR,

BEEP, DBEEP, ABEEP, ADBEEP, @SOU-, ^MUT-, ^VOL-, @BRT-, BRIT-, ^RAF-, ^RFR-, ^RFRP-, ^RMF-, ^RSR-,

^SHO-, @SHO, ^ENA-, @ENA, ^BSF-, ^BSM-, ^BFB-, ^BML-, ^BPP-,

^BSP-, ^BMC-, ^GIV-, ^GLH-, ^GLL-, ^GSC, ^GSN-, ^BOR-,

^CPF-, ^APF-, ^DPF-,

@PWD-, ^PWD-,

^TXT-, ^BAT-, ^UNI-, ^BAU-, ^ANI-, ^BMF-, ^BCB-, ^BCF-, ^BCT-,

^BWW-, ^BRD-, ^BSO-, ^BDO-, ^JSB-, ^JSI-, ^JST-,

^ICO-, ^BMP-, ^BOP-, ^BBR-, ^TEC-, ^TEF-, ^FON-, ^BMI-,

OLD: BTON, BTOF, !B, !T, TEXT, @TXT, !F, FONT, !I, ICON, !C


Поддерживаются элементы интерфейса:

  • Page, Popup
  • General, multi-state general, bargraph, multi-state bargraph, joystick, text input

Лицензирование подразумевает возможность приобретения одной лицензии на все панели управления iRidium, которые работают с 1 контроллером; также возможно приобретение лицензий на каждое мобильное устройство.


Инструкция для AMX TPDesign4


Базовый вариант использования iRidium предполагает загрузку на мобильное устройство проекта, созданного в редакторе TPDesign4, БЕЗ использования средств разработки iRidium.


1 Откройте проект *.TP4 в iRidium Transfer

Если проект открыт в TPDesign4, закройте его, иначе возникнет ошибка доступа к файлу

Transfer input-AMX.png


2 Настройте параметры контроллера в iRidium Transfer

Файл *.TP4 не содержит IP адрес вашего контроллера АМХ и другие параметры, поэтому их нужно настроить:

Transfer TP4 Settings.png

Host - IP-адрес контроллера АМХ

Port - TCP порт управления (всегда 1319)

Login - Логин при использовании защищенной сессии

Password - Пароль при использовании защищенной сессии

Device ID - Уникальный идентификатор панели (Panel ID), не должен дублироваться на разных панелях


3 Если панелей управления несколько, настройте для них разные Device ID

Задавать уникальный Device ID необходимо, т.к. нельзя подключить к AMX несколько панелей управления с одним ID, это вызовет ошибки в работе контроллера.

Настройки, которые могут быть уникальны, вынесены в свойства панелей управления (вкладка Panels):

Transfer TP4 Advansed-Settings.png


4 Синхронизируйте iRidium Transfer и панели управления

Шаги, которые следует выполнить для загрузки вашего интерфейса визуализации на панель управления:

TransferringSteps.png


Подробно:

Apple iOS: приложение i3 pro

Android OS: приложение i3 pro

Windows 7/8: приложение i3 pro

Mac OS: приложение i3 pro



Дополнительные возможности

Патч TPDesign4

Он нужен, чтобы создавать интерфейсы в разрешении iPad, iPhone, Android и др. Разрешение не должно быть больше 2000 пикселей в ширину или высоту - это ограничение TPDesign4 (оно отсутствует в iRidium)

AMX Patch.png



Смена настроек подключения

Возможность смены параметров подключения нужна, если вы отключаетесь от Wi-Fi сети объекта автоматизации и начинаете использовать 3G или другую Wi-Fi сеть. Чтобы управление продолжило работать, нужно переключиться с локального на публичный IP адрес интернет-маршрутизатора.

Переключение не происходит автоматически, вам нужно будет нажать на клавишу выбора режима соединения. Для возможности удаленного доступа необходимо сделать порты управления системой автоматизации публичными. Для этого настраивают службу Port Forwarding на интернет-маршрутизаторе. Защищенное соединение может обеспечить VPN.


Встраиваемый интерфейс для настройки AMX

Вы можете быстро интегрировать в ваш проект *.TP4/TP5 специальный интерфейс, который поможет первоначальной и текущей настройке параметров подключения к контроллеру. Внешний вид интерфейса можно менять в iRidium Studio (перекрасить, перевести на другой язык, добавить картинки).

Amxandsetupprojectui1.png
Amxandsetupprojectui2.png

интерфейс настройки параметров подключения для планшета и ПК (+ темная версия)

интерфейс настройки параметров подключения для смартфона (+ темная версия)

Как добавить интерфейс настройки подключения в свой проект *.TP4/TP5:

  1. Скачайте и установите средства разработки iRidium на ваш ПК, запустите iRidium Studio
  2. Откройте в iRidium Studio проект *.TP4/TP5
  3. Откройте в iRidium Studio проект Setup AMX Connection.irpz
  4. Перетащите проект Setup AMX Connection на ваш проект - они автоматически объединятся:
    Amxandsetupprojectmerge.png
  5. [опционально] Нажмите кнопку [JS] на панели инструментов iRidium Studio и уточните стандартные настройки драйвера AMX (в скрипте, начиная со строки 16). Этот шаг можно пропустить
  6. Сохраните проект АМХ, он будет сохранен как файл *.irpz. Файл можно загрузить на сайт iridiummobile и использовать на панелях управления


Интерфейс автоматически откроется при первом запуске проекта. Потом его можно вызывать в любой момент, смахиванием справа-налево на главной странице вашего проекта (для iOS и Android, на Windows жесты не работают).

Вы можете вызывать интерфейс с контроллера AMX командой открытия страницы "Setup AMX Connection".


Команда установки параметров подключения в TPDesign4

Команду можно выполнить в проекте TP4 и отправить с контроллера.

IR_PARAMETERS-<host>,<port>,<login>,<password>,<panel_id>

  • <host> - IP-адрес контроллера АМХ
  • <port> - TCP порт управления
  • <login> - Логин при использовании защищенной сессии
  • <password> - Пароль при использовании защищенной сессии
  • <panel_id> - Уникальный идентификатор панели (Panel ID), не должен дублироваться на разных панелях


Пример вызова по нажатию на кнопку (Command Output):

IR_PARAMETERS-192.168.0.100,1319,,,10001

IR_PARAMETERS-192.168.0.100,1319,Admin,Admin,10001


Пример вызова с контроллера:

send_command dvTP, "'IR_PARAMETERS-192.168.0.100,1319,Admin,Admin,10001'"

AMX IR PARAMETERS.png


URL схемы (ссылки, запуск программ...)

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


Синтаксис команды (TPDesign4):

IR_EXECUTE-<string>

<string> - строка команды, которую нужно выполнить. Формат строки может отличаться в зависимости от ОС, на которой запущено приложение i3 pro


Примеры:

  • IR_EXECUTE-http://iridiummobile.net/ - откроет сайт iridiummobile.net в браузере
  • IR_EXECUTE-music:// - откроет приложение Музыка на iOS


Пример в TPDesign4:

AMX IR EXECUTE-TP4.png

Пример в Netlinx:

BUTTON_EVENT [10001:1:0,1]
{
    PUSH: 
    {
	send_command 10001:1:0,"'IR_EXECUTE-http://iridiummobile.net/'"
    }
}


Динамические списки (IRLB)

Динамический список iRidium (List) - элемент проекта, на базе которого в проекте АМХ из одного попапа (шаблона) формируется прокручивающийся список, пункты которого добавляются и удаляются во время работы проекта.

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


Подробная инструкция >>



Инструкция для iRidium Studio

iRidium Studio - редактор графических интерфейсов, в котором можно изменить, или создать с нуля визуализацию для AMX.


Причины использовать iRidium Studio вместо TPDesign4:

  1. В iRidium Studio можно настроить подключение сразу к нескольким контроллерам АМХ одновременно
  2. iRidium Studio не ограничивает пользователя в выборе разрешения проекта. При работе в TPDesign4, вы не можете выбрать разрешение вручную
  3. Язык Java Script упрощает создание логики прямо внутри проекта визуализации. Java Script может отправлять команды контроллеру и управлять графическими элементами интерфейса
  4. Кроме АМХ, в проект можно добавить управление любым оборудованием, совместимым с iRidium, в том числе аудио-видео, медиа-серверами и др. Это удобно при работе с несколькими системами, т.к. не требует внесения изменений в программу контроллера


Доработайте прокт TP4

Проект из TPDesign4 проект можно открыть в iRidium Studio и доработать на свое усмотрение. После внесения изменений проект нельзя вернуть в TP4, но можно использовать на любой панели iRidium

Создайте новый дизайн

На сайте iRidium Mobile можно купить, или бесплатно скачать графический интерфейс для будущего проекта iRidium. Но, его нельзя будет использовать в TPDesign4

Если вы планируете доработать *.TP4 в iRdium Studio, изменяя при этом только графическую часть проекта, используйте информацию о графических возможностях редактора.

Если вы планируете создать графическую часть и настроить также управление АМХ, используйте следующую инструкцию:



Подключение к AMX

Создайте в iRdium Studio новый проект или откройте файл *.TP4. Откройте панели DEVICE BASE (драйверы, с которыми может работать iRidium) и PROJECT DEVICE PANEL (драйверы, которые должны работать в проекте).

Найдите драйвер AMX и перетяните его в PROJECT DEVICE PANEL. Настройте драйвер для подключения к контроллеру:

AMX inEditor ADDnCONNECTION.png

Host - IP-адрес контроллера АМХ

Port - TCP порт управления (всегда 1319)

Login - Логин при использовании защищенной сессии

Password - Пароль при использовании защищенной сессии

Device ID - Уникальный идентификатор панели (Panel ID), не должен дублироваться на разных панелях


Смена настроек подключения

You need the possibility to change connection properties when you disconnect from the Wi-Fi network of the automation object and start using 3G or another Wi-Fi network. To maintain control of the object you need to switch from the local to public IP-address of the Internet router.

The switch is not automatic. You have to select the connection mode. For remote acces you have to make ports for controlling the automation system public. In order to do that you have o set up the Port Forwarding service on your Internet router. VPN can provide protected connection.


1 Download the template (*.js) (right-click button: "Save object as ..."), add the template in the script editor with the buttonIcon Scripts.png (+) Add Script from file


2 Set up script properties as it is shown in the example:

function Internal_1() {
IR.GetDevice("AMX").SetParameters({Host: "192.168.0.100", Port: 1319, Login: "admin", Password: "pass", PanelID: 10001});
}
function External_1() {
IR.GetDevice("AMX").SetParameters({Host: "215.110.10.10", Port: 1319, Login: "admin", Password: "pass", PanelID: 10001});
}

Copy the driver name from Projeсt Device Panel - the list of properties has to be copied from the example.


3 Select the button which will be responsible for the switch of Internal and External properties. Open Macros Editor for the Press event (Object Properties > Programming), select the Script Call command and add it by double-clicking on it. Select the name of the function which will be activated by the button:

Script call internal-external.png

Now each pressing on the button will apply the corresponding connection properties.


Настройка переменных

Для унификации работы с разным оборудованием, настройка переменных в iRidium заметно отличается от работы в TPDesign4.

в TPDesign4 вы указываете номера переменных и команды в настройках "Programming" графического элемента. Там же настраиваются параметры уровня.

В iRidium Studio нужно создать адрес в PROJECT DEVICE PANEL (Commands и Feedback) и перетянуть на графический элемент. Указывается, какие события должны вызвать активацию команды на элементе: "Press", "Release", "Move". После этого адрес появляется во вкладке "Programming" настроек элемента.


Быстрое создание списка переменных

Изначально переменные и графические элементы в iRidium разделены. Имея проект контроллера AMX, вы можете выяснить список переменных, которые должны работать в проекте и сможете быстро создать этот список в iRidium:

AMXaddCommandsRange.png

На выходе вы получаете 50 переменных Channel Port: 1 Channel Code: 1...50; Level Port: 1 Level Code: 1...50. Создавать диапазоны переменных можно в несколько приемов.


Channel

Идентичные настройки переменной типа "Channel" в AMX TPDesign4 и iRidium Studio на примере Item Type: General (Button) с дефолтными настройками:

AMXandIridiumChannelSettings.png

в TPDesign4 вы указываете Сhannel Port и Channel Code в настройках "Programming" графического элемента.

В iRidium Studio нужно создать адрес в PROJECT DEVICE PANEL (Commands и Feedback) и перетянуть на графический элемент. Укажите значения: "Press: 1", "Release: 0" и "Add a Feedback Channel", чтобы элемент работал аналогично кнопке в AMX. После этого адрес отобразится во вкладке "Programming" настроек элемента.

Настройка "Data: Internal" в iRidium позволит всегда отправлять переменной одно и то же значение, указанное в ее настройках (true или false).

Если элемент не должен отправлять команды, но должен реагировать на изменение Channel, перетяните на элемент переменную Channel из вкладки Feedback и выберите "In Value"


Level

Идентичные настройки переменной типа "Level" в AMX TPDesign4 и iRidium Studio на примере Item Type: Bargraph (Level) с дефолтными настройками:

AMXandIridiumLevelettings.png

в TPDesign4 вы указываете Level Port и Level Code в настройках "Programming" графического элемента. Там же настраивают параметры уровня.

В iRidium Studio нужно создать адрес в PROJECT DEVICE PANEL (Commands и Feedback) и перетянуть на графический элемент. Поставьте галочки "Press", "Release", "Move" и "Add a Feedback Channel", чтобы элемент работал аналогично уровню в AMX. После этого адрес отобразится во вкладке "Programming" настроек элемента.

Параметры уровня нужно настроить во вклдаке "General".

При создании команды в iRidium (вкладка Commands), обязательно создавайте и обратную связь (Feedback), чтобы переменные работали корректно. Быстро добавить обратную связь можно через меню правой кнопки мыши.

Если элемент не должен отправлять команды, но должен реагировать на изменение Level, перетяните на элемент переменную Level из вкладки Feedback и выберите "In Value"


String

Идентичные настройки отправки "String" в AMX TPDesign4 и iRidium Studio на примере Item Type: General (Button) с дефолтными настройками:

AMXandIridiumStringettings.png

в TPDesign4 вы указываете String Output Port и String Output в настройках "Programming" графического элемента.

В iRidium Studio нужно создать команду в PROJECT DEVICE PANEL (Commands) и перетянуть на графический элемент. Поставьте галочку "Press" и впишите строку для отправки, чтобы элемент работал аналогично AMX. После этого команда отобразится во вкладке "Programming" настроек элемента.

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


Command

Идентичные настройки отправки "Command" в AMX TPDesign4 и iRidium Studio на примере Item Type: General (Button) с дефолтными настройками:

AMXandIridiumCommandSettings.png

в TPDesign4 вы указываете Command Port и Command Output в настройках "Programming" графического элемента.

В iRidium Studio нужно создать команду в PROJECT DEVICE PANEL (Commands) и перетянуть на графический элемент. Поставьте галочку "Press" и впишите строку для отправки, чтобы элемент работал аналогично AMX. После этого команда отобразится во вкладке "Programming" настроек элемента.

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


Address

Идентичные настройки "Address" в AMX TPDesign4 и iRidium Studio на примере Item Type: General (Button) с дефолтными настройками:

AMXandIridiumAddressSettings.png

в TPDesign4 вы указываете Address Port и Address Code в настройках "Programming" графического элемента.

В iRidium Studio нужно создать команду в PROJECT DEVICE PANEL (Feedbacks) и перетянуть на графический элемент. После этого команда отобразится во вкладке "Programming" элемента.


Driver tokens

Токены драйвера - это пременные, доступные на чтение. Возвращают информацию о подключении к АМХ. Перетащите токен на графический элемент, чтобы вывести его значение.

GUI Descr Tokens.png

Online - состояние подключения к АМХ (Online/Offline = 1/0)

Status - статус подключения к АМХ (Offline/Connect/Online/Disconnect = 0...3)

Host - доменное имя удаленной системы

HostPort - порт на удаленной системе, к которому подключается iRidium

IP - IP-адрес панели управления

HostIP - IP-адрес удаленной системы, к которой подключен iRidium

Port - локальный порт iRidium, через который осуществляется связь с АМХ

В AMX TPDesign4 нет аналогов Project Tokens или System Tokens. Через System Tokens можно получить дату, время и другие параметры панели, где запущен iRidium. Project Tokens - локальные переменные, в которых можно хранить числа, строки или массивы между запусками приложения.



JavaScript API

API iRidium - это набор JavaScript функций, позволяющий управлять проектом визуализации iRidium. Чтобы добавить JavaScript в свой проект, изучите руководство.

Руководство рассчитано на разработчиков, знакомых с программированием на JavaScript и объектно-ориентированной парадигмой разработки. В руководстве описаны основные понятия, используемые в API и методы решения типовых задач управления проектом iRidium.

Все доступные объекты API подробно описаны в справочнике по программному интерфейсу.


Эмулятор: проверка проекта

Эмулятор (Emulator) - приложение для проверки работы проекта в редакторе iRidium Studio.

Эмулятор работает только после авторизации с использованием логина и пароля с сайта iRidium Mobile

Режимы работы Эмулятора настраиваем в Tools > Options > Emulator:

  • Client Fullscreen - запуск в полноэкранном режиме
  • Client Sound On - включить/выключить звук в приложении
  • Show log at Emuator Start - автоматически открывать окно лога (иначе лог можно открыть по нажатию F4)


Path to the license.png

Горячие клавиши:

  • F4 - открыть лог
  • F5 - запустить Эмулятор
  • F7 - открыть меню управления аккаунтом и проектами
  • F8 - открыть системные настройки (введите пароль 2007)



Синхронизация с панелью управления

Если вы - интегратор, вы можете быстро запустить созданный интерфейс визуализации на панели управления - смартфоне, планшете или ПК. Установите приложение i3 pro и авторизуйтесь в нем с помощью вашего логина и пароля интегратора с сайта iRidium Mobile.


Используйте i3 pro для iOS, Android, Windows, Mac в тестовом режиме, загружая проекты через iRidium Transfer (возможность доступна только для интеграторов):


Настройки iRidium Transfer


Коммерческое использование iRidium возможно толкьо при загрузке проектов визуализации с помощью облачного сервиса iRidium Cloud на сайте iRidium Mobile (см. инструкцию).

iRidium Cloud может настроить только зарегистрированный интегратор. После настройки, доступно приглашение пользователей к управлению объектом автоматизации.