Cisco TelePresence Touch10 Manuel utilisateur

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.

In-Room Control Using Touch10

User Interface Extensions, CE9.0, June 2017

What’s In This Document

Introduction

Denition of Terms.......................................................................... 4

In-Room Controls ........................................................................... 5

Creating a User Interface

Creating a User Interface for the Touch10..................................... 7

Launch the In-Room Control Editor................................................ 8

A Tour of the In-Room Control Editor............................................. 9

Application Programming Interface (API)

API for Programming In-Room Controls....................................... 11

Widgets

Overview of Widgets .................................................................... 16

Switch........................................................................................... 17

Slider ............................................................................................ 18

Button ........................................................................................... 19

Group Button ................................................................................ 20

Icon Button ................................................................................... 21

Spinner ......................................................................................... 22

Text............................................................................................... 23

Directional Pad.............................................................................. 24

Spacer .......................................................................................... 25

Command Reference

Events........................................................................................... 27

Commands ................................................................................... 29

Statuses........................................................................................ 30

Use of a Video Switch

Using a 3rd Party Video Switch to Extend the Number

of Video Sources Available........................................................... 32

Command Details ......................................................................... 33

Video Switch Example.................................................................. 34

Troubleshooting

Using the Development Tools on the Web Interface

for Troubleshooting....................................................................... 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 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.

Introduction

With In-Room Control you can add

custom elements to our Touch10

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 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 MX, SX and

DX Series video systems running

Collaboration Endpoint Software,

version CE9.0 or later.

Denition of Terms

Introduction

What Is In-Room Control?

The following terms will be used throughout

this document:

Video 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 name: Cisco TelePresence

Touch10. Also known as Touch10 controller, or

Touch10 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 Touch10.

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 elds, that you can

use to build an in-room control panel for

Touch10 .

To utilize the features of the In-Room

Control you will need a Cisco video

system with a Touch10/DX 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 editor

oers 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 Touch10/DX user interface.

Together, all of this provides a

powerful combination of the control

system’s functionality and the user-

friendly Touch10/DX user interface.

All examples in this document show

Touch10 user cases only, but this

should not cause diculties due

to the high degree og similarity

between the two interfaces..

In-Room Controls

Introduction 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 has its entry icon

in the status bar at the top of

the Touch10/DX display. Once

established, this entry icon is

visible at all times.

• Home panel has its entry icon

located to the right of the buttons

appearing along the bottom of the

Touch10/DX 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

Touch10/DX display. This entry icon

is visible when in a call only.

Video system

Blinds

Climate

Lights

Other...

In-room

control

editor

xAPI

Control system

Touch10

Examples of how customization made by means of In-Room Control may appear on the Touch10, with an icon as shown at

left and the menu appearing when that icon has been tapped, allowing control of lights and blinds, as shown at right.

In-Room Control schematics

Creating a User Interface

The editor that you launch from the

video system’s web interface and

the oine editor share the same

le format, so les created in one

version can be opened and modied

in the other.

Creating a User Interface for the Touch10

Creating a User Interface

Shared le format

Use the in-room control editor to create customized panels for peripheral controls on the video system’s Touch10/DX 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 Touch10/

DX, 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 Touch10/DX.

Oine

There are two places you can download the oine 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 oine editor, extract the les from the

downloaded zip-le. Retain the folder structure.

When using the oine editor you will be working with les, rather than

communicating directly with the video system and Touch10/DX. Apart

from this, the oine editor has full functionality.

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

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

Launch the In-Room Control Editor

Creating a User Interface

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.

Oine version. If you are using the oine version of

the editor, use a browser to open the index.html le

that you nd in the rceditor folder.

With no panels already dened, the user interface will

look as shown at right.

Click on as indicated by the text Add your rst

panel.

The rst 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.

Create new panel from here

If you want to assign the

panel to a dierent location,

this is done here.

Note that you cannot have

more than one panel per

location

Undo, Redo and

Export conguration

to video system

A Tour of the In-Room Control Editor

Creating a User Interface

The Directional pad (New!) can be

used to control e.g. Apple TV

The spacer (New!) helps you get a

better layout

The icon chosen here

will be the one that

appears on the In-Room

Control button for that

panel on the Touch10

display

Example of a page not yet

populated— in this case

the very rst page of the

Home panel with a single

unpopulated row

Add a new row to the

page here

ID is used to refer to

a widget.

Text is what appears

on the Touch10

Tip! In addition to clicking

the Undo and Redo icons,

you may also use the

familiar keyboard shortcut

commands to copy and

paste (Ctrl c & Ctrl v /

Cmd c & Cmd v)

Once you start

to populate a

page of a panel,

the widget IDs in

use will appear

here to provide

a simpler

overview.

Clicking 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 elements known as widgets.

The maximum number of pages per panel is 50.

Widgets are arranged in a four-column grid. The widgets are

placed into the grid according to the following rules:

• A widget lls between one and four columns depending on

its size.

• Rows are right-aligned.

• If you add more widgets than t in one line, widgets wrap

to a new line within the same row.

The properties panel will

display settings for any part

selected/highlighted with the

yellow frame. Selection can be

Panel, Page, Row or Widget.

This controls the width

of a widget. Width sizes

available depends on

widget type

The Widget IDs shown

here belong to the active

panel (shown with a blue

background).

Add a new page to the

current panel here

The panel name will appear

on the Touch10 together

with the In-Room Control

button for that panel

Drag widgets

onto the page to

populate it

Page properties are

accessed by clicking here.

options

Yellow frame

Application Programming Interface (API)

Autres manuels pour TelePresence Touch10

Table des matières

Autres manuels Cisco Unité de contrôle

Cisco

Cisco HPNA Manuel utilisateur

Cisco

Cisco NCS 1010 Feuille d'instructions

Cisco

Cisco MGX RPM-XF Manuel utilisateur

Cisco

Cisco ONS 15200 Manuel utilisateur

Cisco

Cisco TelePresence MCU 4500 Series Manuel utilisateur

Cisco

Cisco 6015 Manuel d'utilisation et d'entretien

Cisco

Cisco TelePresence Touch10 Manuel utilisateur

Cisco

Cisco NM-1CT1 Guide de démarrage rapide

Cisco

Cisco FlexWAN Manuel utilisateur

Cisco

Cisco Catalyst 5000 Series Manuel utilisateur

Cisco

Cisco LightStream 1010 Guide de démarrage rapide

Cisco

Cisco NM-1E2W Guide de démarrage rapide

Cisco

Cisco 3110 Manuel utilisateur

Cisco

Cisco Catalyst WS-X3001 Manuel de l'opérateur

Cisco

Cisco WS-SVC-ASA-SM1-K7 Manuel d'installation et d'exploitation

Cisco

Cisco PA-VXA Series Instructions d'utilisation et d'entretien

Cisco

Cisco SCE8000 GBE Manuel utilisateur

Cisco

Cisco TelePresence MCU 4200 Series Manuel utilisateur

Cisco

Cisco MEM-NP8F Series Guide de démarrage rapide

Cisco

Cisco ATUC-4DMT-ISDN Instructions d'utilisation et d'entretien

Cisco

Cisco EHWIC-3G-EVDO Manuel utilisateur

Cisco

Cisco GS7000 Mode d'emploi

Cisco

Cisco GS7000 Manuel de l'opérateur

Cisco

Cisco C3850-NM-4-1G Mode d’emploi

Manuels Unité de contrôle populaires d'autres marques

Festo

Festo Compact Performance CP-FB6-E Manuel de la liste des pièces

Elo TouchSystems

Elo TouchSystems DMS-SA19P-EXTME Manuel utilisateur

JS Automation

JS Automation MPC3034A Manuel utilisateur

JAUDT

JAUDT SW GII 6406 Series Guide rapide

Spektrum

Spektrum Air Module System Manuel utilisateur

BOC Edwards

BOC Edwards Q Series Manuel utilisateur

KHADAS

KHADAS BT Magic Manuel utilisateur

Etherma

Etherma eNEXHO-IL Manuel utilisateur

PMFoundations

PMFoundations Attenuverter Manuel utilisateur

GEA

GEA VARIVENT Manuel utilisateur

Walther Systemtechnik

Walther Systemtechnik VMS-05 Manuel utilisateur

Altronix

Altronix LINQ8PD Instructions de montage

Eaton

Eaton Powerware Series Manuel utilisateur

WAGO

WAGO 750-407/040-000 Manuel utilisateur

Sony

Sony CCU-590 Manuel utilisateur

Graco

Graco 25D614 Manuel utilisateur

Task Force Tips

Task Force Tips YE-RF-900 Manuel de programmation

Shini

Shini SPV-U Series Manuel utilisateur