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

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

Содержание

iRidium for HDL Buspro

a set of tools for creating interfaces to control equipment in the HDL Buspro bus

the documentation is updated 16.2.2017


Description

iRidium for HDL Buspro is a set of tools for creating interfaces to control homes or offices on the basis of HDL equipment.

iRidium for HDL Buspro enables connection of control panels (iOS, Android, Windows, Mac) to the HDL bus via any HDL IP interface. At that the number of concurrent connections is not limited by the interface.


Connection

Equipment configuration and settings required for iRidium to control HDL equipment.


Ways of connection to HDL

Different ways of connection to the bus enable local work and work via the Internet, depending on whether you have a static IP-address or not :

HDL scheme.png

1. Local

HDL Inet.png

2. Internet

HDL-Remote.png

3. HDL Remote Server


1. The "Local" mode works only in the local network and it does not allow to set up control of the bus via the Internet. The broadcast address is used for connection. The local connections works with any HDL IP module.


2. The "Internet" mode enables connection to the HDL IP module via the Internet without using HDL Remote Server. In the "Internet" mode the connection is established directly between the panel and the HDL IP module. In order to work in this mode the router of the HDL network has to have the static IP-address and use the DDNS service.

HDL IP interface with firmware not earlier than HDL_V04.06U


3. The "HDL Remote Server" mode enables connection to the HDL IP module via the Internet if you do not have a static IP-address or domain (DDNS). The connection is established via the HDL Internet server which is used for authorization between the iRidium control panel and the HDL IP interface. After the authorization the connection is direct without using the server.

HDL IP interface with firmware not earlier than HDL_V04.06U

Bus scanning

Scanning works only in the local network - it enables fast adding of all HDL devices with preset commands in the project.

Create a new project and click the button Scan > HDL Buspro Net (UDP) in the Project Device Panel window:

before scanning close HDL Buspro Setup Tool.

Hdl general scan.png


If you cannot scan the bus, add HDL Buspro Network (UDP) and devices manually:

Hdl general db.png


Commands & Feedbacks

As a result of scanning you will have three levels of the HDL bus:

  • HDL-Buspro Network (UDP) - the HDL bus, it unites all controlled devices (relays, sensors, etc.). The bus has an IP-address for external control via the HDL IP interface
  • HDL Devices - the devices in the bus. They have unique addresses - Subnet ID and Device ID
  • Commands and Feedbacks - the commands and feedback channels inside the devices which enable control of their separate properties.


Commands and feedback channels have to be assigned to project graphic items to control equipment:

  • Commands are assigned to graphic items indicating the value to be sent to the bus when clicking on the items
  • Feedback channels are assigned to graphic items to display the equipment state in the bus


To assign commands or channels to graphic items use the drag&drop method.

Below you can see examples of commands for controlling HDL equipment with the help of operation codes.


Settings for connection to the bus

Connection modes: Local, Internet and HDL Remote Server.

Local

The "Local" mode works only in the local network and it does not allow you to set up control of the bus via the Internet. The broadcast address is used for connection. The local connections works with any HDL IP module.

Hdl settings local.png

In the settings of the HDL IP module indicate Network Parameter to work in the local network

  • IP: the local address of the HDL IP module
  • Subnet Mask: the subnet mask
  • Route IP: the default gateway
Hdl settings local editor.png

In the settings of HDL Gateway indicate the local address for connection with the HDL IP module. On the recommendation of your system administrator you can change the broadcast address. Otherwise, leave the default setting.

  • Send Timeout: the forced interval between commands sent by the control panel to the HDL IP module (it helps to decrease the load on the IP module and the HDL bus)
  • Connect Mode: Local – the mode for local connection with the HDL IP module
  • Broadcast: 255.255.255.255 – the broadcast address for exchanging data with HDL


Internet

The "Internet" mode enables connection to the HDL IP module via the Internet without using HDL Remote Server. In the "Internet" mode the connection is established directly between the panel and the HDL IP module. In order to work in this mode the router of the HDL network has to have the static IP-address and use the DDNS service.


HDL IP interface with firmware not earlier than HDL_V04.06U
access to the bus via Internet can be via one licensed HDL IP interface (concurrent connection to several HDL IP interfaces via the Internet is not supported)

Hdl settings Inet.png

In the settings of the HDL IP module indicate Connection Preferences: properties for connection to the HDL IP module

  • Type: Remote Server
  • Project Name, Group Name: the names of the project and group of projects
  • User, Password: the properties of the protected connection
  • Preferred Server, Port: the properties of connection to the HDL Remote Server (they will not be used in the “Internet” mode, but have to be indicated)
Hdl settings Inet editor.png
  • Send Timeout: the forced interval between commands sent by the control panel to the HDL IP module (it helps to decrease the load on the IP module and the HDL bus)
  • Connect Mode: Internet – the mode of connection with the HDL IP module
  • Host: the public IP-address of your router for accessing to the HDL IP module via the router
  • Port: the HDL port for direct connection to the HDL IP module via the Internet (6000)
  • Login: the login for connection, from the Remote Server settings of the IP module *Password: the password for connection, from the Remote Server settings of the IP module *Project Name: the project name from the Remote Server settings of the IP module


To work via the Internet, indicate the public IP-address of the router to which the controller is connected and set up Port Forwarding.

You can see the public IP-address of the router here


HDL Remote Server

The "HDL Remote Server" mode enables connection to the HDL IP module via the Internet if you do not have a static IP-address or domain (DDNS). The connection is established via the HDL Internet server which is used for authorization between the iRidium control panel and the HDL IP interface. After the authorization the connection is direct without using the server.


HDL IP interface with firmware not earlier than HDL_V04.06U
access to the bus via Internet can be via one licensed HDL IP interface (concurrent connection to several HDL IP interfaces via the Internet is not supported)

Hdl settings Inet.png

In the settings of the HDL IP module indicate Connection Preferences: properties of the clients which have to have the possibility to connect to the HDL IP module

  • Type: Remote Server
  • Project Name, Group Name: the names of the project and group of projects
  • User, Password: the properties of protected connection
  • Preferred Server, Port: the properties for connection to the HDL server
Hdl settings Server editor.png

In the settings of HDL Gateway (UDP) indicate properties of connection with the HDL IP module via the remote server.

  • Send Timeout: принудительный интервал между командами, которые управляющая панель отправляет IP модулю HDL (помогает снизить нагрузку на IP модуль и шину HDL)
  • Connect Mode: Remote Server – режим соединения с IP модулем HDL
  • Host: адрес удаленного сервера HDL
  • Port: порт подключения к IP модулю через удаленный сервер (как в настройках IP модуля)
  • Login: логин подключения из настроек IP модуля
  • Password: пароль подключения из настроек IP модуля
  • External Port: порт доступа к HDL IP интерфейсу, "проброшенный" на вашем маршрутизаторе (6000). Если оставить поле пустым, оно будет заполнено данными, которые передаст HDL Server
  • Project Name: имя проекта из настроек IP модуля


To work via the Internet, indicate the public IP-address of the router to which the controller is connected and set up Port Forwarding.

You can see the public IP-address of the router here


Changing the connection settings

Возможность смены параметров подключения нужна, если вы отключаетесь от Wi-Fi сети объекта автоматизации и начинаете использовать 3G или другую Wi-Fi сеть. Чтобы управление продолжило работать, нужно переключиться с локального на публичный IP адрес интернет-маршрутизатора.

Переключение не происходит автоматически, вам нужно будет нажать на клавишу выбора режима соединения. Для возможности удаленного доступа необходимо сделать порты управления системой автоматизации публичными. Для этого настраивают службу Port Forwarding на интернет-маршрутизаторе. Защищенное соединение может обеспечить VPN.


1 Скачайте шаблон (*.js) (правая кнопка: "Сохранить объект как..."), добавьте шаблон в редактор скриптов Icon Scripts.png клавишей (+) Add Script from file


2 Настройте параметры скрипта, как показано в примере:

function Internal_1() {
IR.GetDevice('HDL-BUS Pro Network (UDP)').SetParameters({Host: "255.255.255.255", Port: 6000, SendNeedConfirm: 0, SendTimeout: 20, ConnectMode: 0});
}
function External_1() {
IR.GetDevice('HDL-BUS Pro Network (UDP)').SetParameters({Host: "215.110.10.10", Port: 6000, Login: "User", Password: "User", SendNeedConfirm: 0, SendTimeout: 20, ConnectMode: 3, ExtendedPort: 6000, Project: "ir_proj", Group: "ir_group"});
}

Скопируйте имя драйвера из Projсet Device Panel, список параметров нужно скопировать из примера в точности.


3 Выберите кнопку, которая будет отвечать за переключение Internal и External параметров. Откройте Macros Editor для события Press (Object Properties > Programming), выберите команду Script Call и добавьте ее двойным кликом. Выберите имя функции, которую вызовет кнопка:

Script call internal-external.png

Теперь каждое нажатие на кнопку будет применять соответствующий набор настроек подключения.

Examples:

// Local (ConnectMode=0)
IR.GetDevice("HDL Buspro UDP").SetParameters({Host: "255.255.255.255", Port: 6000, SendNeedConfirm: 0, SendTimeout: 20, ConnectMode: 0})
 
// Internet (ConnectMode=2)
IR.GetDevice("HDL Buspro UDP").SetParameters({Host: "215.110.10.10", Port: 6000, Login: "User", Password: "User", SendNeedConfirm: 0, SendTimeout: 20, ConnectMode: 3, Project: "ir_proj"})
 
// HDL Remote Server (ConnectMode=3)
IR.GetDevice("HDL Buspro UDP").SetParameters({Host: "215.110.10.10", Port: 9999, Login: "User", Password: "User", SendNeedConfirm: 0, SendTimeout: 20, ConnectMode: 3, ExtendedPort: 6000, Project: "ir_proj", Group: "ir_group"})



Devices

Device categories to which HDL devices can be related to at scanning the bus. The list includes devices available on hdlautomation.com at the moment of writing the article and supported by iRidium.

The list of device commands can be changed after scanning or manual adding in the project.

Contact the support team - (support@iridiummobile.ru) if it is required to update the list or you found some inaccuracy.


Устройства:

category device operation codes
Panels
Switch Panel Panel Control
DLP Panel Panel Control, Read Temperature
DLP Panel (AC, FH) Panel Control, Read Temperature, Floor Heating from DLP
Dimming Actuators
Dimmer - 1CH Lighting
Dimmer - 2CH Lighting
Dimmer - 4CH Lighting
Dimmer - 6CH Lighting
Dimmer - 12CH Lighting
Relay Actuators
Relay - 4CH Lighting
Relay - 8CH Lighting
Relay - 12CH Lighting
Relay - 16CH Lighting
LED Actuators
RGB LED Driver - 3CH Lighting
LED Dimmer - 6CH Lighting
DALI Actuators DALI Dimmer - 64CH Lighting
DMX Actuators
DMX Gateway - 16CH Lighting
DMX Controller - 512CH Lighting
DMX Controller - 48CH Lighting
0-10V Actuators Ballast Controller - 6CH + 6CH Lighting
Sensors
Ourdoor Sensor Read Sensor Status (Sensors in One); Universal Switch (201-248)
Sensor with 12 functions Read Sensor Status (12in1, 8in1 314), Universal Switch
Mini Ceiling Sensor (4 in 1) Read Sensor Status (Sensors in One); Universal Switch (201-248)
Ceiling Mount Sensor Temp-Hum-Lux
Ceiling Mount Sensor Air Quality
Ceiling Mount Sensor 8-In-1
Ceiling Mount Sensor 7-In-1
Ceiling Mount Mini Sensor PIR
Movement sensor for ceiling-mounting
Wall Mount Sensor UItrasonic-PIR
Wall Mount Sensor Wide Field PIR
Security
Security Module Security, Universal Switch
Logic Module Logic, Universal Switch
Climate Actuators
Temperature Sensor - 4CH Read Temperature New
Floor Heating Module - 6CH Floor Heating from Heating Module, Universal Switch
HVAC Module AC
Shading Actuators
Curtain Module - 2CH Curtain Switch
Motorized Curtain - 1CH + % Curtain Switch
Tubular Blind Controller - 1CH + % Curtain Switch
Background Audio
Z-Audio Music
Music Box Music
Hotel System Hotel RCU Room Controller Unit Lighting, Curtain Switch, Universal Switch
Communication Gateways
IR Emitter Universal Switch
SMS Module GPRS, Universal Switch
KNX Port Universal Switch
RS232 Converter Universal Switch
Smart Metering
Power Meter - 3 PHASE Power Meter
Power Meter - 1 PHASE Power Meter
Dry Contact
Dry Contact - 4CH Dry Contact, Universal Switch
Dry Contact - 8CH Dry Contact, Universal Switch
Dry Contact - 24CH Dry Contact, Universal Switch

Commands

Recommended ways of controlling the HDL bus devices are listed after description of operation codes (below). Operation codes support sending of values in a particular range which you have to consider when setting up graphic items. Some operation codes support only receiving feedback, without command sending. The ways of receiving feedback are also presented after each operation code.

To send a command you need to drag it on a graphoc item and indicate the value (Value) to be sent. To display feedback you need to drag the channel on the graphic item and indicate where the value (Value) has to be output

SendValue.png

Macro commands

By pressing one button you can send commands to several HDL devices.

You can assign several commands to one graphic item. they will be sent to equipment one by one from top downward without any delay. The feedback channel can be assigned only once. Otherwise the incoming data will be processed incorrectly.

To assign several commands to one graphic item drag them one by one on the item. Select the corresponding events (Press, Release, Move) in the dialog window:

MacroCommands.png

Delay between commands (ms) is added through the macros editor. Select the Other folder, the Delay command. It is recommended to add delay for providing reliable processing of commands by equipment.

MacroAddDelay.png

See more information about command sending in description of operation codes.

Operation codes

To control equipment you need to set up commands (Commands) and feedback channels (Feedbacks). To send a command you need to drag it on the graphic item and indicate the value (Value) to be sent. To display feedback you need to drag the feedback channel and indicate where the value (Value) has to be output

SendValue.png

Possible settings of commands, channels and graphic items when working with different operation codes:


Lighting

Single Channel Lighting

The command with feedback: control of dimmer brightness, switching relays on/off.

Select the HDL device, укажите егоindicate its Subnet ID / Device ID, select the device type: Dimmer, Relay. Now you can set up comamnds for controlling channels brightness and receiving data about their states.


Command:

Operation Code Single Channel Lighting the command for setting up channel brightness
Channel 1-254 the number of the relay (dimmer) channel
255 all relay (dimmer) channels
Running Time (s) 0-14 the time during which brightness is changed
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0 to switch off
100 to switch on
0-100 to set up channel brightness (only for dimmers)

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Single Channel Lighting the current channel brightness
Channel 1-254 the number of the relay (dimmer) channel
Value 0-100 the current channel brightness for displaying on graphic items


Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Control of the DMX RGB strip with the help of the palette:

RGB palette for DMX

RGB LED strips are controlled with the help of DMX controllers and have one of the following configuration:

  • Red, Green, Blue - three channels for controlling the LED strip color. Decrease of brightness is performed by decreasing brightness of separate channels.
  • Red, Green, Blue, Alpha - four channels for controlling the LED strip color and brightness


Variant 1 Control RGB strips with the help of three (four) Level items.


You create 3 (4) Unsigned 8-bit (Subtupe: VALUE) variables in the project. The variables are controlled in the range 0...255, value increase in the channel corresponds to the increase brightness of the respective color.

LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming


Variant 2 Control of RGB strips with the help of palette


You can use any colored item as a palette - you will be able to send commands of setting up the selected color to equipment by moving a finger on the item.

It requires adding a special script - RGB libraries - in your project. The script has to be added only once. Then you will be able to use it to control RGB strips of any built-in iRidium drivers.

2.1 Create a palette and auxiliary items. You can use any colored image as a palette.

  • Set up the palette like Joystick with the range 0...100 for Х and Y coordinates
  • Set up an inactive item Button which will display the color selected on the palette
  • If it is required set up active Button items which will change the strip brightness step-by-step
RGBPalette.png

2.2 Download the file RGB_Library.js

This file enables color control with the help of JavaScript. Add the file in your visualization project: open the project in iRidium Studio, click Icon Scripts.png, select the item ( + ) "Add Script From File"

2.3 Create an empty script file: ( + ) "New Script" to add the description of your RGB palette in it:

Describe the palette and the item for displaying the selected color in the script file:
///////// Copy this function to make one more RGB palette ///////
RGB_player(
         "Driver",                                            // Driver in project
         "Channel Red",                                       // Name of Red Channel
         "Channel Green",                                     // Name of Green Channel 
         "Channel Blue",                                      // Name of Blue Channel
         255,                                                 // Top limit for RGB channel (100 or 255)
         IR.GetItem("Page 1").GetItem("Item Color Picker 1"), // Item "Color Picker"
         /////// optional parameters ///////////////////////////
         IR.GetItem("Page 1").GetItem("Item Display 1"),      // Item "Display"
         )

The extended version has buttons for controlling brightness:

Palette, displaying the color and the button +/- for controlling brightness

///////// Copy this function to make one more RGB palette ///////
RGB_player(
         "Driver",                                            // Driver in project
         "Channel Red",                                       // Name of Red Channel
         "Channel Green",                                     // Name of Green Channel 
         "Channel Blue",                                      // Name of Blue Channel
         255,                                                 // Top limit for RGB channel (100 or 255)
         IR.GetItem("Page 1").GetItem("Item Color Picker 1"), // Item "Color Picker"
         /////// optional parameters ////////////////////////////
         IR.GetItem("Page 1").GetItem("Item Display 1"),      // Item "Display"
         IR.GetItem("Page 1").GetItem("Up 1"),                // Item "Up"
         IR.GetItem("Page 1").GetItem("Down 1"),              // Item "Down"
         10                                                   // Increment step for "Up" and "Down"
         )


In the description indicate where the palette is and to what equipment it sends data:

  • IR.GetDevice("Driver") - the name of the diver to which you will send RGB commands. Copy the driver name in PROJECT DEVICE PANEL
  • "Channel Red", "Channel Green", "Channel Blue" - the names of the variables (Commands) which are responsible for control of red, green and blue color components. Copy the names in PROJECT DEVICE PANEL. The Commands names have to be the same as the names of Feedbacks from where information about the current color of the RGB strip comes.
    HDL-Buspro, Domintell - they have a special way of writing names. For them you need to indicate <the device name in the network>:<the channel name>, for example "Dimmer in Bedroom:Channel 1"
  • 255 - the maximum brightness value for each color. For the majority of equipment brightness is regulated in the range from 0 to 255 but there are drivers which control color brightness in the range 0...100 (for example, HDL). For HDL-Buspro indicate value 100 for this property.
  • IR.GetItem("Page 1").GetItem("Item Color Picker 1") - the page name ("Page 1") and the item on it ("Item Color Picker 1") which you will use as a palette
  • IR.GetItem("Page 1").GetItem("Item Display 1") - the page name ("Page 1") and the item on it ("Item Display 1") which you will use for displaying the color selected on the palette
  • IR.GetItem("Page 1").GetItem("Up 1") - the page name ("Page 1") and the item on it ("Up 1") which will increase brightness of the selected color on pressing
  • IR.GetItem("Page 1").GetItem("Down 1") - the page name ("Page 1") and the item on it ("Down 1") which will decrease brightness of the selected color on pressing
  • 10 - the value on which brightness of the selected color will increase/decrease when clicking Up and Down


2.3 Click "OK" to save the palette description. Start Emulator to test its work.

Errors which can appear at incorrect palette description are displayed in the log window (F4)


RGB lighting

Single Channel lighting.

RGB LED strips are controlled with the help of DMX controllers and have one of the following configuration:

  • Red, Green, Blue - three channels for controlling the LED strip color. Decrease of brightness is performed by decreasing brightness of separate channels.
  • Red, Green, Blue, Alpha - four channels for controlling the LED strip color and brightness


Variant 1 Control RGB strips with the help of three (four) Level items.


You create 3 (4) Unsigned 8-bit (Subtupe: VALUE) variables in the project. The variables are controlled in the range 0...255, value increase in the channel corresponds to the increase brightness of the respective color.

LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming


Variant 2 Control of RGB strips with the help of palette


You can use any colored item as a palette - you will be able to send commands of setting up the selected color to equipment by moving a finger on the item.

It requires adding a special script - RGB libraries - in your project. The script has to be added only once. Then you will be able to use it to control RGB strips of any built-in iRidium drivers.

2.1 Create a palette and auxiliary items. You can use any colored image as a palette.

  • Set up the palette like Joystick with the range 0...100 for Х and Y coordinates
  • Set up an inactive item Button which will display the color selected on the palette
  • If it is required set up active Button items which will change the strip brightness step-by-step
RGBPalette.png

2.2 Download the file RGB_Library.js

This file enables color control with the help of JavaScript. Add the file in your visualization project: open the project in iRidium Studio, click Icon Scripts.png, select the item ( + ) "Add Script From File"

2.3 Create an empty script file: ( + ) "New Script" to add the description of your RGB palette in it:

Describe the palette and the item for displaying the selected color in the script file:
///////// Copy this function to make one more RGB palette ///////
RGB_player(
         "Driver",                                            // Driver in project
         "Channel Red",                                       // Name of Red Channel
         "Channel Green",                                     // Name of Green Channel 
         "Channel Blue",                                      // Name of Blue Channel
         255,                                                 // Top limit for RGB channel (100 or 255)
         IR.GetItem("Page 1").GetItem("Item Color Picker 1"), // Item "Color Picker"
         /////// optional parameters ///////////////////////////
         IR.GetItem("Page 1").GetItem("Item Display 1"),      // Item "Display"
         )

The extended version has buttons for controlling brightness:

Palette, displaying the color and the button +/- for controlling brightness

///////// Copy this function to make one more RGB palette ///////
RGB_player(
         "Driver",                                            // Driver in project
         "Channel Red",                                       // Name of Red Channel
         "Channel Green",                                     // Name of Green Channel 
         "Channel Blue",                                      // Name of Blue Channel
         255,                                                 // Top limit for RGB channel (100 or 255)
         IR.GetItem("Page 1").GetItem("Item Color Picker 1"), // Item "Color Picker"
         /////// optional parameters ////////////////////////////
         IR.GetItem("Page 1").GetItem("Item Display 1"),      // Item "Display"
         IR.GetItem("Page 1").GetItem("Up 1"),                // Item "Up"
         IR.GetItem("Page 1").GetItem("Down 1"),              // Item "Down"
         10                                                   // Increment step for "Up" and "Down"
         )


In the description indicate where the palette is and to what equipment it sends data:

  • IR.GetDevice("Driver") - the name of the diver to which you will send RGB commands. Copy the driver name in PROJECT DEVICE PANEL
  • "Channel Red", "Channel Green", "Channel Blue" - the names of the variables (Commands) which are responsible for control of red, green and blue color components. Copy the names in PROJECT DEVICE PANEL. The Commands names have to be the same as the names of Feedbacks from where information about the current color of the RGB strip comes.
    HDL-Buspro, Domintell - they have a special way of writing names. For them you need to indicate <the device name in the network>:<the channel name>, for example "Dimmer in Bedroom:Channel 1"
  • 255 - the maximum brightness value for each color. For the majority of equipment brightness is regulated in the range from 0 to 255 but there are drivers which control color brightness in the range 0...100 (for example, HDL). For HDL-Buspro indicate value 100 for this property.
  • IR.GetItem("Page 1").GetItem("Item Color Picker 1") - the page name ("Page 1") and the item on it ("Item Color Picker 1") which you will use as a palette
  • IR.GetItem("Page 1").GetItem("Item Display 1") - the page name ("Page 1") and the item on it ("Item Display 1") which you will use for displaying the color selected on the palette
  • IR.GetItem("Page 1").GetItem("Up 1") - the page name ("Page 1") and the item on it ("Up 1") which will increase brightness of the selected color on pressing
  • IR.GetItem("Page 1").GetItem("Down 1") - the page name ("Page 1") and the item on it ("Down 1") which will decrease brightness of the selected color on pressing
  • 10 - the value on which brightness of the selected color will increase/decrease when clicking Up and Down


2.3 Click "OK" to save the palette description. Start Emulator to test its work.

Errors which can appear at incorrect palette description are displayed in the log window (F4)



Read Status of Channels

Command: to request the current brightness value of dimmer/relay channels. Feedback comes to the channel "Single Channel Lighting". It is usually used with Timer: 0 to get the dimmer/relay state at the application launch.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Dimmer, Relay. Now you can set up the command of requesting the dimmer/relay state:


Command:

Operation Code Read Status of Channels to get the value for which the channel aims
Single Channel Read Actual to get the channel brightness at the moment of the request
Channel 1-255 to send the request to one dimmer/relay channel
0 to send the request to all dimmer/relay channels
Need Confirm Disable/Enable to wait for the confirmation about request delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the request
0 to send the request once, at the application launch
1...n (c) to repeat the request with the indicated interval
Value - it is not used (you can leave it empty or write zero)


Control:

It is recommended to set up Use Timer: 0 - the command will be sent to equipment at the application launch. You do not need to assign the command to graphic items. You do not need to use the command during work as dimmers and relays send their status to the bus automatically.


Displaying states:

The result of work will be written in the channel "Single Channel Lighting" as feedback.


Scene Control

Command: to start the scene saved in the dimmer/relay memory. Scenes are set up for devices of one Area.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Dimmer, Relay. Now you can set up the command of starting the scene:


Command:

Operation Code Scene Control to start the scene
Area Number 1-255 the number of the Area for which the scene is set up
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0-255 the scene number

* Value - indicate it when dragging the command on graphic items


Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

Displaying states:

Results of command work are not sent to the application.


Sequence Control

Command: to start the sequence saved in the dimmer/relay memory. Sequences are set up for devices of one Area.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Dimmer, Relay. Now you can set up the command of starting the sequence:


Command:

Operation Code Sequence Control to start the sequence of commands
Area Number 1-255 the number of the Area for which the sequence is set up
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0-255 the sequence number

* Value - indicate it when dragging the command on graphic items


Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

Displaying states:

Results of command work are not sent to the application.


Logic

Logic Control

Command with feedback: control of the logic unit state.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type with support of commands for controling logic units. Now you can set up the commands:


Command:

Operation Code Logic Control to set up the state of the logic unit
Logic Block No. 1-255 the number of the logic unit
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0 Disable
1 Enable

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Logic Control the state of the logic unit
Logic Block No. 1-255 the number of the logic unit
Value 0/1 the state of the logic unit (0 - Disable, 1 - Enable)

Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Status of Logic

Command: to request the current state of the logic unit. Feedback comes to the channel "Logic Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type with support of commands for controling logic units. Now you can set up the command:


Command:

Operation Code Read Status of Logic to request the state of the logic unit
Logic Block No. 1-255 the number of the logic unit
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

It is recommended to set up Use Timer: 0 - the command will be sent to equipment at the application launch. You do not need to assign the command to graphic items. You can use the command during application work to request the unit state at a particular moment.


Displaying states:

Results of command work will be written in the channels "Logic Control" as feedback (0 = Disable, 1 = Enable).


Universal Switch

Universal Switch Control

Command with feedback: control of the universal switch state.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type with support of commands for controling the universal switch. Now you can set up the commands:


Command:

Operation Code Universal Switch Control to set up the state of the universal switch
Universal Number 1-255 the number of the universal switch
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0 OFF
255 ON. The same value used to send the IR command. Universal Number is a number of the IR command in the memory of the transmitter. As a feedback you'll receive the value 1

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Universal Switch Control the state of the universal switch
Universal Number 1-255 the number of the universal switch
Value 0/1 the state of the universal switch (0 - OFF, 1 - ON)

Only Dry contact with not more than 32 set up universal switches sends data about changes of its status automatically. The state of the rest devices have to be requested to display feedback.


Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


UV Switch for Floor Heating

Universal Switch Control commands for the module of floor heating SB-DN-FH06 (HDL_V04.10U_2014/06/06). They enable setting up work properties of all or separate channels of the module.
OFF = 0, ON = 255 (value to send).


FH Switch Value Action
ALL CH 1 ON/OFF ON/OFF
ALL CH 2 ON Normal
ALL CH 3 ON Day
ALL CH 4 ON Night
ALL CH 5 ON Away
ALL CH 6 ON Timer
ALL CH 7 ON Heat->Cool
ALL CH 7 OFF Cool->Heat
FH Switch Value Action
CH1 11 ON/OFF ON/OFF
CH1 12 ON Normal
CH1 13 ON Day
CH1 14 ON Night
CH1 15 ON Away
CH1 16 ON Timer
CH1 17 ON Heat->Cool
CH1 17 OFF Cool->Heat
CH1 70 ON 6C
CH1 71 ON 7C
CH1 72 ON 8C
CH1 73 ON 9C
CH1 74 ON 10C
CH1 75 ON 11C
CH1 76 ON 12C
CH1 77 ON 13C
CH1 78 ON 14C
CH1 79 ON 15C
CH1 80 ON 16C
CH1 81 ON 17C
CH1 82 ON 18C
CH1 83 ON 19C
CH1 84 ON 20C
CH1 85 ON 21C
CH1 86 ON 22C
CH1 87 ON 23C
CH1 88 ON 24C
CH1 89 ON 25C
CH1 90 ON 26C
FH Switch Value Action
CH2 21 ON/OFF ON/OFF
CH2 22 ON Normal
CH2 23 ON Day
CH2 24 ON Night
CH2 25 ON Away
CH2 26 ON Timer
CH2 27 ON Heat->Cool
CH2 27 OFF Cool->Heat
CH2 95 ON 6C
CH2 96 ON 7C
CH2 97 ON 8C
CH2 98 ON 9C
CH2 99 ON 10C
CH2 100 ON 11C
CH2 101 ON 12C
CH2 102 ON 13C
CH2 103 ON 14C
CH2 104 ON 15C
CH2 105 ON 16C
CH2 106 ON 17C
CH2 107 ON 18C
CH2 108 ON 19C
CH2 109 ON 20C
CH2 110 ON 21C
CH2 111 ON 22C
CH2 112 ON 23C
CH2 113 ON 24C
CH2 114 ON 25C
CH2 115 ON 26C
FH Switch Value Action
CH3 31 ON/OFF ON/OFF
CH3 32 ON Normal
CH3 33 ON Day
CH3 34 ON Night
CH3 35 ON Away
CH3 36 ON Timer
CH3 37 ON Heat->Cool
CH3 37 OFF Cool->Heat
CH3 120 ON 6C
CH3 121 ON 7C
CH3 124 ON 10C
CH3 122 ON 8C
CH3 125 ON 11C
CH3 123 ON 9C
CH3 126 ON 12C
CH3 127 ON 13C
CH3 128 ON 14C
CH3 129 ON 15C
CH3 130 ON 16C
CH3 131 ON 17C
CH3 132 ON 18C
CH3 133 ON 19C
CH3 134 ON 20C
CH3 135 ON 21C
CH3 136 ON 22C
CH3 137 ON 23C
CH3 138 ON 24C
CH3 139 ON 25C
CH3 140 ON 26C
FH Switch Value Action
CH4 41 ON/OFF ON/OFF
CH4 42 ON Normal
CH4 43 ON Day
CH4 44 ON Night
CH4 45 ON Away
CH4 46 ON Timer
CH4 47 ON Heat->Cool
CH4 47 OFF Cool->Heat
CH4 145 ON 6C
CH4 146 ON 7C
CH4 147 ON 8C
CH4 148 ON 9C
CH4 149 ON 10C
CH4 150 ON 11C
CH4 151 ON 12C
CH4 152 ON 13C
CH4 153 ON 14C
CH4 154 ON 15C
CH4 155 ON 16C
CH4 156 ON 17C
CH4 157 ON 18C
CH4 158 ON 19C
CH4 159 ON 20C
CH4 160 ON 21C
CH4 161 ON 22C
CH4 162 ON 23C
CH4 163 ON 24C
CH4 164 ON 25C
CH4 165 ON 26C
FH Switch Value Action
CH5 51 ON/OFF ON/OFF
CH5 52 ON Normal
CH5 53 ON Day
CH5 54 ON Night
CH5 55 ON Away
CH5 56 ON Timer
CH5 57 ON Heat->Cool
CH5 57 OFF Cool->Heat
CH5 170 ON 6C
CH5 171 ON 7C
CH5 172 ON 8C
CH5 173 ON 9C
CH5 174 ON 10C
CH5 175 ON 11C
CH5 176 ON 12C
CH5 177 ON 13C
CH5 178 ON 14C
CH5 179 ON 15C
CH5 180 ON 16C
CH5 181 ON 17C
CH5 182 ON 18C
CH5 183 ON 19C
CH5 184 ON 20C
CH5 185 ON 21C
CH5 186 ON 22C
CH5 187 ON 23C
CH5 188 ON 24C
CH5 189 ON 25C
CH5 190 ON 26C
FH Switch Value Action
CH6 61 ON/OFF ON/OFF
CH6 62 ON Normal
CH6 63 ON Day
CH6 64 ON Night
CH6 65 ON Away
CH6 66 ON Timer
CH6 67 ON Heat->Cool
CH6 67 OFF Cool->Heat
CH6 195 ON 6C
CH6 196 ON 7C
CH6 197 ON 8C
CH6 198 ON 9C
CH6 199 ON 10C
CH6 200 ON 11C
CH6 201 ON 12C
CH6 202 ON 13C
CH6 203 ON 14C
CH6 204 ON 15C
CH6 205 ON 16C
CH6 206 ON 17C
CH6 207 ON 18C
CH6 208 ON 19C
CH6 209 ON 20C
CH6 210 ON 21C
CH6 211 ON 22C
CH6 212 ON 23C
CH6 213 ON 24C
CH6 214 ON 25C
CH6 215 ON 26C


UV Swith for IR Emitter

Control of IR emitters in HDL sensors and separate emitters is performed with the help of the Universal Switch command.

The installer saves the list of IR commands (up to 254 commands) in the memory of the IR emitter and iRidium calls a command by sending its number to the emitter.


Command:

Operation Code Universal Switch Control to set up the state of the universal switch, send the IR command
Universal Number 1-255 the IR command number in the emitter memory
Need Confirm Disable/Enable to wait for the confirmation about the command delivery from the bus (it is not recommended)
Use Timer false not to use the timer of automatic command repetition
0 to send the iR command once, at the application launch
1...n (c) to repeat the IR command with the indicated interval
Value * 255 to send the IR command

* Value - indicate it when dragging the command on graphic items


Read Status of Universal Switch

Command: to request the current state of the universal switch. Feedback comes to the channel "Universal Switch Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type with support of commands for controlling the universal switch. Now you can set up the command:


Command:

Operation Code Read Status of Universal Switch to request the state of the universal switch
Universal Number 1-255 the number of the universal switch
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

It is recommended to set up Use Timer: 0 - the command will be sent to equipment at the application launch. You do not need to assign the command to graphic items. You can use the command during application work to request the unit state at a particular moment.


Displaying states:

Results of command work will be written in the channels "Universal Switch Control" as feedback (0 = OFF, 1 = ON).


Curtain Switch

Curtain Switch Control

Command with feedback: control of the state of the 3-position relay for curtains, blinds and shutters

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Curtain. Now you can set up the commands:


Command:

Operation Code Curtain Switch Control to control the drive of the curtains controller
Curtain Number 1-16 the number of the controlled drive of the curtains controller
17 to control the curtains position in the range 0...100%

(only for controllers with 1 channel and described possibility of % control)

Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 0 Stop
1 Up
2 Down
0-100 only for Сurtain Number: 17

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Curtain Switch Control the state of the drive of the curtains controller
Curtain Number 1-16 the number of the controlled drive of the curtains controller
17 to activate control of the curtains position in the range 0...100%
(only for controllers with 1 channel and described possibility of % control)
Value 0/1/2 Stop/Up/Down
0-100 only for Сurtain Number: 17

Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Read Status of Curtain Switch

Command: to request the state of the curtains controller. Feedback comes to the channel "Curtain Switch Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Curtain. Now you can set up the command:


Command:

Operation Code Read Status of Curtain Switch to request the state of the curtains controller
Curtain Number 1-16 the number of the controlled driveof the curtains controller
17 to request the curtain position in the range 0...100% (only for controllers with 1 channel and described possibility of % control)
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

It is recommended to set up Use Timer: 0 - the command will be sent to equipment at the application launch. You do not need to assign the command to graphic items. You can use the command during application work to request the state at a particular moment.


Displaying states:

Results of command work will be written in the channels "Curtain Switch Control" as feedback (0 - Stop / 1 - Up / 2 - Down or 0-100 for 1-channel controllers).


GPRS

GPRS Control

Command: to send a message with the help of the GPRS module

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: SMS Module. Now you can set up the commands:


Command:

Operation Code GPRS Control to send the message
Action 1 the Message
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * 1-24 the number of the message group

* Value - indicate it when dragging the command on graphic items

Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming

Displaying information:

Information about the status of command execution is not used in the application.


Panel

Panel Control

Command with feedback: to control functions of the DLP panel including control of air conditioners (AC) and floor heating (Floor Heating), connected to the DLP panel.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel. Now you can set up the commands:


Command:

Operation Code Panel Control to control the DLP panel
Parameter Option Value *
1 IR Control 0 0 = OFF, 1 = ON
2 Lock Panel 0 0 = OFF, 1 = ON
3 AC Power 0 0 = OFF, 1 = ON
4 Cooling Temp 0 0-84
5 Fan Speed 0 0 = Auto, 1 = High, 2 = Medium, 3 = Low
6 AC Mode 0 0 = Cooling, 1 = Heating, 2 = Fan , 3 = Auto, 4 = Dehumidfy
7 Heat Temp 0 0-84
8 Auto Temp 0 0-84
9 Rise Temp 0 0-5
10 Decrease Temp 0 0-5
11 Back Light Status 0 0 = OFF, 1 = ON
12 Lock AC 0 0 = OFF, 1 = ON
13 Back LIght Level 0 0-100
14 Status Light Level 0 0-100
15 Shield Button 1-255 (Key No.) Key Status 0 = Invalid, 1 = Valid
16 Shield Page 1-255 (Page No.) Page Status 0 = Invalid, 1 = Valid
17 Control Button LED 1-255 (Key No.) Key Status 0 = Invalid, 1 = Valid
18 Control Button 1-255 (Key No.) Key Status 0 = Invalid, 1 = Valid - to trigger all the commands under it
19 Dry Temp 0 0-84
20 Temp Status 0 0 = OFF, 1 = ON
21 Temp Mode 0 1 = Normal, 2 = Day , 3 = Night, 4 = Away, 5 = Timer
22 FH Rise Temp 0 0-5
23 FH Decrease Temp 0 0-5
24 Lock Setup Page 0 0 = OFF, 1 = ON
25 Normal Temp 0 0-84
26 Day Temp 0 0-84
27 Night Temp 0 0-84
28 Away Temp 0 0-84
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Panel Control control of the DLP panel (the panel state)
Parameter 1-28 see the table of commands
Option see the table of commands
Value see the table of commands

Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Read Status of Panel

Command: to request the current state of one of the properties of the DLP panel. Feedback comes to the channel "Panel Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel. Now you can set up the command:


Command:

Operation Code Read Status of Panel to request the state of the selected property of the DLP panel
Parameter 1-28 see the table of properties #Panel Control
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

During application work you can use the command to request the panel property state at the selected time (on timer or with the help of graphic items)


Displaying states:

The result of command work will be written in the channels "Panel Control" as feedback.


AC

AC Control

Command with feedback: to control air conditioners via the HVAC module, without connecting to the DLP panel.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: AC. Now you can set up the commands:


Command:

Operation Code AC Control to control the air conditioner
Parameter Value *
1 Temperature Type 0 = C, 1 = F
2 Cooling Temp Point 0-86
3 Heating Temp Point 0-86
4 Auto Temp Point 0-86
5 Dry Temp Point 0-86
6 Mode 0 = Cooling, 1 = Heating, 2 = Fan, 3 = Auto, 4 = Dry
7 Fan 0 =Auto, 1 = High, 2 = Medium, 3 = Low
8 AC Status 0 = OFF, 1 = ON
9 Setup Mode 0 = Cooling, 1 = Heating, 2 = Fan, 3 = Auto, 4 = Dry
10 Setup Speed 0 =Auto, 1 = High, 2 = Medium, 3 = Low
Option 1-128 condition number
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code AC Control to display the air conditioner state
Parameter Value *
1 Temperature Type 0 = C, 1 = F
2 Current Temperature 0-99
3 Cooling Temp Point 0-86
4 Heating Temp Point 0-86
5 Auto Temp Point 0-86
6 Dry Temp Point 0-86
7 Mode 0 = Cooling, 1 = Heating, 1 = Fan, 3 = Auto, 4 = Dry
8 Fan 0 = Auto, 1 = High, 1 = Medium, 3 = Low
9 AC Status 0 = OFF, 1 = ON
10 Setup Mode 0 = Cooling, 1 = Heating, 1 = Fan, 3 = Auto, 4 = Dry
11 Setup Speed 0 = Auto, 1 = High, 1 = Medium, 3 = Low
12 Current Mode 0 = Cooling, 1 = Heating, 1 = Fan, 3 = Auto, 4 = Dry
13 Current Fan 0 = Auto, 1 = High, 1 = Medium, 3 = Low
14 Sweep 0 = Enable, 1 = Disable
15 Sweep Mode 0= No Sweep , 1 = Sweep Now
Option 1-128 the number of the air conditioner

* Value comes to the feedback channel. It can be used for displaying on items.

Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Read Status of AC

Command: to request the current state of one of the properties of the AC controller. Feedback comes to the channel "AC Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: AC. Now you can set up the command:

Feedback:

Operation Code Read Status of AC to request the air conditioner state
Parameter 0-128 the number of the air conditioner
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

During application work you can use the command to request the panel property state at the selected time (on timer or with the help of graphic items)


Displaying states:

The result of command work will be written in the channels "AC Control" as feedback.


Floor Heating from DLP

Floor Heating Control (DLP)

Command with feedback: to control floor heating via the DLP panel.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel (AC, FH). Now you can set up the commands:


Command:

Operation Code Floor Heating Control (DLP) to control floor heating via the DLP panel
Parameter Value *
1 Temperature Type 0 = C, 1 = F
3 Status 0 = OFF, 1 = ON
4 Mode 1 = Normal, 2 = Day , 3 = Night, 4 = Away, 5 = Timer
5 Normal Temperature 5-95
6 Day Temperature 5-95
7 Night Temperature 5-95
8 Away Temperature 5-95
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Floor Heating Control (DLP) to dispaly the status of floor heating via the DLP panel
Parameter Value *
1 Temperature Type 0 = C, 1 = F
2 Current Temperature Value
3 Status 0 = OFF, 1 = ON
4 Mode 1 = Normal, 2 = Day , 3 = Night, 4 = Away, 5 = Timer
5 Normal Temperature 5-95
6 Day Temperature 5-95
7 Night Temperature 5-95
8 Away Temperature 5-95
9 Timer 0 = Day, 1 = Night

* Value comes to the feedback channel. It can be used for displaying on items.

Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Read Status of Floor Heating (DLP)

Command: to request the current state of one of the floor heating properties via the DLP panel. Feedback comes to the channel "Control Floor Heating Status".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel (AC, FH). Now you can set up the command:

Feedback:

Operation Code Read Status of Floor Heating (DLP) запрос состояния теплого пола
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated
Value - it is not used (you can leave it empty or write zero)

Control:

During application work you can use the command to request the floor heating state at the selected time (on timer or with the help of graphic items)


Displaying states:

The result of command work will be written in the channels "Floor Heating Control (DLP)" as feedback.


Floor Heating from Heating Module

Commands for controlling 6-channel floor heating module (for mounting on the DIN-rail). The comamnds are sent to the module directly, without using the DLP panel.

Floor Heating Module Control

Command with feedback: to control floor heating.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Floor Heating Module. Now you can set up the commands:


Command:

Operation Code Floor Heating Module Control to control floor heating via the floor heating module
Parameter Value *
1 Temperature Type 0 = C, 1 = F
3 Current Work Status 0 = Heating, 1 = Cooling, 2 = Heating power output, 3 = Cooling power output
4 Mode 1 = Normal, 2 = Day , 3 = Night, 4 = Away, 5 = Timer
5 Normal Temperature 5-95
6 Day Temperature 5-95
7 Night Temperature 5-95
8 Away Temperature 5-95
9 Current Work Status Enable 0 = OFF, 1 = ON
12 Vavle Status 0 = OFF, 1 = ON
Channel 1-8 the floor heating channel
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Floor Heating Module Control to display the floor heating state
Parameter Value *
1 Temperature Type 0 = C, 1 = F
2 Current Temperature 0-100
3 Current Work Status 0 = Heating, 1 = Cooling, 2 = Heating power output, 3 = Cooling power output
4 Mode 1 = Normal, 2 = Day , 3 = Night, 4 = Away, 5 = Timer
5 Normal Temperature 5-95
6 Day Temperature 5-95
7 Night Temperature 5-95
8 Away Temperature 5-95
9 Current Work Status Enable 0 = OFF, 1 = ON
10 Timer 0 = Day, 1 = Night
11 Vavle Status 0 = OFF, 1 = ON
12 Vavle Value 0-100 %

* Value comes to the feedback channel. It can be used for displaying on items.

Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Read Status of Floor Heating Module

Command: to request the current state of one of the floor heating properties. Feedback comes to the channel "Floor Heating Module Control".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Floor Heating Module. Now you can set up the command:

Feedback:

Operation Code Read Status of Floor Heating Module to request the floor heating state
Channel 1-8 the floor heating channel
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value - it is not used (you can leave it empty or write zero)

Control:

During application work you can use the command to request the floor heating properties at the selected time (on timer or with the help of graphic items)


Displaying states:

The result of command work will be written in the channels "Floor Heating Module Control" as feedback.


Sensors In One

Read Sensor Status (8 in 1, Device Type 315)

Command with feedback: to read data of the 8-in-1 sensor.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Sensor 8 in 1 (type 315). Now you can set up the commands:


Command:

Operation Code Read Sensor Status to request the sensor properties
Parameter 1-24 Logic Number
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used (you can leave it empty or write zero)

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Sensor Status the sensor state
Parameter Value *
1 Dry Contact 1 Status 0 = OFF, 1 = ON
2 Dry Contact 2 Status 0 = OFF, 1 = ON
4 Motion Snesor 0 = No movement, 1 = Movement
7 Delay Time - value

* Value comes to the feedback channel. It can be used for displaying on items.
Out of date sensors supports: 3 - Lux (0/1), 5 - Switch 1 (0/1), 6 - Switch 2 (0/1)


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Sensor Status (8 in 1, Device Type 314)

Command with feedback: to read data of the 8-in-1 sensor.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Sensor 8 in 1 (type 314). Now you can set up the commands:


Command:

Operation Code Read Sensor Status to request the sensor properties
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Sensor Status the sensor state
Parameter Value *
1 Current Temperature 0-80 (-20C – 60C)
2 Brightness value
3 Motion 0 = No movement, 1 = Movement
5 Dry Contact 1 Status 0 = OFF, 1 = ON
6 Dry Contact 2 Status 0 = OFF, 1 = ON

* Value comes to the feedback channel. It can be used for displaying on items.
Out of date sensors supports: 4 - Sonex (0/1), 7 - Switch 1 (0/1), 8 - Switch 2 (0/1)


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Sensor Status (12 in 1)

Command with feedback: to read data of the 12-in-1 sensor.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Sensor 12 in 1. Now you can set up the commands:


Command:

Operation Code Read Sensor Status to request the sensor properties
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Sensor Status the sensor state
Parameter Value *
1 Current Temperature 0-80 (-20C – 60C)
2 Brightness Lux
3 Motion Sensor 0 = No movement, 1 = Movement
4 Sonic 0 = No movement, 1 = Movement
5 Dry Contact 1 0 = OFF, 1 = ON
6 Dry Contact 2 0 = OFF, 1 = ON

* Value comes to the feedback channel. It can be used for displaying on items.

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Sensor Status (Sensors In One)

Command with feedback: to read data of "Sensors in One".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Sensors In One. Now you can set up the commands:


Command:

Operation Code Read Sensor Status to request the sensor properties
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Sensor Status the sensor state
Parameter Value *
1 Current Temperature 0-80 (-20C – 60C)
2 Brightness 0-100
3 Air 0 = Clean, 1 = Mild, 2 = Moderate, 3 = Servere
4 Gas 0-100%
5 Motion Sensor 0 = No movement, 1 = Movement
6 Dry Contact 1 0 = OFF, 1 = ON
7 Dry Contact 2 0 = OFF, 1 = ON

* Value comes to the feedback channel. It can be used for displaying on items.

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Temperature

Command with feedback: to read temperature of the DLP panel or another device with the temperature sensor.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel or another with the temperature sensor. Now you can set up the commands:


Command:

Operation Code Read Temperature to request data from the temperature sensor
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Temperature the sensor temperature
Channel 1-255 the number of the temperature sensor (for the DLP panel: 1)
Value * the current temperature

* Value comes to the feedback channel. It can be used for displaying on items.

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Temperature New

Command with feedback: to read temperature: the command of the new type with support of fractional values.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: DLP Panel or another with the temperature sensor. Now you can set up the commands:


Command:

Operation Code Read Temperature to request data from the temperature sensor
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Temperature New the sensor temperature
Channel 1-255 the number of the temperature sensor (for the DLP panel: 1)
Value * the current temperature (float)

* Value comes to the feedback channel. It can be used for displaying on items.

Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Universal Control

Command with feedback: to control properties of different types of sensors with Universal Control support.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type. Now you can set up the commands:


Command:

Operation Code Universal Control to set up the sensor property
Option Value *
1 PIR sensitivity 1-100
2 Ultrasonic sensitivity 1-100
3 Temperature sensor validity 0 = Disable, 1 = Enable
4 LUX sensor validity 0 = Disable, 1 = Enable
5 Humidity sensor validity 0 = Disable, 1 = Enable
6 Air quality sensor validity 0 = Disable, 1 = Enable
7 PIR sensor validity 0 = Disable, 1 = Enable
8 Ultrasonic sensor validity 0 = Disable, 1 = Enable
9 Dry contact 1 validity 0 = Disable, 1 = Enable
10 Dry contact 2 validity 0 = Disable, 1 = Enable
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Universal Control the state of the sensor properties
Option Value
1 PIR sensitivity 1-100
2 Ultrasonic sensitivity 1-100
3 Temperature sensor validity 0 = Disable, 1 = Enable
4 LUX sensor validity 0 = Disable, 1 = Enable
5 Humidity sensor validity 0 = Disable, 1 = Enable
6 Air quality sensor validity 0 = Disable, 1 = Enable
7 PIR sensor validity 0 = Disable, 1 = Enable
8 Ultrasonic sensor validity 0 = Disable, 1 = Enable
9 Dry contact 1 validity 0 = Disable, 1 = Enable
10 Dry contact 2 validity 0 = Disable, 1 = Enable

* Value comes to the feedback channel. It can be used for displaying on items.


Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Analog Value

Command with feedback: to request properties of different types of sensors with Analog Value support.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type. Now you can set up the commands:


Command:

Operation Code Read Analog Value to request the sensor property
Parameter 0-255 the channel number
Option the type of the requested property
0 Lux
1 Temperature
2 Power
3 Current
4 Pressure
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used (you can leave it empty or write zero)

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Analog Value the sensor property
Parameter 0-255 the channel number
Option the type of the requested property
0 Lux
1 Temperature
2 Power
3 Current
4 Pressure
Value * 0-255 the value of the selected variable

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Security

Arm Security Module

Command with feedback: to set up the state of the security module. It sets up the current security mode (Arm) in the indicated Area.

add iRidium control panels in the list of devices which can control the security controller: Subnet ID: 253, Device ID: 254.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Security Module. Now you can set up the commands:


Command:

Operation Code Arm Security Module to set up the security mode
Area 1-8 the security area
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * to select the security mode (Arm)
6 Disarm
5 Day Arm
4 Night with Guest Arm
3 Night Arm
2 Away Arm
1 Vacation Arm

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Arm Security Module to display the current security mode
Area 1-8 the security area
Value * the current security mode (Arm)
6 Disarm
5 Day Arm
4 Night with Guest Arm
3 Night Arm
2 Away Arm
1 Vacation Arm

* Value comes to the feedback channel. It can be used for displaying on items.

Control:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Status of Arm

Command with feedback: to request the mode of the security module. It returns the current security mode (Arm) in the indicated Area in the channel "Arm Security Module".

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Security Module. Now you can set up the commands:


Command:

Operation Code Read Status of Arm to request the current security mode
Area 1-8 the security area
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * - it is not used

* Value - indicate it when dragging the command on graphic items


Control:

It is recommended to set up Use Timer: 0 - the command will be sent to equipment at the application launch. You do not need to assign the command to graphic items. You do not need to use the command during work as the security module sends its status to the bus automatically.


Displaying states:

The result of command work will be written in the channels "Arm Security Module" as feedback.


Alarm Security Module

Command: to activate the alarm signal. The signal (Alarm) in the indicated Area is activated by the comamnd to the security module. You cannot display the status of alarm signals.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Security Module. Now you can set up the commands:


Command:

Operation Code Alarm Security Module to activate the alarm signal
Area 1-8 the security area
Option Value *
4 Current Alarm 0 = OFF, 1 = ON
5 Emergency Alarm 0 = OFF, 1 = ON
6 Panic Alarm 0 = OFF, 1 = ON
7 Gas Alarm 0 = OFF, 1 = ON
8 Fire Alarm 0 = OFF, 1 = ON
9 Temperature Alarm 0 = OFF, 1 = ON
10 Power Alarm 0 = OFF, 1 = ON
11 Silence Alarm 0 = OFF, 1 = ON
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Control:

Activate the alarm signal by pressing on the button or sitch it with the help of the trigger:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming

TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


Dry Contact

Read Status of Dry Contact

Command with feedback: to request the dry contact state

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Dry Contact. Now you can set up the commands:


Command:

Operation Code Read Status of Dry Contact to request the dry contact state
Area 1-255 the area
Input Number 1-255 the dry contact number
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Status of Dry Contact to read the dry contact state
Area 1-255 the area
Input Number 1-255 the dry contact number
Value * 0 = OFF, 1 = ON the dry contact state

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Status of Dry Contact (security)

Command with feedback: to request the state of the dry contact set up for work with the security module, when the sensor is included in "Alarm List"

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Dry Contact. Now you can set up the commands:


Command:

Operation Code Read Status of Dry Contact (security) to request the state of the dry contact included in "Alarm List" of the security module
Area 1-255 the area
Input Number 1-255 the dry contact number
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Status of Dry Contact (security) to read the dry contact state
Area 1-255 the area
Input Number 1-255 the dry contact number
Value * 0 = OFF, 1 = ON the current state of the dry contact

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Power Meter

Read Voltage

Command with feedback: to request the current voltage (A:1, B:2, C:3) of the meter

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Power Meter. Now you can set up the commands:


Command:

Operation Code Read Voltage to request the current voltage
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Voltage the current voltage
Parameter 1-3 the channel (phase) number
Value * the current voltage

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Current

Command with feedback: to request the effective value of the alernating current (A:1, B:2, C:3, T:4)

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Power Meter. Now you can set up the commands:


Command:

Operation Code Read Current to request the effective value of the alternating current
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Current the effective value of the alternating current
Parameter 1-4 the channel (phase) number
Value * the effective value of the alternating current

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Power

Command with feedback: to request the active power (A:1, B:2, C:3, T:4)

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Power Meter. Now you can set up the commands:


Command:

Operation Code Read Power to request the active power
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Power the active power
Parameter 1-4 the channel (phase) number Value * the active power

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Power Factor

Command with feedback: to request the power factor (A:1, B:2, C:3, T:4)

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Power Meter. Now you can set up the commands:


Command:

Operation Code Read PowerFactor to request the power factor
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Power Factor the power factor
Parameter 1-4 the channel (phase) number
Value * the power factor

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Read Electricity

Command with feedback: to request the active energy (A:1, B:2, C:3, T:4)

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Power Meter. Now you can set up the commands:


Command:

Operation Code Read Power Factor to request the value of active energy
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value * it is not used

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code Read Power Factor the value of active energy
Parameter 1-4 the channel (phase) number
Value * the value of active energy

* Value comes to the feedback channel. It can be used for displaying on items.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)


Music

Music Control (DLP)

Commands have to be sent to Z-Audio, the DLP panel is not required.

Command with feedback: to control Z-Audio commands, the same commands DLP panels send. It allows you to get the list of Z-Audio tracks. Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Z-Audio. Now you can set up commands for the available audio sources * (Source):

* Source:

  • 1 – SD CARD
  • 2 – NAS-HDD (FTP Server)
  • 3 – SERVER
  • 4 – WEB-RADIO
  • 5 – RADIO
  • 6 – AUDIO IN
  • 7 – INTERCOM


Command:

Operation Code Music Control (DLP) to control playback
Command Zone Source *
0 POWER 1-9 -
1 STATUS REQUEST 1-9 -
2 SOURCE NEXT 1-9 -
3 VOLUME 1-9 -
4 MUTE 1-9 -
5 TONE REQUEST 1-9 -
6 BASS UP 1-9 -
7 BASS DOWN 1-9 -
8 TREBLE UP 1-9 -
9 TREBLE DOWN 1-9 -
10 PLAY/STOP - 1-9
11 PLAY - 1-9
12 STOP - 1-9
13 PLAY MODE REQUEST - 1-9
14 MODE NEXT - 1-9
15 MODE PREV - 1-9
16 LIST NEXT - 1-9
17 LIST PREV - 1-9
18 NEXT - 1-9
19 PREV - 1-9
20 CHADJ NEXT - 1-9
21 CHADJ PREV - 1-9
22 CHANNEL SCAN NEXT - 1-9
23 CHANNEL SCAN PREV - 1-9
24 CHANNEL NEXT - 1-9
25 CHANNEL PREV - 1-9
26 SAVE - 1-9
27 UPDATE STATUS - 1-9
28 UPDATE LIST - 1-9
160 LIST - 1-9
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
0 to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval
Value it is not used. Write 0 when dragging the command on items


Feedback:

Operation Code Music Control (DLP) the playback status
Command Zone Source * Value **
128 SOURCE 1-9 - 1-9
129 VOLUM 1-9 - 0-100
130 DND - 1-9
131 LOCK - 1-9 0 = LOCKED, 1 = UNLOCKED
132 POSITION IN PERSENT - 1-9 0-100
133 POSITION CURRENT - 1-9 0-999.9 s
134 POSITION TOTAL - 1-9 0-999.9 s
135 PLAY STATUS - 1-9 1 = STOP, 2 = PLAY
136 PLAY MODE - 1-9 1-4
137 LINE 1 - 1-9 List: No/Total
138 LINE 2 - 1-9 Playlist Name
139 LINE 3 - 1-9 Song: No/Total
140 LINE 4 - 1-9 Song Name
141 BASS - 1-9 1-7
142 TREABLE - 1-9 1-7
160 LIST - 1 or 2 List ***

* Value comes to the feedback channel. It can be used for displaying on items.

*** List - the list of folders and tracks which can be displayed with the help of the List item, see the example of use below.


Displaying the list of tracks (the LIST command):

Z-AUDIO LIST

The List graphic item allows you to form the list of tracks and perform actions on clicking on the list items:

  • to open the folder on clicking on the list item - folder
  • to start playback on clicking on the list item - track
  • to return to the folder above when clicking on the first list item: [ ... ]


The list items will be organized on the basis of the template - the popup which has to be created in the project beforehand. Creation and filling in items are performed automatically. Item settings:

List, the item where the list of tracks will be displayed:
ZAudioListTemplate.png

List Template: the name of the popup selected as the template for each list item.

Popup, the template of one list item:
ZAudioPopupTemplate.png

The track name will be written in the text field of the popup, not the items on it.

Assign the LIST command to control the list and to display data:

ZAudioListCommand.png
  1. Select the List graphic item, open the Programming tab
  2. Select the Select event. In the macros editor for the Select event find the command Send To Driver > Send Token
  3. In the Channel string select the LIST command for the SD or FTP source
  4. In the Token string select the path to the List graphic item on the page or popup, the item property: SelectItem
  5. Click ОК to save the command


Assign LIST feedback to display the list of Z-Audio tracks on the item:

ZAudioListFb.png
  1. In Project Device Panel select the LIST feedback channel from the SD or FTP source
  2. Drag the feedback channel on the List graphic item, select "More..." in the dialog of assigning
  3. Select the This property of the graphic item
  4. Click ОК to save feedback

Now the command and feedback are set up, the item will display the list of Z-Audio tracks.


Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Music Control (TTP)

Command with feedback: the auxiliary TTPlayer command to control Z-Audio. The Z-Audio functions are fully covered by the Music Control (DLP) command, without requesting use of the DLP panel.

Select the HDL device, indicate its Subnet ID / Device ID, select the device type: Z-Audio. Now you can set up the commands:


Command:

Operation Code Music Control (TTP) to control playback
Parameter Option Value *
1 - Source selection N/A 1 - SD card
2 - External audio input
3 - FTP server
4 - Radio FM On
2 - Play mode N/A 1 - Single playing
2 - Single repetition
3 - Order cycle
4 - All repetition
3 - List/Channel N/A 1 - Previous list
N/A 2 - Next list
1-255 3 - Select List Number
N/A 4 - Previous channel
N/A 5 - Next channel
1-255 6 - Select Channel Number
4 - Play control 0-79 1 - Previous
2 - Next
3 - Play
4 - Stop
5 - Volume N/A 0 - Auto
1 - High
2 - Medium
3 - Low
6 - Play 0-999 - Song 0-255 - List
Need Confirm Disable/Enable to wait for the confirmation about command delivery from the bus (it is not recommended)
Use Timer false not to use timer for automatic repeat of the command
to send the command once, at the application launch
1...n (c) to repeat the command with the indicated interval

* Value - indicate it when dragging the command on graphic items


Feedback:

Operation Code the playback status
Parameter Option Value *
see the table with description of the command list|}

* Value comes to the feedback channel. It can be used for displaying on items.


Control:

With the help of graphic items you can write the selected value in the variable:

BUTTON

It is a graphic item with 1 or 2 states. Buttons depending on settings can be fixed or not. Each pressing on Button initiates sending of the same set of commands assigned to it.


1 Create a variable were a number or string has to be written. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all settings):

UImakeAbutton.png
Type Button
Feedback Reaction of the item on user pressings and receiving data from equipment
  • Momentary - the button sends values but does not display feedback
  • Channel - the button sends values and displays feedback
  • None - the button does not visually react on pressings or receiving of feedback
  • Invert Channel - the button sends values and dispalys feedback inversely (false - on, true - off)

3 Drag the variable on the button and indicate the following in the dialog window:

UIdragCommand.png
Action Send Number - write numbers in the variable. You can switch to Send String for sending ASCII strings
Event for Action Interface events connected to the button. When the event are activated the indicated value will be written in the variable
  • Press - send on pressing
  • Release - send on releasing the button
  • Hold - send in cycles on holding the button
  • Move - it does not work with Button


You can use several events together. For example, send [ 100 ] on pressing and [ 0 ] on releasing.

Value Values for writing in the variable. The button sends the same value written in Value
Add a feedback channel (Create a feedback channel) Tick this if you want the button not only to write values in the variable but also change its state when receiving data from tthe variable. The received value will affect the button state (on/off) and it can be displayed in the button text field.

4 Now the variable is connected to the button. You can see all relations in OBJECT PROPERTIES > Programming


TRIGGER BUTTON

Trigger switch with the help of the "Trigger Button" item allows to send 2 values indicated in Trigger Value 1 and Trigger Value 2 alternately. When there is feedback the trigger automatically takes the respective value and sends the value opposite to the current one on pressing. The trigger cannot be set up for working with 3 and more values.


1 Create a variable which has to be switched between 2 values. Set it up as it is shown in the instructions.

2 Create a button and set it up as follows (see all item settings):

UImakeAtriggerButton.png
Type Trigger Button
Feedback Reaction on pressings and receiving data from equipment
  • Channel - switches the value and displays feedback (other types are not used)
Trigger Value 1 / Trigger Value 2 the values which will be sent alternately when clicking the button, they depend on the variable type

3 Drag the variable on the trigger, in the dialog window indicate:

UIdragCommandToTrigger.png
Action Send Token - send to the variable Value indicated in the graphic item properties (Trigger Value 1 or Value 2 depending on the current trigger state)
Event for Action An interface event connected to the button. When the event is activated the indicated value will be sent to the variable
  • Press - send on press
  • Release - send on release



For Trigger button you can use only one event at a time

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the button to know its current value and change it when receiving data from the variable and on clicking.

4 Now the variable is connected to the trigger. You can see all relations in OBJECT PROPERTIES > Programming


LEVEL

Pressing on the level or moving of the slider sends to the variable the value corresponding to the current slider position.

1 Create a variable which has to be regulated. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

UImakeAlevel.png
Type Level
Feedback the level reaction on user's pressings and receiving data from equipment
  • Channel - to send values and display feedback (the slider moves when receiving data)
Min / Max the limits of level regulation: they define the value range in which the slider moves
Invert Range to swap the top and bottom level parts. i.e. the regulation from 0 to 100 will be performed not from the bottom upwards (when the level is vertical) but from top downwards.

3 Drag the variable to the level, indicate in the dialog window:

UIdragCommandToLevel.png
Action Send Token - to send to the variable Value, taken as the current slider position in the Min...Max range
Event for Action the event interface connected to the button. When the event is activated the indicated value will be written in the variable
  • Press - to send Value on pressings
  • Release - to send Value on releasing
  • Move - to send all intermediate Values when moving the slider.
    add Delay (100) before commands for the Move event to avoid overload of equipment (with the Delay command Move will work once in 100 ms)



You can use all three events together.

Add a feedback channel (Create a feedback channel) Tick it for the slider to move in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

UP/DOWN BUTTON

A graphic item has 2 states. At that each clicking changes the current value by "Up/Down Value", but within the "Max/Min Value" range. The calculated value is sent by the variable: thus the step increment/decrement of the variable is implemented. It is required to have feedback from the variable in real time to work with the item.


1 Create a variable which has to be incremented/decremented. Set it up as it is shown in the instructions.

2 Create a level and set it up as follows (see all settings):

Editor window Object Properties General Up Down.png
Type Up/Down Button
Feedback Reaction of the level on user's clickings and receiving data from equipment
  • Momentary - the button has to be clicked visually right away, it does not display feedback visually
Up/Down Value the increment/decrement step (it can be more or less than zero)
Min/Max Value the increment/decrement limits (minimum limit for decrement and maximum limit for increment)
Hold Value the increment/decrement step when the Hold event is activated. Commands for controlling equipment can be assigned using both Press and Hold - then the value will be incremented/decremented when you hold the button pressed
Hold Time time of holding the button for the Hold event to be activated
Repeat Time frequency of repeating the On Hold events

3 Drag the variable on the button and in the dialog window indicate:

Editor drag to UDB.png
Action Send Token - send to the variable Value calculated as a sum of the current values and the increment step
Event for Action The interface event connected to the button. When the event is activated the calculated increment value will be written in the variable
  • Press - send on pressing
  • Hold - increment the value with the indicated frequency on holding



You can use two events at a time.

Add a feedback channel (Create a feedback channel) Tick this field as it is required for the increment to be calculated in accordance with the actual variable state

4 Now the variable is connected to the level. You can see all relations in OBJECT PROPERTIES > Programming

RADIO BUTTONS

Radio Button - an interface item which allows to select one of the preset options. In iRidium Radio Buttons are not separated as an item type as they can be set up on the basis of Trigger Button. The task of Radio Buttons: to send to the variables values from different buttons from which you can select only one.

Settings and behavior of Radio Button depend on the variable you work with. You can find several examples below.


Variant 1 Radio Buttons for controlling one variable with the possibility to receive feedback. Values are written in one variable: equipment returns the current state of this variable.

  1. Set up the Trigger Button items (see the image) in a number equal to the number of Radio Buttons. In the fieldsTrigger Value 1 and 2 indicate the same values corresponding to those which have to be sent to the controlled variable by each button
  2. Drag the command for controlling the variable on all Radio Buttons. Select the Press or Release events for sending, tick Add A Feedback Channel to display the variable status


RadioButtons-MainSettings.png
RadioButtons-DragCommand.png

the set up button will go to State 2 only when the variable takes the value indicated in Trigger Value 1 and 2


Variant 2 Radio Buttons for controlling variables with possibility to receive feedback. ON/OFF values are written in different variables; equipment returns the current state of these variables. The variables are not synchronized by automation equipment for working in the Radio Buttons mode (inactive modes on the side of iRidium have to be off)

  1. Set up the items Type: Trigger Button, Feedback: Channel, indicate Trigger Value 1 = inactive, Trigger Value 2 = the variable active state (for example 0/1, 0/100)
  2. Drag the commands for controlling the variables on graphic items. By the example of the first item of the group:
    1. Send zeros to all variables in the Radion Buttons group to deactivate the current active mode. In order to do that select Action: Send Number in the dialog window for command sending
    2. Add Delay(50) ms through the macros editor of the Press event to give equipment time to deactivate the active mode
    3. Drag the command for controlling the variable corresponding to Radio Button on the item. Leave Action: Send Token. Value on the Press (or Release) event, tick Add a Feedback Channel


RadioButtons-MainSettings-Septd.png
RadioButtons-DragCommand-Septd.png

If the equipment working modes are synchronized on the automation equipment side (when activating one of the modes the rest are automatically deactivated) you do not need to send zeros to the deactivated variables. Execute only article 2.3 of the settings.


Displaying states:

Graphic items can display values of variabls by changing their state or text:

CHANGE STATE

1 Set up the graphic item so it would display the received values:

SetUpItemToDisplayValue.png

Select in the General settings:

Feedback: Channel (if 0 = false) or
Feedback: Invert Channel (if 0 = true).

This feedback type enables the item to process data received from variables

2 Assign the equipment channel (Feedback) to the graphic item:

SetUpItemToDisplayValue2.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

For correct work the item needs 2 states. The first one corresponds to the zero value, the second - to any value different from zero.

The $V template added in the item text will enable output of received values in the item text.

DISPLAY IN TEXT

1 Drag the equipment channel (Feedback) to the graphic item:

DragChannelToDisplayTxt.png

Drag the feedback channel or the variable on the item, select In Text in the dialog window

The item can have any number of states and settings. The value will be output in the text field of all item states.

DragChannelToDisplayValue.png

Add $V in the item text. Drag the feedback channel or the variable on the item, select In Value in the dialog window. It will enable output of the received whole number and ass any text to it.

There are templates for outputting fractions and etc.:

LIST OF TEMPLATES

Template Function Template Function
$V the integer part of the current value $P the current value of Level in percentage of maximum
$F1 - 5 value with a floating point
From 1 to 5 - number of symbols after a point
$H the upper Level value
$S current Item state number $A current Level value minus the lower Level value
$R the Level range (the upper value minus the lower value) $L the lower Level value
$X the current value in the HEX type $$ the "dollar" symbol

A command (template) of incoming data processing and displaying is entered into the text field of a graphic Item and can be combined with other text or symbols (comments, units of measurement)



Emulator: project testing

Emulator - an application launched in iRidium Studio to test the project work.

An Emulator works only when you authorized with login and password from iRidium Mobile web site

Emulator work modes see in iRidium Studio > Tools > Options > Emulator:

  • Client Fullscreen - start the Emulator in Full Screen mode (press Alt+F4 to Exit)
  • Client Sound On - switch sound in app
  • Show log at Emuator Start - open the log window automatically at Emulator start (you can also use F4)


Path to the license.png

Hot keys:

  • F4 - open the debug log
  • F5 - launch Emulator
  • F7 - open the app Menu to manage account and download projects from iRidium Cloud
  • F8 - open the settings (password: 2007)


Synchronization with control panels

Upload and launch of the iRdidium project on the control panel is performed with the help of the iRidium Transfer application, installed on your PC. You can also upload the project on the panel from the editor via Transfer.


Use i3 pro for iOS, Android, Windows, Mac in Test Mode by downloading projects via iRidium Transfer (the possibility is available for integrators):


iRidium Transfer settings


Commercial use of iRidium is possible only at download of visualization projects with the help of the iRidium Cloud service on the iRidium Mobile web site (see the instructions).

iRidium Cloud can be set up only by a registered integrator. After the setting up he can invite end-users to control the automation object.