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

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

the documentation is updated 12.1.2017


Description

iRidium for Helvar - is a set of tools for creating interfaces to control lighting on the basis of Helvar equipment.

You can connect to Helvar using different ways (drivers): HelvarNet (TCP), HelvarNet (UDP), HelvarNet Internal (UDP), Helvar AV (RS232).

Make sure your Helvar router supports the HelvarNet protocol. Otherwise you need to update the software and firmware

For connection via IP use DIGIDIM 910/920


iRidium licensing for Helvar (more).


Connection

Equipment configuration and settings required for iRidium to control Helvar.


Ways of connection to Helvar

Helvar drivers have special features which have to be considered when selecting the way of control:

Helvar HowItWorks.png

Local connection:
HelvarNet (TCP), HelvarNet (UDP), HelvarNet Internal (UDP), HelvarAV (RS232)

Helvar Scheme Inet.png

Internet connection:
HelvarNet (TCP)

  • HelvarNet (TCP)
    • supports Site licensing
    • updates the device status by requests from control panels
    • supports 1 connection in the local network
    • supports 1 connection via the Internet
  • HelvarNet (UDP)
    • supports Site licensing
    • updates the device status by requests from control panels
    • gets only the changes requested by control panels
    • supports several connections in the local network
    • does not support connection via the Internet
  • HelvarNet Internal (UDP)
    • uses broadcasting - UDP broadcasting within the segment of the IP network
    • does NOT support Site licensing
    • information about the state change comes without forced requests ** supports several connections in the local network
    • does not support connection via the Internet
  • Helvar AV (RS232)
    • uses the RS232 transport for connection to DALI
    • does NOT support Site licensing
    • supports 1 connection in the local network
    • does not support connection via the Internet


Adding of the Helvar driver in iRidium

Helvar does not allow automatic formation of the list of devices which can be controlled, so they have to be added manually. Drag the selected driver from DEVICE BASE in PROJECT DEVICE PANEL:

Helvar Add Driver.png


Commands & Feedbacks

As a result we have two levels of Helvar settings:

  • Helvar Net (TCP) - the driver unites the list for the Helvar system
  • Commands and Feedbacks - the commands and feedback channels inside the driver. They enable control of Helvar equipment. The commands are device properties available for writing. The channels are properties available for reading.

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 variables when clicking on the items
  • Feedback channels are assigned to graphic items to display the variable state


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

for fast creation of Feedback with the same settings with Command, right-click on Command and select the "Create Feedback" option. You can create Feedback for several commands at a time.


Setting up connection to Helvar

Select the driver and connection settings by default. They can be changed while working with the project.


HelvarNet (TCP):

Helvar general helvarnet-tcp.png
  • Host - the router IP-address in the local network (or the router public IP-address)
  • Port - the ТСР port of connection to the router. It is always 50000 for HelvarNet (TCP)


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


HelvarNet (UDP):

Helvar general helvarnet-udp.png
  • Host - the router IP-address in the local network
  • Port - the UDP port of connection to the router. It is always 50001 for HelvarNet (UDP)


HelvarNet Internal (UDP):

Helvar general helvarnet-int-udp.png
  • Port - the UDP port of connection to the router. It is always 50002 for HelvarNet Internal (UDP)


HelvarNet Helvar AV (RS232):

Helvar general helvar-av.png
  • Port - the number of the PC СОМ-port to which the Digidim 503AV interface is connected
  • Baud Rate - the speed of data exchange with the interface
  • Data Bits - the number of information bits in a frame
  • Parity - the parity control
  • Update Time (ms) - the frequency of data update



Change of connection settings

You need the possibility to change connection properties when you disconnect from the Wi-Fi network of the automation object and start using 3G or another Wi-Fi network. To maintain control of the object you need to switch from the local to public IP-address of the Internet router.

The switch is not automatic. You have to select the connection mode. For remote acces you have to make ports for controlling the automation system public. In order to do that you have o set up the Port Forwarding service on your Internet router. VPN can provide protected connection.


1 Download the template (*.js) (right-click button: "Save object as ..."), add the template in the script editor with the buttonIcon Scripts.png (+) Add Script from file


2 Set up script properties as it is shown in the example:

function Internal_1() {
IR.GetDevice("HelvarNet (TCP)").SetParameters({Host: "10.254.1.2", Port: 50000});
}
function External_1() {
IR.GetDevice("HelvarNet (TCP)").SetParameters({Host: "215.110.10.10", Port: 50000});
}

Copy the driver name from Projeсt Device Panel - the list of properties has to be copied from the example.


3 Select the button which will be responsible for the switch of Internal and External properties. Open Macros Editor for the Press event (Object Properties > Programming), select the Script Call command and add it by double-clicking on it. Select the name of the function which will be activated by the button:

Script call internal-external.png

Now each pressing on the button will apply the corresponding connection properties.


Control of equipment

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 are presented below:


Direct Level, Query Load Level

Direct Level is used to turn on/turn off/ set up brightness of a device (Device) or group(Group).

Query Load Level is a feedback channel which regularly requests the status of the controlled device (Device) and sends it to the interface.


Command (Direct Level Device):

Command Direct Level Device to set up the device state (on/off/brightness)
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the preset brightness value


Command (Direct Level Group):

Command Direct Level Group to set up the device state (on/off/brightness)
Group 1...16383 the group address in the Helvar system
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the preset brightness value

* Value - indicate when dragging the command on graphic items. In the Helvar system the range for any device is 0 ~ 100 but dimmers do not process all values of the range and relays react on zero and non-zero values. At that for relays there is "trip limit" and if you send the value less than the limit relays will not work. The settings are formed in the process of Helvar configuration.


Feedback (Query Load Level):

Command Query Load Level to request and display the device state (brightness). For Device only
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Use Timer Yes/No to request the device status on timer (HelvarNet does not give the status without requests). If the timer is off the device status will not be received.
Timer 0...n (ms) the frequency of requesting the device status
Value * 0...100 the current value of device brightness

* Value - comes to the feedback channel, use it 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)



RGB 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)


Recall Scene

Use the "Recall Scene Device / Group" command to activate the scene programmed for the device or the device group in the Helvar system.

The command for scene activation can be directed on loads only (dimmers, relay units, ...):


Command (Recall Scene Device):

Command Recall Scene Device to activate the scene for the device
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
CL 0...1 Constant Light: 1 = On, 0 = Off
Block 1...8 the block number, "Scene 1.2" = block 1 scene 2 (see Helvar Designer).
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 1...n the scene number


Command (Recall Scene Group):

Command Recall Scene Group to activate the scene for the group of devices
Group 1...16383 the group address in the Helvar system
CL 0...1 Constant Light: 1 = On, 0 = Off
Block 1...8 the block number, "Scene 1.2" = block 1 scene 2 (see Helvar Designer).
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 1...n the scene number

* Value - indicate when dragging the command on graphic items


Feedback:

You cannot receive information about which scene is activated at the moment.


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


Direct Proportion

Setting up proportions. When using "Direct Proportion" the set up value is calculated as difference between the last value (set by a scene or directly) and the maximum output device level.


Command (Direct Proportion Device):

Command Direct Proportion Device to set up the proportion for the device
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the proportion value


Command (Direct Proportion Group):

Command Direct Proportion Group to set up the proportion for the group
Group 1...16383 the group address in the Helvar system
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the proportion value

*Value - indicate when dragging the command on graphic items


Feedback:

The current device state comes to Query Load Level


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

How to calculate the proportion value


The result of writing the positive proportion: if the last scene set 44% brightness and you will write 50 in "Direct Proportion Device", the result brightness will be 72%:

44 + (100 - 44)*50/100 = 72%

The result of writing the negative proportion: if the last scene set 44% brightness and you will write -50 in "Direct Proportion Device", the result brightness will be 22%:

44*50/100 = 22%


Modify Proportion

Proportion modification. Results can be calculated using "#Direct Proportion" formulas. But "Modify Proportion" affects the value of the proportion and not the result. So to 50% added via "Direct Proportion" we can add 5% via "Modify Proportion" (total 55%) and get the result of the initial formula.

Command (Modify Proportion Device):

Command Modify Proportion Device to modify the proportion for the device
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the proportion value


Command (Modify Proportion Group):

Command Modify Proportion Group to set up the proportion for the group
Group 1...16383 the group address in the Helvar system
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * 0...100 the proportion value

*Value - indicate when dragging the command on graphic items


Feedback:

The current device value comes to Query Load Level


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

How to modify the proportion value


The result of writing the positive modification: on the example of the "Direct Proportion" command described in the previous section. When the command is sent, the next proportion modification by 5% will give 75% brightness as it is applied to the previous value of "Direct Proportion":

44 + (100 - 44)*(50 + 5)/100 = 75%

The result of writing the negative modification: on the example of the "Direct Proportion" command described in the previous section. When the command is sent, the next proportion modification by -5% will give 19% brightness as it is applied to the previous value of "Direct Proportion":

44*(50 - 5)/100 = 19%


Emergency Test Control Commands

"Emergency Function Test Device" and "Emergency Duration Test Device" - requests for the emergency state for sending to DALI interfaces only. There will not be any response from non-emergency devices of the system.


Command (Device):

Command Emergency Function Test Device the request for the device emergency functions
Emergency Duration Test Device the request for the duration of the emergency state
Stop Emergency Tests Device to stop all emergency testing
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value * - it is not used - input 0 or leave empty


Command (Group):

Command Emergency Function Test Device the request for the DALI emergency functions
Emergency Duration Test Device the request for the duration of the emergency state
Stop Emergency Tests Device to stop all emergency testing
Group 1...16383 the address of the group of devices in the Helvar system
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value 0...100 it is not used - input 0 or leave empty


Feedback (Device):

Command Emergency Function Test Device the emergencies of the DALI device
Emergency Duration Test Device the request for the duration of the emergency state
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Fade Time 0...6553.5*10^3 (ms) the speed of switching the status from current to the preset one
Value 0...n the current state


Feedback (Group):

Command Emergency Function Test Device the emergencies of the DALI device
Emergency Duration Test Device the request for the duration of the emergency state
Group 1...16383 the address of the group of devices in the Helvar system
Value 0...n the current state

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:

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)


Query Commands

Requests for the device status in the Helvar system are formed in the Feedbacks tab and are activated in a cycle with an interval which can be set in the Timer property.

If the selected protocol of work with Helvar supports auto-notifications about the changes of system statuses, then create Feedback without timer.

Feedback:

Command General Query Commands
Query Clusters all identifiers of items (Cluster Member) from the cluster
Query Routers all identifiers in the indicated cluster
LSIB - Last Scene In Block the last activated scene of the indicated block
Query Device Type the type of the device to which the request is sent. 1 - DALI, 2 - Digidim, 4 - SDIM, 8 - DMX
Query Description the device/group description
Device State Query Commands
Query Device State the device flags (properties) - the list
Query Device Is Disabled disabling of the device
Query Lamp Failure failure of the lamp
Query Device Is Missing non-availability of the device
Query Device Is Faulty failure of the device
Query Emergency Battery Failure failure of the emergency battery
Measurement / Input / Level Query Commands
Query Measurement changing of the analog property, for example, light (Analogue Input Unit)
Query Inputs thee state of the digital input
Query Load Level the device status
Power Consumption Query Commands
Query Power Consumption device power consumption
Query Group Power Consumption power consumption of all devices in the group
Emergency Test Query Commands
Query Emergency Function Test Time the time of the emergency testing
Query Emergency Function Test State the status of the emergency testing. Pass - 0, Lamp Failure - 1, Battery Failure - 2, Faulty - 4, Failure - 8, Test Pending - 16, Unknown - 32
Query Emergency Duration Test Time the duration of the emergency testing
Query Emergency Duration Test State the duration of the emergency state
Query Emergency Battery Charge the remaining charge of the emergency battery
Query Emergency Battery Time the total work time of the emergency battery
Query Emergency Total Lamp Time the total work time of the lamp from any power source
System Query Commands
Query Time, Longitude, Latitude, Time Zone, Daylight Saving Time, Software Version, HelvarNet Version the system properties
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Use Timer Yes/No the request for the device status on timer (HelvarNet does not five the status without requests). If the timer is off then the device status cannot be received.
Timer 0...n (ms) the frequency of requests for the device status
Subdevice 1...255 the subdevice address
Value * 0...100 the current property value

* Value - comes to the feedback channel, use it 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)


Query Device State

Each device from the Helvar system of controlling lighting can give information about some of its properties (flags) by request. It can be used when monitoring the state of the lighting system.


To display the device flags, create the feedback channel. In its settings indicate the device address and the frequency of requesting the flag. The channel is assigned to the graphic item which will display the flag status (0 - not active, 1 - active):

Feedback:

Command Query Device State to request the state of the device property
Command Property Disabled Device or subdevice has been disabled, usually an IR subdevice or a DMX channel
Lamp Failure Unspecified lamp problem
Missing The device previously existed but is not currently present
Faulty Ran out of addresses (DALI subnet) / unknown Digidim control device / DALI load that keeps responding with multi-replies
Refreshing DALI subnet, DALI load or Digidim control device is being discovered
Resting Load is intentionally off whilst the control gear is being powered by the emergency supply
Reserved
In Emergency No mains power is being supplied
In Prolong Mains has been restored but device is still using the emergency supply
FT In Progress The Functional Test is in progress (brief test where the control gear is being powered by the emergency supply)
DT In Progress The Duration Test is in progress. This test involves operating the control gear using the battery until the battery is completely discharged. The duration that the control gear was operational for is recorded, and then the battery recharges itself from the mains supply
DT Pending The Duration Test has been requested but has not yet commenced. The test can be delayed if the battery is not fully charged
FT Pending The Functional Test has been requested but has not yet commenced. The test can be delayed if there is not enough charge in the battery
Battery Fail Battery has failed
In Hi Bit Prevents an emergency fitting from going into emergency mode
FT Requested Emergency Function Test has been requested
DT Requested Emergency Duration Test has been requested
Unknown Initial state of an emergency fitting
Over Temperature Load is over temperature/heating
Over Current Too much current is being drawn by the load
Comms Error Communications error
Severe Error Indicates that a load is either over temperature or drawing too much current, or both
Bad Reply Indicates that a reply to a query was malformed
Device Mismatch The actual load type does not match the expected type
Cluster 1...253 the device address (@ address)
Router 1...254 the device address (@ address)
Subnet 1...4 the device address (@ address)
Device 1...255 the device address (@ address)
Use Timer Yes/No the request for the device status on timer (HelvarNet does not five the status without requests). If the timer is off then the device status cannot be received.
Timer 0...n (ms) the frequency of requests for the device status
Subdevice 1...255 the subdevice
Value * 0...100 the current property value

* Value - comes to the feedback channel, use it 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)


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.