background image

41

D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved

Room Simulator

Summary of Contents for TelePresence Touch10

Page 1: ...led by external control systems Since both the Cisco video system and the other peripherals now are controlled from the Touch10 DX Series user interface you will get a consistent user experience throughout the meeting room The version of the in room control utility described in this document is available for the SX MX and DX Series video systems running Collaboration Endpoint Software version CE9 ...

Page 2: ...oubleshooting 36 Tips and Tricks Recommended Best Practice 38 Granting Access to In Room Control Editor and Extensions API 40 Room Simulator Running the Simulator 42 How to Use This Guide When reading this on javascript enabled devices the left menu bar and the entries in the table of contents are all hyperlinks You can click on them to go to the topic Product Documentation User guides and complia...

Page 3: ...3 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Introduction ...

Page 4: ...eo system Video system or codec in the Cisco TelePresence MX Series or SX Series running Collaboration Endpoint Software version CE9 0 or later Sometimes referred to as video device Control system Third party control system with hardware drivers for peripherals for example Crestron AMX Raspberry Pi Touch10 Out touch based control device for the MX Series and SX Series video systems Full product na...

Page 5: ...troduction More About How In Room Control Works You can customize the Touch10 DX user interface to allow control of peripherals in a meeting room for example playback of a sound or movie source lights and blinds You can also add content sensitive controls appearing only when in a call and or only outside calls This means that altogether you have three sets of panels at your disposal Global panel h...

Page 6: ...6 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Creating a User Interface ...

Page 7: ...ou will immediately see the result on the Touch10 DX Offline There are two places you can download the offline editor from Download from http www cisco com go in room control docs Or sign in to a video system s web interface with administrator credentials navigate to Integration In Room Control and click Download Editor If you choose to download the offline editor extract the files from the downlo...

Page 8: ...video system already it will load automatically into the editor The Create icons as in the below example will then read Edit wherever a panel has already been created Offline version If you are using the offline version of the editor use a browser to open the index html file that you find in the rceditor folder With no panels already defined the user interface will look as shown at right Click on ...

Page 9: ...ng a panel in the list will display panel properties in the right panel enabling you to change name icon and location The system supports a maximum of three panels In call visible during calls only Home visible outside calls only Global visible at all times An in room control panel is arranged in pages Each page consists of one or more rows which you can populate with text and user interface eleme...

Page 10: ...10 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Application Programming Interface API ...

Page 11: ... Touch10 DX the video system sends the associated events The control system should respond to these events by switching on the lights in the room and send the corresponding command back to the video system When someone switch on the lights in the room the control system should send a command to the video system so that the video system can update the Touch10 DX In Room Control panel to reflect tha...

Page 12: ...ibed in the Widgets chapter UserInterface Extensions Event suited for terminal output mode UserInterface Extensions Widget suited for XML output mode A single string contains information about the type of action which widget triggered the event identified by the Widget ID and the widget value The type of action which widget triggered the event identified by the Widget ID and the widget value are i...

Page 13: ...If you have given each of your pages a unique Page ID the system can send events when a page is opened or closed EventPageOpened sent when a page is opened EventPageClosed sent when a page is closed The pages are like radio buttons opening another page will close the current page In that case both the EventPageClosed and the EventPageOpened will be issued How to register xfeedback register event U...

Page 14: ...someone physically changes something in the room for example turns on the lights using a wall control As a response to an event for example when someone has tapped the Lights On button on the Touch10 DX In Room Control panel The control system must also do all that is necessary in the room to reflect the action on the Touch10 DX In Room Control panel for example switch on the light Consult the Wid...

Page 15: ...15 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Widgets ...

Page 16: ...er interface extensions are included in the Command reference chapter The Widget Identifier All widgets on a Touch10 DX in room control panel need a unique identifier a Widget ID The Widget ID may either be defined by you or assigned automatically The Widget ID can be any name or number we recommend using a descriptive name without special characters The maximum number of characters is 40 The Widg...

Page 17: ...of the button changes immediately when you tap it However the control system must always send a SetValue command to the video system when the button toggles between on and off This ensures that the status is updated accordingly Example Set a button with WidgetId togglebutton to on xCommand UserInterface Extensions Widget SetValue WidgetId togglebutton Value on Switch is a two state button which in...

Page 18: ...ce Extensions Event Changed Signal slider 68 end e UserInterface Extensions Event Released Signal slider 68 end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 slider WidgetId Value item 1 68 Value Type item 1 released Type Action Widget Extensions UserInterface Event Pressed Triggered when the slider is pressed Value N A Changed Triggered when the...

Page 19: ...s Events Example Press and release the button with WidgetId button Terminal mode e UserInterface Extensions Event Pressed Signal button end e UserInterface Extensions Event Released Signal button end e UserInterface Extensions Event Clicked Signal button end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 button WidgetId Value item 1 Value Type ite...

Page 20: ...th Group ID two Terminal mode e UserInterface Extensions Event Pressed Signal groupbutton two end e UserInterface Extensions Event Released Signal groupbutton two end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 groupbutton WidgetId Value item 1 two Value Type item 1 released Type Action Widget Extensions UserInterface Event Pressed Triggered wh...

Page 21: ...sed Signal symbol end e UserInterface Extensions Event Released Signal symbol end e UserInterface Extensions Event Clicked Signal symbol end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 symbol WidgetId Value item 1 Value Type item 1 clicked Type Action Widget Extensions UserInterface Event Pressed Triggered when the button is pressed Value N A R...

Page 22: ... spinner decrement end e UserInterface Extensions Event Clicked Signal spinner decrement end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 spinner WidgetId Value item 1 decrement Value Type item 1 clicked Type Action Widget Extensions UserInterface Event Pressed Triggered when one of the spinner buttons is pressed Value increment decrement Releas...

Page 23: ...e the SetValue command to enter text dynamically Example of use Help text instructions explanation of what different presets mean or informative text from the control system such as The projector is warming up The text box with larger font size is primarily meant for status values such as the current temperature in the room About Texts Events None Commands Use the SetValue command to set the text ...

Page 24: ...of use Controlling AppleTV Events Example Press and release the button with WidgetId dirpad Terminal mode e UserInterface Extensions Event Pressed Signal dirpad up end e UserInterface Extensions Event Released Signal dirpad up end e UserInterface Extensions Event Clicked Signal dirpad up end XML mode Event UserInterface item 1 Extensions item 1 Widget item 1 Action item 1 WidgetId item 1 dirpad up...

Page 25: ...he Spacer lets you add space between or after widgets It is no more than a layout tool The width of the spacer is adjustable 1 4 If you set it to maximum it will occupy its own line making it usable as a vertical spacer as well About Spacers The Spacer is no more than a layout tool Consequently there are no events or commands associated with it ...

Page 26: ...26 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Command Reference ...

Page 27: ...entifier of the widget that triggers the event and Value is the value of the widget The range of allowed values depends on the widget type UserInterface Extensions Event Released Sent by the video system when a widget is released even if moving the finger out of the widget before releasing it Equivalent to the UserInterface Extensions Widget Action event with Type Released e UserInterface Extensio...

Page 28: ...Interface Event in which WidgetId String 0 40 The unique identifier for the widget that triggered the event Value String 0 255 The value of the widget The range of allowed values depends on the widget type Type Pressed Changed Released Clicked Pressed Sent when a widget is first pressed Changed Sent when changing a widget s value only for toggle buttons and sliders Released Sent when a widget is r...

Page 29: ...idgetId String 0 40 The unique identifier for the widget UserInterface Extensions Widget UnsetValue This command empties the value of the given widget and the UserInterface Extensions statuses are updated accordingly The user interface is notified that the widget is no longer selected USAGE xCommand UserInterface Extensions Widget UnsetValue WidgetId WidgetId in which WidgetId String 0 40 The uniq...

Page 30: ...on widget type String 0 255 WidgetId The unique widget identifier String 0 40 Example xstatus UserInterface Extensions s UserInterface Extensions Widget 1 Value on s UserInterface Extensions Widget 1 WidgetId togglebutton s UserInterface Extensions Widget 2 Value 255 s UserInterface Extensions Widget 2 WidgetId slider s UserInterface Extensions Widget 3 Value Blinds s UserInterface Extensions Widg...

Page 31: ...31 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Use of a Video Switch ...

Page 32: ...he codec upon connection requesting the following from the codec xFeedback register Event UserInterface Presentation ExternalSource The event issued will be as follows e UserInterface Presentation ExternalSource Selected SourceIdentifier XXXX Where XXXX is a unique string ID used to identify this source when selecting or setting state see the following pages for more on this Furthermore there are ...

Page 33: ...e from the list xcommand UserInterface Presentation ExternalSource Remove SourceIdentifier SourceIdentifier in which SourceIdentifier is a unique string ID used to identify this source when selecting or setting state UserInterface Presentation ExternalSource RemoveAll This command removes all sources from the list xcommand UserInterface Presentation ExternalSource RemoveAl UserInterface Presentati...

Page 34: ...ce State Set State Ready SourceIdentifier bluray xcommand UserInterface Presentation ExternalSource State Set State Ready SourceIdentifier appletv xcommand UserInterface Presentation ExternalSource State Set State Ready SourceIdentifier tv If one of the sources is selected on the video switch the controller should send a command accordingly xcommand UserInterface Presentation ExternalSource Select...

Page 35: ...35 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Troubleshooting ...

Page 36: ...etValue command to the video system The CurrentValue column status will be updated and the Touch10 in room control panel changes accordingly Click Unset to clear the value of the widget send an UnsetValue command If a control system is connected to the video system the Current Value and Update Value columns may come out of sync The Current Value column always shows the current status regardless of...

Page 37: ...37 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Tips and Tricks ...

Page 38: ...ontrol editor from the video system s web interface 2 Create the in room control panel you want or import a previously saved panel from file Import From file 3 Click Export To codec Other Useful Stuff Remember previous values when turning lights off e g a light with a slider for dimming and toggle for on off remember the current light state when turning off and use that value when turning back on ...

Page 39: ...up button a light preset set the sliders and toggle buttons accordingly If the lights are changed away from a preset for instance by changing a slider or toggle button deselect all options in the group button Control of Temperature The combination of a spinner and a large font text box value may be used to control temperature Use the spinner to set the desired temperature and the large font text b...

Page 40: ... In order to access the In room control editor you will need to have administrator rights However an administrator may create an In room Control User account With this account it is possible to log into the codec to run the In room Control Editor No other part of the web interface is accessible from this account If you use SSH to log into the codec only a very limited set of the API will be access...

Page 41: ...41 D1535805 User Guide In Room Control for Touch10 Produced June 2017 for CE9 0 2015 2017 Cisco Systems Inc All rights reserved Room Simulator ...

Page 42: ... you will be prompted to confirm that Note As the simulator is self contained any controller connected to the codec should be disconnected when running the simulator to avoid conflicts Tip We recommend using Google Chrome browser when running the simulator Other browsers may fail to run the simulator properly To invoke the simulator navigate to Integration In Room Control in the web interface and ...

Page 43: ...ABOVE NAMED SUPPLIERS DISCLAIM ALL WARRANTIES EXPRESSED OR IMPLIED INCLUDING WITHOUT LIMITATION THOSE OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING USAGE OR TRADE PRACTICE IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT SPECIAL CONSEQUENTIAL OR INCIDENTAL DAMAGES INCLUDING WITHOUT LIMITATION LOST PROFITS OR LOSS OR D...

Reviews: