`Cisco TelePresence Codecs

This driver controls the Cisco Telepresence Codecs over TCP or Serial connections. See Connection Settings below for more info.

Version 1.0 of this driver was based on API version TC4.0 November 2010, tested on a C40 Codec running software version TC4.0.1.240265. Version 1.1 is based on API TC7.2, tested on an SX80 with software 7.2.1

Release History

1.0 The first release of the driver

1.1 adjusted connect method for newer product, fixed volume commands, added support for the Presentation function, including source selection and screen layout.

1.11 Fixes a startup problem that can prevent the driver from connecting and changes presentation commands to use 'Presentation Sources' rather than 'Connector Numbers'

The remote emulation files have been removed from the API and cannot be used with the newer systems. They remain here for compatability with older devices and files but cannot be used in new programming. When updating older filed to use newer software you will have to replace (re-drag) the older volume commands with the new ones

Config Settings

Connection Settings

TCP Control is not enabled by default in TelePresence units so it must be turned on before the driver can function. The method for doing this is completely different for the different units but is generally accessinble through the units web interface. The TCP connection requires the username and password to be entered in order to establish a connection over the network. If you are using a serial connection this is not required, in fact it must be disabled. The serial connection must have the correct baud rate set in the configuration.

Calls

The driver tracks up to three calls at a time, you can accept, disconnect or suspend any of these calls (individually OR collectively), as well as display it's current state and statistics. Calls can be initiated by dialing from the keypad or calling from the codec’s internal address book, which is displayed as a scrolling list. The driver does not know when the phonebook has been edited though so a command is included to allow you to redownload the current phonebook from the codec.

Cameras

The driver gives PTZ control of both local and far end cameras including allowing you to set and recall camera presets. The range of the camera sliders is dependant on the camera you use so you will probably have to adjust that to make the gauges work.

Preferences

There are a few configuration variables that allow you to change the system without effecting individual calls, these include auto-answer, far end control, do not disturb and mic muting.

Remote Control Emulation (C Series Only)

There is a series of commands that allow emulation of the codec’s IR remote. You can use these when programming a handheld remote where the feedback will all come from the on-screen display. The sample file has these on a page of the touchscreen as a demonstration but they would not normally be used there.

Driver Events

Driver events will be triggered when the codec powers on and off, whenever audio is muted or unmuted, and whenever a camera moves. Events are also triggered by call status; there is an event when the first call goes begins and another when the last call ends. There is another event when an incoming call is detected. Starting in 1.1 there are driver events when Presentation mode is enabled, and anytime the source changes.

Connection Status Variable

A variable is available that will track the connection state of the driver. It is found at the end of the list of text variables and is used on the main page of the K4 in the sample file. The variable has four states: Disconnected, Logging In, Initializing and Online. The variable should progress through these and should normally stay at Online. It is not necessary to use this on a panel; it may be reserved for testing purposes.