iridium for Crestron

Transcription

1 iridium for Crestron Fast Start (Sequence of Operation with iridium for Crestron) Review of iridium Software Package for Crestron The iridium Software Package for Crestron includes components for installation on your PC under Windows XP/7 and components for installation on ios devices. The part of the package which is installed on your PC and necessary for operation with the Crestron equipment is the iridium Transfer application which is meant for converting and uploading GUIs on the Apple ios or Windows control panels. The part of the software package for installation on ios devices is iridiumhd Client application which is in charge of launching and running GUIs on target a device. In order to enable the connection of iridiumhd ios Client to the Crestron controller (iridiumhd Client is connected to the controller as an original Crestron panel) it is required to purchase a demo iridium license. Licenses for ios are stored in the Transfer application and are transferred to target ios devices along with GUIs. Licenses for Windows are stored in the project folder. iridium supports operation with the following devices: Apple ios devices (ipad, iphone, ipod Touch) Windows XP & Windows 7 based devices Recommendations and Requirements for Operation with the iridium Software Package for Crestron PC under Microsoft Windows XP / 7 iridiumhd application installed on your ios device from the Apple App Store Wi-Fi network for uploading and updating GUIs and also for Crestron connection Internet connection for acquiring and activation of iridium license keys iridium license file for enabling the connection to the Crestron controller

2 2 Contents 1 Review of iridium Software Package for Crestron 1 Recommendations and Requirements for Operation with the iridium Software Package for Crestron 1 Installation of the iridium Software Package Components 3 Description of the iridium Transfer Interface and Design Adding 4 Setting up the Connection to the Crestron Controller 6 Setting up the Connection to the Crestron Controller for BASE Licenses 6 Setting up the Connection to the Crestron Controller for ULTIMATE Licenses 7 Addition of ios Devices to the Transfer Panel List 8 Description of the Licensing Procedure for the Control Device 9 Receipt of UDID for Activation of the iridium Base License for an ios Device 9 Receipt of the Serial Number of the Crestron controller for Activation of the iridium Ultimate License 10 Licensing Procedure of an ios Device (for any License Type) 11 Activation of the iridium Base License Key 13 Activation of the iridium Ultimate License Key 15 Uploading of the License File to iridium Transfer 16 Setting of Connection to the Crestron Controller for iridiumhd ios Client 17 Creation of iridium Windows-Client for 19 Receipt of HWID for iridium Windows-Client Licensing 21

3 3 Installation of the iridium Software Package Components In order to start your work, it is necessary to install two parts of the iridium software package. The first part, an installation package for your personal computer under Windows XP / 7, can be downloaded from the iridium web site, in the Download section: The iridium software package for personal computer consists of several components, but you will only need iridium Transfer to work with Crestron projects (*.vtz). It is software for converting and downloading designs to the control devices. The second part of the iridium software package is the Client application for installation on the devices based on the Apple ios operation system. The application is called iridiumhd and can be downloaded from the official AppStore (itunes: The iridiumhd Client application is a software component of iridium that is in charge of launching and using a graphic interface, forming and sending commands to the controlled equipment.

4 4 Description of the iridium Transfer Interface and Design Adding After the iridium package for your personal computer and the iridiumhd Client are installed, you can start work with the Crestron project. Start the iridium Transfer application. On the main screen you can see several tabs: Panels, Designs and Licences. All these tabs are related to each other and correspond to different aspects of forming and uploading iridium on the control device. Let s start work with the Transfer application by adding your own interface design created with the Vision Tools Pro-e editor into the list of Designs in the Transfer application. iridium Transfer operates with GUIs in *.vtz format, you need to compile project files in *.vtp format before adding them to the Transfer application. Compiling is made in the Vision Tools Pro-e editor. To start the compiling select the Compile Project function in the File menu of the editor or press the F12 button. The compiled project can be saved for the following panel types: DVP 4, DVP 4DI, DVPHD, DVPHD CUSTOM-GB, ST 1700С, STX 1700C, STX 1700CXP, TPS 12, TPS 12G-QM, TPS 15, TPS 15G-QM, TPS 17, TPS 1700, TPS 17G-QM, TPS 2000, TPS 3000, TPS 3000L, TPS 3100, TPS 4000, TPS 4000L, TPS 4500, TPS 4L, TPS 5000, TPS 6, TPS 6000, TPS 6IR, TPS 6L, TPS 6X, TPS GA-TPI, TPS G-TPI, TPS TPI, DGE 1, DGE 1_V12, DGE 1_V15, MTX 3, PTX 3, TPMC 10, TPMC 12, TPMC 15-CH, TPMC 15-QM, TPMC 17-CH, TPMC 17-QM, TPMC 3X, TPMC 4SM, TPMC 4SMD, TPMC 4X, TPMC 4XG, TPMC 8L, TPMC 8X, TPMC 9 + Crestron Mobile.

5 5 The acquired compiled GUI file in *.vtz format can be uploaded in iridium Transfer. Addition of a new design can be done by clicking on the Add Design button or by the Drag&Drop method, i.e. by dragging a design into the Transfer application window. During this process a new window will be opened, allowing to setup basic settings such as: name of the design necessity of enabling/disabling sounds for button push activation of the full screen mode on ios devices (if it is required the status bar can be displayed on the ios device) activation of the full screen mode on Windows devices displaying of the cursor on Windows devices (It should be deactivated in projects made for operation on sensor panels)

6 For ios devices, turning off Full Screen mode means that together with the iridium interface you will see a standard status bar of the ios device. Appearance of the status bar can be selected from the suggested list. During creation of a new project, if you are planning to include the status bar, make sure to account for width of the status bar: 20 pixels for ipod, iphone 3, ipad 1, 2 40 pixels for ipod Touch 4 / iphone 4, 4s. After pressing the OK button, the graphic interface will be converted and added to the list of designs in the iridium Transfer application (The Device Configure and Passwords tabs are not activated right after the conversion. You will be able to edit them when opening the project again). 6 Now in order to upload the design to the control device based on Apple ios operation system, it is necessary to establish connection between the iridium Transfer application installed on your personal computer, and the iridiumhd Client application installed on the ios device. Setting up the Connection to the Crestron Controller! Settings of connection to Crestron are DIFFERENT for Base and Ultimate Licenses. Do not forget to consider the license type when setting up the connection to the controller. Please see the further instructions and description of license types. Setting up the Connection to the Crestron Controller for BASE Licenses You can indicate the settings for connection to the Crestron controller in Transfer in the Device Configure menu: Properties > Device Configure. For a design which will be used for launching on a Windows or ios based device with BASE License it is necessary to indicate such connection properties as an IP-address of the controller, a connection port and a panel identifier. The properties of connection to the controller:

7 7 In the device settings you need to indicate: IP-address of the Crestron controller; Port (by default ); Panel identifier (Cresnet ID). Setting up the Connection to the Crestron Controller for ULTIMATE Licenses For a design with ULTIMTE License it is necessary to indicate such connection properties as an IP-address of the controller, a connection port, a panel identifier and a controller port for requesting the serial number (to check the authenticity of the ULTIMATE License). Set the properties of connection to the controller in the Device Configure menu: In the device settings you need to indicate: IP-address of the Crestron controller; Port (by default ); Panel identifier (Cresnet ID); Port of connection to the controller to check the authenticity of the license; Indicate the password if you use the secure connection.

8 8 Addition of ios Devices to the Transfer Panel List In order to establish the connection between Transfer and iridiumhd, it is needed to add the control device with the installed iridiumhd Client into the list of Panels in Transfer. Addition of the ios based device into the list of Panels in Transfer is available through the Device Search option. For a successful Search, please make sure that your PC and ios device are connected to the same Wi-Fi network and there is communication between them (it can be checked with ping request). Discovery of the device cannot be done over USB connection. To start discovery of the devices, press the Search button in the Panels tab of the Transfer application, and open the iridiumhd Client application on your ios device. Please make sure you are opening the application, and not restoring it from the minimized state which is possible on the devices with multitasking support. Before starting the discovery, delete the iridiumhd Client from the list of the launched applications. If Wi-Fi is active and the search port for panels in the Transfer application (10000) is not blocked or busy by another application, your ios device will appear in the list of panels in Transfer: Here you can see two fields highlighted red. The first field is for selection of the graphic interface that will be uploaded on the selected panel. It is possible to select a required design from the dropdown list containing all added designs in the Transfer application. The second field is for the attaching the license file that will enable the graphic interface to connect to the controlled equipment. In case if a license file is absent, there will be no connection between iridiumhd and equipment, you will not be able to either send control commands or receive the feedback. At this stage, you can generate your project for Windows but it won t have connection to the equipment without the license.

9 9 Description of the Licensing Procedure for the Control Device In order to receive a license file, you are required to purchase iridium Activation Key and go through the licensing process. The licensing process includes activation of the purchased key, and after it you will receive the license file for an ios device that needs to be added into the Transfer application or the license file for a Windows device that needs to be added to the folder with the ready project. iridium keys differ both by operation systems of the control devices they are bound to and by their type. There are two types of licenses: Base licenses enable the connection of the control device (ipad/iphone/ipod Touch, Windows panels) to the controlled equipment. The Base license is bound to the particular panel (ios or Windows). Ultimate licenses contain information on the licensed controller. The Ultimate license type is bound to the particular controller identified by ID. It enables the connection of any number of devices with control iridium GUIs to the controller. Receipt of UDID for Activation of the iridium Base License for an ios Device For receiving UDID of the ios panel from the list of Panels in Transfer, copy it from the Panels tab in the device parameter line: Besides, UDID of the ios device can be copied from the itunes application. It can be helpful when a device is added manually or when you work via Internet:

10 10 Receipt of the Serial Number of the Crestron controller for Activation of the iridium Ultimate License To receive the identifier (serial number) of the Crestron controller which is required for activation of the iridium Ultimate license on an ios or Windows device, you can use the iridium Util application which is a part of a standard iridium installation package. You can download iridium Util from our web site. Start iridium Util under Administrator rights (through the right-click menu: Run as Administrator ) 1. Go to the «Serials» tab to receive the serial number of the controller 2. Select the Crestron controller from the dropdown list 3. Indicate the properties of connection to the controller (the IP-address of the controller, connection port and Password if it is a secure connection) 4. Press the «Request» button and copy the appeared serial number from the «Serial» string:

11 11 Licensing Procedure of an ios Device (for any License Type) Licensing procedure of an ios device begins with purchasing iridium Activation Key (Base or Ultimate) which will be necessary for generation of the license file. iridium Activation Key can be purchased in two ways: 1. You can register at our web site, wait till your registration is approved and purchase Activation Key directly from the web site, in section BUY: 2. You can contact the official iridium distributor in your country. A list of distributors is located in the Partners section at our web site:

12 If you are an independent installer for automation systems, you can also receive demo activation keys for free, after filling in a separate registration form at our web site: 12 After the purchase is made, you will receive an with Activation Key that will be used to activate the iridium license, i.e. to generate a license file for a selected device: Activation of your key is made at the following web site: You will receive the login information to access the activation web site in the . Here you can also recover your license file in case it was lost:

13 13 Activation of the iridium Base License Key In order to activate a Base license you will be required to enter the following information in corresponding fields: your address where the license file will be sent to, Activation Key that you received in , and identification of the specific device (Device UDID) for which the license is generated: After completing all required fields in the Activation window, you will be asked to fill out a user form. This short form needs to be filled out only once and will be used in the future for activation of new licenses from the same address:

14 14 The next step will be receiving of your License File. You can directly download it from the web site, right after activation: or it can be saved from the that will be automatically sent to the specified address.

15 15 Activation of the iridium Ultimate License Key In order to activate the Ultimate license you will be required to enter the following information in corresponding fields: your address where the license file will be sent to, Activation Key that you received in , and identification of the Crestron controller (serial number) for which the license is generated: After completing all required fields in the Activation window, you will be asked to fill out a user form. This short form needs to be filled out only once and will be used in the future for activation of new licenses from the same address. The next step will be receiving of your License File. The iridium license is the file with the extension.irl which can be directly downloaded from the web site, right after activation or it can be saved from the that will be automatically sent to the specified address.

16 16 Uploading of the License File to iridium Transfer The iridium license is the file with the extension.irl received after the key activation. After the license file has been downloaded it is necessary to add it into the list of licenses in the Transfer application (Do not forget that licenses for ios devices are added in Transfer only. Licenses for Windows devices are stored separately). Addition of the license file is done by the Add License button or by dragging and dropping it into the Transfer application window: After the file has been added to it can be attached to the ios device in the Panels tab. Do not forget that in the Licenses tab you can add licenses for ios devices only. Only the license file which was activated for a particular panel can be bound to the device in the Panels tab: When the design and license are ready it is possible to move on to setting up the connection of control device to the Crestron controller and uploading a design from Transfer.

17 17 Setting of Connection to the Crestron Controller for iridiumhd ios Client Indication of parameters of the connection to the controller and updating of the design is done in the Settings window of the iridiumhd Client application which can be accessed from the general Settings window of your ios device: In the iridiumhd ios Client settings it is required to indicate: Type of connection to the Crestron controller either through the local network or through the internet. Make one of the choices active (One of the switches should be active. Usually local network connection is used - Internal). Setting of the rest properties of the iridiumhd Client is not necessary as they will be transferred to the ios device along with the project (settings of connection to the controller are indicated after converting the project in Transfer, in the Device Configure menu: Properties > Device Configure).

18 18 Further the Update options on an ios device are set: Turn on ability to process the Update and indicate the IP address of the computer where the Transfer application is running. You can find the local IP address of the computer in the right lower corner of Transfer: *GUI Update can be done either over local network or via Internet. When all the settings are completed all that is required is to restart iridiumhd Client on your ios device in order to start Update. Please note that for devices that support multitasking, you need to fully close the software, as minimizing maximizing of the software will not work. In order to do a full close of iridiumhd Client, you need to fully delete it from the list of running applications, as it is shown in our instruction at Wiki Opening of the configured application will start the update process from Transfer. After it s completed your design should be fully functional and you can disable GUI update ability in Settings.

19 19 Creation of iridium Windows-Client for Crestron Now let s take a look at the process of creating a iridium Windows based Client an application file for launching under Windows XP/7. Here you need to use a particular algorithm for operation with the Crestron Windows based projects. For the design added into the Transfer application, and intended to be launched under Windows and for the design uploaded on the ios device, the setting of the connection properties is not necessary as they are transferred along with the *.vtz project. If it is required you can customize the connection settings in the Device Configure menu: In the device settings you need to indicate: IP address of the Crestron controller; ID). Port (by default ); Panel identification (Cresnet

20 20 Further you need to select the design prepared this way in the list of Designs in Transfer and click the Generate for Windows button in the Design tab: You will receive a file folder with a Windows Client application and additional files: Now in order to make the Client application to be fully functional it is necessary to add a license file for Windows into the same folder. Receiving of a license file is done exactly in the same way as for ios devices described above, except for the process of receiving the unique identification for the panel.

21 21 Receipt of HWID for iridium Windows-Client Licensing For Windows devices a unique identifier which is required for license file receipt is HWID. It s attached to the computer s hard disk drive. You can find HWID of your computer where the Transfer application is installed through the About menu: Or if you open any iridium demo project on the control device without a license you will be able to receive HWID of your device from a warning popup window: After the license file has been received and added into the generated project folder the Client application can be launched. If you don t have any warnings when you are launching the Windows based Client, it means your license was accepted and your project will run in a fully functional mode. Additional information about operation with the iridium software package can be found at our Wiki.: