Download  Print this page

Advertisement

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

Advertisement

Table of Contents

   Also See for Cisco MX300G2

   Summary of Contents for Cisco MX300G2

  • Page 1 Touch 10 User Interface Extensions CE8.1 D15358.01 APRIL 2016 D15358.01 APRIL 2016 Collaboration Endpoint software Collaboration Endpoint software version 8.1 version 8.1 © 2016 Cisco Systems, Inc. © 2016 Cisco Systems, Inc. APRIL 2016 All rights reserved. All rights reserved.
  • Page 2 Cisco TelePresence systems are available at Widgets ......................20 http://www.cisco.com/go/telepresence/docs Command reference The widget identifier ...................20 Toggle button ....................21 We recommend that you visit the Cisco web site regularly for Slider ......................22 updated versions of this guide. Troubleshooting Spinner .......................23 Button with custom text ................24 Tips and tricks Button with symbol ..................25...
  • Page 3 Table of contents Introduction Introduction Introduction Create a user interface API for in-room control Widgets Command reference Troubleshooting Tips and tricks Examples Introduction D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 4 SX Series that runs Collaboration Endpoint Software, version CE8.1 or later. Sometimes referred to as video device. Since both the Cisco video system and the other peripherals are controlled from Create a user interface the Touch 10 user interface, you get a consistent user experience throughout the meeting room.
  • Page 5 In-room controls Table of contents You need a Cisco video system with a Touch 10 user interface, and a third- In-room control icon party control system, for example Crestron, AMX, Apple HomeKit, or Android. (entry icon) Introduction Introduction The video system's API, referred to as the xAPI, is the link between the video system and the control system.
  • Page 6 Tips and tricks Examples Create a user interface Use the in-room control editor to create the user interface and to apply it to the video system D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 7 Export new in-room control panel to file Offline in-room control editor In-room control editor launched from the video system's web interface D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 8 (codec) Tutorial on how to use the editor Link to online guides Widget library D15358.01 APRIL 2016 The in-room control editor Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 9 Troubleshooting Tips and tricks Examples Start or continue the design of an in-room control panel D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 10 Four-column grid Design panel Widget library D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 The in-room control editor. Widgets from the widget library are placed in a four-column grid. © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 11 Drag a page, row, or widget, and drop it in its new text. Command reference position. Drop it outside the design panel to delete it. Troubleshooting Tips and tricks Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 12 Settings in the editor. If you change to the other icon, you have to export the in-room control panel to the video system again. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 13 API for in-room control API for in-room control API for in-room control Widgets Command reference Troubleshooting Tips and tricks Examples API for in-room control D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 14 Go to Examples 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. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 15 Touch 10 in-room control panel to reflect that the light is on. Consult the Command reference chapter for an overview of all relevant events, commands and statuses for in-room control. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 16 </UserInterface> </Event> Two event versions that a control system can register to: one suited for terminal output mode, the other for XML output mode D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 17 *e UserInterface Extensions Widget LayoutUpdated ** end Troubleshooting XML output mode: <Event> Tips and tricks <UserInterface item="1"> <Extensions item="1"> <Widget item="1"> Examples <LayoutUpdated item="1"/> </Widget> </Extensions> </UserInterface> </Event> D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 18 Message flow - turn on the lights using the wall control D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 19 API for in-room control Widgets Widgets Widgets Command reference Troubleshooting Tips and tricks Examples Widgets Description of the user interface elements and their associated events and commands D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 20 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. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 21 However, the control system must always send a command to the SetValue Collaboration Endpoint software WidgetId: "togglebutton" Value: "on" version 8.1 video system when the button toggles between on and off. This ensures that © 2016 Cisco Systems, Inc. the status is updated accordingly. All rights reserved.
  • Page 22 However, the control system must always send a command to the SetValue Collaboration Endpoint software Value: "98" version 8.1 video system to tell the new position of the slider. This ensures that the status is © 2016 Cisco Systems, Inc. updated accordingly. All rights reserved.
  • Page 23 Use the command to add or update the text between the two SetValue D15358.01 APRIL 2016 buttons. Collaboration Endpoint software xCommand UserInterface Extensions Widget SetValue WidgetId: "spinner" version 8.1 Value: "22" © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 24 D15358.01 APRIL 2016 xCommand UserInterface Extensions Widget SetValue WidgetId: "button" A value of will highlight the button, and a value of will "active" "inactive" Collaboration Endpoint software Value: "active" version 8.1 release it. © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 25 D15358.01 APRIL 2016 xCommand UserInterface Extensions Widget SetValue WidgetId: "symbol" A value of will highlight the button, and a value of will "active" "inactive" Collaboration Endpoint software Value: "active" version 8.1 release it. © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 26 UserInterface Extensions Widget UnsetValue Collaboration Endpoint software version 8.1 WidgetId: "groupbutton" Use the command to release all buttons in the group so that no UnSetValue © 2016 Cisco Systems, Inc. button is highlighted. All rights reserved.
  • Page 27 Use the command to set the text in the text box. SetValue xCommand UserInterface Extensions Widget SetValue WidgetId: "textbox" Value: "The projector is warming up." D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 28 Command reference Troubleshooting Tips and tricks Examples Command reference Syntax and semantics for events, commands, and statuses, that are used with the user interface extensions D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 29: Table Of Contents

    UserInterface Extensions List ..............32 Troubleshooting Statuses ......................33 UserInterface Extensions Widget [n] WidgetId ..........33 Tips and tricks UserInterface Extensions Widget [n] Value ..........33 Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 30: Events

    <Value> widget type. is the value of the widget. The range of allowed values depends on the widget type. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 31: Userinterface Extensions Widget Action

    Clicked: Sent when a widget is clicked (pressed and released without moving the finger out of the widget). D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 32: Commands

    USAGE: xCommand UserInterface Extensions Widget UnsetValue WidgetId: WidgetId where : String (0, 40) WidgetId The unique identifier for the widget. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 33: 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 D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 34 Create a user interface API for in-room control Widgets Command reference Troubleshooting Troubleshooting Troubleshooting Tips and tricks Examples Troubleshooting Help to identify the source of an error D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 35 SetValue is sent from a real control system, or from the Update Value column. D15358.01 APRIL 2016 Collaboration Endpoint software Send command version 8.1 Widget status to update widget © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 36 API for in-room control Widgets Command reference Events Troubleshooting Troubleshooting Tips and tricks Status Widget ID Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 37 Create a user interface API for in-room control Widgets Command reference Troubleshooting Tips and tricks Tips and tricks Tips and tricks Examples Tips and tricks D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 38 The control system must always send the dimmer value back to the video system using the command. SetValue D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 39 Launch the in-room control editor from the video system's web interface. b. Click Settings. Tips and tricks Tips and tricks c. Click the Delete icon in the Remove configuration section. Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 40 Create a user interface API for in-room control Widgets Command reference Troubleshooting Tips and tricks Examples Examples Examples Examples For inspiration and guidance on best practices D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 41 Create a user interface Tabs API for in-room control Widgets Command reference Troubleshooting Tips and tricks Examples Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 42 D15358.01 APRIL 2016 • If the lights are changed away from a preset, for instance by changing a Collaboration Endpoint software slider or toggle button, unselect all options in the group button. version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 43 They do not stop until all the way up or down. • Short press any button in order to stop the movement after a long press. Then no separate stop button is necessary. D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 44 Create a user interface API for in-room control Widgets Command reference Troubleshooting Tips and tricks Examples Examples D15358.01 APRIL 2016 Collaboration Endpoint software version 8.1 © 2016 Cisco Systems, Inc. All rights reserved.
  • Page 45 Troubleshooting WITH ALL FAULTS. CISCO AND THE ABOVE- NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT On our web site you will find an overview of the worldwide Cisco contacts. LIMITATION, THOSE MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND Go to: http://www.cisco.com/go/offices...

This manual is also suitable for:

Mx800Mx700Mx200g2Sx10Sx20Sx80

Comments to this Manuals

Symbols: 0
Latest comments: