IRidium App

From iRidium Mobile Wiki
Jump to: navigation, search

AppIco.png i2 Control V2.2
the client for iOS/Windows/Android/OS X
actual version: 2.2
i2 Control V2.2 is installed from
AppStore, Google Play or iRidium mobile web site
separately for each operating system
Arrow download.png


i2 Control V2.2 is a client application inside which you can launch the iRidium visualization interface. The i2 Control V2.2 application displays the graphic part of the visualization project, enables work of drivers and scripts – connection with controlled equipment. Any iRidium visualization project can be launched on all supported OS.

The visualization project can be changed only in iRidium GUI Editor on PC.



Installation and setting up of the i2 Control V2.2 application on different OS:

i2 Control V2.2 for Windows
Windows 7/8: stationary PCs, all-in-one PCs, tablets
i2 Control V2.2 for Apple iOS
Apple iOS (6-9): iPad, iPhone, iPod touch
i2 Control V2.2 for Android
Android OS (2.3+): smart phones, tablets
i2 Control V2.2 for Mac
OS X (10.5+): Mac Mini, iMac, MacPro, MacBook


How to get a fully-functional project in i2 Control V2.2:

IRidiumAppStructure.png
  1. Register on the iRidium mobile web site
  2. Download and install iRidium Environment for PC
  3. Get free licenses for testing or commercial licenses
  4. Download and install i2 Control V2.2 on devices where iRidium projects have to work
  5. Create a visualization project for control panels
  6. Set up equipment control in the visualization project
  7. Add the project and license in iRidium Transfer
  8. Upload the project and license on the control panel - в i2 Control V2.2
  9. Deactivate the project update function in the i2 Control V2.2 settings to launch the project faster


How to upload the project and license in i2 Control V2.2:

The project can be uploaded on the control panel from PC with the help of iRidium Transfer or by the link from the remote resource (НТТР/HTTPs). The i2 Control V2.2 application supports upload of several projects.

Uploading projects in i2 Control V2.2
Fast upload of iRidium projects on control panels from iRidium Transfer on the local PC
Remote upload of projects in i2 Control V2.2
Updating projects via the Internet with the help of links, QR-codes, iRidium Transfer
Multi-design
Upload of several projects and licenses on one control panel
Solving problems with project upload and panel search
Reasons and ways of solving problems with project upload and panel search

↑ Back

Indication of the i2 Control V2.2 Status in Transfer

The indicator of the panel status displays the connection mode of i2 Control V2.2 to iRidium Transfer.

For project update on the panel to work, the indicator inTransfer has to be green (On) - the i2 Control V2.2 application is launched and opened on the panel:

Transfer update.png


Meanings of the panel status indicator in Transfer:

Transfer RedLamp.png i2 Control V2.2 is not launched on the control panel or cannot connect with Transfer
- project upload will not start until the problems are solved.
Transfer YellowLamp.png i2 Control V2.2 is launched on the control panel but Update in its settings is deactivated
- project upload is deliberately deactivated in the i2 Control V2.2 settings
Transfer GreenLamp.png i2 Control V2.2 is launched on the control panel
- project upload will start when clicking the Reload button


Deactivation of the Project Update Function on the Panel

It is possible to manage the function of project upload in i2 Control V2.2. When you deactivate the update you fasten the launch of i2 Control V2.2 as the application stops waiting for project upload Transfer. It is required after finishing work on the project.

The change of the update mode can be performed only in the i2 Control V2.2 settings on the control panel.


To open the i2 Control V2.2 settings, click "Show System Menu" (the right click menu in Transfer):

AppSettingsFromTransfer.png


WinApp Settings1.png

The Update properties in the i2 Control V2.2 settings:

  • Enable: Yes/No - enable/disable project update
  • Update Host – the IP-address of the PC with running iRidium Transfer.
  • Update Port – the ТСР порт though which project update is performed. By default it is 10000.
    If you need to change the update port, do it in the Transfer settings and restart both applications.
  • Update Now – the command for the forced update


Unmark the "Enable" checkbox right after the upload of the final project version on the control panel
It will fasten the application launch. The checkbox can always be marked again in the i2 Control V2.2 settings.


Transfer YellowLamp.png i2 Control V2.2 is launched on the control panel but Update in its settings is deactivated
- project upload is deliberately deactivated in the i2 Control V2.2 settings
Transfer GreenLamp.png i2 Control V2.2 is launched on the control panel
- project upload will start when clicking the Reload button

↑ Back

Controlling Equipment via the Internet

The i2 Control V2.2 application can work with your equipment locally or remotely. To set up remote control, follow instructions for your equipment or general recommendations through the example of the AV & Custom Systems driver.


If the control panel should hold the connection with the system when the panel is out of the limits of the Wi-Fi network of the system, you need to set up the switch between the Internet and the local network.

The remote mode suggests connection to the system via the Internet. At that the external IP-address or the domain name of the system to which you need to connect have to be used.


Attention.png In iRidium Wi-Fi/3G CANNOT be switched automatically. For switching between the Internet and the local network you need buttons with special settings. See the settings below.
Attention.png To control the system remotely you have to open the system for external access -
to set up the Port Forwarding Service.
Attention.png To secure equipment from unauthorized access we recommend using secure connection with the remote system (VPN).


Setting up of the switch Wi-Fi/3G in iRidium projects:

Scripts PpenTemplate.png

1. Open the script editor in iRidium GUI Editor.

2. Download and add into your project the template of the Wi-Fi/3G switch (Add Script from file):
download the template of the Wi-Fi/3G switch

The Wi-Fi/3G switch is performed with the help of the script function SetParameters

Setting up of parameters of the Wi-Fi/3G switch:

function Internal_1() // Function name
{
IR.GetDevice('AV & Custom Systems (TCP)').SetParameters({Host: "192.168.0.100", Port: "10005"}); // Driver Name + Parameters
}
function External_1()
{
IR.GetDevice('AV & Custom Systems (TCP)').SetParameters({Host: "220.115.10.10", Port: "10005",});
}

Indicate in the command settings:

  • Function name – the name of the switch function (command). Two functions cannot have the same name in a project.
  • Driver Name – the name of the driver which parameters are changed
  • Parameters – the set of the switch parameters which you need to apply to the driver


Assign commands to buttons:

  1. Select the button which will be responsible for the Wi-Fi/3G switch.
    Open the properties of the button: Object Properties > Programming
  2. Open Macros Editor of the button for the Press or Release events
  3. Select the Script Call command and add it by double-clicking on it
  4. Select the name of the function you want to activate in the drop-down list. Create the command.

Script call internal-external.png


Set up access to the equipment from the Internet:

In order to do that open the equipment ports for remote access.


Download the example of the Wi-Fi/3G switch (project) >>

↑ Back

Updating Projects via the Internet

Set up updating projects via the Internet. In order to do that you need to:

  • set up the system menu of the project, when the control panel and PC with iRidium Transfer are in one IP network
  • set up the router for remote access to the controlled equipment

↑ Back

Local and Remote Debugging of i2 Control V2.2 (logging)

Logging in Windows

Log window.png

iRidium Log is a window where information about iRidium work, error messages and iRidium Script logs (IR.Log) are output in the text format.


To open the iRidium log in Windows, click F4.


Remote logging in iOS/Android/OS X

iRidium Log in iOS/Android/OS X is a system journal which iRidium can send to Syslog Server via IP. iRidium Log is used for troubleshooting and script debugging. It can be send to the Syslog Server installed on your PC.

App UpdateSettings Remote.png

Activate the Remote Debugging function in the i2 Control V2.2 settings.

  • 192.168.XX.XX – the local IP-address of the PC with Syslog Server
  • 514 – the port of Syslog Server listener
  • 8 – the logging depth (1 – the most critical messages, ... , 8 – all messages)
  • ON – logging activation
Click Apply and restart i2 Control V2.2.


Set up the Syslog server:

Install and set up any Syslog server for Windows on your PC, for example, www.winsyslog.com.

Restart i2 Control V2.2 and the application will start sending the system journal to the Syslog server on your PC.


Android Debugging via USB

It enables you to save the log of i2 Control V2.2 work on the Android based tablet or smart phone as a text file. The saved log can be used for detecting errors in the program work.

See Android Debugging via USB

↑ Back

Licensing of i2 Control V2.2

A license for i2 Control V2.2 is an *.irl file which is uploaded i2 Control V2.2 via the iRidium Transfer application. The license file is uploaded on the control panel only with an iRidium project (*.irpz) – the visualization interface. On the control panel the license file enables connection to the equipment set up in the project.


A license can be assigned to HWID – the control panel identifier. Such license is called "Device License" and it can work only on this control panel.

[ ! ] about deletion of i2 Control V2.2
Remember that i2 Control V2.2 for iOS ( iPad/iPhone/iPod touch) will change HWID if you delete the application and then install it again! Install one more application of the same developer (iRidium mobile) on your iOS device (for example, i2 Control and i2 Control V2.2 for HWID not to change at deletion of one of the applications.


A license can be assigned to Serial number –the serial number of one of the controllers of your installation: AMX, Crestron, KNX, KNX IP BAOS, HDL, Global Cache, Helvar. Such license is called "Site License" and it can be uploaded on any control panel as it is not related to HWIDs (panel identifiers). Thus, you can connect any panel to the licensed controller. Do not forget that Site licensing is supported only by a limited list of controllers and systems: AMX, Crestron, KNX, KNX IP BAOS, HDL, Global Cache, Helvar.


If a control panel or controller are broken and have to be substituted by a new one, you can transfer your license to the new device for free in your MY ACCOUNT section on the iRidium mobile web site.


To buy a license, you can use an online form or request an invoice. After the payment you will receive an activation key with which you will be able to activate the license – to assign it to your MY ACCOUNT section and HWID (or Serial Number). When the license is assigned to the control panel or controller, it can be downloaded from the web site as an *.irl file and upload it on your control panel via iRidium Transfer.

↑ Back