Cisco TelePresence MX200G2 User manual

1
In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
In-Room Control on
Touch10
User Interface Extensions
Cisco TelePresence
MX200G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
CE8.2
JULY 2016
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
2
Table of contents
Introduction........................................................................................... 4
Definition of terms................................................................................. 4
In-room controls ................................................................................... 5
Create a user interface for the Touch 10.............................................. 7
Launch the In-room Control editor ....................................................... 8
Create an In-room Control panel .......................................................... 9
API for programming in-room controls ............................................... 14
Widgets .............................................................................................. 20
The Widget Identifier ........................................................................ 20
Toggle button ................................................................................... 21
Slider ................................................................................................ 22
Spinner ............................................................................................. 23
Button with custom text.................................................................... 24
Button with symbol........................................................................... 25
Group button .................................................................................... 26
Text box............................................................................................ 27
Command reference........................................................................... 29
Events............................................................................................... 30
Commands....................................................................................... 32
Statuses ........................................................................................... 33
Troubleshooting .................................................................................. 35
Development tools on the web interface ......................................... 35
Tips and tricks..................................................................................... 38
Examples ............................................................................................ 41
How to use this guide
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 compliance and safety information for Cisco
TelePresence systems are available at http://www.cisco.com/go/
telepresence/docs
We recommend that you visit the Cisco web site regularly for
updated versions of this guide.
Who has access to the editor?
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 accessible.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Table of contents

3
In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
Introduction
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Introduction

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
4
Introduction
With In-Room Control you can add custom elements to our Touch 10
user interface. Such user interface extensions may be controls for
lights or blinds, or other peripherals controlled by external control
systems.
Since both the Cisco video system and the other peripherals now are
controlled from the Touch 10 user interface, you will get a consistent
user experience throughout the meeting room.
The version of the in-room control feature described in this
document, is available for the SX Series and MX Series video
systems running Collaboration Endpoint Software, version CE8.2 or
later.
Definition of terms
Video system. Video system or codec in the Cisco TelePresence
MXSeries or SXSeries running Collaboration Endpoint Software,
version CE8.2 or later. Sometimes referred to as video device.
Control system. Third-party control system with hardware drivers for
peripherals, for example Crestron, AMX, Apple HomeKit, or Android.
Touch 10. Out touch-based control device for the MXSeries and
SXSeries video systems. Full product name: Cisco TelePresence
Touch 10. Also known as Touch 10 controller, or Touch 10 user
interface.
In-room control panel. Panel with controls for third-party peripherals
in the room. The panel opens when you tap the corresponding
in-room control icon in the status bar on Touch 10. See the
Create a user interface chapter for more on this.
In-room control editor. Our easy to use drag-and-drop editor for
making in-room control panels.
xAPI. The bidirectional API of the video system. The xAPI allows
third-party applications to interface with and interact with the video
system, and vice versa.
Widget. User interface element, for example buttons, sliders, and
text fields, that you can use to build an in-room control panel for
Touch 10.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Introduction

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
5
In-room controls
Example of Global and Homescreen in-room control panels on Touch
10. Any In-Call panel icons existing will be visible during calls only.
Global control
panel example
Global entry icon
example
You can customize the Touch 10 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 has its entry icon in the status bar at the top of the
Touch 10 display. Once established, this entry icon is visible at all
times.
• Homescreen panel has its entry icon located to the right of the
buttons appearing along the bottom of the Touch 10 display. This
entry icon is visible outside calls only.
• In-Call panel has its entry icon located to the right of the buttons
appearing along the bottom of the Touch 10 display. This entry
icon is visible when in a call only.
You need a Cisco video system with a Touch 10 user interface, and a
third-party control system, for example Crestron, AMX.
The video system’s API, referred to as the xAPI, is the link between
the video system and the control system. Use the events and
commands exposed by the xAPI when you program the control
system.
The simple drag-and-drop in-room control editor offers a library of
user interface elements, referred to as widgets. You can use these
widgets to create your own in-room control panel for the Touch 10
user interface.
Together, all of this provides a powerful combination of the control
system’s functionality and the user-friendly Touch 10 user interface.
In-room control schematics
Video system
Blinds
Climate
Lights
Other...
In-room
control
editor
xAPI
Control system
Touch10
Homescreen
entry icon
example
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Introduction

6
In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
Create a user interface
Use the in-room control editor to create the user interface and to apply it to
the video system
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
7
Create a user interface for the Touch 10
Use the in-room control editor to create customized panels for
peripheral controls on the video system’s Touch 10 user interface.
Connected to the video system
If you have access to the video system, you can launch the editor
from the video system’s web interface.
If an in-room control panel already has been created on the Touch 10,
this will automatically load into the editor, ready to act as a starting
point for your design.
When you push a new panel to the video system, you will
immediately see the result on the Touch 10.
In-room control editor launched from the video system's web interface
Push new in-room control
panel to video system
Import existing in-room control
panel from video system
Export new
in-room control
panel to file
Import an
in-room control
panel from file
Video system
Touch10
In-room
control
editor
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
downloaded zip-file. Retain the folder structure.
When using the offline editor you will be working with files, rather
than communicating directly with the video system and Touch10.
Apart from this, the offline editor has full functionality.
The editor that you launch from the video system’s web interface and
the offline editor share the same file format, so files created in one
version can be opened and modified in the other.
Offline in-room control editor
Export new
in-room control
panel to file
Import an
in-room control
panel from file
Offline
in-room
control
editor
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
8
Export your panel to the video
system (codec), or export it to
a file that can be imported back
into the editor at a later stage
There are three sets of panels
available; Global, Homescreen
and In-Call. Each set may
contain multiple pages. To
create a panel, click here.
Link to online guides
Import the current panel from
the video system (codec), or
import a panel that has been
exported to a file on an earlier
occasion
Launch the In-room Control editor
Sign in to the video system's web interface with administrator
credentials, navigate to Integration > In-Room Control, and click
Launch Editor.
If there is a set of in-room control panels on the 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,
open the index.html file that you find in the rceditor folder.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
9
Create an In-room Control panel
Start Designing the In-room Control Panel
If an existing in-room control panel failed to load automatically on
launching the editor, choose one of these alternatives:
• Create creates a blank in-room control panel in the editor for
either Global use, Homescreen use or In-Call use.
• Import> From file loads an in-room control panel, which has been
exported to a local file on an earlier occasion, into the editor.
• Import> From codec loads the current in-room control panel from
the video system into the editor. Not available in the offline editor.
All alternatives erase any unsaved data in the editor, but the existing
in-room control panel on the video system is neither overwritten nor
deleted until a new panel is exported to the video system.
Start or continue the design of an in-room control panel
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
10
Populating the In-room Control panel
What you see in the editor's design panel is similar to how the in-
room control panel will appear on the Touch10.
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 elements known as widgets.
Widgets are arranged in a four-column grid. The widgets are placed
into the grid according to the following rules:
• A widget fills between one and four columns depending on its
size.
• Rows are right-aligned.
• If you add more widgets than fits in one line, widgets wrap to a
new line within the same row.
How you use the user interface elements for your meeting room is
up to you. You can, for example, create panels with preset buttons
for lights and blinds, or support for more complex scenarios such as
controls for many microphones in a large meeting room. You can find
some examples for inspiration in the Examples chapter.
More on how to create the panel can be found on the next page.
The in-room control editor. Widgets from the widget library are placed in a four-column grid.
Design panel
Widget library
Four-column grid
Buttons with familiar
symbols like home,
power, arrows, camera
and loudspeaker controls,
media player controls
Buttons with custom text,
group buttons, toggle
button, sliders, spinners,
and other elements
Page shows a setup of a
Global in-room control,
but the principles apply to
all three sets of in-room
controls.
Any panels already created,
appears in a list beneath
the Panels button. To create
more panels, click Panels.
This will show the panel
front page again. Choose a
new panel to create, or click
an existing one to continue
editing it.
This is how a panel looks before you have started to populate it.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
11
1Give the page a name
Click the page text, and enter a
name.
2Give the row a name
Click the row text, and enter a
name.
3Add widgets from the library
Drag and drop as many widgets as
you need from the widget library
onto a row.
4Enter custom text on widgets
Click the dummy-text on a button,
group button, or text field, and
enter the appropriate text.
5Define unique identifiers
Click the widget, and type unique
identifiers in the input fields that
pops up below the design panel.
You can either use the pre-
assigned identifiers or define your
own.
All widgets have a unique
WidgetID. Only Group buttons have
GroupIDs.
Read more about the identifiers in
the Widgets chapter.
6Add more rows
Click +to add a new row.
Repeat steps 2-5 for each row.
7Add more pages
Click +to add a new page.
Repeat steps 1–6 for each page.
8Choose an entry icon
Click Panel icon and choose a
control icon (entry icon).
If you created a Global panel, the
control icon appears in the status
bar on Touch10. When you tap the
icon, the in-room Global control
panel opens.
For Homescreen and In-Call, the
entry icon will appear as a button to
the right of the call control buttons.
8b Give the panel a name
Click Panel name and type in a
descriptive name. This field is not
available with the Global panel.
9Click on the garbage bin icon to
delete the entire panel from the
editor. To remove a panel from the
Touch 10, remove it from the editor
and then push your altered editor
configuration to the video system.
The panel’s icon should disappear
instantly.
88b 1
2
3
6
74
5
9
Tip Drag a page, row,
or widget, and drop it in
a new position. Drop it
outside the design panel
to delete it.
For more on how
to create more
panels, see the
previous page.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
12
Apply In-room Control panel to the video system
(Not available when using the offline editor. Instead, you should
export the in-room control panel to a file in order to save your work
for later.)
Apply the in-room control panel to the video system. You will see the
results immediately on the Touch 10.
• Choose Export > To codec
Check the result on Touch 10
(Not available when using the offline editor.)
Tap the in-room control icon in the Touch 10 status bar to open the
in-room control panel.
Example of two sets of in-room control panels. The Global has been
selected (blue light bulb) and a panel consisting of three panes is shown.
To the right of the Share button, a in-room control Homescreen entry icon
has been added.
Which in-room control icons (entry icons) used is defined by the
Panel icon setting, as shown on the previous page.
Export the In-room Control panel to file
You may also export the in-room control panel to a file. This file can
be imported back into the editor at a later stage. Note that you will
export all your work (Global, Homescreen and In-Call panels)
• Choose Export > To file
If you are using the offline editor, this is the only way you can save
your work for later.
Exporting to file may also be useful as a way of creating a design
template if you are going to push the same in-room control panel to
multiple video systems.
Files exported while connected to a video system are in the same
format as files exported from an offline editor. This means that any
of these files can be imported into an editor launched from a video
system's web interface, and then pushed to the video system's
Touch 10.
Remove a panel from Touch10
To remove a panel from the Touch 10, remove it from the editor and
then push your editor configuration to the video system. The panel’s
icon should disappear instantly.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Create a user interface

13
In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
API for in-room control
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
14
Connect to the video system
The video system's API (also known as the xAPI) allows bidirectional
communication with third-party control systems, such as those from
AMX or Crestron. There are multiple ways to access the xAPI:
• Telnet
• SSH
• HTTP/HTTPS
• Ethernet port
• RS-232/serial connection
Regardless of the method you choose, the structure of the xAPI is
the same. Choose the access method that suits your application and
video system the best.
Consult the API guide for your video system to get a full description
of available access methods and how to use the xAPI. Go to
http://www.cisco.com/go/sx-docs for SX Series, or
http://www.cisco.com/go/mx-docs for MX Series
Then, click Reference Guides > Command References to find the API
guides.
API for programming in-room controls
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
15
Communicate over the API
The video system and the control system exchange messages
through the xAPI to make sure that the Touch10 in-room control
panel always reflects the actual status of the room.
The video system sends one or more events when someone uses
one of the controls on the Touch10 in-room control panel, and the
control system should send a command to the video system when
there is a change in the room settings.
Video system
xAPI
Control system
Touch10
Commands
Events
The video system and the control system exchange messages
through the xAPI.
Examples:
• When someone taps a Lights On button on Touch10, 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 Touch10 in-room control panel to
reflect that the light is on.
See the Command reference chapter for an overview of all relevant
events, commands and statuses for in-room control.
Pairing the video system and the control system
You can register the control system as a peripheral that is connected to
the video system.
xCommand Peripherals Connect ID: “ID” Type: ControlSystem
where ID is the unique ID for the control system, typically the MAC
address.
See the API guide for more details about this command, and its options.
The control system must send heartbeats to the video system to let the
video system know that the control system is connected. The control
system stays on the connected devices list (refer to xStatus Peripherals
ConnectedDevice) as long as the video system receives these
heartbeats from the control system.
xCommand Peripherals HeartBeat ID: “ID” [Timeout: Timeout]
where ID is the unique ID for the control system, typically the MAC
address, and Timeout is the number of seconds between each
heartbeat. If Timeout is unspecified, it is assumed to be 60 seconds.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
16
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 included as separate
elements in the XML tree.
How to register:
xfeedback register event/UserInterface/Extensions/Event
How to register:
xfeedback register event/UserInterface/Extensions/Widget
Example:
*e UserInterface Extensions Event Pressed Signal: "WidgetId:Value"
** end
*e UserInterface Extensions Event Changed Signal: "WidgetId:Value"
** end
*e UserInterface Extensions Event Released Signal: "WidgetId:Value"
** end
*e UserInterface Extensions Event Clicked Signal: "WidgetId:Value"
** end
Example:
<Event>
<UserInterface item="1">
<Extensions item="1">
<Widget item="1">
<Action item="1">
<WidgetId item="1">WidgetId</WidgetId>
<Value item="1">Value</Value>
<Ty pe item="1">Type</Type>
</Action>
</Widget>
</Extensions>
</UserInterface>
</Event>
Two event versions that a control system can register to: one suited for terminal output mode, the other for XML output mode
Type of action
Events for widget actions
The video system sends one or more of the following events when
someone uses the controls on the Touch10 in-room control panel:
• Pressed - sent when a widget is first pressed
• Changed - sent when changing a widget's value
(applies to toggle buttons and sliders only)
• Released - sent when a widget is released
(also when moving away from the widget before
releasing)
• Clicked - sent when a widget is clicked
(pressed and released without moving away from the
widget)
These events are sent in two versions.
• UserInterface Extensions Event - suited for terminal output mode
• UserInterface Extensions Widget - suited for XML output mode
See the table below to find out the version best suited for your control
system to register to.
When, and by which widgets (user interface elements), these events
are triggered, are described in the Widgets chapter.
Type of action
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
17
Event for panel update
The video system sends the following event when a new in-room
control panel is applied:
• LayoutUpdated - sent when a new in-room control panel for
Touch10 is exported to the video system
As a response to this event, the control system should send
commands to initialize all widgets so that they reflect the true status
of the room settings.
How to register:
xfeedback register event/UserInterface/Extensions/Widget/
LayoutUpdated
Example:
Terminal output mode:
*e UserInterface Extensions Widget LayoutUpdated
** end
XML output mode:
<Event>
<UserInterface item="1">
<Extensions item="1">
<Widget item="1">
<LayoutUpdated item="1"/>
</Widget>
</Extensions>
</UserInterface>
</Event>
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
18
Commands and Statuses
The SetValue command, which sets the value of a widget, is
essential when working with in-room controls:
xCommand UserInterface Extensions Widget SetValue Value: Value
WidgetId: WidgetId
When the video system receives a SetValue command, the video
system's status and the Touch 10 in-room control panel are updated
accordingly.
It is important that the control system sends
SetValue commands in
the following situations, so that the Touch 10 in-room control panel
truly reflects the status of the room:
• When the control system initially connects to the video system.
• When the video system restarts.
• When the control system restarts.
• When a new in-room control panel is exported to the video
system from the in-room control editor (as response to the
LayoutUpdated event).
• When 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 Touch 10 in-room control
panel.
The control system must also do all that is necessary in the room
to reflect the action on the Touch 10 in-room control panel, for
example switch on the light.
Consult the Widgets chapter for more details about which commands
apply to the different widgets (user interface elements).
Examples
User
Control
system Lights
Video system
with Touch 10
Tap Lights On Pressed and
Released events
for Lights On
widget
Turn lights on
Set the value of
the Lights On
widget to active
The appearance
of the light widget
has changed to
match what the
user can see in
the room
Message flow—turn on the lights using the controls on Touch10
User
Control
system Lights
Video system
with Touch 10
Set the value
of the Lights
On widget to
active
The
appearance
of the light
widget has
changed to
match what
the user can
see in the
room
User
Turn lights
on with wall
control
Signal that
lights are on
Message flow—turn on the lights using the wall control
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
API for in-room control

19
In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
Widgets
Description of the user interface elements and their associated
events and commands
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Widgets

In-Room Control on Touch10
for Cisco TelePresence
MX200 G2, MX300 G2,
MX700, MX800,
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
20
The Widget Identifier
All widgets on a Touch 10 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 WidgetID is the programming link between Touch 10, the video
system, and the control system. The WidgetID will be included in all
events that are associated with a widget, and you must use the same
identifier when you send commands to that widget via the code that
you write for your control system.
Group Identifiers
One of the widgets, the Group button, has two types of identifiers:
The WidgetID refers to the complete group of buttons, while
GroupIDs are unique identifiers for the individual buttons within the
group.
Option 1 Option 2 Option 3
Widget_ID_groupbutton
Group_ID_one Group_ID_two Group_ID_three
A GroupID is assigned automatically, but can be defined by you
instead. A GroupID can be any name or number; we recommend
using a descriptive name without special characters. The maximum
number of characters is 255.
Widgets
The Touch 10 in-room control panel is composed of user interface
elements called widgets. You can find the complete widget library in
the right pane of the in-room control editor.
• General tab: Buttons with custom text, group buttons, toggle
button, sliders, text fields and more.
• Icons tab: Buttons with familiar symbols for Home, Power, Arrow
up/down/left/right, Camera controls, Loudspeaker controls,
Microphone control, Media player controls, and more.
The content of the next few pages describes each widget type, with
emphasis on:
• Commands that change the value of the widget
• Events that are sent (pressed, changed, released, clicked) and
which actions trigger these events
• Examples of commands and events, both in terminal output mode
and XML output mode
Syntax and semantics for all events, commands and statuses that are
related to in-room controls (user interface extensions) are included in
the Command reference chapter.
Table of contents
Introduction
Create a user interface
API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples
Widgets