Материал из for iRidium developers
Перейти к: навигация, поиск
Other languages:
English • ‎русский


Проект для 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)
    перемещение между настройками ввода-вывода и параметрами сервера
    1. I/O - выбрав этот раздел серверного проекта, вы увидите теги сервера и теги драйвера
    2. Config - выбрав этот раздел, вы увидите настройки сервера
  3. Теги сервера (Server Tags)
    список переменных, из которых будет сформирован драйвер iRidium Server в панельном проекте. Можно создать виртуальные теги, не связанные с реальным оборудованием (заполнение производится через скрипт)
  4. Настройки тегов сервера
    параметры тегов iRidium Server (имя, размерность, сохранение в базу данных, связь с JS функцией и др.)
  5. Теги драйвера (Driver Tags)
    переменные оборудования, к которым должен подключиться iRidium Server. Все переменные в этой вкладке проецируются на теги сервера. Через теги сервера панель управления получает доступ к оборудованию
  6. Настройки тегов драйвера
    параметры драйверов, с которыми работает iRidium Server. При создании переменной драйвера, автоматически создается тег сервера с тем же именем
  7. База данных (Device Base)
    хранилище встроенных драйверов (продуктов) iRidium. Включает инструменты создания драйверов для пользователей и дополнительные базы скриптовых драйверов.
  8. GC Cloud (IR Database)
    база ИК команд для использования с преобразователями Global Caché



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

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

Editor window Server Project Overview.png
Project Overview:


Теги сервера, теги драйвера (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 - подробная информация
  • ALL - вся информация


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


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

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

Icon Scripts.png открыть редактор скриптов iRidium
<translate>

Editor window JS Editor.png


JSnew.png новый файл скрипта:
  • создать файл скрипта
  • открыть файл скрипта (*.js)
  • создать папку
JSdel.png удалить выбранный в списке файл скрипта
JSupdown.png переместить вверх/переместить вниз
JSpass.png установить пароль на просмотр и редактирование файла скрипта
JSrename.png переименовать файл скрипта
JSsavefile.png сохранить файл *.js
JShelp.png показать/скрыть справку по методам и событиям IR.
JSapply.png применить внесенные в скрипт изменения
JSserch.png поиск по слову или строке (Ctrl+F)
JSundoredo.png отменить/вернуть изменение
Icon Emulator.png запустить Эмулятор
JSfunctions.png поиск по именам функций в файле JS

</translate>



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

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

Editor window Device Base.png
Инструменты базы данных:
Add – добавить драйвер из базы данных в проект. Добавление производится методом Drag&Drop: перетащите драйвер из вкладки Device во вкладку Project
Editor window Device Base icon Edit.png Edit – изменить базу данных. Это профессиональный инструмент, который позволяет создавать собственные базы данных и изменять существующие. Нельзя использовать с основной базой данных iRidium.


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

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

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


Editor window Device Base icon Edit.png Edit - открыть редактор базы данных

Действия с базами:
Editor window Device Base icon new.png New – создать новую базу данных. Используется для профессиональной настройки оборудования и создания собственных устройств на базе драйвера AV & Custom Systems
Editor window Device Base icon Attach.png Attach – добавить новую базу в список GUI Editor
Editor window Device Base icon Detach.png Detach – убрать выбранную базу из списка GUI Editor
Editor window Device Base small.png
Editor window DB Editor.png

</translate>


GC Cloud (IR Database)

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

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

GCDB 1.png

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

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

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

GCD 11.png

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



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

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

GUIpirpz.png

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

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

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


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


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

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

GUIscriptCoder.png

</translate>



Настройки Studio

Команды, доступные в выпадающих списках File Project Tools Help View


File

New
Editor window new project.png

File > New > New Panel Project

  • Project Name - имя нового проекта
  • Target Device - тип устройства, на котором будет запускаться проект (определяет разрешение проекта). Выберите "Custom", чтобы ввести разрешение вручную
  • Landscape Widht / Landscape Height - разрешение пейзажной страницы проекта в пикселях
  • Page Name - имя первой страницы нового проекта
  • Orientation - положение стартовой страницы (портретная/пейзажная)
Editor window new server project.png

File > New > New Server Project

  • Project Name - the name of new server project
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 Закрыть редактор и все открыте проекты в нем. Предложит сохранить изменения в проектах.


Tools

Languages Выбрать язык интерфейса редактора
Options
Editor window Tools Option.png
Основные настройки iRidium GUI Editor:
  • настройки Эмулятора
  • Параметры загрузки изображений в галерею
  • Отображение объектов
  • Проверка обновлений
  • Параметры сканирования сети
  • Сохранение резервных копий проектов


Открыть настройки: Инструменты > Настройки (Tools > Options)


"Emulator" - настройки работы Эмулятора в редакторе

Editor Tools Option Emulator.png

В разделе Client License задается режим работы Эмулятора i3 pro

  • 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 - включить создание резервной версии проекта при каждом его сохранении. Сохраняется только файл конфигурации без библиотеки изображений. Для его использования необходимо разархивировать поврежденный проект irpz как zip архив и заменить в нем файл проекта irp на сохраненный в бекап
  • Check updates at start - проверять наличие обновлений при каждом запуске редактора
  • Check BETA-builds - проверять наличие бета-версий редактора при каждом его запуске
  • Divider for file group operations - разделитель, отделяющий порядковый номер состояния от имени изображения при импорте анимированного объекта в галерею редактора


"Default Control Settings" - настройки шрифта на новом элементе, созданном с помощью инструмента "Draw Item"

Editor Tools Option File DefaultCS.png
  • Font - тип и размер шрифта на новом элементе
  • Font Color - цвет текста на новом элементе
  • State 1 - цвет первого состояния
  • State 2 - цвет второго состояния
Certificates Генерация сертификатов для магазина приложений (в разработке)
Default Panels Size Вернуть стандартное размещение панелей и окон редактора.

Help

Editor Help Руководство пользователя iRidium Studio
Update Editor Проверка обновлений редактора. Обновление изменяет сам редактор и сопутствующие приложения. Настройки сохраняются.
Send Bug Report Отправить отчет об ошибке на портал технической поддержки
About Информация о версии редактора

View

View Содержит список вкладок и инструментов тулбара, которые можно отобразить или скрыть в окне редактора