Api Fundamentals; Connecting To The Api; Password; Rs-232/Serial Connection - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec

Introduction

API fundamentals

This chapter contains a top-level view of the mechanisms
supported by the codec API.
Here you can read about how to access the API, how to use
the command line and what the different parts of the API can
be used for. Information on how to use the feedback functions
that are available for the codec is included in this chapter.
The API consists of four major groups:
• Commands
• Configurations
• Status
• Events
These four groups are hierarchically organized, which makes
it easier to find related functionality. You can find the complete
lists of all commands, configurations and statuses in the
following chapters.
SX20 Codec API Reference Guide CE8.1, APRIL 2016.
D15316.03
About the API About the API xConfiguration

Connecting to the API

There are several ways to access the codec API. Regardless
of which method you choose, the structure of the API stays
the same. Choose the connection method that suites your
application best. Before you start, please read this section
about the different methods, as some of those may require
additional configuration changes before being enabled.
The following configurations, apart from password, can be set
from the System configuration menu on the web interface or
from the command line interface. All of the examples are for
the command line interface.

Password

The video system is delivered with a default user account
with full credentials. The user name is admin, and initially, no
password is set for the default user.
It is mandatory to set a password for the admin user in order to
restrict access to system configuration. You should in addition
set a password for any other user with similar credentials.
You can set the password on the codec's web interface. Open
a web browser and enter the IP address of the video system in
the address bar and log in. Click your user name in the upper
right corner and choose Change password in the drop down
menu.
xCommand

RS-232/serial connection

This is one of the most used connections to our products for
integrators, as it can be used without an IP address, DNS or a
network.
Codec configurations
There are two different configurations that can be changed
for serial connections; the baud-rate and whether login is
required or not. A reboot of the codec is required for these
settings to take effect.
Connecting
For the SX20 codec you need a USB to RS-232 adapter to
connect to the USB port.
NOTE:
•
•
•
23
API Reference Guide
xStatus Appendices
xConfiguration SerialPort BaudRate:
<9600/19200/38400/57600/115200>
xConfiguration SerialPort LoginRequired: <Off/On>
For security reasons the password prompting is turned on
by default, but it can be turned off if preferred.
The default baud rate is set to 38400. The reason for this
is that the codec can give very much feedback. When
using 9600 baud it may cause your integration to appear
sluggish. We therefore recommend keeping the connec-
tion at this speed or higher.
During the initial boot sequence, the codec uses a baud
rate of 38400 regardless of the application baud rate you
have set.
Copyright © 2016 Cisco Systems, Inc. All rights reserved.