Cisco MX200G2 Manual page 15

Communicate over the API
Table of contents
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.
Introduction
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
Create a user interface
there is a change in the room settings.
API for in-room control API for in-room control
Widgets
Command reference
Troubleshooting
Tips and tricks
Examples:
• When someone taps a Lights On button on Touch 10, the video
Examples
• When someone switch on the lights in the room, the control
In-Room Control on Touch 10
for Cisco TelePresence
MX200 G2, MX300 G2,
See the
MX700, MX800,
events, commands and statuses for in-room control.
SX10, SX20, SX80
Collaboration Endpoint
software version CE8.2
D15358.02 - JULY 2016
www.cisco.com
© 2016 Cisco Systems, Inc.
All rights reserved.
xAPI
Touch 10
Commands
Video system
Events
The video system and the control system exchange messages
through the xAPI.
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.
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.
Command reference chapter for an overview of all relevant
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
Control system
address, and Timeout is the number of seconds between each
heartbeat. If Timeout is unspecified, it is assumed to be 60 seconds.
15