Cisco Room Devices Driver 4.

GENERAL INFORMATION
SIMPLWINDOWS NAME: Cisco Room Devices 4.0

CATEGORY: Conferencing

v. 3.0 – Release
v. 3.1 – Feature additions & bug fixes
v. 3.2 – Feature additions & bug fixes
v 3.2.1 – Bug fixes
VERSION: v 3.2.3 – Feature additions & bug fixes
v 3.2.4 – Feature additions & bug fixes
v 3.3 – Bug fixes
v 3.4 – Updated AddressBook reference & fixes for international characters
v 4.0 – Updated for Newtonsoft v4.0.8.0

VERSION DATE: 3/9/2020

DESCRIPTION: Used to control a Cisco room device

Database Version Requirements

This module requires v200 or newer of the Crestron database. It will not work with
older versions.
How communication operates

This module can be used on a COM port or it can use SSH. Only one type may be
used at run-time. The socket connections are handled internally. No prior
initialization is required by the programmer – the module will begin communicating
with the codec once the signal Connect has a rising edge regardless of the transport
used.
SSH has two modes: Secure and Unsecure. Unsecure mode auto-accepts a
connection while Secure mode will check a file of host key fingerprints before
sending any sensitive data. This file is stored in \NVRAM\CiscoSxCodec\ and is a
JSON formatted List<string> collection.
The module outputs a connection state on all three types of transports. The
LoggedIn state (4d) should be used to buffer any commands that need to be sent
once the system is logged in and ready to process commands. Any commands
triggered before being logged in will be ignored.

GENERAL NOTES: Each transport connection has a digital output that specifies if the module is busy
processing data received from the codec. When the module initially connects to the
device it will request a lot of information from the codec depending on the settings
on the module. The programmer can enable/disable initial phonebook requests, call
history requests, and booking requests. All other sections are automatically polled at
the start. Depending on these settings and the transport used, it may take several
minutes until the module is complete with initialization.

How the phonebook operates

-Download as needed:
The first 500 entries (or all entries depending on the download settings) are
downloaded initially either by the user or as a programmed function. The module will
only output 10 entries using an XSIG signal. To view all entries the programmer
must use the signals Navigate Up/Down Page to see more entries.

The module will keep downloading entries so that the 10 entries are always
populated as long as there are entries on the codec. The internal code will make sure
there is a buffer of at least 5 pages before requesting more.
This same logic is used on folders and on searches with a search parameter.

Support for the Address Book smart object is disabled with this setting.
 Cisco Room Devices Driver 4.0
Support for setting the number of contacts to display a time is disabled with this
setting.

-Download All
All entries are retrieved from the phonebook using a recursive search.
Support for the Address Book smart object is enabled with this setting.
Support for setting the number of contacts to display a time is enabled with this
setting.

To support international characters on any XSIG output, the following must be done:
1. Route XSIG <aout[n]> to symbol “ToAscii” with the convert method set to “Pass
Thru Mark As ASCII”.

2. Route ToAscii outputs to symbol “ToUtf16” with the convert method set to
“Standard Order”

3. Use the output of “ToUtf16” for displaying strings in the SIMPL Windows
application.

How the call system works

A call is divided into three main types: Incoming, Outgoing, and Connected
-Any call dialed will be available as an Outgoing call until it is connected.
-Any call incoming will be available as an Incoming call until it is connected.

Only 5 concurrent calls within each section are supported. Calls will automatically
move up in index as other calls are removed.

Props on the Address Book Smart Object:

The property names will be:
-“callRate”
-“callType”
-“number”

CRESTRON HARDWARE REQUIRED: 3 Series Processor

Cisco TelePresence Software tested TC 7.3, CE 8.3.4, CE 9.1.X through CE 9.7.X

versions

1. Only supports Microphones 1 & 2

2. Only supports Camera 1
Cisco TelePresence SX-10
3. Only supports video input connectors 1, 2, & 3
4. Only supports video output connector 1

1. Only supports Microphones 1 & 2

2. Only supports Camera 1
Cisco TelePresence SX-20
3. Only supports video input connectors 1 & 2
4. Only supports video output connectors 1 & 2

Cisco TelePresence SX-80 All features should be supported that are exposed by this module

1. Only supports Microphones 1 & 2

2. Only supports Camera 1
Cisco TelePresence MX200 G2
3. Only supports video input connectors 1 & 2
4. Only supports video output connector 1
 Cisco Room Devices Driver 4.0

1. Only supports Microphones 1 & 2

2. Only supports Camera 1
Cisco TelePresence MX300 G2
3. Only supports video input connectors 1 & 2
4. Only supports video output connector 1

1. Only supports Camera 1 & 2

Cisco TelePresence MX700 2. Only supports video input connector 1
3. Only supports video output connector 1

1. Only supports Camera 1 & 2

Cisco TelePresence MX800 2. Only supports video input connector 1
3. Only supports video output connector 1

1. Only supports Microphone 1

2. Only supports Camera 1
Cisco DX80
3. Only supports video input connector 1
4. Does not support video output connectors

1. Only supports Microphone 1

2. Only supports Camera 1
Cisco DX70
3. Only supports video input connector 1
4. Does not support video output connectors

1. Only supports Microphones 1, 2, & 3

2. Only supports Camera 1
Cisco Webex Room 55
3. Only supports video input connectors 1 & 2
4. Only supports video output connector 1

1. Only supports Microphones 1, 2, & 3

2. Only supports Camera 1
Cisco Webex Room 70
3. Only supports video input connectors 1, 2, & 3
4. Only supports video output connectors 1 & 2

1. Only supports Microphones 1, 2, & 3

2. Only supports Camera 1
Cisco Webex Room Kit
3. Only supports video input connector 1, 2, & 3
4. Only supports video output connector 1 & 2

1. Only supports Microphones 1, 2, & 3

2. Only supports Camera 1
Cisco Webex Room Kit Plus
3. Only supports video input connector 1, 2, & 3
4. Only supports video output connector 1 & 2
 Cisco Room Devices Driver 4.0

CONTROL - LOCAL & CORPORATE PHONEBOOK:

If enabled, once the system gets into a logged-in state it will use the
LocalPhonebook_EnableInitialPoll
D functionality provided by <PhonebookType>_Request. If disabled, the
CorporatePhonebook_EnableInitialPoll
user/programmer are required to pulse <PhonebookType>_Request.

Download As Needed – Requests the first 500 entries of the phonebook in

LocalPhonebook_Request the root directory.
D
CorporatePhonebook_Request Download All – Requests all the entries in the phonebook including all
folders.

LocalPhonebook_Search Requests the first 500 entries of the phonebook in any directory that
D
CorporatePhonebook_Search match the SearchString specified.

LocalPhonebook_SearchString
CorporatePhonebook_SearchString S Used to specify the search parameters of a phonebook search.

LocalPhonebook_SelectEntry Selects an entry in the phonebook.

A
CorporatePhonebook_SelectEntry Valid values are 1 - 10

Selects a contact method that is associated with the currently selected

LocalPhonebook_SelectContactMethod entry.
A
CorporatePhonebook_SelectContactMethod
Valid values are 1 - 5

LocalPhonebook_ClearSelectedEntry
D Clears all feedback on the currently selected entry.
CorporatePhonebook_ClearSelectedEntry

LocalPhonebook_DialSelected Dials the currently selected entry with either the first available contact
D
CorporatePhonebook_DialSelected method if one is not specified or the specified contact method.

LocalPhonebook_NavigateToPreviousDirectory
D Navigates the phonebook to the parent folder of the current folder.
CorporatePhonebook_NavigateToPreviousDirectory

LocalPhonebook_NavigateToRootDirectory
D Navigates the phonebook to the root folder.
CorporatePhonebook_NavigateToRootDirectory

Navigates the phonebook down one page. There are a total of 50 pages
with 10 items on each page.
LocalPhonebook_NavigateDownPage
D As the user navigates through the pages, the internal code will keep
CorporatePhonebook_NavigateDownPage
requesting and removing entries to allow for navigation through all entries
in the phonebook, not limited by the original 500 entries downloaded when
RequestPhonebook is pulsed.

LocalPhonebook_NavigateUpPage
D Navigates the phonebook up one page.
CorporatePhonebook_NavigateUpPage
 Cisco Room Devices Driver 4.0

FEEDBACK - LOCAL & CORPORATE PHONEBOOK:

The current status of the phonebook. This will specify if a
LocalPhonebook_Status download is taking place, how many entries are downloading, and
S
CorporatePhonebook_Status how many entries were found in a download. The will also display
any errors with a search.

LocalPhonebook_DownloadState 1 = Downloading
A
CorporatePhonebook_DownloadState 2 = Download Complete

LocalPhonebook_NumberOfEntries Specifies the number of entries in the current selected page.

A
CorporatePhonebook_NumberOfEntries Values are 1-10

LocalPhonebook_Entries_XSIG XSIG containing up to 10 entry names for the current selected

S
CorporatePhonebook_Entries_XSIG page.

LocalPhonebook_Selected_NumberOfContactMethods Specifies the number of contact methods for a selected entry.

A
CorporatePhonebook_Selected_NumberOfContactMethods Values are 1 - 5

LocalPhonebook_Selected_ContactMethods_XSIG
S XSIG containing up to 5 contact methods for the selected entry.
CorporatePhonebook_Selected_ContactMethods_XSIG

LocalPhonebook_CurrentFolder
S Specifies the current folder the phonebook is displaying.
CorporatePhonebook_CurrentFolder

LocalPhonebook_Selected_Name
S Specifies the Name field of the currently selected entry.
CorporatePhonebook_Selected_Name

LocalPhonebook_Selected_Title
S Specifies the Title field of the currently selected entry.
CorporatePhonebook_Selected_Title

Specifies the Number field of the currently selected entry and

LocalPhonebook_Selected_Number
S contact method. This will be the first available option if one is not
CorporatePhonebook_Selected_Number
selected.

LocalPhonebook_Selected_Device
S Specifies the Device field of the currently selected entry.
CorporatePhonebook_Selected_Device

Specifies the Protocol field of the currently selected entry and

LocalPhonebook_Selected_Protocol
S contact method. This will be the first available option if one is not
CorporatePhonebook_Selected_Protocol
selected.

Specifies the CallRate field of the currently selected entry and

LocalPhonebook_Selected_CallRate contact method. This will be the first available option if one is not
S selected.
CorporatePhonebook_Selected_CallRate
 Cisco Room Devices Driver 4.0

FEEDBACK - LOCAL & CORPORATE PHONEBOOK:

Specifies the CallType field of the currently selected entry and
LocalPhonebook_Selected_CallType
S contact method. This will be the first available option if one is not
CorporatePhonebook_Selected_CallType
selected.
 Cisco Room Devices Driver 4.0

CONTROL – NEAR END CAMERAS:

This will request a list of camera presets currently available on the
NearEnd_RequestPresets D
codec.

NearEnd_SelectCamera A Determines which camera will be controlled.

NearEnd_ResetPosition D Resets the position of the selected camera.

NearEnd_PanLeft D Pan Left operation on the selected camera.

NearEnd_PanRight D Pan Right operation on the selected camera.

NearEnd_TiltUp D Tilt Up operation on the selected camera.

NearEnd_TiltDown D Tilt Down operation on the selected camera.

NearEnd_ZoomIn D Zoom In operation on the selected camera.

NearEnd_ZoomOut D Zoom Out operation on the selected camera.

NearEnd_FocusNear D Focus Near operation on the selected camera.

NearEnd_FocusFar D Focus Far operation on the selected camera.

NearEnd_AutoFocus D AutoFocus operation on the selected camera.

Sets the Brightness Mode of the selected camera.

NearEnd_BrightnessMode A Valid values:

1 – Auto
2 – Manual

Sets the default brightness level of the selected camera. This will
NearEnd_BrightnessLevel A only be used when NearEnd_BrightnessMode is set to Manual but
the value can still be altered regardless of the current state.

NearEnd_SelectPreset A Selects a camera preset on the selected camera.

NearEnd_ActivateSelectedPreset D Activates the selected camera preset.

Saves the current camera position as the currently selected preset.

NearEnd_SaveSettingsAsCurrentPreset D
If the preset is not defined then this will not be saved.

NearEnd_RemoveSelectedPreset D Removes the selected preset from the selected camera.

Adds a new preset to the selected camera with the name

NearEnd_AddNewPreset D NearEnd_NewPresetName. This will use the current camera’s
position.

Specifies the name of any new preset that would be added by

NearEnd_NewPresetName S
NearEnd_AddNewPreset.
 Cisco Room Devices Driver 4.0

FEEDBACK – NEAR END CAMERAS:

NearEnd_NumberOfCameras A The number of cameras the module supports.

NearEnd_CameraNames_XSIG S The names of all the cameras.

NearEnd_CurrentPresetSaved D This signal will pulse when a preset is successfully saved.

NearEnd_NumberOfPresets A The number of presets for the currently selected camera.

NearEnd_PresetNames_XSIG S The names of the presets for the currently selected camera.

CONTROL – FAR END CAMERAS:

Selects a connected call for camera control.
All camera controls are per-call.
A
FarEnd_SelectCall

Valid values: 1- 5

FarEnd_PanLeft D Performs the Pan Left operation on the selected call’s camera.

FarEnd_PanRight D Performs the Pan Right operation on the selected call’s camera.

FarEnd_TiltUp D Performs the Tilt Up operation on the selected call’s camera.

FarEnd_TiltDown D Performs the Tilt Down operation on the selected call’s camera.

FarEnd_ZoomIn D Performs the Zoom In operation on the selected call’s camera.

FarEnd_ZoomOut D Performs the Zoom Out operation on the selected call’s camera.

Selects a source on the selected call.

FarEnd_SelectSource A
Valid values: 0 – 15 where 0 = No source and 15 = Source 15

Activates a room preset on the selected call (This must be enabled

FarEnd_SelectPreset A on the far end to function).
Valid values: 1 - 15
 Cisco Room Devices Driver 4.0

CONTROL – CALL CONTROL:

Answer All D Answers all incoming calls.

Answer[1] - Answer[5] D Answers the selected incoming call.

RejectAll D Rejects all incoming calls.

Reject[1] - Reject[5] D Rejects the selected incoming call.

HangUpAll D Hangs up all connected & outgoing calls.

HangUpConnectedCall[ [1] - HangUpConnectedCall[ [5] D Hangs up the selected connected call.

HangUpOutgoingCall[1] - HangUpOutgoingCall[5] D Hangs up the selected outgoing call.

HoldAll D Puts all connected calls on hold.

Hold[1] - Hold[5] D Puts the selected connected call on hold.

ResumeAll D Resumes all connected calls on hold

Resume[1] - Resume[5] D Resumes the selected connected call on hold

Ignore All D Ignores all incoming calls.

Ignore[1] - Ignore[5] D Ignores the selected incoming call.

Join All D Joins all connected calls.

Transfer[1] - Transfer[5] D Transfers the selected connected call to the TransferDestination.

TransferDestination S The URI that should be used when transferring a connected call.
 Cisco Room Devices Driver 4.0

FEEDBACK – INCOMING CALL STATUS:

IncomingCall[1] - IncomingCall[5] D Specifies if there is an incoming call.

IncomingCall_Number[1] - IncomingCall_Number[5] S The number of the incoming call(s).

IncomingCall_DisplayName[1] to
S The display name of the incoming call(s).
IncomingCall_DisplayName[5]

IncomingCall_Status[1] - IncomingCall_Status[5] S The status of the incoming call(s).

IncomingCall_CallType[1] - IncomingCall_CallType[5] S The call type of the incoming call(s).

FEEDBACK – CONNECTED CALL STATUS:

ConnectedCall_IsActive[1] - ConnectedCall_IsActive[5] S Specifies if there is a connected call

ConnectedCall_Number[1] - ConnectedCall_Number[5] S The number of the connected call(s).

ConnectedCall_DisplayName[1] to
S The display name of the connected call(s).
ConnectedCall_DisplayName[5]

ConnectedCall_Status[1] - ConnectedCall_Status[5] S The status of the connected call(s).

ConnectedCall_CallType[1] - ConnectedCall_CallType[5] S The call type of the connected call(s).

ConnectedCall_OnHold[1] - ConnectedCall_OnHold[5] D Specifies if a connected call is on hold.

FEEDBACK – OUTGOING CALL STATUS:

Specifies if there is an outgoing call. Any calls dialed on the Touch
OutgoingCallIsActive[1] - OutgoingCallIsActive[5] D
10 or similar Cisco panel will also appear here.

OutgoingCall_Number[1] - OutgoingCall_Number[5] S The number of the outgoing call(s).

OutgoingCall_DisplayName[1] to
S The display name of the outgoing call(s).
OutgoingCall_DisplayName[5]

OutgoingCall_Status[1] - OutgoingCall_Status[5] S The status of the outgoing call(s).

OutgoingCall_CallType[1] - OutgoingCall_CallType[5] S The call type of the outgoing call(s).

 Cisco Room Devices Driver 4.0

CONTROL – CALL SETTINGS:

EnableDoNotDisturb D 1 - Enables Do Not Disturb

DisableDoNotDisturb 1 - Disables Do Not Disturb

EnableAutoAnswer D 1 - Enables Auto Answer

DisableAutoAnswer 1 - Disables Auto Answer

The number of seconds the codec will wait until auto-answering an

incoming call.
AutoAnswerDelay A

Valid values: 0 - 50

The default call rate the codec will use.

Valid values:
DefaultCallRate A
128, 256, 384, 512, 768, 1152, 1472, 1920, 2560, 3072, 4000,
6000

The default call protocol the codec will use.

Valid values:

DefaultCallProtocol A 1 – Auto
2 – H320
3 – H323
4 – SIP

The encryption mode the codec will use.

Valid values:
EncryptionMode A 1 – Off
2 – On
3 – Best Effort
 Cisco Room Devices Driver 4.0

FEEDBACK – CALL SETTINGS:

0 = Do Not Disturb is disabled
DoNotDisturb_IsEnabled D
1 = Do Not Disturb is enabled

0 = Auto Answer is disabled

AutoAnswer_IsEnabled D
1 = Auto Answer is enabled

The number of seconds the codec will wait until auto-answering an

incoming call.
AutoAnswerDelay A

Outputs 0 - 50

The default call rate of the codec.

DefaultCallRate A 128, 256, 384, 512, 768, 1152, 1472, 1920, 2560, 3072, 4000,
6000

The default call protocol of the codec.

1 – Auto
DefaultCallProtocol A 2 – H320
3 – H323
4 – SIP

The encryption mode of the codec.

1 – Off
EncryptionMode A
2 – On
3 – Best Effort
 Cisco Room Devices Driver 4.0

CONTROL – CALL HISTORY:

Enables polling for call history entries when the system gets to a
CallHistory_EnableInitialPoll D
logged in state.

CallHistory_Request D Requests the first 100 call history entries.

CallHistory_SearchString S The search parameters for a call history request.

Acknowledges all call history entries (this will be all entries, not just
CallHistory_AcknowledgeAll D
the ones displayed).

Deletes all call history entries (this will be all entries, not just the
CallHistory_DeleteAll D
ones displayed).

Selects an entry.
CallHistory_SelectEntry A
Valid values: 1 – 10

CallHistory_AcknowledgeSelected D Acknowledges the selected entry.

CallHistory_DeleteSelected D Deletes the selected entry.

CallHistory_DialSelected D Dials the selected entry.

CallHistory_NextPage D Navigates to the next 10 entries.

CallHistory_PreviousPage D Navigates to the previous 10 entries.

FEEDBACK – CALL HISTORY:

CallHistory_NumberOfEntries A The number of call history entries on the current page.

CallHistory_Entries_XSIG S The current call history entries on the current page.

Specifies if call history is currently being downloaded.

CallHistory_DownloadState A 1 – Downloading
2 – Download Complete
 Cisco Room Devices Driver 4.0

CONTROL – DIALING:
Dialing_StringToDial S The URI that should be dialed when PlaceCall is pulsed.

Places a call using StringToDial as the URI and the settings below
Dialing_PlaceCall D
if set.

Defines the type of call that should be specified when using

PlaceCall.
Valid values:
Dialing_CallType A
0 = Default
1 = Audio
2 = Video

Defines the protocol that should be used when using PlaceCall

If left unset the codec will use its default protocol for the call.

Valid values:
Dialing_CallProtocol A
1 – Auto
2 – H320
3 – H323
4 – SIP

Defines the call speed that should be used when using PlaceCall.
If left unset the codec will use its default call rate for the call.

Dialing_CallSpeed A
Valid values:
128, 256, 384, 512, 768, 1152, 1472, 1920, 2560, 3072, 4000,
6000
 Cisco Room Devices Driver 4.0

CONTROL – DTMF:
Selects a connected call to send DTMF tones to.
DTMF_SelectCall A
Valid values: 1 – 5

DTMF_Key0 - DTMF_Key9, DTMF_Key* and DTMF_Key# D Sends the DTMF key to the selected connected call.

DTMF_SendCustomString D Sends StringToSend to the selected connected call.

The string that should be sent as a DTMF tone to the connected

DTMF_StringToSend S
call.

CONTROL – AUDIO:
Sets the volume on the codec.
SetVolume A
Valid values: 0 – 100

VolumeUp D Increases the volume by one step.

VolumeDown D Decreases the volume by one step.

The rate (ms) at which the module should increase/decrease

VolumeRampingRate A
volume. Default value is 250ms.

VolumeMuteOn D Enables volume mute.

VolumeMuteOff D Disables volume mute.

The rate at which volume up/down will be sent while ramping. This
VolumeRampingRate A
value is in milliseconds. The default value is 250ms.

Toggles volume mute.

VolumeMuteToggle D
CE 9.X Only.

MicrophoneMuteOn D Enables microphone mute (all microphones).

MicrophoneMuteOff D Disables microphone mute (all microphones).

Toggles microphone mute (all microphones).

MicrophoneMuteToggle D
CE 9.X Only.

Set the gain on a microphone.

MicrophoneGain[1] - MicrophoneGain[8] A
Valid values: 0 to 70
 Cisco Room Devices Driver 4.0

FEEDBACK – AUDIO:
The current volume level of the codec .
VolumeLevel_Value A
0 – 100

VolumeIsMuted D Specifies if volume mute is enabled.

MicrophonesAreMuted D Specifies if microphone mute is enabled.

Specifies the gain of each individual microphone.

MicrophoneGainValue[1] - MicrophoneGainValue[8] A
0 - 70
 Cisco Room Devices Driver 4.0

CONTROL – VIDEO:
Sets the main video source.
SetMainVideoSource A
Valid values: 1 – 4 (Source 1 through Source 4)

Sets the active connector on Source 4.

Valid values:
SetActiveConnector A
1 – DVI
2 - S-Video / Composite

SelfView_Enable D Enables Self View.

SelfView_Disable D Disables Self View.

SelfView_EnableFullscreen D Enables fullscreen.

SelfView_DisableFullscreen D Disables fullscreen.

Sets the monitor role.

SelfView_Monitor A
Valid values: 1- 4 (Monitor Role 1 – through Monitor Role 4)

Sets the PIP Position.

Valid values:
1 – Center Left
2 – Center Right
SelfView_PIP_Position A 3 – Lower Left
4 – Lower Right
5 – Upper Center
6 – Upper left
7 – Upper Right

Sets the picture layout.

Valid values:
1 – Auto
2 - Equal
PictureLayout A
3 – Overlay
4 – Prominent
5 - Single
6 - Custom
 Cisco Room Devices Driver 4.0

FEEDBACK – VIDEO:
Specifies the main video source.
MainVideoSource A
1 – 4 (Source 1 through Source 4)

0 = Self view is disabled

SelfView_IsOn D
1 = Self view is enabled

0 = Fullscreen is disabled
SelfView_IsFullscreen D
1 = Fullscreen is enabled

Specifies the monitor role.

SelfView_Monitor_Value A
1- 4 (Monitor Role 1 – through Monitor Role 4)

Specifies the PIP position.

1 – Center Left
2 – Center Right
3 – Lower Left
SelfView_PIP_Position_Value A
4 – Lower Right
5 – Upper Center
6 – Upper left
7 – Upper Right

Specifies the picture layout.

1 – Auto
2 - Equal
PictureLayout_Value A
3 – Overlay
4 – Prominent
5 - Single
 Cisco Room Devices Driver 4.0

CONTROL – PRESENTATION:
Starts the presentation.
Presentation_Start D
Settings below must be set prior to starting the presentation.

Presentation_Stop D Stops the presentation.

Specifies the input source that should be used on the presentation.

Only InputSource or Connector can be used. If both are set then
InputSource takes priority.
Presentation_InputSource A
Valid values:
1 – 4 = Input 1 through Input 4
5 = None

Specifies the input connector that should be used on the

presentation.
Only InputSource or Connector can be used. If both are set then
InputSource takes priority.
Presentation_Connector A
Valid values:
1 – 5 = Connector 1 through Connector 5
6 = None

Specifies the sending mode that should be used on the

presentation.

Presentation_SendingMode A Valid values:

1 – Local and Remote
2 – Local Only

Specifies the instance that should be used on the presentation.

Valid values:
1 – New
2 – Instance 1
Presentation_Instance A 3 – Instance 2
4 – Instance 3
5 – Instance 4
6 – Instance 5
7 – Instance 6
 Cisco Room Devices Driver 4.0

FEEDBACK – PRESENTATION:
LocalPresentation_IsStarted D Specifies if a local presentation has started.

Specifies the current presentation mode:

1 – Off
Presentation_Mode A
2 – Sending
3 - Receiving

Specifies the current source/input that is being used by an active

PresentationSource_Is_Input[x] D
presentation.
 Cisco Room Devices Driver 4.0

CONTROL – ROOM PRESETS:

Activates and selects a room preset .
Room presets differ to camera presets in that they store video
ActivateRoomPreset A
settings as well as camera positions.
Valid values: 1 - 15

DeleteRoomPreset A Deletes the currently selected preset.

Stores the current camera and room settings as the selected

StoreRoomPreset A
preset.
 Cisco Room Devices Driver 4.0

CONTROL – MESSAGE WINDOW:

ClearMessageAlert D Clears the current message alert being displayed by the codec.

Shows a new message alert on the codec with the settings set
ShowMessageAlert D
below.

NewMessageAlertTitle S The title that should be used when showing a message alert.

NewMessageAlertText S The text that should be used when showing a message alert.

ClearMessagePrompt D Clears the current message prompt being displayed by the codec.

SelecMessagePromptOption1 through Selects one of the five message prompt options being displayed by
D
SelecMessagePromptOption5 the codec.

Shows a new message prompt on the codec with the settings set
ShowMessagePrompt D
below.

NewMessagePromptTitle S The title that should be used when showing a message prompt.

NewMessagePromptText S The text that should be used when showing a message prompt.

NewMessagePromptOption1 through
D The options that should be used when showing a message prompt.
NewMessagePromptOption5

FEEDBACK – MESSAGE WINDOW:

0 – No message alert is active
MessageAlertIsActive D
1 - Message alert is active

MessageAlertTitle S The title of the active message alert.

MessageAlertText S The text of the active message alert.

0 – No message prompt is active

MessagePromptActive D
1 – Message prompt is active

MessagePromptTitle S The title of the active message prompt.

MessagePromptText S The text of the active message prompt.

MessagePromptOptionIsSelectable[1] through
D Specifies if an option is available on the active message prompt.
MessagePromptOptionIsSelectable[5]
MessagePromptOptionText[1] through
S The text on the active message prompt.
MessagePromptOptionText[5]

MessagePromptOptionSelected[1] through Specifies which option was selected on the active message
D
MessagePromptOptionSelected[5] prompt.
 Cisco Room Devices Driver 4.0

CONTROL – BOOKINGS:
Enables polling for booking entries when the system gets to a
Bookings_EnableInitialPoll D
logged in state.

GetBookings D Gets the first 50 bookings for the current day.

Sets how time is displayed on all the string outputs.

Valid values:
TimeDisplayMode A
1 = 24 Hour
2 = 12 Hour

SelectBooking A Selects a booking entry.

JoinSelectedBooking D Joins the selected booking entry.

ClearSelectedBooking D Clears all string outputs associated with the selected booking.

Selects the contact method for the selected booking.

SelectContactForSelectedBooking A
(Not implemented)

JoinActiveBooking D Joins the next available booking if it is joinable.

Selects the contact method for the active booking.

SelectContactForActiveBooking A
(Not implemented)
 Cisco Room Devices Driver 4.0

FEEDBACK – BOOKINGS:
NumberOfBookings A The number of bookings that are available.

BookingTitles_XSIG S XSIG containing all booking titles.

BookingAgendas_XSIG S XSIG containing all booking agendas.

BookingStartTimes_XSIG S XSIG containing all booking start times.

BookingEndTimes_XSIG S XSIG containing all booking end times.

Booking_SelectedIsJoinable D Specifies if the selected booking is joinable.

Booking_SelectedInProgress D Specifies if the selected booking is in progress.

Booking_SelectedName S The selected booking’s name field.

Booking_SelectedDescription S The selected booking’s description field.

Booking_SelectedStartTime S The selected booking’s start time field.

Booking_SelectedEndTime S The selected booking’s end time field.

Booking_SelectedDuration S The selected booking’s duration field.

Booking_SelectedOrganizer S The selected booking’s organizer full name field.

Booking_SelectedWebExUrl S The selected booking’s WebEx URL field.

Booking_SelectedWebExNumber S The selected booking’s WebEx Number field.

Booking_SelectedWebExPassword S The selected booking’s WebEx Password field.

Booking_SelectedWebExHostKey S The selected booking’s WebEx Host Key field.

The amount of numbers available for the selected booking.

Booking_SelectedNumberOfContacts A
(Not implemented)

XSIG containing all of the numbers available for the selected

Booking_SelectedNumbers_XSIG S booking.
(Not implemented)

Booking_ActiveIsJoinable D Specifies if the active booking is joinable.

Booking_ActiveInProgress D Specifies if the active booking is in progress.

Booking_ActiveProgress A (Not implemented)

 Cisco Room Devices Driver 4.0

Booking_ActiveName D The active booking’s name field.

Booking_ActiveDescription S The active booking’s description field.

Booking_ActiveStartTime S The active booking’s start time field.

Booking_ActiveEndTime S The active booking’s end time field.

Booking_ActiveDuration S The active booking’s duration field.

Booking_ActiveOrganizer S The active booking’s organizer full name field.

Booking_ActiveWebExUrl S The active booking’s WebEx URL field.

Booking_ActiveWebExNumber S The active booking’s WebEx Number field.

Booking_ActiveWebExPassword S The active booking’s WebEx Password field.

Booking_ActiveWebExHostKey S The active booking’s WebEx Host Key field.

The amount of numbers available for the active booking.

Booking_ActiveNumberOfNumbers A
(Not implemented)

XSIG containing all of the numbers available for the active

Booking_ActiveNumbers_XSIG S booking.
(Not implemented)
 Cisco Room Devices Driver 4.0

CONTROL – SPEAKER TRACK:

SpeakerTrack_Activate D Activates Speaker Track.

SpeakerTrack_Deactivate D Deactivates Speaker Track.

FEEDBACK – SPEAKER TRACK:

SpeakerTrack_IsActivated D Specifies whether or not Speaker Track is currently activated.

CONTROL – PRESENTER TRACK:

Sets the Presenter Track mode:

1 – Off
2 – Follow
PresenterTrack_Mode A 3 – Diagnostic
4 – Background
5 – Setup
6 - Persistent

FEEDBACK – PRESENTER TRACK:

PresenterTrack_IsAvailable D Specifies whether or not Presenter Track is available on the codec.

Specifies the current Presenter Track mode:

1 – Off
2 – Follow
PresenterTrack_ModeValue A 3 – Diagnostic
4 – Background
5 – Setup
6 - Persistent
 Cisco Room Devices Driver 4.0

CONTROL – SYSTEM:
ActivateStandby D Activates standby.

DeactivateStandby D Deactivates standby.

Changing the logging mode.

Valid values:
LoggingMode A 1 – No logging
2 – Regular logging
3 – Verbose logging

Allows the programmer to set the username used and override the
OverrideUsername S one specified by the property. The programmer must disconnect
and reconnect to use the new username.

Allows the programmer to set the password used and override the
OverridePassword S one specified by the property. The programmer must disconnect
and reconnect to use the new password.

FEEDBACK – SYSTEM:
SoftwareVersion S The current software version running on the codec.

ProductID S The product name of the codec.

StandbyState S The current standby state of the codec.

MACAddress S The MAC address of the codec.

IPV4Address S The IP V4 address of the codec.

IPV6Address S The IP V6 address of the codec.

SIPURI S The SIP URI in use by the codec.

SIPStatus S The current SIP state.

H323GatekeeperAddress S The H323 Gatekeeper address.

H323GatekeeperPort S The H323 Gatekeeper port.

H323GatekeeperStatus S The H323 Gatekeeper status.

 Cisco Room Devices Driver 4.0

CONTROL – DIAGNOSTICS:
This will clear the current set of diagnostics and query the device
RunDiagnostics D for a new list. It will use the filter specified by the signal
DiagnosticsFilter.

This selects the type of filter to use when running diagnostics.

0 – No Filter
DiagnosticsFilter A 1 – Alerts
2 – All
3 - None

FEEDBACK – DIAGNOSTICS:
The number of diagnostic messages received from the device. The
DiagnosticsCount A
limit is 10 messages.

A description of the diagnostic message. This is automatically

Diagnostics_Description[1 – 10] S
truncated to 255 characters.

Diagnostics_Level[1 - 10] S The level of the diagnostic message

Diagnostics_Type[1 - 10] S The type of diagnostic message

Any references that were included in the diagnostic message. This

Diagnostics_Reference[1 - 10] S
is automatically truncated to 255 characters.
 Cisco Room Devices Driver 4.0

CONTROL – SSH:
The address that should be used for the connection. This can be
SSHServerAddress S
the hostname or the IP address of the device.

The port that should be used for the connection.

Valid values:
SSHServerPort A
1 – 65535

Default value: 22

SSH_Connect D Connects to the codec using an SSH connection.

SSH_Disconnect D Disconnects from the codec.

Accepts the currently received SSH key and stores it in a file in

SSH_AcceptKey D
NVRAM.

SSH_RejectKey D Rejects the currently received SSH key and closes the connection.

SSH_CustomCommandToDevice S Sends data to the device. The driver will append a CRLF.

FEEDBACK – SSH:
0 – No unknown keys have been received
SSH_UnknownKeyReceived D
1 – An unknown key has been received. Must accept or reject.

SSH_Key S The received host key fingerprint.

0 – Not connected
SSH_Connected D
1 – Connected

1 – Connected
2 – Connecting
SSH_ConnectionState A
3 – Disconnected
4 – Logged In (Ready to receive and process commands)

SSH_FromDevice S Data received from the device.

 Cisco Room Devices Driver 4.0

CONTROL – COM:
When pulsed, this will allow the driver to communicate with the
COM_Start D
codec.

COM_Stop D When pulsed, this will stop all communication with the codec.

FromDevice S Data received on the COM port.

FEEDBACK – COM:
0 – Not connected

COM_Connected D 1 – Connected

Note: This is determined by Start/Stop.

1 – Connected
2 – Connecting (Not applicable)
COM_ConnectionState A
3 – Disconnected
4 – Logged In (Ready to receive and process commands)

ToDevice S Data that should be sent to the COM port.

 Cisco Room Devices Driver 4.0

FEEDBACK – VIDEO INPUTS:

VideoInput[x]_Exists D Specifies if the video input exists on the device.

VideoInput[x]_IsConnected D Specifies if there is a source connected to the video input.

Specifies the current signal state:

VideoInput[x]_SignalState A 1 – OK – There is a valid input source connected

2 – Unknown – There is no input source connected
3 – Unsupported – The current source is not supported

Specifies the connector type of the input:

1 - Camera
2 – Composite
3 – DVI
4 – 3G-SDI
VideoInput[x]_ConnectorType A 5 – HDMI
6 – USB
7 – Unknown
8 – VGA
9 – Component
10 – HD-SDI

The resolution height of the connected video source. This will be 0

VideoInput[x]_ResolutionHeight S
if there is no source connected.

The resolution width of the connected video source. This will be 0 if

VideoInput[x]_ResolutionWidth S
there is no source connected.

The refresh rate of the connected video source. This will be 0 if

VideoInput[x]_RefreshRate S
there is no source connected.
 Cisco Room Devices Driver 4.0

PARAMETERS:
The username that is used in the login sequence. User level determines what
Username S commands and feedback are available during run-time. This module will not
stop any command from being sent due to user level.

Password S The password that is used in the login sequence.

COM – Use the COM port and the COM group of signals.
Communication Mode A
SSH – Use the SSH transport and the SSH group of signals.

Unsecure – Allows all connections.

SSH Security Mode A Secure – Requires matching host key fingerprints with either user input or
using a file in NVRAM

Download All – Downloads all entries in the phonebook when Request is

used

LocalPhonebook Download Settings A

Download As Needed – Downloads entries when they are needed. Request
will limit the search to 500 entries and then continue requesting entries as the
user navigates the phonebook using Page Up/Down

The provider name that is used to specify which phonebook is used on the
LocalPhonebook Provider Name S
AddressBook Smart Object.

When Download All is used, this will be used to determine how many entries
LocalPhonebook Entries Per Page A are outputted on the signal <LocalPhonebook_Entries_XSIG>.
Valid range: 10-500

Download All – Downloads all entries in the phonebook when Request is

used

CorporatePhonebook Download Settings A

Download As Needed – Downloads entries when they are needed. Request
will limit the search to 500 entries and then continue requesting entries as the
user navigates the phonebook using Page Up/Down

The provider name that is used to specify which phonebook is used on the
CorporatePhonebook Provider Name S
AddressBook Smart Object.

When Download All is used, this will be used to determine how many entries
CorporatePhonebook Entries Per Page A are outputted on the signal <CorporatePhonebook_Entries_XSIG>.
Valid range: 10-500

Specifies how many call history entries to download.

CallHistory Entries to Download A
Valid range: 1-200