Cisco Integration Configuration Package AVI Edition

v1.0.1.
Installation and Configuration Manual
 Page 2

TABLE OF CONTENTS
1. OVERVIEW ............................................................................................................................................................. 4
1.1. INTRODUCTION.......................................................................................................................................................... 4
1.2. THE COMPONENTS OF THE PACKAGE .............................................................................................................................. 4
1.2.1. Cisco Integration script AVI Edition module ................................................................................................. 4
1.2.2. Cisco Room Control Extension AVI Edition logic module ............................................................................. 4
1.2.3. Sample device driver modules ..................................................................................................................... 4
1.3. INSTALLATION REQUIREMENTS ...................................................................................................................................... 5
1.4. RELEASE NOTES ......................................................................................................................................................... 5
1.4.1. Fixes:............................................................................................................................................................. 5
1.4.2. Adds.............................................................................................................................................................. 5
1.4.3. Known Issues ................................................................................................................................................ 6
2. INSTALLATION AND CONFIGURATION ................................................................................................................... 7
2.1. INSTALLATION OF THE LARA CONFIGURATION FILE ........................................................................................................... 7
2.2. SETTING THE PARAMETERS OF THE CISCO MODULE INSTANCES IN THE LARA CONFIGURATION ................................................... 8
2.2.1. Setting the parameters of the Cisco_Room_Device instance ...................................................................... 8
2.2.2. Setting the parameters of the Cisco_Room_Control logic instance........................................................... 18
2.3. SETTING THE PARAMETERS OF THE DEVICE DRIVER INSTANCES INCLUDED IN THE SAMPLE CONFIGURATION................................. 24
2.3.1. GPIO driver settings.................................................................................................................................... 24
2.3.2. Lights driver settings (GPIO port based driver) .......................................................................................... 26
2.3.3. Shading driver settings (GPIO port based driver) ....................................................................................... 27
2.3.4. Projector screen driver settings (GPIO port based driver) ......................................................................... 29
2.3.5. LG_Sample_Display .................................................................................................................................... 31
2.4. INITIAL AUTOMATIC TAURUS SETTINGS ......................................................................................................................... 34
2.5. INITIAL AUTOMATIC CISCO CODEC SETTINGS .................................................................................................................. 34
3. OPERATION ......................................................................................................................................................... 35
3.1. STARTING LARA ...................................................................................................................................................... 35
3.2. DOWNLOADING THE LARA CONFIGURATION ................................................................................................................. 35
3.3. HANDLING DEVICE DRIVER MODULES AND INSTANCES ...................................................................................................... 36
3.3.1. Adding driver modules ............................................................................................................................... 36
3.3.2. Creating instances ...................................................................................................................................... 37
3.3.3. Connecting driver instances to Room Control rows................................................................................... 38
3.3.4. Deleting device driver instances ................................................................................................................ 38
3.3.5. Deleting device driver modules .................................................................................................................. 39
4. APPENDIX ............................................................................................................................................................ 40
4.1. SYSTEM DIAGRAMS .................................................................................................................................................. 40
4.1.1. Lightware Taurus – Cisco Room Device with HDMI USB capture card connection example ..................... 40
4.1.2. Lightware Taurus – Cisco Room Device with USB-C connection example ................................................. 40
4.2. CISCO INTEGRATION SCRIPT MODULE METHODS AND EVENTS ............................................................................................ 41
4.2.1. Events ......................................................................................................................................................... 41
4.2.2. Methods ..................................................................................................................................................... 43
4.3. CISCO ROOM CONTROL EXTENSION AVI EDITION MODULE DRIVER TYPES AND CONTROL TYPES ............................................... 48
4.3.1. Driver types reference................................................................................................................................ 48
4.3.2. Control types reference ............................................................................................................................. 50
4.4. DRIVER COMPATIBILITY LIST ....................................................................................................................................... 53
4.4.1. LARA Factory display drivers ...................................................................................................................... 53
4.4.2. LARA AVI Edition drivers............................................................................................................................. 54
4.4.3. Sample drivers included in the sample Integration package ..................................................................... 55
4.5. ADDING CUSTOM CONTROL ROW TYPE ......................................................................................................................... 56
4.5.1. Defining and setting a new driver type ...................................................................................................... 56
4.5.2. Adding the driver type to the parameter list of the Row Type setting options ......................................... 57

Cisco Integration Configuration Package AVI Edition

 Page 3

Version Comment Date

1.0 Initial version March 14, 2024

1.0.1 Updated for v1.0.1 June 25, 2024

Cisco Integration Configuration Package AVI Edition

 Page 4

1. Overview
1.1. Introduction

This integration package provides means for installing and configuring Cisco Room Device – Taurus integration with
Cisco touch panel room control features without the need of JavaScript coding.
Simple room control scenarios detailed in this manual need only instance parameter settings of the Cisco Room
Control logic module instance.
More complex scenarios can be addressed by using the Cisco specific events and methods provided by the Cisco Room
Device module instance in the rules section of the included or of a separate logic module.
The solution contains:
• a LARA configuration with basic device drivers as a sample configuration
• a LARA configuration without any device drivers
• this documentation
A compatibility list of for device drivers is included in section Driver compatibility list of this document.
Device drivers that are not on this list but are compatible with the solution can also be added to the configuration.

1.2. The components of the package

1.2.1. Cisco Integration script AVI Edition module

The Cisco Integration script AVI Edition module handles the control connection with the Cisco Room Device and it
provides methods and events to access the most frequently used commands and events of the connected Cisco Room
Device in addition to the standard functions of the factory Cisco integration script module built into LARA.

1.2.2. Cisco Room Control Extension AVI Edition logic module

The Cisco Room Control Extension AVI Edition logic module connects room devices using their device driver modules
with the Cisco Room Device.
It provides an easy and automated way to set up a simple room control panel with up to 6 control rows on the Cisco
touch panel user interface.
For more complex scenarios the solution can be amended or modified by adding rules using the events and methods
of the Cisco Integration script module and the device driver modules installed, to the existing or to a separate logic
module.

1.2.3. Sample device driver modules

The driver modules enable the connection between the general commands of the Cisco Room Control Extension AVI
Edition logic module and the specific devices controlled by the driver modules. The commands are standardized for
device classes and are detailed in the Appendix section of this document.

Cisco Integration Configuration Package AVI Edition

 Page 5

Optionally the driver modules can provide feedback events towards the logic module enabling true feedback on the
Cisco touch panel user interface. The events are standardized for device classes and are detailed later in the Appendix
section this document.
To show the options provided by the integration package, a sample driver set is included in the ‘sample’ version of
the package.
It is also possible to define a custom device class with custom commands and events, by adding a descriptor JSON
object to the code of the logic module in this release. The process is detailed in the Appendix section of this document.

1.3. Installation requirements

 A Lightware Taurus unit at least with the firmware version shown below by product family, or
higher:
o UCX-TPX-TX20: v1.9.0b9
o UCX-HC40: v2.12.0b3
o UCX-HC30: v2.11.0b3
 A Cisco Room Device running firmware RoomOS version 11.14 or higher
 One display connected to the Cisco Room Device

1.4. Release Notes

1.4.1. Fixes:
 RS232 integration issue,
 BYOD Selection issue (not having the BYOD content on screen) with RoomOS 11.9 and up,
 Cisco codec restart causes missing external sources in the Share Screen list,
 Cisco codec restart causes missing external sources' status information when BYOD(s) connected
to Taurus UCX, Taurus TPX and MMX2
 Cisco Room Kit Mini configuration issues fixed and chaged to have same user experience like you
have with Room Bar

1.4.2. Adds
 Room Bar Pro (added in the previous internal release),
 UCX-4x2-HC40-BD,
 New input conenction list with connector names for the codecs to have easier configuration,
 Selectable Presentation Selection Mode to have Manual (default) and AutoShare,
 Selectable Share Video Input Connector Visibility to have Always (default) and IfSignal when you
want to see the input only in Share Screen list when connected source has active video input
signal,
 Information to LARA status board for codec type, taurus type, codec service provider mode
(webex/mtr), integration connection type

Cisco Integration Configuration Package AVI Edition

 Page 6

1.4.3. Known Issues

 Taurus TPX RX's P3 serial port integration can struggle with uploading additional UI panels like
large room control panel (embedded BYOD Selection panel uploads in a correct way)

Cisco Integration Configuration Package AVI Edition

 Page 7

2. Installation and configuration

2.1. Installation of the LARA configuration file

Before uploading and configuring the LARA configuration file of the solution please download the latest firmware
from https://lightware.com/, then upgrade your UCX, TPX or MMX2 Matrix Switcher and activate LARA.
For further information please refer to the following links:

 https://lightware.com/pub/media/lightware/filedownloader/file/User-
Manual/Taurus_UCX_series_Users_Manual.pdf
 https://lightware.com/pub/media/lightware/filedownloader/file/User-Manual/LARA_Users_Manual.pdf
 https://lightware.com/lara/

Start LARA on the Taurus according to the Taurus User Manual and upload the LARA configuration file using the
menu item as shown in the picture below:

How to upload a LARA configuration

Next step is to set the parameters of the module instances.

Cisco Integration Configuration Package AVI Edition

 Page 8

2.2. Setting the parameters of the Cisco module instances in the LARA configuration

2.2.1. Setting the parameters of the Cisco_Room_Device instance

For setting the parameters of the Cisco Integration script AVI Edition module instance named Cisco_Room_Device,
on the LARA Status Board click on the button shown in the picture below:

Set Cisco_Room_Device instance parameters

Cisco Integration Configuration Package AVI Edition

 Page 9

2.2.1.1. Setting the instance parameters, General room settings, Cisco settings

Set Cisco_Room_Device instance parameters, General Room and Cisco settings

General room settings

 Name of the Room

Set here the name of the room that appear in message boxes. This parameter does not overwrite the configured room
name of the Cisco room device.

Cisco settings

 Codec type
Select the type of the Cisco room device used from the drop-down list.
 Connection type
Select the type of the connection to the Cisco room device from the drop-down list.
“Ethernet” for LAN connection or “Serial port” for connection using the Taurus serial port and an FTDI cable.
 IP address of the connected Cisco Room Device unit
It is needed for the communication with the Cisco room device in case the Connection type is set to “Ethernet”
 Serial port number of the Taurus

Cisco Integration Configuration Package AVI Edition

 Page 10

This setting is needed when the Connection type is set to “Serial”.

Select “P1” from the drop-down list for Taurus serial port P1, or “P2” for serial port P2, or “P3” for serial port P3.
P3 can be used when it exists, like in case of the Taurus TPX.

2.2.1.2. Setting the instance parameters, Authentication, (Cisco) Outputs:

Set Cisco_Room_Device instance parameters, Authentication, Outputs settings

Set authentication on Taurus side

 Authentication needed
Select from the drop-down list, “true” means authentication is needed for connection to the Cisco Room device,
“false” means authentication is not needed for this.
 Username for Cisco codec connection
When the Authentication required setting is “true”, set the username for the authentication here
 Password for Cisco codec connection
When the Authentication required setting is “true” set the password for the authentication here

Cisco Integration Configuration Package AVI Edition

 Page 11

Set authentication on Cisco side

In case authentication is needed, the username and password described below has to be created on the Cisco codec
before use, with the following options:
 Privileges has to be enabled at least for:
o – RoomControl,
o – Integrator,
o – Admin.
 The following option has to be disabled:
o Require passphrase change on next user sign in.

Set new user on Cisco codec web interface

Cisco Integration Configuration Package AVI Edition

 Page 12

Outputs

 Output connector #1
Select the device connected to the output port nr.1 of the Cisco room device.
Available options:
o Display (default setting)
o USB Capture Device
o No connection

 Output connector #2
Select the device connected to the output port nr.2 of the Cisco room device.
Available options:
o Display
o USB Capture Device
o No connection (default setting)

 Output connector #3
Select the device connected to the output port nr.3 of the Cisco room device.
Available options:
o Display
o USB Capture Device
o No connection (default setting)

This version of Cisco integration supports one Display connected to the Cisco room device.
A USB Capture Device is needed when a Cisco room device without an USB-C connector is used and full BYOD
functionality with Cisco camera access is required.
For proper operation, select only one output as USB Capture Device.

Cisco Integration Configuration Package AVI Edition

 Page 13

2.2.1.3. Setting the instance parameters, Taurus settings, Inputs, Outputs:

Set Cisco_Room_Device instance parameters, Taurus Inputs and Outputs settings

Taurus Settings

Inputs (Source labels on Cisco Touch Panel)

 Input #1 label
Set here the label used on the Cisco touch panel for the source connected to Taurus input port #1
 Input #2 label
Set here the label used on the Cisco touch panel for the source connected to Taurus input port #2
 Input #3 label
Set here the label used on the Cisco touch panel for the source connected to Taurus input port #3
 Input #4 label
Set here the label used on the Cisco touch panel for the source connected to Taurus input port #4.

If there is no source connected to an input, leave the parameter blank.

Outputs

 Output #1 is connected to

Cisco Integration Configuration Package AVI Edition

 Page 14

Select the device connected to the output port nr.1 of the Taurus.
Available options:
o No connection
o Cisco Room Bar - Input Connector #1 (USB-C)
o Cisco Room Bar - Input Connector #2 (HDMI)
o Cisco Room Bar Pro - Input Connector #1 (HDMI)
o Cisco Room Bar Pro - Input Connector #2 (USB-C)
o Cisco Board Pro - Input Connector #1 (USB-C)
o Cisco Board Pro - Input Connector #2 (HDMI)
o Cisco Room Kit EQ - Input Connector #1 (CAM)
o Cisco Room Kit EQ - Input Connector #2 (HDMI)
o Cisco Room Kit EQ - Input Connector #3 (HDCP)
o Cisco Room Kit EQ - Input Connector #4 (USB-C)
o Cisco Room Kit - Input Connector #1 (HDMI)
o Cisco Room Kit Mini - Input Connector #1 (HDMI)
o Cisco Room Kit Plus - Input Connector #1 (CAM)
o Cisco Room Kit Plus - Input Connector #2 (HDCP)
o Cisco Room Kit Plus - Input Connector #3 (HDMI)
o Cisco Room Kit Pro - Input Connector #1 (CAM)
o Cisco Room Kit Pro - Input Connector #2 (CAM)
o Cisco Room Kit Pro - Input Connector #3 (HDMI)
o Cisco Room Kit Pro - Input Connector #4 (HDMI)
o Cisco Room Kit Pro - Input Connector #5 (HDCP)
o Cisco Room Kit Pro - Input Connector #6 (CAM)
o Cisco Codec Plus - Input Connector #1 (CAM)
o Cisco Codec Plus - Input Connector #2 (HDCP)
o Cisco Codec Plus - Input Connector #3 (HDMI)
o Cisco Codec Pro - Input Connector #1 (CAM)
o Cisco Codec Pro - Input Connector #2 (CAM)
o Cisco Codec Pro - Input Connector #3 (HDMI)
o Cisco Codec Pro - Input Connector #4 (HDMI)
o Cisco Codec Pro - Input Connector #5 (HDCP)
o Cisco Codec Pro - Input Connector #6 (CAM)
o Cisco Desk Pro - Input Connector #1 (HDMI)
o Cisco Room 70 G2 - Input Connector #1 (CAM)
o Cisco Room 70 G2 - Input Connector #2 (CAM)
o Cisco Room 70 G2 - Input Connector #3 (HDMI)
o Cisco Room 70 G2 - Input Connector #4 (HDMI)
o Cisco Room 70 G2 - Input Connector #5 (HDCP)

Cisco Integration Configuration Package AVI Edition

 Page 15

o Cisco Room 70 G2 - Input Connector #6 (CAM)

o Cisco TelePresence SX20 - Input Connector #1 (DVI)
o Cisco TelePresence SX80 - Input Connector #1 (CAM)
o Cisco TelePresence SX80 - Input Connector #2 (CAM)
o Cisco TelePresence SX80 - Input Connector #3 (HDMI)
o Cisco TelePresence SX80 - Input Connector #4 (DVI)
o Cisco TelePresence SX80 - Input Connector #5 (YC)
o Cisco DX70 - Input Connector #1 (HDMI)
o Cisco DX80 - Input Connector #1 (HDMI)
o Cisco MX700 - Input Connector #1 (CAM)
o Cisco MX700 - Input Connector #2 (CAM)
o Cisco MX700 - Input Connector #3 (HDMI)
o Cisco MX700 - Input Connector #4 (DVI)
o Cisco MX700 - Input Connector #5 (YC)
o Cisco MX800 - Input Connector #1 (CAM)
o Cisco MX800 - Input Connector #2 (CAM)
o Cisco MX800 - Input Connector #3 (HDMI)
o Cisco MX800 - Input Connector #4 (DVI)
o Cisco MX800 - Input Connector #5 (YC)

 Output #2 is connected to
Select the device connected to the output port nr.2 of the Taurus.
Available options are the same as for Output #1.
 Output #3 is connected to
Select the device connected to the output port nr.3 of the Taurus (if exists).
Available options are the same as for Output #1.

Cisco Integration Configuration Package AVI Edition

 Page 16

2.2.1.4. Setting the instance parameters, Operation:

Set Cisco_Room_Device instance parameters, Operation settings

Operation

 Presentation Mode
Available options:
o Manual (default)
Manual interaction needed to present your connected source via tapping on the Navigator's Share
Screen and tap on view or present to have the conencted source's content on screen or in call to far
end.
o AutoShare
When there is an active video signal then the codec automatically selects the connected source to present
on the screen (no need to tap on Share Screen list).

 Share Video Input Connector Visibility

Available options:
o Always (default)
Presents all the configured external source labels to stay in the Share Screen list.
o IfSignal
Presents those sources only in the the Share Screen list which has active incoming video signal.

Cisco Integration Configuration Package AVI Edition

 Page 17

 Enable BYOD pop-up on source connection

This setting defines on what event should the source connected to one of the input ports of the Taurus be selected.
Available options:
o On video signal
Recommended setting for all room devices except those listed under option “No (automatic selection,
last detect)”
o On USB connection or on video signal
o No
Recommended setting for Room Kit Mini, Room Bar, Room Bar Pro and Room Kit EQ

 Enable BYOD panel creation

This setting defines whether a BYOD selection panel is created for the Cisco touch panel.
Available options:
o Auto
BYOD panel is created for Cisco room devices without USB-C connection
o Yes
BYOD panel is created
o No
BYOD panel is not created

 MonitorRole setting
This setting defines how or to which value the MonitorRole parameter of the Cisco Codec HDMI output connected
to the USB Capture card will be set.
Available options:
o Auto
The MonitorRole parameter will be set automatically according to which Cisco Codec HDMI output is
selected for the USB Capture card. (default value)
o First
The MonitorRole parameter will be set to First for the Cisco Codec HDMI output selected for the USB
Capture card.
o Second
The MonitorRole parameter will be set to Second for the Cisco Codec HDMI output selected for the USB
Capture card.
o Third
The MonitorRole parameter will be set to Third for the Cisco Codec HDMI output selected for the USB
Capture card.
o No setting
The MonitorRole parameter will NOT be set for the Cisco Codec HDMI output selected for the USB
Capture card.

 Enable debug mode

If this option is set to true, the solution logs detailed information about the operation of the modules in the LARA
Logging window. This is useful when installing the solution or when troubleshooting is needed.
Default value is false, meaning no detailed logging will be done.

Cisco Integration Configuration Package AVI Edition

 Page 18

2.2.2. Setting the parameters of the Cisco_Room_Control logic instance

For setting the parameters of the logic module instance named Cisco_Room_Control, on the LARA Status Board click
on the button shown in the picture below:

Setting Cisco Room Control logic instance parameters:

2.2.2.1. Setting the instance parameters, Room Control Panel settings, Cisco room device instance
name:

The following settings provide information for the logic module for creating and uploading a Room Control Panel to
the Cisco touch screen. The Panel can contain up to 6 rows for control.
In addition to the panel generation, the logic module automatically creates connection between the control elements
of the Room Control Panel created on the Cisco touch screen and the methods and events of the configured Device
Driver instances, according to the level of compatibility. A driver compatibility list can be found in the Appendix section
of this document.
This enables the control of the connected devices via the Cisco touch screen and also true feedback from the
compatible Device Drivers.
The type of the Device Drivers is easily set by selecting the type of control for the actual row using a drop down list.

Cisco Integration Configuration Package AVI Edition

 Page 19

Setting Cisco Room Control logic instance parameters, Room Control panel settings

Room Control Panel settings

 Panel Name
The name of the room control panel to be shown on the Cisco touch screen can be defined here.
 Button color
The color of the button shown on Cisco touch screen for the room control extension panel can be selected here by a
drop-down list.
Available options:
o Lightware Red #9e0b0f
o Custom Light #6f739e
o Custom Dark #262626
 Panel Operation
Sets on which Cisco touch screen state shall the button of the Room Control Panel appear on.
Available options:
o Home Screen and call controls
(default value)
o Home Screen
o Call controls
o Hidden
o MTR
for MTR mode of the Codec
 Cisco Device Instance
Sets the name of the LARA instance of the Cisco Integration script AVI Edition module. The default name is
Cisco_Room_Device.

Cisco Integration Configuration Package AVI Edition

 Page 20

2.2.2.2. Setting the instance parameters, Room Control Panel Row settings:

Setting Cisco Room Control logic instance parameters, Room Control Panel Row settings

Row settings

Up to 6 control rows can be set for the Room Control Panel

For Row 1 up to Row 6 setting options are the same:

 Label
Sets the title of the room control row on the Room Control Panel
 Typel
Sets the type of the room control to be used for the room control row.
Available options:
o Light ON/OFF (Button)
o Display ON/OFF (Button)
o Display Audio MUTE/UNMUTE (Button)
o Display Audio LEVEL (Slider)
o Projector ON/OFF (Button)
o Screen DOWN/UP (Button)

Cisco Integration Configuration Package AVI Edition

 Page 21

o Screen DOWN/STOP/UP (Button)

o Shades OPEN/CLOSE (Button)
o Shades OPEN/STOP/CLOSE (Button)
o Audio DSP LEVEL (Slider)
o Audio DSP LEVEL (Slider) BIAMP
o Audio DSP MUTE/UNMUTE (Button)
o Audio DSP MUTE/UNMUTE (Button) BIAMP
o GPIO ON/OFF (Button)
o GPIO ON/STOP/OFF (Button)
o Not Used
This is the default value, the row is not generated

 Controlled Device Instance ID

Sets the Device Driver instance name for the device driver of the controlled device
The row is not generated in case this parameter is empty
For rows not needed, leave the Label parameter empty, and the Type parameter set as Not Used.

2.2.2.3. Setting the instance parameters, Hard button and Other options

With the help of the “Hard button options” settings it is possible to control devices of compatible type using the so
called “Hard buttons” of the Cisco touch screen.
These control buttons can be either physical „hard” buttons on the Cisco touch unit or generated by software on the
Cisco touch screen.

Setting Cisco Room Control logic instance parameters, Hard Button Options settings

Cisco Integration Configuration Package AVI Edition

 Page 22

Main Speakers level

 Controlled Device Instance ID

Sets the Device Driver instance name for the device driver of the device controlled by the Audio Volume so called
„hard button” controls on the Cisco touch screen.

 Type
Sets the type of the control.
Available options:
o Audio DSP LEVEL (Slider)
o Display Audio LEVEL (Slider)
o Not Used
(default value)

Main Microphones Mute

 Controlled Device Instance ID

Sets the Device Driver instance name for the device driver of the device to be controlled by the Microphone Mute
„hard button” control on the Cisco touch screen.

 Type
Sets the type of the control.
Available options:
o Audio DSP MIC MUTE/UNMUTE BIAMP
o Not Used
(default value)

Setting Cisco Room Control logic instance parameters, Other options settings

Cisco Integration Configuration Package AVI Edition

 Page 23

Other options

 Display follows Codec power state

In case “true” is selected from the drop-down list, the display specified by the Display driver instance ID parameter is
switched On or Off according to the standby state of the Cisco Room Device.
 Display driver instance ID.
The name of the Display Driver instance that controls the display to follow the standby status of the Cisco Room
Control device.
 Enable verbose console logging
Enable detailed console logging, used mainly for issue tracking during installation or operation
Default value is “false” (not enabled).

Cisco Integration Configuration Package AVI Edition

 Page 24

2.3. Setting the parameters of the Device Driver instances included in the sample
configuration

For the proper operation, the instance parameters of the device drivers to be used have to be set in accordance with
the required functionality and system design.
In this section setting the parameters of the sample device driver instances is explained.

2.3.1. GPIO driver settings

Instance parameters

Setting GPIO_1 instance parameters

 IP address
Leave empty for the Taurus running the LARA configuration (localhost).
Otherwise set here the IP address of the Taurus the GPIO interface of which is to be controlled.
 Port number
Do not change the default 6107 unless a different TCP port is used for the control
 GPIO port
The number of the GPIO port controlled. Value has to be within 1 and 6
 GPIO port 2

Cisco Integration Configuration Package AVI Edition

 Page 25

The number of the 2nd GPIO port to be controlled. Set it equal to the GPIO port for single port use operation, otherwise
operation is dual port use mode. Value has to be within 1 and 6
Dual port use mode means the first port can set to “On” by the On method, the other port will be set to “Off”. The 2nd
port can be set to “On” by the Off method in which case the first port will be set to “Off”. Both ports are set to “Off”
by the Stop method. Events are dispatched accordingly.
 Polarity
o Normal:
On = High, Off = Low GPIO level
o Inverted:
On = Low, Off = High GPIO level

Methods:

 portOn
Sets GPIO port to “On” according to instance parameter settings. In dual port use mode it sets GPIO port 2 to “Off”
too.
 portOff
Sets GPIO port to “Off” according to instance parameter settings. In dual port use mode it sets GPIO port 2 to “On”
too.
 portsStop
In dual port use mode sets both GPIO ports to “Off” according to instance parameter settings

Events:
 portChangedToOn
GPIO port status has changed to “On”. In dual port mode GPIO port 2 has changed to “Off” too.
 portChangedToOff
GPIO port status has changed to “Off”. In dual port mode GPIO port 2 has changed to “On” too.
 portsStopped
In dual port use mode, GPIO port and GPIO port 2 both have changed to “Off”

Cisco Integration Configuration Package AVI Edition

 Page 26

2.3.2. Lights driver settings (GPIO port based driver)

Instance parameters:

Setting Lights_1 instance parameters

 IP address
Leave empty for the Taurus running the LARA configuration (localhost).
Otherwise set here the IP address of the Taurus the GPIO interface of which is controlled.
 Port number
Do not change the default 6107 unless a different TCP port is used for control
 GPIO port
The number of the GPIO port controlled. Has to be within 1 and 6

Methods:
 powerOn
Sets GPIO port to “High”
 powerOff
Sets GPIO port to “Low”

Cisco Integration Configuration Package AVI Edition

 Page 27

Events:
 poweredOn
GPIO port has changed to “High”
 poweredOff
GPIO port has changed to “Low”

2.3.3. Shading driver settings (GPIO port based driver)

Instance parameters:

Setting Shades_1 instance parameters

 IP address
Leave empty for the Taurus running the LARA configuration (localhost).
Otherwise set here the IP address of the Taurus the GPIO interface of which is controlled.
 Port number
Do not change the default 6107 unless a different TCP port is used for control
 GPIO port
The number of the GPIO port controlled. Has to be within 1 and 6
 GPIO port 2

Cisco Integration Configuration Package AVI Edition

 Page 28

The number of the 2nd GPIO port to be controlled. Set it equal to the GPIO port for single port use operation, otherwise
operation is double port use. Value has to be within 1 and 6
 Polarity
o Normal:
On = High, Off = Low GPIO level
o Inverted:
On = Low, Off = High GPIO level

Methods:
 shadesOpen
Sets GPIO port to “On”. In dual port use mode it sets GPIO port 2 to “Off” too.
 shadesClose
Sets GPIO port to “Off”. In dual port use mode it sets GPIO port 2 to “On” too.
 shadesStop
In dual port use mode sets both GPIO ports to “Off” according to instance parameter settings

Events:
 shadesOpened
GPIO port has changed to “On”. In dual port mode GPIO port 2 has changed to “Off” too.
 shadesClosed
GPIO port has changed to “Off”. In dual port mode GPIO port 2 has changed to “On” too.
 shadesStopped
In dual port use mode, GPIO port and GPIO port 2 both have changed to “Off”

Cisco Integration Configuration Package AVI Edition

 Page 29

2.3.4. Projector screen driver settings (GPIO port based driver)

Instance parameters:

Setting Projector_Screen_1 instance parameters

 IP address
Leave empty for the Taurus running the LARA configuration (localhost).
Otherwise set here the IP address of the Taurus the GPIO interface of which is controlled.
 Port number
Do not change the default 6107 unless a different TCP port is used for control
 GPIO port
The number of the GPIO port controlled. Has to be within 1 and 6
 GPIO port 2
nd
The number of the 2 GPIO port to be controlled. Set it equal to the GPIO port for single port use operation, otherwise
operation is dual port use. Value has to be within 1 and 6
 Polarity
o Normal:
On = High, Off = Low GPIO level
o Inverted:
On = Low, Off = High GPIO level

Cisco Integration Configuration Package AVI Edition

 Page 30

Methods:
 screenUp
Sets GPIO port to “On”. In dual port use mode it sets GPIO port 2 to “Off” too.
 screenDown
Sets GPIO port to “On”. In dual port use mode it sets GPIO port 2 to “Off” too.
 screenStop
In dual port use mode sets both GPIO ports to “Off” according to instance parameter settings

Events:
 screenGoesDown
GPIO port has changed to “On”. In dual port mode GPIO port 2 has changed to “Off” too.
 sreenGoesUp
GPIO port has changed to “Off”. In dual port mode GPIO port 2 has changed to “On” too.
 screenStopped
In dual port use mode sets both GPIO ports to “Off” according to instance parameter settings

Cisco Integration Configuration Package AVI Edition

 Page 31

2.3.5. LG_Sample_Display

Instance parameters:

Setting LG_Sample_Display instance Control parameters

Control parameters

 Control type
The type of control connection can be selected from the drop down list.
Available options:
o Ethernet TCP/IP
o RS 232 serial
 Display ID
The Display ID of the LG Display to be controlled. Possible values are 0-255.
0 is the group ID to address all LG displays that can be reached over the control connection. No feedback messages
will be received from the LG display(s) when setting this value as the Display ID.
 Polling Interval
Status polling interval in millisec. Do not set below 10000 millisec.
 Enable console logging

Cisco Integration Configuration Package AVI Edition

 Page 32

Detailed console logging for the driver can be enabled when necessary. Default value is “false”.

Other parameters

Setting LG_Sample_Display instance other parameters

 WOL MAC Address

The MAC Address of the LG Display can be given here for the powerOn method to use the WakeOnLAN method.
Depending on the settings of the LG display it is possible that it can be powered on by the Wake On LAN method only.
 UCX serial port
The RS232 port of the Taurus device can be selected here by using the drop down list for control of the LG display
over serial connection.
 IP address
The IP address of the LG display can be given for control over LAN connection.

Methods:
 powerOn
Sends powerOn command to the display
 powerOff
Sends powerOff command to the display
 mute
Sends mute command to the display (audio)

Cisco Integration Configuration Package AVI Edition

 Page 33

 unmute
Sends unmute command to the display (audio)
 setVolume
Sends setVolume command to the display (audio)

Events:
 powerStatusChanged, On
The power status of the display changed to “On”
 powerStatusChanged, Off
The power status of the display changed to “Off”
 muteStatusChanged, On
The audio mute status of the display changed to “On”
 muteStatusChanged, Off
The audio mute status of the display changed to “Off”

Cisco Integration Configuration Package AVI Edition

 Page 34

2.4. Initial automatic Taurus settings

During the LARA configuration startup, after connecting to the Taurus unit by the Cisco_Room_Device module
instance, the following initial settings are done:
In case the connection type is set to “Serial port”, the parameters of the serial port determined by the “Serial port
number of the Taurus” parameter are set to:
 Baudrate: 115.2 kbps
 StopBits: 1
 Parity: None

2.5. Initial automatic Cisco codec settings

In the case when a USB Capture device is used for BYOD functions, for proper operation, the MonitorRole property of
the Cisco codec output that the USB Capture Device is connected to is set automatically.
This automatic setting can be changed when necessary, for details please refer to section 2.2.1.4.

Cisco Integration Configuration Package AVI Edition

 Page 35

3. Operation
3.1. Starting LARA

After setting the parameters detailed in the previous chapter, the LARA configuration is ready to be run.
Start the LARA configuration running as shown in the picture below:

Starting the LARA configuration

3.2. Downloading the LARA configuration

To save the settings you made use the download configuration function as shown in the picture below

Saving the LARA configuration

You can set the name of the configuration file to be created by the download

Cisco Integration Configuration Package AVI Edition

 Page 36

Setting the LARA configuration filename

3.3. Handling device driver modules and instances

Device drivers can be added to and deleted from the LARA configuration as detailed in the following sections.
Do not forget to download your LARA configuration after finishing changes for backup purposes. In the previous
section it is shown how to do it.

3.3.1. Adding driver modules

You can add device driver modules in the “Browse Modules” tab of the LARA window:

LARA Browse Modules

They can be added by creating a new device driver module:

Cisco Integration Configuration Package AVI Edition

 Page 37

Create a new driver module

or by uploading a device driver module file:

Upload a driver module file

After the necessary device driver module uploaded or created, an instance has to be created based on the module:

3.3.2. Creating instances

After selecting the module on the Browse Modules tab, the creation of an instance of this module can be done by
pressing the create instance icon:

Cisco Integration Configuration Package AVI Edition

 Page 38

Create an instance of a module

The creation is completed by setting and saving the instance parameters specific to the driver.
The instance parameters can be modified later, after the instance creation just as already shown for the module
instances of this Integration package.

3.3.3. Connecting driver instances to Room Control rows

After having created the instance and having set its instance parameters for the specific device to be controlled, the
instance can be connected to one of the rows on the automatically created room control panel for the Cisco touch
screen by giving the name of this instance in one of the Row parameter groups within the instance parameters of
the Cisco_Room_Control logic module, as described in section 2.2.2.2. The type of the driver has to be set too.

3.3.4. Deleting device driver instances

Instances that are not needed can be deleted
Delete only the instance in case you have other instances of the same module or in case you will need the module
later.

Cisco Integration Configuration Package AVI Edition

 Page 39

Deleting an instance

3.3.5. Deleting device driver modules

When not needed any more, device driver modules can be deleted, too.
Deleting a module deletes also all of its instances from the configuration.

Deleting a module

Cisco Integration Configuration Package AVI Edition

 Page 40

4. Appendix
4.1. System diagrams
4.1.1. Lightware Taurus – Cisco Room Device with HDMI USB capture card connection example

4.1.2. Lightware Taurus – Cisco Room Device with USB-C connection example

Cisco Integration Configuration Package AVI Edition

 Page 41

4.2. Cisco Integration script module methods and events

4.2.1. Events
The Cisco Integration script AVI edition module provides the events listed below for other modules to use status and
event feedbacks received from the Cisco room device. Detailed specification of these events can be found on the
Cisco RoomOS website: https://roomos.cisco.com/xapi

UserInterface Extensions Widget Action

UserInterface extensions widget action happened.
Parameters:
 type: string The type of the action. eg. “pressed”, “clicked”, “changed”.
 value: string The value associated with the action type and the widget.
 widgetId: string, The unique identifier (widgetId) of the widget.

CallDisconnect
Call was disconnected.
Parameters:
 event: object Contains call disconnect details. Please find details in the Cisco
RoomOs documentation

IncomingCallIndication
Incoming call indication.
Parameters:
 event: object Contains incoming call details:
o CallId integer
o DisplayNameValue string
o RemoteURI string

OutgoingCallIndication
Outgoing call indication.
Parameters:
 event: object Outgoing call details:
o CallId integer

UserInterface Extensions Event PageClosed

Page closed on UserInterface.
Parameters:
 event: object PageClosed event details in object form.
o PageId string

Cisco Integration Configuration Package AVI Edition

 Page 42

UserInterface Extensions Panel Clicked

Page closed on UserInterface.
Parameters:
 event: object Panel clicked event details in object form.
o PanelId string

UserInterface Presentation ExternalSource Selected

Presentation ExternalSource selected.
Parameters:
 event: object Details for external source selected, in object form.
o SourceIdentifier string

UserInterface Extensions Event Pressed

UserInterface Extensions Pressed event happened.
Parameters:
 event: object Details of the Pressed event, in object form.
o Signal string

Video Output Connector

Video output connector status changed.
Parameters:
 status: object Video output connector status change details.

Video Input Connector

Video input connector status changed.
Parameters:
 status: object Video input connector status change details.

Standby State
Standby State status changed.
Parameters:
 status: string values:
o Standby The device is in standby state.
o EnteringStandby The device is entering the standby state.
o Halfwake The device is in standby, but greets the user when presence is
detected by motion or the Proximity pairing app.
o Off The device is not in standby.

Cisco Integration Configuration Package AVI Edition

 Page 43

Message Send
Message sent by Message Send command has been received.
Parameters:
 message: string Contains the message text received

Audio Volume
Audio Volume changed
Parameters:
 status: integer Shows the volume level of the loudspeaker output, 0-100.

Audio VolumeMute
Audio Volume Mute status changed
Parameters:
 status: string “On”, or “Off”

Audio Microphones Mute

Audio Microphones Mute status changed
Parameters:
 status: string “On”, or “Off”

LARA Connected Status

LARA - Cisco Codec Connected Status changed
Parameters:
 connected: boolean true: connected, false: disconnected

LARA Cisco Error In Connection

LARA Cisco Communication Error Happened in the connection
Parameters:
 errorHappened: boolean True in case communication error happened between LARA
and Cisco

4.2.2. Methods
The Cisco Integration script AVI edition module provides the methods listed below for sending commands to the Cisco
room device. Detailed specification of the commands can be found on the Cisco RoomOS website:
https://roomos.cisco.com/xapi

Cisco Integration Configuration Package AVI Edition

 Page 44

4.2.2.1. Methods for specific Cisco commands

userinterfaceExtensionsWidgetSetValue(widgetId, value)
Sets the value of the given widget. Updates the UserInterface Extensions status tree.
Parameters:
 widgetId: string, the unique identifier (widgetId) of the widget
 value: string the value to be set for the widget

userinterfaceExtensionsWidgetUnsetValue(widgetId)
Empties the value of the given widget. Updates the UserInterface Extensions status tree and notifies the user interface
that this widget is no longer selected.
Parameters:
 widgetId: string, the unique identifier (widgetId) of the widget

userinterfaceExtensionsWidgetAction(widgetId, value, type)

Sets the action of the given widget. Updates the UserInterface Extensions status tree.
Parameters:
 widgetId: string, The unique identifier (widgetId) of the widget
 value: string The value of the widget. The range of values depends on the
widget type
 type: string, The type of widget that is set.


userInterfaceMessagePromptDisplay(title, text, duration, feedbackid)

Displays a small window on screen with a title, text for response from the user. The message is displayed on screen
until duration, or until the user gives a response, or until the device receives a UserInterface Message Prompt Clear
command.
Parameters:
 title: string, The title of the message
 text: string, Enter the text line to be displayed. The <p> and <br> HTML tags will
result in line breaks as normal; any other tags will appear as plain text
 duration: number, Sets how long (in seconds) the message window is to be displayed on
the screen. If set to 0 (zero) the message window is displayed until a UserInterface Message
Prompt Clear command is sent
 feedbackid: string, To identify the feedback enter a feedbackid

userInterfaceMessagePromptClear(feedbackid)
Removes the window which was displayed using the UserInterface Message Prompt Display command. This is
required when the Duration parameter is not set.
Parameters:
 feedbackid: string, The FeedbackId corresponds to the FeedbackId given by the
UserInterface Message Prompt Display command

Cisco Integration Configuration Package AVI Edition

 Page 45

userInterfaceMessageAlertDisplay(title, text, duration)

Displays an alert message on screen.
Parameters:
 title: string, The title of the message
 text: string, The message to be displayed. The <p> and <br> HTML tags will result
in line breaks as normal; any other tags will appear as plain text
 duration: number, Sets how long (in seconds) the message window is to be displayed on
the screen. If set to 0 (zero) the message window is displayed until a UserInterface Message Alert
Clear command is sent

userInterfaceMessageAlertClear()
Removes the window which was displayed using the UserInterface Message Alert Display command. This is required
when the Duration parameter is not set.

messageSend(text)
Triggers a Message Send event which sends text to any listening clients.
parameter:
 text: string, The text that the message contains

conferenceDoNotDisturbActivate()
This command switches on the Do Not Disturb mode. When Do Not Disturb is switched on, all incoming calls are
rejected and registered as missed calls. The calling side receives a busy signal.

conferenceDoNotDisturbDeactivate()
Switches off the Do Not Disturb mode. When Do Not Disturb is switched off incoming calls come through as normal.

callAccept()
Accepts an incoming call.

callDisconnect()
Disconnects a call.

audioVolumeMute()
Mutes the volume on the selected audio unit.

audioVolumeUnmute()
Sets the volume on the device back on after muting.

Cisco Integration Configuration Package AVI Edition

 Page 46

audioVolumeSet(level)
Sets the volume on one of the video conferencing device's audio units (built-in loudspeakers, headsets, or handset)
to a specified level.
Parameter:
 level: string, 0-100. 70 equals 0 dB gain, and 100 equals 15 dB gain.

audioVolumeIncrease(steps)
Increases the volume on one of the video conferencing device's audio units (built-in loudspeakers, headsets, or
handset). By default, the volume is increased by 5 steps (each step is 0.5 dB). Use the Steps parameter if you want to
override the default behavior.
Parameter:
 steps: number, Optional. The number of steps to increase the volume with, 1-
10, default: 5. One step is 0.5 dB.

audioVolumeDecrease(steps)
Decreases the volume on one of the video conferencing device's audio units (built-in loudspeakers, headsets, or
handset). By default, the volume is decreased by 5 steps (each step is 0.5 dB). Use the Steps parameter if you want to
override the default behavior.
Parameter:
 steps: number, Optional. The number of steps to decrease the volume with, 1-
10, default: 5. One step is 0.5 dB.

4.2.2.2. Methods for general Cisco command sending

sendCustomCommandToCodec(command, parameters, callback)

Sends custom command to codec. For the command options Refer to Cisco RoomOS xapi manual, link at the beginning
of this section.
Parameters:
 command: string The command to be sent to the codec.
 parameters: json Optional, parameters for the command, in JSON format.
 callback: function Optional, callback function to be called after the command has
been successfully executed.

setCustomCodecConfig(command, value, callback)

Sends custom config (command) to codec. For the config (command) options Refer to Cisco RoomOS xapi manual, link
at the beginning of this section.
Parameters:
 command: string The config command to be sent to the codec.
 value: string Optional, string type parameter for the config
command.
 callback: function Optional, callback function to be called after the command has
been successfully executed.

Cisco Integration Configuration Package AVI Edition

 Page 47

addCustomListenerToCodec(eventName, type, callback)

Subscribes to a custom event or status of the Cisco codec.
Parameters:
 eventName: string The name of the event to subscribe on.
 type: string Type of the subscription, ‘status’ or ‘event’ according to
the Cisco xapi.
 callback: function Optional, callback function to be called when an even received
via this subscription.

4.2.2.3. Methods for user panels handling

panelSave(panel_name, panel_content)
Saves a User Interface extension panel with name given in panel_name and with definition in xml format in
panel_content parameters to the Cisco codec.
Parameters:
 panel_name: string The name of the panel to be saved.
 panel_content string The xml content of the panel. It can be edited and downloaded
from the Cisco codec.

panelRemove(panel_name)
Removes a User Interface extension panel with name given in panel_name parameter from the Cisco codec.
Parameters:
 panel_name: string The name of the panel to be removed.

Cisco Integration Configuration Package AVI Edition

 Page 48

4.3. Cisco Room Control extension AVI Edition module driver types and control types
4.3.1. Driver types reference
List of the driver types definitions this integration version supports.
The type is the driver type identifier.
Commands contain the list of method names. When one of the controls in the control row are activated eg. a button
is pressed, this driver type will call from this list the corresponding method of the driver instance set for the row.
Parameters contain the parameters corresponding to the methods in the commands list. In case there are any
parameters defined for it, the method will be called with these parameters.
Events contain the event names accepted by the driver type. When a compatible and configured driver sends an event
on the list with optionally eventparams listed, true feedback will be shown on the corresponding control row of the
Cisco Room Control Panel accordingly.

 type: "Light ON/OFF (Button)",

commands: “powerOn", "powerOff"
events: "poweredOn", "poweredOff"
rowtype: "ONOFF"
 type: "GPIO ON/OFF (Button)",
commands: "portOn", "portOff"
events: portChangedToOn", "portChangedToOff"
rowtype: "ONOFF"
 type: "GPIO ON/STOP/OFF",
commands: "portOn", "portsStop", "portOff"
events: "portChangedToOn", "portsStopped", "portChangedToOff"
rowtype: "ONSTOPOFF"
 type: "Display ON/OFF (Button)",
commands: "powerOn", "powerOff"
events: "powerStatusChanged", "powerStatusChanged"
eventparams: "On", "Off"
rowtype: "ONOFF"
 type: "Projector ON/OFF (Button)",
commands: "powerOn", powerOff"
rowtype: "ONOFF"
 type: "Screen DOWN/UP (Button)",
commands: "screenUp", “screenDown"
events: "screenGoesUp", "screenGoesDown"
rowtype: "UPDOWN"
 type: "Screen DOWN/STOP/UP (Button)",
commands: "screenDown", "screenStop", "screenUp"
events: "screenGoesDown", "screenStopped", "screenGoesUp"
rowtype: "DOWNSTOPUP"
 type: "Shades OPEN/CLOSE (Button)",
commands: "shadesOpen", ”shadesClose"
events: "shadesOpening", "shadesClosing"
rowtype: "OPENCLOSE"
 type: "Shades OPEN/STOP/CLOSE (Button)",
commands: "shadesOpen", "shadesStop", "shadesClose"
events: "shadesOpening", "shadesStopped", "shadesClosing"
rowtype: "OPENSTOPCLOSE"

Cisco Integration Configuration Package AVI Edition

 Page 49

 type: "Audio DSP MUTE/UNMUTE (Button)",

commands: "muteOn", "muteOff"
events: "muteStatusChanged", "muteStatusChanged"
eventparams: "On", "Off"
rowtype: "MUTEUNMUTE"
 type: "Audio DSP MUTE/UNMUTE (Button) BIAMP",
commands: "setMute", "setMute"
parameters: {1: instanceTag* 2: channel* 3: value}
1: {1: "0", 2: "1", 3: "true"}
2: {1: "0", 2: "1", 3: "false"}
*: can be changed according to the Biamp configuration.
events: "muteStatusChanged", "muteStatusChanged"
eventparams: "On", "Off"
rowtype: "MUTEUNMUTE"
 type: "Audio DSP MIC MUTE/UNMUTE BIAMP",
commands: "setMute", "setMute"
parameters: {1: instanceTag* 2: channel* 3: value}
1: {1: "3", 2: "1", 3: "true"}
2: {1: "3", 2: "1", 3: "false"}
*: can be changed according to the Biamp configuration.
events: "muteStatusChanged", "muteStatusChanged"
eventparams: "On", "Off"
rowtype: "MUTEUNMUTE"
 type: "Display Audio MUTE/UNMUTE (Button)",
commands: "mute", "unmute"
events: "muteStatusChanged", "muteStatusChanged"
eventparams: "On", "Off"
rowtype: "MUTEUNMUTE"
 type: "Audio DSP LEVEL (Slider)",
commands: "setLevel"
parameters: 100
rowtype: "Slider"
 type: "Audio DSP LEVEL (Slider) BIAMP",
commands: "setLevel"
parameters: {1: dspType, 2: instanceTag*, 3: channel*, 4: min dB**, 5: max dB**}
1: {1: "B", 2: "0", 3: "1", 4: -40, 5: -20}
*: can be changed according to the Biamp configuration
**: mindB and maxdB the slider value will be set between, according to the slider position
can be changed according to the Biamp configuration
rowtype: "Slider"
 type: "Display Audio LEVEL (Slider)",
commands: "setVolume"
parameters: 100
rowtype: "Slider"
 type: "Main Speakers LEVEL (Touch Navigator embedded main speaker volume control)",
commands: "audioVolumeSet”
parameters: 255
events: "Audio Volume"
rowtype: "Slider"
 type: "Main Speakers MUTE/UNMUTE",
commands: "audioVolumeMute", "audioVolumeUnmute"
events: "Audio VolumeMute", "Audio VolumeMute"

Cisco Integration Configuration Package AVI Edition

 Page 50

eventparams: "On", "Off"

rowtype: "MUTEUNMUTE"

4.3.2. Control types reference

List of the control type definitions this integration version supports. These can be associated with driver types via the
rowtype parameter of the driver type defining object.
The elements of the control type object:
type: The unique identifier of the control type.
controls: Contains the number of the controls in the control row.
widgetType: The type of the set of widgets to be used, in accordance with the options Cisco offers for user
interface extension panel controls. Available options are:
o “Button”
o “3Button”
o “Slider”
o “GroupButton”
o ToggleButton
o SpinnerH
o SpinnerV
o SpinnerPM
widgetValues: The values of the widgets of the control row.
width: The width of the control row in the Cisco touch Room Control panel row

 type: "ONOFF",
controls: 2, (in Cisco touch Room Control panel row)
widgetType: "Button",
widgetValues: 1: "ON", 2: "OFF"
width: 2 (in Cisco touch Room Control panel row)
 type: "ONSTOPOFF",
controls: 3,
widgetType: "3Button"
widgetValues: 1: "ON", 2: "STOP", 3: "OFF"
width: 4
 type: "OnOff",
controls: 2,
widgetType: "GroupButton",
widgetValues: 1: "On", 2: "Off"
width: 4
 type: "MUTEUNMUTE",
controls: 2,
widgetType: "Button",
widgetValues: 1: "MUTE", 2: "UNMUTE"
width: 2
 type: "MuteUnmute",
controls: 2,
widgetType: "GroupButton",

Cisco Integration Configuration Package AVI Edition

 Page 51

widgetValues: 1: "Mute", 2: "Unmute"

width: 4
 type: "UPDOWN",
controls: 2,
widgetType: "Button",
widgetValues: 1: "UP", 2: "DOWN"
width: 2
type: UPSTOPDOWN",
controls: 3,
widgetType: "3Button",
widgetValues: 1: "UP", 2: "STOP", 3: "DOWN"
width: 4
 type: "DOWNSTOPUP",
controls: 3,
widgetType: "3Button",
widgetValues: 1: "DWN", 2: "STOP", 3: "UP"
width: 4
 type: "UpDown",
controls: 2,
widgetType: "GroupButton",
widgetValues: 1: "Up", 2: "Down"
width: 4
 type: "OPENCLOSE",
controls: 2,
widgetType: "Button",
widgetValues: 1: "OPEN", 2: "CLOSE"
width: 4
 type: "OPENSTOPCLOSE",
controls: 3,
widgetType: "3Button",
widgetValues: 1: "OPEN", 2: "STOP", 3: "CLOSE"
width: 4
 type: "OpenClose",
controls: 2,
widgetType: "GroupButton",
widgetValues: 1: "Open", 2: "Close"
width: 4
 type: "Toggle",
controls: 2,
widgetType: "ToggleButton",
widgetValues: 1: "on", 2: "off"
width: 4
 type: "SpinnerH",
controls: 2,
widgetType: "Spinner",
widgetValues: 1: "increment", 2: "decrement"
width: 4
 type: "SpinnerV",
controls: 2,
widgetType: "Spinner",
widgetValues: 1: "increment", 2: "decrement
width: 4

Cisco Integration Configuration Package AVI Edition

 Page 52

 type: "SpinnerPM",
controls: 2,
widgetType: "Spinner",
widgetValues: 1: "increment", 2: "decrement"
 type: "Slider",
controls: 1,
widgetType: "Slider",
widgetValues: 1: "Slider"
width: 4

Cisco Integration Configuration Package AVI Edition

 Page 53

4.4. Driver compatibility list

4.4.1. LARA Factory display drivers

Driver Version Edition Control methods Feedback events DriverType Control type Compatibility

LG Signage 1.1.5 Factory powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
mute, unmute - Display Audio MUTE/UNMUTE (Button) MUTEUNMUTE Control
setVolume - Display Audio LEVEL (Slider) Slider Control

Sony Bravia 1.1.3 Factory powerOn, powerOff powerStatusChanged Display ON/OFF (Button) ONOFF Control,
Feedback
mute, unmute muteStatusChanged Display Audio MUTE/UNMUTE (Button) MUTEUNMUTE Control,
Feedback
setVolume - Display Audio LEVEL (Slider) Slider Control

PJ-Link 1.1.4 Factory powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
mute, unmute - Display Audio MUTE/UNMUTE (Button) MUTEUNMUTE Control

Cisco Integration Configuration Package AVI Edition

 Page 54

4.4.2. LARA AVI Edition drivers

Driver Version Edition Control methods Feedback events DriverType Control type Compatibility

LG Signage 1.1.2 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
setVolume - Display Audio LEVEL (Slider) Slider Control
PJ-Link 1.1.2 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
Sony 1.2.0 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
setVolume - Display Audio LEVEL (Slider) Slider Control
NEC 1.1.2 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
setVolume - Display Audio LEVEL (Slider) Slider Control
Samsung Signage 1.1.2 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
setVolume - Display Audio LEVEL (Slider) Slider Control
Philips 1.2.0 AVI powerOn, powerOff - Display ON/OFF (Button) ONOFF Control
setVolume - Display Audio LEVEL (Slider) Slider Control
Biamp Tesira 1.0.1 AVI setLevel - Audio DSP LEVEL (Slider) BIAMP Slider Control
setMute - Audio DSP MUTE/UNMUTE (Button) BIAMP MUTEUNMUTE Control
setMute - Audio DSP MIC MUTE/UNMUTE BIAMP MUTEUNMUTE Control

Cisco Integration Configuration Package AVI Edition

 Page 55

4.4.3. Sample drivers included in the sample Integration package

Driver Versio Editio Control Feedback events DriverType Control type Compatibili
n n methods ty
LG_AVI_Sample_Dri 1.0.0 AVI powerOn, powerStatusChang Display ON/OFF (Button) ONOFF Control,
ver powerOff ed Feedback
mute, unmute muteStatusChange Display Audio MUTE/UNMUTE MUTEUNMUTE Control,
d (Button) Feedback
setVolume - Display Audio LEVEL (Slider) Slider Control
GPIO_Driver 1.0.0 AVI portOn, portOff portChangedToOn, GPIO ON/OFF (Button) ONOFF Control,
portChangedToOff Feedback
portOn, portChangedToOn, GPIO ON/STOP/OFFOFF (Button) ONSTOPOFF Control,
portsStop, portsStopped, Feedback
portOff portChangedToOff

Lights_Driver_GPIO 1.0.0 AVI powerOn, poweredOn, Light ON/OFF (Button) ONOFF Control,
powerOff poweredOff Feedback
Projector_Screen 1.0.0 AVI screenDown, screenGoesDown, Screen DOWN/UP (Button) UPDOWN Control,
Driver_GPIO screenUp screenGoesUp Feedback
screenDown, screenGoesDown, Screen DOWN/STOP/UP (Button) DOWNSTOPUP Control,
screenStop, screenStopped, Feedback
screenUp screenGoesUp

Shades_Driver_GPIO 1.0.0 AVI shadesOpen, shadesOpening, Shades OPEN/CLOSE (Button) OPENCLOSE Control,
shadesClose shadesClosing Feedback
shadesOpen, shadesOpening, Shades OPEN/STOP/CLOSE OPENSTOPCLO Control,
shadesStop, shadesStopped, (Button) SE Feedback
shadesClose shadesClosing

Cisco Integration Configuration Package AVI Edition

 Page 56

4.5. Adding custom control row type

4.5.1. Defining and setting a new driver type

4.5.1.1. Finding the driver type array of JSON elements

Adding a new driver type in this integration version needs the adding of a new JSON object defining the command
and event options of the new driver to the array of driver type defining JSON objects.
This driverTypes array can be found:

How to find the driverTypes array

4.5.1.2. Adding the new driver type JSON object to the driver array
The JSON object defining the new driver type has to be added to the driverTypes array.
The keys of the JSON object defining a driver type are:
 type: string Contains the unique name of the driver type
 commands: JSON Contains the command names for each control identified by numbers.
eg:
{1: "portOn", 2: "portsStop", 3: "portOff"}
Commands can be the same, in this case they differ in the parameters applied. eg:
{1: "setMute", 2: "setMute"}
 parameters JSON Contains parameters in objects for the commands above.
Empty command parameters example for the first command set above:
{1: {1: ""}}, 2: {1: ""}, 3: {1: ""}}
Command parameters example for the second command set above (Biamp mute):
{1: {1: "0", 2: "1", 3: "true"}, 2: {1: "0", 2: "1", 3: "false"}

Cisco Integration Configuration Package AVI Edition

 Page 57

In this later example pressing the first control of the Biamp mute on off row on the Cisco touch panel will call the
setMute command of the Biamp driver instance with the first set of parameters, ie. BiampInstance.setMute(“0”,
“1”, “true”).
 events: JSON Optional. Contains the events of a driver instance that are listened to,
and acted on by setting the value of the corresponding control element on the Cisco touch panel.
eg.
{1: "portChangedToOn", 2: "portsStopped", 3: "portChangedToOff"}
In case there are no feedback events for the driver type, events and eventparams can be left out from the driver
type descriptor JSON object.
 eventparams: JSON When there are events to listen to, it contains the
corresponding eventparameters to listen to, or empty “” values in case there are no eventparams
to listen to. eg. empty eventparams object:
{1: "", 2: "", 3: ""},
Eventparams example for events where the event parameter is important (display on/off):
events: {1: "powerStatusChanged", 2: "powerStatusChanged"},
eventparams: {1: "On", 2: "Off"},
 rowtype: Contains the type of the control row to apply. Available types are listed in
section 4.3.2.

4.5.2. Adding the driver type to the parameter list of the Row Type setting options

To add a driver type to the parameter list, go the “Edit Options” of the Row 1 Type instance parameter as shown in
the following picture:

Where to add the driver type to the selectable options of the Row 1 Type

After clicking on the “Edit Options”, the list of selectable options come up:
Additional value can be added by pressing the “+” icon at the bottom of this list (1), then after filling the new value
pair into the new empty line the list has to be saved by pressing the Save button (2)

Cisco Integration Configuration Package AVI Edition

 Page 58

List of selectable options for the Row 1 Type instance parameters

Cisco Integration Configuration Package AVI Edition