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

Other languages:
English • ‎русский


Projects for iRidium Server

This section describes work with iRidium Studio when creating projects for iRidium Server. iRidium Server processes data from automation equipment, saves them and sends the information to control panels. A server project does not have a graphic part - it is a set of scripts and a list of equipment you want to work with.

Create a new project for iRidium Server:
iRidium Studio > File > New > New Server Project

New server project.png


Workspace of Server Projects

After starting iRidium Studio and creating of Server Project you can see the workspace which consists of:

GUI serverMode overview.png
  1. Studio Settings
    the drop-down lists from which you can access to editor settings: File, Project, Tools, Help, View
  2. Project Overview
    moving between the input-output settings and server parameters
    1. I/O - in this section of your server project you will see server tags and driver tags
    2. Config - in this section you will see server settings
  3. Server tags
    the list of variables from which the iRidium Server driver in the panel project will be formed. You van create virtual tags, not connected with real equipment (filling in is performed via scripts)
  4. Settings of server tags
    the parameters of iRidium Server tags (name, size, saving data in the database, relations with JS functions, etc.)
  5. Driver tags (Driver Tags)
    the equipment variables to which iRidium Server has to connect. All variables in this tab are projected on server tags. Via the server tags control panels get access to equipment
  6. Settings of driver tags
    the parameters of drivers with which iRidium Server works. When creating a driver variable the server tag with the same name is created automatically
  7. Device Base
    the storage of built-in iRidium drivers (products). It contains tools for creating drivers for users and additional databases of script drivers.
  8. GC Cloud (IR Database)
    the database of IR commands for use with Global Caché converters



Project Overview

Project Overview enables you to move between the windows of server settings:

Editor window Server Project Overview.png
Project Overview:
  • I/O - the inputs/outputs; it opens server tags and driver tags for editing
  • Config - the server project settings


Server Tags, Driver Tags (I/O)

The tab is opened when clicking on I/O in Project Overview

Server IO Settings.png

1. Virtual variables (Virtual) - переvariables where you can write any data received as a result of script work (numbers, strings, arrays). Virtual variables are available for changing from control panels.

  • Virtual > Channels - the variables available for writing
  • Virtual > Tags - the variables available for reading


2. Server Tags - variables which are formed automatically when adding controlled equipment to driver tags. Names of server tags correspond to the names of driver variables in driver tags

  • Driver > Driver Tokens - the information about connection to equipment, reading only
  • Driver > Commands - the variables available for writing
  • Driver > Feedbacks - the variables available for reading


3. Settings of tags - they enable setting up virtual tags and server tags.

  • settings for writing
    • Name - the short name
    • Full Name - the full name to refer from scripts
    • Description - the description (optional)
    • Script - to execute the JavaScript function without arguments every time the tag is activated


  • settings for reading
    • Name - the short name
    • Full Name - the full name to refer from scripts
    • Description - the description (optional)
    • Store In DB - saving of all changed values in the database
    • Access - the variable type: Public - it can be changed from control panels, Private - it can be changed only from the server
    • Deadband - the change which will not be considered when building graphs on the basis of tag data. For example, if Deadband: 0.5, the change of the variable by 0.3 will not be displayed on the graph in the client application
    • Script - to execute the JavaScript function without arguments every time the tag is activated


4. Driver Tags - equipment variables to which iRidium Server has to connect. All variables in this tab are automatically projected on server tags.

5. Settings of tags - they enable you to set up equipment variables controlled by the server. The settings are unique. They depend on the driver type the server works with.



Server Settings (Config)

The tab is opened when clicking on Config in Project Overview

Server Config Settings.png

1. Job Notes - information about the project. It will be displayed in the panel projects connected to this server project

  • Customer/Order - the customer and order
  • Project Name - the project name
  • Address - the address of the automation object
  • Phone - the customer phone number
  • Email - the customer e-mail address


2. Description - notes about the project, version history. It will be displayed in the panel projects connected to this server project

3. General - main project properties

  • Project Name - the server project name


4. Settings - the settings of the server and the iRidium Server driver which will connect the server and panel projects. This information will be displayed in all panel projects connected to this server project:

  • Server host - the server IP-address
  • Server port - the port of connection to the server (by default: 30464)
  • Login (under development) - the login for connection of control panels to the server
  • Password (under development) - the password for connection of control panels to the server
  • System ID (under development) - the unique server identifier used for push notifications and the DDNS server


5. Debugging Log Level - the depth of logging, what information is displayed in the server log:

  • Global - it displays the upper level of logging common for all subcategories of the log. No information higher than the level indicated in Global will appear in any of the log subcategories
  • Core - it is formed by the server core
  • Database - it is formed by the database
  • Script - it is formed by scripts
  • Webserver - it is formed by the web server


Logging levels:

  • EMERGENCY -
  • ALERT -
  • CRITICAL - critical errors, application work is impossible
  • ERROR - errors, application work is possible
  • WARNING - warnings, application work is possible
  • NOTICE -
  • INFO - main information
  • DEBUG - detailed information
  • ALL - all information


Click Save in the lower part of the settings window to save the server settings.


JS Editor

It is a tool for creating programs in the Java Script language which will work on the server. The logic of server work is formed with the help of scripts. The server supports its own set of Java Script methods and properties.

Icon Scripts.png open the editor of iRidium scripts
<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>



Project encryption

Full encryption of projects (saving in the protected format)

GUIpirpz.png

iRidium projects (*.irpz, *.sirpz) can be saved in the protected format which will not allow other parties to get access to project editing, its settings and resources (icons, sounds, images, equipment channels).

Protected projects (*.pirpz, '*.psirpz) cannot be opened in Studio but they can be uploaded on control panels where the application will automatically unpack and start the interface.

Project encryption is an irreversible process. Files saved in the *.pirpz format cannot be turned back to *.irpz or edited. They can be only uploaded on control panels. Encrypted projects are saved together with the original ones. You can edit original projects only.


There are also means for protecting data inside *.irpz projects which work without encrypting the whole project:


Encryption of script files

You can limit iRidium Script viewing and editing by assigning an access password to it:

GUIscriptCoder.png



Studio Settings

Commands available in the drop-down lists File Project Tools Help View


File

New
Editor window new project.png

File > New > New Panel Project

  • Project Name - the name of a new project
  • Target Device - the type of the device on which the project will be launched (defines the project resolution). Select "Custom" to input the resolution manually *Landscape Widht / Landscape Height - the resolution of the landscape page in pixels
  • Page Name - the name of the first page of the new project
  • Orientation - the orientation of the start page (Portrait/Landscape)
Editor window new server project.png

File > New > New Server Project

  • Project Name - the name of a new server project
Open Profect Open the saved project in the editor (*.irpz)
Save Project Save the selected project (*.irpz)
Save Project As... Save the project with another name
Close Project Close the selected project
Close All Projects Close all projects opened in the editor
Reopen The list of recently opened projects. Click on the project to open it
Save Protect project Save the protected project (*.pirpz), which can be uploaded on control panels but cannot be edited. The encrypted file is saved together with the original one. You cannot turn it back to *.irpz or edit. More
Import Import to the opened project data from controller cofiguration files or other iRidium projects:
  • pr3, pr4, pr5, knxproj - import of group addresses from ETS (for KNX equipment)
  • csv - import of registers for Modbus (the special CSV table for Modbus in the iRidium format)
  • smw - import of joins for Crestron
  • irp, irpz - import of drivers with all commands and settings from other iRidium projects
Exit Close the editor and all opened projects in it. You will be offered to save changes in the projects.


Tools

Languages Select the language of the editor interface
Options
Editor window Tools Option.png
Main settings of iRidium GUI Editor:
  • Emulator settings
  • Properties of uploading images in Gallery
  • Displaying of objects
  • Checking for updates
  • Properties of network scanning
  • Saving of project back-up copies


Open the settings: Tools > Options


"Emulator" - settings of Emulator in the editor

Editor Tools Option Emulator.png

The mode of work with Emulator ( with connection to equipment or without it) is set up in the Client License section

  • Client Fullscreen - to launch the Emulator on full screen
  • Client Sound On - to play sounds in Emulator
  • Show log at Emulator Start - open the log window (F4) automatically


"Showing" - settings of displaying in the editor workspace

Editor Tools Option Showing.png
  • Channels Count - to display the number of commands assigned to the item
  • Font - the size and type of the font which will be used for displaying information about the item in the editor workspace (item name, number of comamnds, etc.)
  • Show Items In Tree - to show the list of graphic items of the page in the project page tree
  • Grid - activation and setting of the grid in the editor workspace
  • Grid Color - the grid color
  • Render - the type of rendering of the editor workspace


"Scan" - settings of HDL Buspro network scanning

Editor Tools Option Scan.png
  • Scan Count - the number of network scanning cycles
  • Scan Timeout, ms - the duration on one scanning cycle in ms


"File Operating" - settings of project auto save and backup, editor update and file import in Gallery

Editor Tools Option File Operating.png
  • Backup, Backup Path - to activate creation of project backup at each saving. Only the configuration file is saved, without library of images. In order to use it you need to unpack the damaged irpz project as a zip archive and substitute the project irp file to the one saved in backup in it
  • Check updates at start - to check for updates at each launch of the editor
  • Check BETA-builds - to check for editor beta-versions at each launch of the editor
  • Divider for file group operations - the divider separating the state order number from the image name when importing animated objects in Gallery


"Default Control Settings" - font settings for new items created with the help of the "Draw Item" tool

Editor Tools Option File DefaultCS.png
  • Font - the font type and size on new items
  • Font Color - the text color on new items
  • State 1 - the color of the first state
  • State 2 - the color of the second state
Certificates Generation of certificated for the application store (under development)
Default Panels Size Return the standard positioning of editor windows and panels.

Help

Editor Help iRidium Studio user manual
Update Editor Checking for editor updates. Updates change the editor and accompanying applications. The settings stay the same.
Send Bug Report Send the repot about found bugs to the technical support portal
About Information about the editor version

View

View Contains the list of toolbar tabs and tools which have to be shown or hidden in the editor window