This page is a translated version of the page Crestron and the translation is 100% complete.

Other languages:

iRidium for Crestron

a set of tools for creating interfaces for controlling Crestron processors Description

the documentation is updated 26.10.2018

training:
webinars and video-lessons >>

download:

Description

iRidium for Crestron is a set of tools for creating interfaces to control homes or offices on the basis of Crestron equipment. iRidium works on iOS, Android, Windows, Mac and can connect to several processors at a time.

iRidium work is tested on Crestron processors of 2 and 3 generation.

Connection

Equipment configuration and settings required for iRidium to control Crestron.

Connection to processors

iRidium connects to equipment directly, without using any additional hardware.

iRidium communicates with Crestron joins. You can get the list of joins from *.smw (SIMPL™) projects.

Import of joins from SIMPL Windows projects

When creating a project in SIMPL Windows do not forget to add a panel in the project and set its identifier IP ID – iRidium control devices will use this IP ID for connection to the Crestron controller:

Save the SIMPL Windows (*.smw) project. Open iRidium Studio and select the *.smw file in the menu "File > Import":

As a result you receive the tree with the device (controller) and project joins:

You can add the Crestron driver in your project from the iRidium database manually:

Commands & Feedbacks

As a result we have two levels of PLC settings:

Crestron - the driver unites the list of joins of the Crestron processor
Commands and Feedbacks - the commands and feedbacks inside devices. They enable control of joins. The commands are joins available for writing, the channels are joins 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 joins when clicking on the items
Feedback channels are assigned to graphic items to display the joins state

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

Below you can see examples of commands for control of different types of registers.

Types of Crestron joins:

Digital - the bit variable (0 .. 1). It is used in commands and status channels
Analog - 16-bit unsigned variable (0 .. 65535). It is used in commands and status channels
Serial - the data string in the ASCII format. It is used in status channels only to get string data

Setting up connection to processors

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

SSL is deactivated:

Host - the controller IP-address
Port: 41794 - the port for Crestron control
IP ID - the panel identifier in the SIMPL project (enter as a decimal number, 0D => 13)
Telnet Port: 41795 - the Telnet port for deactivated SSL
Telnet Login - leave empty
Telnet Password - leave empty
SSL: False - SSL is deactivated

SSL is activated:

Host - the controller IP-address
Port: 41794 - the port for Crestron control
IP ID - the panel identifier in the SIMPL project (enter as a decimal number, 0D => 13)
Telnet Port: 41797 - the Telnet port for activated SSL
Telnet Login - the SSL login
Telnet Password - the SSL password
SSL: True - SSL is deactivated

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

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

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 button (+) Add Script from file

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

function Internal_1() { IR.GetDevice("Crestron").SetParameters({Host: "192.168.0.100", Port: 41794, NetID: 3, TelnetPort: 41795, TelnetSSL: 0}); }

function External_1() {

IR.GetDevice("Crestron").SetParameters({Host: "215.110.10.10", Port: 41794, NetID: 3, TelnetPort: 41797, TelnetLogin: "admin", TelnetPassword: "pass", TelnetSSL: 1});

}

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:

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

Examples:

// SSL turned Off
IR.GetDevice("Crestron").SetParameters({Host: "192.168.0.100", Port: 41794, NetID: 3, TelnetPort: 41795, TelnetSSL: 0})
 
//SSL turned On
IR.GetDevice("Crestron").SetParameters({Host: "215.110.10.10", Port: 41794, NetID: 3, TelnetPort: 41797, TelnetLogin: "admin", TelnetPassword: "pass", TelnetSSL: 1})
	//Host - IP address
	//Port - connection port
	//Login - login, if needed
	//Password - password, if needed
	//NetID - Panel ID from SIMPL project in DEC format (not HEX!)
	//TelnetPort - 41795 if SSL disabled, 41797 if SSL enabled
	//TelnetLogin - Telnet login
	//TelnetPassword - Telnet password
	//TelnetSSL - 0 - don't use / 1 - use

Control of joins

To control joins 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

Possible settings of commands, channels and graphic items are presented below:

Digital

Command:

Type	Digital	the Digital join (boolean) is available for writing and reading
Join	1 .. n	the join address
Value *		the value
0 .. 1		0 = Off, 1 = On

* - indicate when dragging the command on graphic items

Feedback:

The settings are similar to commands. Values come to Feedback and they can be used for displaying the status of joins on items

Control:

With the help of graphic items you can write the value: 1 or 0 in joins

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

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:

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

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:

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:

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:

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:

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.

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)

Download: templates of value output (0,7 Mb)

Analog

Command:

Type	Analog	the Analog join (2 bytes) is available for writing and reading
Join	1 .. n	the join address
Value *		the value
0 .. 65535		2 bytes

Feedback:

The settings are similar to commands. Values come to Feedback and they can be used for displaying the status of joins 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):

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:

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

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:

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

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:

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:

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.

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

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)

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

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:

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:

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:

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.

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)

Download: templates of value output (0,7 Mb)

Control of the RGB led strip with the help of Analog joins:

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

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:

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

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

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

Serial

Feedback:

Type	Serial	the Serial join (ASCII), available for reading only
Join	1 .. n	the join address
Value *		the value
string		ASCII

* Value comes to Feedback. 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:

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:

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:

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.

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)

Download: templates of value output (0,7 Mb)

Getting images via Serial Join:

download:

example of Serial Join processing to display images

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)

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.

Contents

LIST OF TEMPLATES

LIST OF TEMPLATES

LIST OF TEMPLATES