Peripherals Commands; Xcommand Peripherals Connect; Xcommand Peripherals Heartbeat; Xcommand Peripherals List - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

Peripherals commands

xCommand Peripherals Connect

Register peripherals that are connected to the codec, such as control systems and touch
panels. The registered peripherals are displayed on the web interface under Configuration >
Peripherals.
This command should be used when the peripheral connects to the codec for the first time
or when the software version on the peripheral has changed. The list of connected devices is
available with the command xStatus Peripherals ConnectedDevice [n] Status.
Requires user role: ADMIN, USER
USAGE:
xCommand Peripherals Connect [HardwareInfo: "HardwareInfo"] ID: "ID" [Name:
"Name"] [NetworkAddress: "NetworkAddress"] [SerialNumber: "SerialNumber"]
[SoftwareInfo: "SoftwareInfo"] Type:
where
: String (0, 100)
HardwareInfo
The device's hardware number.
: String (1, 100)
ID
A unique ID for the device you are connecting to, typically a MAC address.
: String (0, 100)
Name
Define a name for the device.
: String (0, 100)
NetworkAddress
Network address for the device you are connecting to.
: String (0, 100)
SerialNumber
The device's serial number.
: String (0, 100)
SoftwareInfo
Software version the device is running.
: Byod/ControlSystem/Other/TouchPanel
Type
Define the type of device you are connecting to.
SX20 Codec API Reference Guide CE8.3, JANUARY 2017.
D15316.05
About the API xConfiguration
Type
xCommand xCommand

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
: String (1, 100)
ID
A unique ID for the device you are connecting to, typically a MAC address.
: Integer (1..65535)
Timeout
Set how long the device will send heartbeat.

xCommand Peripherals List

Lists all currently and previously connected peripherals.
Requires user role: ADMIN, ROOMCONTROL
USAGE:
xCommand Peripherals List [Connected: Connected] [Type: Type]
where
: False/True
Connected
Limit the search to currently connected devices.
: All/ControlSystem/ISDNLink/Other/TouchPanel
Type
Limit the search by device type.
126
API Reference Guide
xStatus Appendices
Copyright © 2017 Cisco Systems, Inc. All rights reserved.