Перейти к основному содержимому

iRidium Studio

Проект для iRidium Server

В этом разделе описана работа с iRidium Studio при создании проекта для iRidium Server. iRidium Server обрабатывает данные от оборудования автоматизации, сохраняет их в базу данных и передает информацию панелям управления. Серверный проект не включает графической части - это набор скриптов и список оборудования, с которым необходимо работать.

Создайте новый проект для iRidium Server:


iRidium Studio > File > New > **New Server Project**

new_server_project.png

Рабочая область серверного проекта

После запуска iRidium Studio и создания нового Server Project , вы увидите рабочую область, состоящую из:

GUI_serverMode_overview.png

  1. Настройки Studio *
    выпадающие списки, из которых можно перейти к настройкам редактора: File, Project, Tools, Help, View
  2. Обзор серверного проекта (Project Overview) *
    перемещение между настройками ввода-вывода и параметрами сервера
  3. I/O * - выбрав этот раздел серверного проекта, вы увидите теги сервера и теги драйвера

  4. Config * - выбрав этот раздел, вы увидите настройки сервера

  5. Теги сервера (Server Tags) *
    список переменных, из которых будет сформирован драйвер iRidium Server в панельном проекте. Можно создать виртуальные теги, не связанные с реальным оборудованием (заполнение производится через скрипт)
  6. Настройки тегов сервера
    параметры тегов iRidium Server (имя, размерность, сохранение в базу данных, связь с JS функцией и др.)
  7. Теги драйвера (Driver Tags) *
    переменные оборудования, к которым должен подключиться iRidium Server. Все переменные в этой вкладке проецируются на теги сервера. Через теги сервера панель управления получает доступ к оборудованию
  8. Настройки тегов драйвера
    параметры драйверов, с которыми работает iRidium Server. При создании переменной драйвера, автоматически создается тег сервера с тем же именем
  9. База данных (Device Base) *
    хранилище встроенных драйверов (продуктов) iRidium. Включает инструменты создания драйверов для пользователей и дополнительные базы скриптовых драйверов.
  10. GC Cloud (IR Database) *
    база ИК команд для использования с преобразователями Global Caché

Обзор серверного проекта (Project Overview)

Project Overview позволяет перемещаться между окнами настроек сервера:

Editor_window_Server_Project_Overview.png

I/O - входы/выходы; открывает для редактирования теги сервера и теги драйвера Config - настройки серверного проекта

Теги сервера, теги драйвера (I/O)

Вкладка открывается при нажатии на пункт I/O в Project Overwiev Server_IO_Settings.png

1. Виртуальные переменные (Virtual) - переменные, в которые можно записывать любые данные, полученные в результате работы скриптов (числа, строки, массивы). Виртуальные переменные доступны для изменения с панели управления.

  • VIrtual > Channels - переменные, доступные для записи
  • VIrtual > Tags - переменные, доступные для чтения

2. Теги сервера (Server Tags) - переменные, которые автоматически формируются при добавлении управляемого оборудования в Driver Tags. Имя тега соответствует имени переменной драйвера в Тегах драйвера

  • Driver > Driver Tokens - информация о подключении к оборудованию, только чтение
  • Driver > Commands - переменные, доступные для записи
  • Driver > Feedbacks - переменные, доступные для чтения

3. Настройка тегов - позволяет настроить виртуальные теги и теги сервера.

  • настройка записи

    • Name - короткое имя
    • Full Name - полное имя для обращения из скрипта
    • Description - описание (опционально)
    • Script - выполнить JavaScript функцию без аргументов каждый раз при активации тега
  • настройка чтения

    • Name - короткое имя
    • Full Tag Name - полное имя для обращения из скрипта
    • Description - описание (опционально)
    • Store In DB - сохранение всех измененных значений в базу данных
    • Access - тип переменной: Public - можно изменить с панели управления, Private - можно изменить только с сервера
    • Deadband - погрешность изменения, которую не нужно учитывать при построении графика на основании данных тега. Например, при Deadband: 0.5, изменение переменной на 0.3 не отобразится на графике в приложении-клиенте
    • Script - выполнить JavaScript функцию без аргументов каждый раз при активации тега

4. Теги драйвера (Driver Tags) - переменные оборудования, к которым должен подключиться iRidium Server. Все переменные в этой вкладке автоматически проецируются на теги сервера.

5. Настройка тегов - позволяет настроить переменные оборудования, которыми управляет сервер. Эти настройки уникальны, и зависят от типа драйвера, с которым работает сервер.


Настройка сервера (Config)

Вкладка открывается при нажатии на пункт Config в Project Overwiev

Server_Config_Settings.png

1. Jobe Notes - информация о проекте. Будет отображаться в панельных проектах, связанных с этим серверным проектом *Customer/Order - заказчик, счет *Project Name - имя проекта *Address - адрес объекта автоматизации *Phone - телефон заказчика *Email - электронный почтовый адрес заказчика

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

3. General - основные параметры проекта *Project Name - имя серверного проекта

4. Settings - настройки сервера и драйвера iRidium Server, который будет связывать серверный и панельный проекты. Эта информация будет отображаться во всех панельных проектах, связанных с этим серверным проектом:

*Server host - IP адрес сервера *Server port - порт подключения к серверу (по-умолчанию: 30464) *Login (будущий функционал) - логин для подключения панелей к серверу *Password (будущий функционал) - пароль для подключения панелей к серверу *System ID (будущий функционал) - уникальный идентификатор сервера, будет использован под систему push нотификаций и DDNS сервер

5. Debugging Log Level - глубина отображения информации в логе сервера:

*Global - отображает верхнюю планку логирования, общую для всех подкатегорий лога. Выше уровня, указанного в Global, информация в логе не появится ни в одной из подкатегорий *Core - формируется ядром сервера *Database - формируется базой данных *Script - формируется скриптами *Webserver - формируется веб-сервером

Уровни логирования:

  • EMERGENCE - приложение не может быть использовано
  • ALERT - действие должно быть предпринято немедленно
  • CRITICAL - критические ошибки, работа приложения невозможна
  • ERROR - ошибки, работа приложения возможна
  • WARNING - предупреждения, работа приложения возможна
  • NOTICE - значимые замечания, работа приложения возможна
  • INFO - основная информация
  • DEBUG - вся информация

Нажмите Save в нижней части окна настроек, чтобы сохранить настройки сервера.

Редактор скриптов (JS Editor)

Инструмент для создания программ на языке Java Script, которые будет работать на сервере. С помощью скриптов формируется логика работы сервера. Сервер поддерживает собственный набор методов и свойств Java Script.

icon_Scripts.png открыть редактор скриптов iRidium


Editor_window_JS_Editor.png

ИконкаДействие / Описание
JSnew.pngНовый файл скрипта:
* создать файл скрипта
* открыть файл скрипта (*.js)
JSdel.pngУдалить выбранный в списке файл скрипта
JSupdown.pngПереместить вверх / переместить вниз
JSpass.pngУстановить пароль на просмотр и редактирование файла скрипта (для вступления пароля в силу необходимо сохранение и повторное открытие проекта)
JSapply.pngПрименить внесённые в скрипт изменения
JSsavefile.pngСохранить в файл *.js
JSExternal_editor.pngОткрыть во внешнем редакторе
* Зашифрованные скрипты нельзя открыть во внешнем редакторе
* Если не выбран внешний редактор в настройках, при нажатии откроется настройка внешнего редактора
JSundoredo.pngОтменить / вернуть изменение
JSColor.pngВставить значение цвета в редакторе
JShelp.pngПоказать / скрыть справку по методам и событиям IR
JSserch.pngПоиск по слову или строке (Ctrl+F)
JS_enable.pngВключение скрипта в работе клиента
JS_disable.pngВыключение скрипта в работе клиента (отключенные скрипты помечены серой иконкой)
Enter_pass.pngВвод пароля
Set_pass.pngСброс пароля (для удаления оставьте поле "Set new password" пустым)
  • Настройки вкладки Script (размер табуляции, внешний редактор) находятся в Настройках Studio: Tools > Studio settings > Script

База данных (Device Base)

Это база драйверов, команд и скриптовых модулей для управления различным оборудованием. Здесь хранятся все поддерживаемые iRidium устройства, которые Вы можете использовать в своих проектах.

Editor_window_Device_Base.png

Add* – добавить драйвер из базы данных в проект. Добавление производится методом Drag&Drop: перетащите драйвер из вкладки Device во вкладку Project
width = "4%"|Editor_window_Device_Base_icon_Edit.pngEdit* – изменить базу данных. Это профессиональный инструмент, который позволяет создавать собственные базы данных и изменять существующие. Нельзя использовать с основной базой данных iRidium.

Редактор базы данных (DataBase Editor)

Инструмент создания преднастроенных драйверов, команд и каналов на основе драйвера AV & Custom Systems.

Это профессиональный инструмент, который позволит настроить управление любым AV оборудованием, медиасервером, преобразователем или другим устройством. Подробно см. в разделе обработка данных.

Editor_window_Device_Base_icon_Edit.png Edit - открыть редактор базы данных

width = "4%"|Editor_window_Device_Base_icon_new.pngNew* – создать новую базу данных. Используется для профессиональной настройки оборудования и создания собственных устройств на базе драйвера AV & Custom Systems
Editor_window_Device_Base_icon_Attach.pngAttach* – добавить новую базу в список GUI Editor
Editor_window_Device_Base_icon_Detach.pngDetach* – убрать выбранную базу из списка GUI Editor

Editor_window_Device_Base_small.png

Editor_window_DB_Editor.png


GC Cloud (IR Database)

GC Cloud - это онлайн-база ИК команд для драйвера Global Cache.

Нажмите "Обновить" , чтобы загрузить список производителей и команд (обязательно подключение к Интернету)

GCDB_1.png

Структура базы:

  • Brands - производители оборудования
  • Device Types - категории оборудования у производителя
  • Codesets & Commands - модели, и соответствующие им ИК команды

Перетащите папку с командами на ИК выход драйвера Global Cache в вашем проекте. Команды настроены заранее, их не нужно редактировать:

GCD_11.png

Команды и папки можно перемещать между ИК выходами модулей GC в проекте перетаскиванием.


Шифрование проекта

Полное шифрование проекта (сохранение в защищенном формате)

GUIpirpz.png

Проект iRidium (**.irpz, .sirpz ) можно сохранить в защищенном формате, который не позволит третьим лицам получить доступ к изменению проекта, его настройкам и ресурсам (иконки, звуки, изображения, каналы оборудования).

Защищенный проект (.pirpz, '.psirpz ) нельзя открыть в Studio, но можно загрузить на панель управления, где приложение автоматически распакует и запустит интерфейс.

Кодирование проекта - необратимый процесс . Файл, сохраненный в формате *.pirpz нельзя превратить обратно в *.irpz, нельзя редактировать. Его можно только загрузить на панель управления. Кодированный проект сохраняется рядом с исходным, редактировать можно только исходный проект.


Также существуют методы защиты данных внутри проекта *.irpz, которые работают без кодирования всего проекта:

Кодирование файла скрипта

Ограничить просмотр и редактирование скрипта (iRidium Script) можно, установив пароль доступа:

GUIscriptCoder.png


Настройки Studio

Команды, доступные в выпадающих списках

Open ProfectОткрыть ранее сохраненный проект в редакторе (*.irpz)
Save ProjectСохранить выбранный проект (*.irpz)
Save Project As...Сохранить проект с другим именем
Close ProjectЗакрыть выбранный проект
Close All ProjectsЗакрыть все проекты, открытые в редакторе
ReopenСписок недавно открывавшихся проектов. Нажмите на проект, чтобы открыть
Save Protect projectСохранить зашифрованный проект (*.pirpz), который можно загрузить на панель, но нельзя отредактировать. Зашифрованный файл сохраняется рядом с исходным.Превратить его в *.irpz и изменить - нельзя. Подробно
ImportИмпортировать в открытый проект данные из файлов конфигурации контроллера или из других проектов iRidium: pr3, pr4, pr5, knxproj - импорт групповых адресов из ETS (для оборудования KNX) csv - импорт регистров для Modbus (специальная CSV таблица для Modbus в формате iRIdium) smw - импорт джоинов для Crestron irp, irpz - импорт драйверов со всеми командами и настройками из других проектов iRidium
ExitЗакрыть редактор и все открыте проекты в нем. Предложит сохранить изменения в проектах.
РазделОписание
LanguagesВыбрать язык интерфейса редактора
Studio settingsEditor_window_Tools_Option.png
Основные настройки iRidium GUI Editor:
- настройки Эмулятора
- Параметры загрузки изображений в галерею
- Отображение объектов
- Проверка обновлений
- Параметры сканирования сети
- Сохранение резервных копий проектов
Открыть настройки: Инструменты > Настройки (Tools > Options)

"Emulator" - настройки работы Эмулятора i3 pro:
Editor_Tools_Option_Emulator.png
- Client Fullscreen - запускать Эмулятор на весь экран
- Client Sound On - воспроизводить звуки в Эмуляторе
- Show log at Emulator start - запускать окно лога (F4)

"Showing" - настройки отображения в рабочей зоне редактора:
Editor_Tools_Option_Showing.png
- Channels Count - отображать число привязанных к элементу команд
- Font - размер и тип шрифта, отображаемого для элементов
- Show Items In Tree - показывать список графических элементов в дереве страниц проекта
- Grid - активация и настройка сетки
- Grid Color - цвет сетки
- Render - тип рендеринга

"Scan" - настройки сканирования сети HDL Buspro
Editor_Tools_Option_Scan.png
- Scan Count - число циклов сканирования сети
- Scan Timeout, ms - длительность одного цикла сканирования

"File Operating" - авто-сохранение и бекап проектов:
Editor_Tools_Option_File_Operating.png
- Backup, Backup Path - создание резервной версии проекта при каждом сохранении
- Check updates at start - проверка обновлений при запуске редактора
- Check BETA-builds - проверка бета-версий
- Divider for file group operations - разделитель при импорте анимированного объекта

"Default Control Settings" - настройки шрифта на новом элементе:
Editor_Tools_Option_File_DefaultCS.png
- Font - тип и размер шрифта
- Font Color - цвет текста
- State 1 - цвет первого состояния
- State 2 - цвет второго состояния

"Script" - вкладка настроек скриптов:
Editor_Tools_Option_File_Script01.png
- Tab size - размер Tab
- External editor - выбор внешнего редактора для скриптов
Внешний редактор:
Editor_Tools_Option_External_editor01.png
Editor_Tools_Option_External_editor02.png - Добавить внешний редактор
Editor_Tools_Option_External_editor03.png - Удалить внешний редактор
- Update without request - автоматическое обновление скрипта
- Алгоритм добавления внешнего редактора:
1. Нажать кнопку "+"
2. Выбрать программу и нажать ОК
3. Нажать ОК в окне External Editor
4. Нажать ОК в окне Studio settings
CertificatesГенерация сертификатов для магазина приложений (в разработке)
Default Panels SizeВернуть стандартное размещение панелей и окон редактора
Update EditorПроверка обновлений редактора. Обновление изменяет сам редактор и сопутствующие приложения. Настройки сохраняются.
Send Bug ReportОтправить отчет об ошибке на портал технической поддержки
AboutИнформация о версии редактора