You can use a third-party USB input device to control certain functions on a room or desk device. A USB keyboard and a Bluetooth remote control with a USB dongle are examples of such input devices.
This feature is meant to complement the functionality of the Touch 10 or the DX user interfaces, wherever convenient. It is not meant to replace the Touch 10 and DX user interfaces.
Examples of applications:
-
In classrooms and during lectures, a small remote control can be used to wake up a room device from standby mode. Also, it may be convenient to use a remote control to select which input source to present.
-
Controlling the camera view (pan, tilt, and zoom) in situations where you are not allowed to use the Touch 10. For example, in operating rooms in a hospital.
Required Equipment
-
A device from the Cisco Webex Room Series or DX Series.
-
A third-party input device that advertises itself as a USB keyboard, for example a Bluetooth remote control with a USB dongle.
Functional Overview
Pressing a button on the USB input device, generates an event in the API of the room or desk device. Macros or third-party control devices can listen for such events, and respond to them. This behavior is similar to the behavior of In-Room Control buttons. It is also possible to listen for the events using webhooks, directly in an SSH session.
There isn't a library of actions readily available to select actions from. You must define and implement the actions to be taken as response to the events yourself. For example:
-
Increase the volume of the room or desk device when the Volume Up key is pressed.
-
Put the room or desk device in standby mode when the Sleep key is pressed.
Configurations, Events, and Status
The configurations and status that are referred in this article, are available both from the web interface of the room or desk device, and in the API. Read the Advanced Settings article for information how to access the web interface and use the API.
The support for third-party USB input devices is disabled by default. Enable it explicitly by setting the to On.
Pressing and releasing a button generates a Pressed and a Released event:
*e UserInterface InputDevice Key Action Key: <name of the key> *e UserInterface InputDevice Key Action Code: <id of the key> *e UserInterface InputDevice Key Action Type: Pressed ** end *e UserInterface InputDevice Key Action Key: <name of the key> *e UserInterface InputDevice Key Action Code: <id of the key> *e UserInterface InputDevice Key Action Type: Released ** end
To listen for events, you must register feedback from the InputDevice events:
xFeedback Register /event/UserInterface/InputDevice ** end
When the room or desk device detects the third-party input device, the input device is listed in the status. The input device may be reported as multiple devices.
Example
There is an example on how you can make the keys of a Bluetooth remote control operate some of the functions of a room or desk device in this article .
Further Information
Find more information about the use of a third-party input device in the Customization guide . Choose the latest version.
Cisco support (TAC) doesn’t support debugging of third-party code, including macros. Please check the Cisco Collaboration Developer community if you need help with macros and third-party code. Also, there are many developer and integrator resources on this site.
