push controls - iroom€¦ · 3. create a gui page that has its resolution set to ipad_landscape,...

© Copyright 2015 Push by Schneider Electric of 10

Push Controls

Module: iBezel

Version 1.0

www.pushcontrols.com.au

© Copyright 2015 Push Controls by Schneider Electric


Contents Disclaimer .............................................................................................................................................................................................. 2

Importing the iBezel Module .................................................................................................................. 3

Configuring the iBezel Module ............................................................................................................... 4

Setting the IP Address ..................................................................................................................... 4

Using Events to trigger Macros ............................................................................................................... 5

Renaming trigger macros ........................................................................................................................................................................ 7

Adding Sample GUI Page......................................................................................................................... 8

Using Multiple Instances in a Single Project ......................................................................................... 10

Disclaimer

The iRoom iBezel module is only compatible with the PC1 and PC2 controllers and will not work with

a PC4 controller. The module assumes a working iBezel system has been installed and commissioned

on site.


Importing the iBezel Module Import the iBezel module by completing the following actions:

1. Right click on ‘PROJECT’ at the top of the tree and select ‘Import Module’. Refer to Figure 1

2. Locate and select ‘iBezel_X.pemod’ (where X is the current version number)

3. Select Open

4. The selected module will now appear in the Module Browser window, where you can view

all Imported Modules, expand to see the contents of these modules.

Figure 1 – Right click on PROJECT, inside the project tree, to import a module.

The selected module will now appear in the module browser window (See Figure 2), where you can

see everything that is included in the module.

Figure 2 – Dragging and dropping the script from the Module Browser window


Configuring the iBezel Module

The iBezel module requires minimal configuration, which is specific to establishing communication

between the Push system and the iBezel dock on the network. The process of configuring the iBezel

module is conducted through the properties of the iBezel SCRIPT DEVICE and is outlined in the

following section.

Setting the IP Address

To configure the iBezel SCRIPT DEVICE we need to select the protocol, and enter the port number

and IP address within the SCRIPT DEVICE properties. To complete this process follow the steps

below:

1. Right click on the iBezel SCRIPT DEVICE and select properties

Figure 3 - Right click on the iBezel SCRIPT DEVICE and select properties

2. Select TCP from the Protocol drop down list

3. Enter the port number assigned to the iBezel for communication (default is 13601)

4. Enter the IP address of the iBezel (default is 192.168.0.100)

Figure 4 - Highlighting protocol, port and IP fields


Using Events to trigger Macros

The iBezel system provides status updates whenever an event occurs within the dock. These events

can be used to trigger macros to run on a Push PC1 or PC2 controller (PC4 is not supported). The

events and the default names of the corresponding macros that will be triggered are listed in the

table below. This list is directly taken from the User Settings tab of the iBezel SCRIPT DEVICE, which

can be accessed by right clicking the SCRIPT DEVICE, select properties and click on the User Settings

tab.

Event Names Name of macro to be triggered

homeButtonPushedMacro "homeButtonPushed" homeButtonReleasedMacro "homeButtonReleased" button1PushedMacro "button1Pushed" button1ReleasedMacro "button1Released" button2PushedMacro "button2Pushed" button2ReleasedMacro "button2Released" button3PushedMacro "button3Pushed" button3ReleasedMacro "button3Released" button4PushedMacro "button4Pushed" button4ReleasedMacro "button4Released" button5PushedMacro "button5Pushed" button5ReleasedMacro "button5Released" button6PushedMacro "button6Pushed" button6ReleasedMacro "button6Released" button7PushedMacro "button7Pushed" button7ReleasedMacro "button7Released" button8PushedMacro "button8Pushed" button8ReleasedMacro "button8Released" digital0OpenedMacro "digital0Opened" digital0ClosedMacro "digital0Closed" digital1OpenedMacro "digital1Opened" digital1ClosedMacro "digital1Closed" digital2OpenedMacro "digital2Opened" digital2ClosedMacro "digital2Closed" digital3OpenedMacro "digital3Opened" digital3ClosedMacro "digital3Closed" digital4OpenedMacro "digital4Opened" digital4ClosedMacro "digital4Closed" digital5OpenedMacro "digital5Opened" digital5ClosedMacro "digital5Closed" digital6OpenedMacro "digital6Opened" digital6ClosedMacro "digital6Closed" digital7OpenedMacro "digital7Opened" digital7ClosedMacro "digital7Closed" digital8OpenedMacro "digital8Opened" digital8ClosedMacro "digital8Closed" irEvent0Macro "irEvent0" irEvent1Macro "irEvent1"


To use an event to trigger a macro follow these steps:

1. Create a new macro by right clicking on the MACROS tag in the project tree and select ‘Add

New Macro’

2. Edit the name of the macro by either right clicking and selecting Edit or selecting your macro

in the project tree and clicking on the Edit button in the Macro Editor window pane. Once in

edit mode, change the name of your new macro to match the macro name (case-sensitive)

assigned to the event you wish to use to trigger your newly created macro, and then click

Save.

a. For example if you wished to trigger a macro to run when button 1 on the iBezel is

released you would create a macro on your controller and change the name of the

new macro to button1Released.

3. Once you have renamed the macro, you can add whatever commands you wish to execute

when the event is fired from the iBezel dock, which can be anything from one command to

multiple commands with delays and conditional statements.

4. After you have finished modifying your macro, upload the controller. The controller will now

run the new macro you have created each time the event is fired from the iBezel dock.

5. Repeat steps 1 to 3 for each event you wish to trigger a macro on your controller.


Renaming trigger macros

You can edit the macro to be triggered when an event fires if you want to have a more customised

name in the project tree, or if you want to trigger an existing macro in your project. To customise the

macro triggers follow the steps below:

1. Right click on the iBezel SCRIPT DEVICE and select properties

2. Click on the User Settings tab

3. Locate the event you wish to modify in the user settings window and then change the value

of the event to the name of the macro you wish to trigger. For example to run a macro

called livingBlindsUp when the button1Released event fires change the value field to

“livingBlindsUp” (quotation marks included, see screenshot below for final result)

4. Now when the button1Released event fires the macro called livingBlindsUp on the controller

will run.

5. Repeat step 3 for each macro you wish to change, then click OK in the SCRIPT DEVICE

properties window and upload the controller with your changes.


Adding Sample GUI Page

The iBezel module contains a sample GUI page that provides all of the components available for

triggering actions on the iBezel system and also displaying feedback of system status and events. The

following section outlines the process of importing the sample page into your project.

Follow the steps below to import the iBezel_Assets GUI page:

1. Open the module browser (Tools->Module Browser) and select the iBezel module

2. Expand GUICONTENT->GROUP: iBezel

3. Create a GUI page that has its resolution set to iPad_Landscape, this will be used as the page

to which we can import the iBezel assets into. If you are unsure about creating a new iPad

Landscape GUI page follow these steps:

a. Right click on the GUI group in your project you wish to add the new GUI page into

and select ‘Add GUI page

b. Select GUI-> Target Screen Resolution -> iPad -> Landscape


4. With both the open GUI page and Module Browser in view drag and drop the iBezel Assets

into the open GUI page and you should see a grey box with a black cross through the middle,

when you release your mouse button the pre-programmed iBezel assets will be added to the

page


Using Multiple Instances in a Single Project

There will be some situations where you have multiple iBezel docks on site to integrate into the one

project. In this scenario you cannot simply copy and paste the script device as this will cause a lot of

clashing in the background of the project and corruption/misinterpretation of event triggers. The

correct way to include multiple instance of the iBezel module in a project is outlined below:

1. Open the module browser (Tools->Module Browser) and select the iBezel module

2. Right click on the iBezel module in the dropdown list and select ‘Create new instance…’

3. You will be prompted to enter a new instance number, if this is the first instance enter the

digit 1, for subsequent instances keep increasing the number of the instance to ensure

unique instances are created each time.

4. Click OK, you will now have a new instance in the module browser to use in your project (see

image below). To add a new instance to the project ensure you select the appropriate

instance and then follow the rest of the sections of this document for importing and

configuration as you would for the original module.

push controls - iroom€¦ · 3. create a gui page that has its resolution set to ipad_landscape,...

Documents