Эта страница является
переводом страницы
IRidium studio 2019 Control tools. Перевод выполнен на 80%.
Control of equipment and logic are available both for i3 pro and iRidium server, as both apps can connect to equipment directly, but iRidium server has tools unavailable in i3 pro.
The tools include:
- DRIVERS - a list of devices and services to which i3 pro or iRidium server is connected to control and get data (not all devices can be displayed here, as devices can be created via JavaScript)
- PROGRAMMING - (only for i3 pro) actions that a graphic item in i3 pro performs, when it is pressed. Items can control internal logics of the interface as well as send/display data received from equipment
- JS. JavaScript - an editor, available for i3 pro or iRidium server. When a script is developed, it's important to consider the environment - a server or a visualization interface, as the environment determines a set of available methods and ways to address data.
- PROJECT TOKENS - variables where user data can be used between launched of i3 pro or iRidium server.
- SYSTEM TOKENS - variables that allow to get information about a device where i3 pro or iRidium server is launched (time, type od OS, parameters of the network, screen, etc.)
- SCHEDULERS (only for iRidium server) - a schedule of events with such settings as: time of activation and period of repetition
- ROUTINES (only for iRidium server) - scenes (a sequence of commands and conditions of their execution) that can be launched according to a schedule
- GC CLOUD - an on-line base od IR-commands to control Audio-Video equipment via IR. Commands are stored in a format for equipment Global Cache
- ETS import. Import of group addresses from ETS5 project (*.knxproj).
DRIVERS. Devices and Services
Driver - is a subprogramm inside i3 pro or iRidium server, that provides interaction with external resources (devices, services). Data can have different formats and address systems , depending on the transmission medium, a driver is responsible for forming and addressing data packages, as well as for processing incoming information.
Read description of driver work.
A driver can be created:
- by importing a configuration file of your equipment, by scanning a local network. Supported (see up to date list in iRidium studio):
- DuoTecno - scanning a network
- HDL-BUS Pro - scanning a network
- KNX (ETS, *.knxproj) - file import forms a list of IP interfaces and group addresses
- Modbus (*.csv) - file import in the internal iRidium format, see documentation for iRidium. A list of registers is formed.
- Crestron (Simpl, *.smw) - file import forms a list of joins
- iRidium script (iRidium studio, *.js) - file import allows to add scripts from one project into another one
- iRidium project (iRidium studio, *.irpz, *.sirpz) - file import allows to add drivers from oner project into another one
- Domintell - scanning a network
- Velbus - scanning a network
- AMX (TPDesign, *.TP4, *.TP5) is not displayed in driver import, but TP4 project can be opened in iRidium studio like *.irpz - file *.TP4 is automatically converted into i3 pro format
- from the data base, where a list of different drivers is stored, that can be used in a project. Commands and feedback channels must be formed manually
- from JavaScript. In this case it is not displayed in the driver tree, but it works at the app launch the way a developer designed it to. See JS API
PROGRAMMING. Actions when Pressed
There are graphic items on pages and popups of a visualization interface. They do certain actions when they are pressed or change their appearance when data are received from equipment. Item behavior depends on its settings, all commands that it sends are shown in the PROGRAMMING folder.
Commands of macros editor to interact with drivers and variables of a project:
- Send To Driver (send values to driver commands)
- Send Number. Send a constant - decimal number (DEC);
- Send Text. Send a constant - data string (ASCII);
- Send Data. send a constant - binary data (BIN);
- Send Token. Send data received from project variables (Value, coordinates, sizes, etc. - variable values defined by object properties);
- Send To Token (sending data to variables - item properties, drivers, project tokens);
- Send Number. write a constant (DEC numeral) in the variable;
- Send Text. write a constant (ASCII string) in the variable;
- Send Token. write a variable in the variable (for example, write item property in project token).
To send a command when an item is pressed, drag'n'drop a driver command/token on this item.
To display driver feedback on an item, drag'n'drop driver feedback/token on the item.
A command / a driver feedback channel / a token can be assigned to a graphic item by drag'n'dropping to the PROGRAMMING window. Here is how to do it:
- Create a graphic item (for example, a button);
- Select a required graphic item with a cursor;
- Drag'n'drop a command / a feedback channek / a token to the required tab of the PROGRAMMING window:
- Relations - assiging a value of a token / a driver feedback channel to an item;
- Press - commands are sent when a button is pressed;
- Release - commands are sent when a button is released;
- Hold - commands are sent in a cycle as long as an item is held;
- End Of Hold - a command is sent once when a button is released, after the button was held;
- Move - a command is sent when a sliding bar or a joystick is moved;
- Select - choice of an item and subitem in List (script list). Access via List API;
- Enter - press of the Enter key in the Edit Box item;
- Gestures - gestures (swipes). Only a page can process a gesture (a gesture can't be set for a window or item area). A gesture can start on a page, graphic item or a window, but it will be passed on to a parent page - commands, set for the page, will be done. Exceptions: such items as Level, Joystic, List and Static List, that process the Move event instead of gestures.
Read more about sending commands and displaying data
Read more about Press, Release and other events in PROGRAMMING
JS. Programming in JavaScript (iRidium script)
Script is available for i3 pro and iRidium server. JavaScript allows to program logics of interface and logics of equipment control. Core: ECMAScript 3, methods of more up-to-date versions are not available.
When scripts are developed, it's important to consider the environment: whether it's a server or a visualization interface, as it defines a set of available methods and ways of addressing data. That's why, sometimes, when a script is transferred from an interface to a server, sometimes changes in the script are required.
There are ready solutions for numerous tasks that can be solved only with the help of script. You can use these modules if you do not have programming skills.
Script is a powerful tool to form logics. To start work with the script:
PROJECT TOKENS
Project tokens are variables to store user data that are used many times. A number or a string can be written in a token and this value is stored between launches of i3 pro or iRidium server.
For example, a token can be used to store passwords, settings and other values that a user changes during his work and they have to be remembered during a session or between launches.
A value can be set in token settings that the token will contain at first launch by default.
Choose the following parameter Remember the state of project tokens in project settings, if it is required to remember the previous value at each start of the app. Otherwise default values will be displayed at each app start.
SYSTEM TOKENS
System tokens are variables that allow to get information about a device where i3 pro is launched. Most system tokens are available only to read, but some of them can be controlled. Data from system tokens can used in the interface (for example, date and time can be displayed) and in the logics of a visualization project.
Addressing system tokens from JavaScript >>
System tokens that can be controlled and not only read:
- Update. project update via iRidium transfer (local): 0 - off, 1 - on.
- Display.Bright. Brightness of display from 0 to 100%.
- Device. Vibro. Launch of a short vibration. The time of vibration must be written in a token as a value in seconds. For iOS it is always 1, other values are inavailable.
- Screensaver.Enable. Control of screensaver work. 0 - turn off, 60000 - turn on after 1 minute of stand-by (value is written in ms). A page for the screensaver must be selected in a project in advance.
- Screensaver.Show. Control of screensaver demonstration: 0 - hide, 1 - show.
- Application. Clear Project Tokens. Reset of all token values of a project to default ones. To activate a toke, send any value (1...n) to it. If a project token has no default value, it won't be cleared.
SCHEDULERS
Schedule of events is available only on iRidium server. It contains a set of events that are activated at a set time once or repeatedly with a period ranging from 1 day to several years.
Each event has the beginning and the end. An action can be done either at the moment when it begins or at the moment when it ends. Actions to be done are set in the ROUTINES tab.
Set the astronomical timer, to start using Sunrise and Sunset events in project settings (Settings > Location) select the longitude and the latitude of the location, where iRidium server works.
i3 pro can control schedules, launched on iRidium server. At the moment, management is carried out using 2 types of schedules: Advanced and Simple.
Advanced are advanced (basic) schedules. Advanced schedules allow to set in the studio the following parameters beforehand: the time and date of event start and end, and the repetition period of an event. Advanced schedules also work with TimeTable item.
Simple are simplified schedules. Simple schedules have fewer setting parameters, but they allow to work with editable routines from a launched panel proejct.
Only the time and date of event start can be set in simple schedules. To assign an action to the end of an event, it is required to create a separate event.
Read a deatailed description of setting editable routines here.
Manual:Setting and Using Schedules >>>
ROUTINES
Routines are available only on iRidium server. Routine is a scene, described in THEN, that is done the moment WHEN event happens , but only if conditions, set in BUT ONLY IF are fulfilled.
Types of events (WHEN):
- getting a value from equipment: a value is compared to the one indicated in the condition
- event activation SCHEDULER - a routine is done the moment a schedule starts or ends
Manual: Setting and Using Routines >>>
GC CLOUD. IR commands for Global Caché
GC CLOUD is a large constantly growing on-line base of IR commands to control audio-video equipment via IR. The commands are stored in the equipment format Global Cache. That's why if you use IP2IR converters by Global Caché (iTach, GC-100-06, GC-100-12), you can use commands from the base, rather than look for them and set them on your own.
For correct work of the commands, use a specialized driver for Global Caché from iRidium database and select a model of your Global Caché device on the driver settings:
After the driver is set, IR commands can be drag'n'dropped on its IR Outputs from GC CLOUD in folders or one by one. Enter the first letter of a manufacturer name in the Brands list to move in the alphabetic list faster, and select the most suitable set of commands in the Device type and Model:
ETS import. Import of group addresses from ETS
iRidium connects to KNX but and it can interact with devices in the bus writing and reading values of group addresses. A list of group addresses can be imported from ETS5 project (*.knxproj) and added to your iRidium project - all at once or in parts. Additional import and settings update of group addresses are supported. Import of KNX IP BAOS datapoints is supported.
To import group addresses from ETS5 project (*.knxproj):
1 Start iRidium studio, create a project and open the following side panels ETS import and Driver tree:
2 Click the Import button in the ETS import panel and choose a *.knxproj file:
3 Choose a format the data will be imported in: in a new file or unite with other ETS projects:
4 Choose required devices to create a driver based on ETS project
Import parameters:
- "Smart import", it analyses flags of objects to create commands, feedback channels and to set a request;
- Use the structure of the Main and Middle groups to create folders with addresses automatically.
Analyses of flags of group addresses sums flags of all communication objects connected with a group address and based on it a decision is made to add a command and a feedback channel.
5 Enter settings to synchronize the ETS file with the driver panel:
Synchronization parameters:
- Add new group addresses from ETS file - it adds new group addressed from a ETS file.
Name format of added devices:
- Group addresses:
- Address and name - address and name,
- Only name - only name,
- Only address - only address.
- BAOS datapoints:
- Name from BAOS datapoint table - name from the table of BAOS datapoints
- Name of linked group address - name of a linked group address
You can come back to synchronization settings by clicking Settings 
in the import panel.
6 When the import is complete, new devices appear in the driver tree, and a base from the EST project is displayed in the import window.
Connection between the driver and a ETS project is given in the Devices window:
- Source ETS Project - ETS project;
- Source ETS Device - a type of device.
A connection can be changed or deleted by clearing these fields.
Connection is created 1:1, thus one driver can have connection with only one device from the base. If a device is connected to driver №2, but earlier it was connected to driver №1, connection with driver №1 is broken. Connections can be restored.
Use the Synchronize button 
, to update addresses in the driver according to synchronization settings.
To update a list of addresses after making changes in a ETS project, export a file from ETS and import it again - data will be united.
New addresses added from the ETS file will be marked with the [new] label.
7 A file of ETS project does not store the address of KNX IP interface. Check that you entered the right IP-address of KNX IP interface:
Tools of ETS import panel
- Import – it adds a new ETS file to the import base or update the contents of the added file. ETS5 (*.knxproj) files are supported.
- Synchronization settings – they are synchronization parameters of data about group addresses between the import panel and the driver (see description of parameters in point 5 manual on import).
- Synchronize – it synchronizes ETS project file woth a corresponding driver in the panel. Press the (3) button to see synchronization settings. Synchronization can be done by drag'n'dropping a file from the import panel onto the driver.
- Sorting method of group addresses. Sorting similar to ETS is supported: "Group addressed", "Devices", "Building".
- The Name field displays a list of group addresses unnited in folders according to a chosen sorting method (6). Names are formed from 3 parts: group address, name (like in ETS), summed flags of connected group objects. To give a name to a command or a feedback channel in a driver only the address name is used
Flags:
- Communication – neither a command, nor a feedback channel can be created without this flag;
- Write – a command will be added;
- Transmit – a feedback channel will be added. The "Read on start" option will be turn off, if there is no Read flag;
- Read – it turns on the "Read on start" option in the settings of a created feedback channel;
- Update – it is not analyzed
- The Type field displays a data subtype of a group address according to ETS. If an address is not connected with group objects, it won't be added to a project. and the type field remains Unknown.
- The status field displays the [new] icon next to addresses that are added during reimport of ETS file. The [sync] icon is dsplayed next to addresses which checkboxes have a different state in the ETS import tab, but they were not changed in the driver or during the update of the database of a ETS project.
- A checkbox allows to add a command or a feedback channel that did not exist in the ETS project to a driver or to delete an added command or feedback channel. The color of arrow (9) does not change. The device must be synchronized after it (3).
- "Smart import" hilights with bright colors commands and feedback channels it considered necessary to add, and with the grey color the ones that are not added.
Menu of Right Mouse Button
When you click the right mouse button on the driver in the ETS import folder, you see a menu with the following functions:
- Sync - synchronization with the driver;
- Remove connection with the driver - delete connection with the driver;
- Return default sync settings - clear user settings and return to the initial solution (applicable to the whole base).
If there is no connection, during synchronization you'll be offered to create a new driver. Otherwise a connected driver is chosen by default.
Commands & Feedbacks
As a result of import we have:
- KNX Router (Interface) - a driver that contains a list of group addresses in the bus;
- Commands and Feedbacks - commands and feedback channels which help to control the group addresses. Commands are group addresses available for writing, feedback channels are group addresses available for reading.
To search in the device tree (Devices window) faster, go to the ETS import tab and click right mouse button on the required address. A window opens to search a command or a feedback channel. The chosen command / feedback channel is highlighted in the Devices window.
Commands and feedback channels must be assigned to graphic items to control equipment:
- A command is assigned to a graphic item with a value that will be sent to the bus whne a graphic itemi is pressed.
- A feedback channel is assigned to a graphic item to display the status of a group address.
To assign a command or a channel to a graphic item use the drag&drop method.
Read more about sending commands from i3 pro interface and display of data
here.
