Xcommand Peripherals Heartbeat; Xcommand Peripherals List; Xcommand Peripherals Pairing Devicediscovery Start; Xcommand Peripherals Pairing Pair - Cisco TelePresence SX20 Codec Reference Manual

Application programming interface (api)
Hide thumbs Also See for TelePresence SX20 Codec:
Table of Contents

Advertisement

Cisco TelePresence SX20 Codec
Introduction

xCommand Peripherals HeartBeat

When a peripheral is registered as a connected device, you can set it to send a heartbeat to the
codec to let the codec know that it is still connected.
This will keep the device on the xStatus Peripherals ConnectedDevice list. If the peripheral is
not set to send a heartbeat, the device will disappear from the list after a while.
Note: Does not apply to cameras.
Requires user role: ADMIN, USER
USAGE:
xCommand Peripherals HeartBeat ID: "ID" [Timeout: Timeout]
where
ID: String (1, 100)
A unique ID for the device you are connecting to, typically a MAC address.
Timeout: Integer (1..65535)
Set how long the device will send heartbeat.

xCommand Peripherals List

Lists all currently and previously connected peripherals.
Requires user role: ADMIN
USAGE:
xCommand Peripherals List [Connected: Connected] [Type: Type]
where
Connected: False/True
Limit the search to currently connected devices.
Type: All/ControlSystem/ISDNLink/Other/TouchPanel
Limit the search by device type.
SX20 Codec API Reference Guide CE8.1, APRIL 2016.
D15316.03
About the API
xConfiguration
xCommand
xCommand

xCommand Peripherals Pairing DeviceDiscovery Start

Start device discovery to detect ISDN Links in the same network.
Requires user role: ADMIN
USAGE:
xCommand Peripherals Pairing DeviceDiscovery Start [AutoPairing: AutoPairing]
[DeviceType: DeviceType] [Timeout: Timeout]
where
AutoPairing: On/Off
You can select to automatically pair the detected device to the endpoint.
DeviceType: ISDNLink
Only look for ISDN Link.
Timeout: Integer (3..60)
Set a maximum time for the search from 3 to 60 seconds.

xCommand Peripherals Pairing Pair

Pair an ISDN Link to an endpoint.
Requires user role: ADMIN
USAGE:
xCommand Peripherals Pairing Pair MacAddress: "MacAddress"
where
MacAddress: String (1, 1450)
Enter the MAC address for the ISDN Link you wish to pair to the endpoint.
108
API Reference Guide
xStatus
Appendices
Copyright © 2016 Cisco Systems, Inc. All rights reserved.

Advertisement

Table of Contents
loading

Table of Contents