Cisco Touch10 Manual

Cisco Touch10 Manual

In-room control
Hide thumbs Also See for Touch10:

Advertisement

Quick Links

In-Room Control Using Touch10
D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved
D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved
User Interface Extensions, CE9.0, June 2017
1
With In-Room Control you can add
custom elements to your Touch10
and DX Series user interface. Such
user interface extensions may be
controls for lights or blinds, or
other peripherals (including one or
more video switches to extend the
number of video sources available),
all controlled 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.0 or later.

Advertisement

Table of Contents
loading

Summary of Contents for Cisco Touch10

  • Page 1 User Interface Extensions, CE9.0, June 2017 D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 2: Table Of Contents

    If you use SSH to log into the codec, only a very limited set of the API will be accessible. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 3 Introduction D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 4: Introduction

    MX, SX and DX Series video systems running Collaboration Endpoint Software, version CE9.0 or later. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 5: In-Room Controls

    The simple drag-and-drop editor in the status bar at the top of Examples of how customization made by means of In-Room Control may appear on the Touch10, with an icon as shown at offers a library of user interface left and the menu appearing when that icon has been tapped, allowing control of lights and blinds, as shown at right.
  • Page 6: Creating A User Interface

    Creating a User Interface D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 7: Creating A User Interface For The Touch10

    Offline in-room control editor control editor Export new in-room control panel to file In-room control editor launched from the video system's web interface D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 8: Launch The In-Room Control Editor

    The first panel will be of the Home panel type (see the previous pages for more on this). You can change this — see the next page for more. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 9: A Tour Of The In-Room Control Editor

    The spacer (New!) helps you get a The maximum number of pages per panel is 50. better layout D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 10: Application Programming Interface (Api)

    Application Programming Interface (API) D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 11: Api For Programming In-Room Controls

    See the Command reference chapter for an overview of all relevant events, commands and statuses for in-room control. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 12 Two event versions that a control system can register to: one suited for terminal output mode, the other for XML output mode these events are triggered, are described in the Widgets chapter. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 13 (off) the AppleTV box for you. <Extensions item=”1”> <Widget item=”1”> <LayoutUpdated item=”1”/> </Widget> </Extensions> </UserInterface> </Event> D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 14 Consult the Widgets chapter for more details about Message flow—turn on the lights using the wall control which commands apply to the different widgets (user interface elements). D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 15: Widgets

    Widgets D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 16: Overview Of Widgets

    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. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 17: Switch

    SetValue command to the video system when the button toggles between on and off. This ensures that the status is updated accordingly. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 18: Slider

    SetValue command to the video system to tell the new position of the slider. This ensures that the status is updated accordingly. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 19: Button

    UserInterface Extensions Widget SetValue WidgetId: “button” Value: “active” user interface. A value of “active” will highlight the button, and a value of “inactive” will release it. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 20: Group Button

    UserInterface Extensions Widget UnsetValue UnSetValue WidgetId: “groupbutton” Use the command to release all buttons in the group so that no button is highlighted. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 21: Icon Button

    UserInterface Extensions Widget SetValue WidgetId: “symbol” will highlight the button, and a value Value: “active” inactive of “ ” will release it. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 22: Spinner

    UserInterface Extensions Widget SetValue WidgetId: “spinner” Value: “22” D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 23: Text

    “The projector is warming up.” . xCommand UserInterface Extensions Widget SetValue WidgetId: “textbox” Value: “The projector is warming up.” D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 24: Directional Pad

    Example of use: Controlling AppleTV <Widget item=”1”> <Action item=”1”> <WidgetId item=”1”>dirpad:up</WidgetId> <Value item=”1”></Value> <Type item=”1”>clicked</Type> </Action> </Widget> </Extensions> </UserInterface> </Event> D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 25: Spacer

    The Spacer is no more than a layout tool. Consequently, there are no as a vertical spacer, as well. events or commands associated with it. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 26: Command Reference

    Command Reference D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 27: Events

    <Value> is the value of the widget. The range of allowed values depends on the widget type. allowed values depends on the widget type. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 28 Clicked: Sent when a widget is clicked (pressed and released </Event> <Value item=”1”>Value</Value> without moving the finger out of the widget). <Type item=”1”>Type</Type> </Action> </Widget> </Extensions> </UserInterface> </Event> D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 29: Commands

    The value of the widget. The range of values depends on the widget type. USAGE: WidgetId : String (0, 40) xCommand UserInterface Extensions List The unique identifier for the widget. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 30: Statuses

    *s UserInterface Extensions Widget 5 WidgetId: “groupbutton” *s UserInterface Extensions Widget 6 Value: “Projector is ready” *s UserInterface Extensions Widget 6 WidgetId: “textfield” ** end D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 31: Use Of A Video Switch

    Use of a Video Switch D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 32: Using A 3Rd Party Video Switch To Extend The Number Of Video Sources Available

    (PC, Cameras, DVD, Document Camera, Apple TV, Chromecast etc) when selecting or setting state — see the following pages for more on this. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 33: Command Details

    SourceIdentifier SourceIdentifier: in which: SourceIdentifier is a unique string ID used to identify this source when selecting or setting state. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 34: Video Switch Example

    *e UserInterface Presentation ExternalSource Selected SourceIdentifier: “appletv” The Controller should listen to this event and display the selected source. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 35: Troubleshooting

    Troubleshooting D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 36: Using The Development Tools On The Web Interface For Troubleshooting

    Current Value column always shows the current status, regardless of whether the SetValue command is sent from a real control system, or from the Update Value column. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 37: Tips And Tricks

    Tips and Tricks D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 38: Recommended Best Practice

    This applies also when the change is triggered D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 39 • Set the toggle button to off when the user moves the slider to If tilted all the way, move the blinds up or down incrementally its minimum D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 40: Granting Access To In-Room Control Editor And Extensions Api

    If you use SSH to log into the codec, only a very limited set of the API will be accessible. D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 41: Room Simulator

    Room Simulator D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 42: Running The Simulator

    To invoke the simulator navigate to Integration > In-Room Control in the web interface and then select Launch Simulator: D1535805 User Guide In-Room Control for Touch10. Produced June 2017 for CE9.0. © 2015–2017 Cisco Systems, Inc. All rights reserved...
  • Page 43 Cisco has more than 200 offices worldwide. Addresses, phone numbers, and fax numbers are listed on the Cisco website at www.cisco.com/go/offices. Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and other countries. To view a list of Cisco trademarks, go to this URL: www.cisco.com/ go/trademarks.

Table of Contents