iRidium для Xicato
Набор инструментов для создания интерфейсов управления оборудованием от производителей Xicato.
документация обновлена 01.01.2024
Описание
iRidium для Xicato - это набор инструментов, позволяющий создать интерфейс для управления осветительными приборами Xicato.
Протестировано с оборудованием:
- XIG-0102-0a;
- XID.
Подключение
Драйвер Xicato работает по http протоколу. Статус онлайн приобретает только во время передачи данных, в остальное время статус всегда офлайн.
Для подключения к оборудованию Xicato необходимо:
- Скачать мобильное приложение Ximtroller (для iOS), Admin Panel (на Win) или другое официальное приложение компании Xicato и настроить оборудование;
- В созданный панельный или серверный проект добавить и настроить драйвер Xicato;
- Привязать команды и фидбеки к элементам графического интерфейса и настроить необходимую логику проекта.
Работа в iRidium
Создайте новый проект и добавьте драйвер Xicato с помощью сканера или ручным вводом данных.
Сканирование сети
Сканирование работает только в локальной сети - оно позволяет быстро добавить в проект iRidium все устройства Xicato. Для этого:
- Создайте новый проект и нажмите клавишу Scan > Xicato Scanner на вкладке Devices ;
- Заполните IP-адрес, порт, логин и пароль для подключения к оборудованию;
- Выберите устройство, которым планируете управлять.
Если сканер не находит оборудование, то вы можете прописать данные настройки драйвера вручную:
Настройка драйвера
- В созданном проекте на вкладке Devices добавьте драйвер Xicato:
- Укажите настройки подключения драйвера:
- Log Level - уровень логирования;
- Host - IP-адрес оборудования;
- Port - порт (по умолчанию 8000);
- Login / Password - логин и пароль доступа к оборудованию;
- Driver Version - версия драйвера.
- Щелкните ЛКМ по добавленному драйверу Xicato и добавьте необходимые подустройства (Add subdevice). Каждое подустройство имеет предустановленный список команд и фидбеков в соответствии со своим типом.
Настройка подустройств
- Name - имя подустройства;
- Driver Type - тип драйвера (Xicato);
- Device ID - уникальный идентификатор устройства (должен соответствовать присвоенному id в веб интерфейсе оборудования);
- Network - имя сети. Cоздать сеть можно с помощью приложения Admin Panel (на Win), если сети нет, то в поле указываем "unsecured";
- Device Type - тип устройства (лампа, группа, мультиканальное устройство).
Настройка команд и фидбеков
Для управления оборудованием настройте команды (Commands) и каналы обратной связи (Feedbacks). Чтобы отправить команду, перетяните ее на графический элемент и укажите значение (Value), которое необходимо отправить. Чтобы отобразить значение с канала обратной связи, перетащите Feedback на графический элемент, и укажите, каким образом вывести значение (Value).
Подробнее о работе с графическими элементами написано в статье "Типы графических элементов".
Lamp
Управление лампой.
Command
| Параметр | Значение | Описание |
|---|---|---|
| Command | Intensity | Установка яркости лампы. |
| Use Value Channel | True / False | True - отправить в канал значение параметра Intensity. False - отправить в канал значение Value. |
| Intensity | 0 ~ 100.0 | Установить яркость лампы. |
| Is Need Fading | True / False | Использовать плавное затухание лампы при выключении / включении. |
| Fading | 0 ~ n | Время затухания / загорания лампы (в мс.). |
| Value* | 0 ~ 100.0 | Установить яркость лампы. |
Value - укажите при перетягивании команды на графический элемент.
| Параметр | Значение | Описание |
|---|---|---|
| Command | Recall Scene | Вызов сценария работы лампы (яркость, затухание, задержка по старту). |
| Scene Number | 1 ~ n | Номер сцены. |
| Is Need Fading | True / False | Использовать плавное затухание ламп в сцене. |
| Fading | 0 ~ n | Время затухания / загорания ламп в сцене (в мс.). |
| Value* | - | Не используется. |
Value - укажите при перетягивании команды на графический элемент.
Feedback
| Параметр | Значение | Описание |
|---|---|---|
| Feedback | Intensity | Состояние яркости лампы. |
| Value* | 0 ~ 100.0 | Текущая яркость лампы. |
Value - значение, которое отдаёт оборудование.
Group
Управление лампами в группе.
Command
| Параметр | Значение | Описание |
|---|---|---|
| Command | Intensity | Установка яркости ламп. |
| Use Value Channel | True / False | True - отправить в канал значение параметра Intensity. False - отправить в канал значение Value. |
| Intensity | 0 ~ 100.0 | Установить яркость ламп. |
| Is Need Fading | True / False | Использовать плавное затухание ламп при выключении / включении. |
| Fading | 0 ~ n | Время затухания / загорания ламп (в мс.). |
| Value* | 0 ~ 100.0 | Установить яркость ламп. |
Value - укажите при перетягивании команды на графический элемент.
| Параметр | Значение | Описание |
|---|---|---|
| Command | Recall Scene | Вызов сценария работы лампы (яркость, затухание, задержка по старту). |
| Scene Number | 1 ~ n | Номер сцены. |
| Is Need Fading | True / False | Использовать плавное затухание ламп в сцене. |
| Fading | 0 ~ n | Время затухания / загорания ламп в сцене (в мс.). |
| Value* | - | Не используется. |
Value - укажите при перетягивании команды на графический элемент.
Multi-Channel Device
Управление мультиканальным устройством.
Command
| Параметр | Значение | Описание |
|---|---|---|
| Command | Multi-Channel Intensity | Установить яркость ламп мультиканального устройства. |
| Quantity Sub-Channel | 1 ~ n | Количество подканалов (не учитывая мастер канал). |
| Channel Number | 0 ~ n | Номер канала (0 - мастер, 1 и более - подканалы). |
| Use Value Channel | True / False | True - отправить в канал значение параметра Intensity. False - отправить в канал значение Value. |
| Intensity | 0 ~ 100.0 | Установить яркость ламп мультиканального устройства. |
| Is Need Fading | True / False | Использовать плавное затухание ламп мультиканального устройства при выключении / включении. |
| Fading | 0 ~ n | Время затухания / загорания ламп (в мс.). |
| Value* | 0 ~ 100.0 | Установить яркость ламп мультиканального устройства. |
Value - укажите при перетягивании команды на графический элемент.
Feedback
| Параметр | Значение | Описание |
|---|---|---|
| Feedback | Multi-Channel Intensity | Состояние яркости ламп мультиканального устройства. |
| Channel Number | 0 ~ n | Номер канала (0 - мастер, 1 и более - подканалы). |
| Value* | 0 ~ 100.0 | Состояние яркости ламп в мультиканальном устройстве. |
Value - значение, которое отдаёт оборудование.
Multi-Channel Group Devices
Управление группой мультиканальных устройств.
Command
| Параметр | Значение | Описание |
|---|---|---|
| Command | Multi-Channel Intensity | Установка яркости ламп в группе мультиканальных устройств. |
| Quantity Sub-Channel | 1 ~ n | Количество подканалов (не учитывая мастер канал). |
| Channel Number | 0 ~ n | Номер канала (0 - мастер, 1 и более - подканалы). |
| Use Value Channel | True / False | True - отправить в канал значение параметра Intensity. False - отправить в канал значение Value. |
| Channel Intensity | 0 ~ 100.0 | Установка яркости ламп в группе мультиканальных устройств. |
| Is Need Fading | True / False | Использовать плавное затухание ламп мультиканального устройства при выключении / включении. |
| Fading | 0 ~ n | Время затухания / загорания ламп (в мс.). |
| Value* | 0 ~ 100.0 | Установка яркости ламп в группе мультиканальных устройств. |
Value - укажите при перетягивании команды на графический элемент.