Poly UI Configuration User's Manual v1.0.0
Poly UI Configuration User's Manual v1.0.0
User’s Manual
Page 2
TABLE OF CONTENTS
1. INTRODUCTION ............................................................................................................................................... 3
2. REFERENCES.................................................................................................................................................... 3
3. POLY A/V CONTROL WITH LARA .............................................................................................................. 3
4. UI CONTROL OVERVIEW .............................................................................................................................. 3
5. PARAMETERS .................................................................................................................................................. 5
6. WORKFLOW .................................................................................................................................................... 8
7. STEP BY STEP CONFIGURATION ............................................................................................................... 9
7.1. ADD THE DRIVER MODULES NEEDED ................................................................................................................................... 9
7.2. CREATE INSTANCES FROM THE DRIVERS ............................................................................................................................. 9
8. POLY UI CONTROL PANEL INSTANCE PARAMETER SETTINGS .................................................... 10
8.1. USER INTERFACE SETTINGS ....................................................................................................................................................10
8.2. SOURCE SELECTION ................................................................................................................................................................... 11
8.3. ROOM CONTROL ........................................................................................................................................................................ 12
8.4. LINKING INSTANCES ..................................................................................................................................................................14
8.5. URL OF THE GENERATED WEB UI........................................................................................................................................14
9. POLY TOUCH CONTROLLER SETTINGS ..................................................................................................15
10. EXAMPLE ......................................................................................................................................................... 17
10.1. APPLICATION EXAMPLE ........................................................................................................................................................... 17
1. Introduction
This document is for integrators to help them to configure and use the Poly UI Control Panel for
HP Poly Android videoconferencing devices.
Minimum software and firmware requirements:
• VideoOS 4.4.0 or newer on HP Poly Android videoconferencing units,
• LARA v1.3.0 or newer on Lightware device.
Compatible HP Poly Android videoconferencing units to communicate with:
• HP Poly Studio X Series ( X30 / X32 / X50 / X52 / X70 / X72 ).
• HP Poly Studio G Series ( G7500 / G62 ).
Compatible Lightware units to run the driver module on it:
• Lightware UCX Family ( 2x1 / 2x2 / 4x2 / 4x3 ) [ HC30 / HC40 ]
• Lightware TPX Family ( 2x1 / 4x3 ) [ TX20 ] and ( 3x3 ) [ RX20 ] and their bundles
2. References
• Poly A/V Control
• Lightware LARA Users Manual
• Lightware UCX series Users Manual
• Lightware Academy
4. UI Control Overview
The Poly VideoOS 4.4.0 (TCOS 6.4.0 included for TC10 and TC8) software update on Poly Android
units provides the ability to enable the A/V Control menu item on Poly TC10 and TC8 touch
controllers, and configure an URL to open a web UI on them when making a swipe on the touch
controller from right to left and tap on the enabled A/V Control item.
The Poly UI Control Panel module provides generated web UI for source expansions and room
control based on user parameter settings through LARA.
Entering the generated web UI’s URL to the touch controllers admin interface makes the web
UI accessible via TC10 or TC8 A/V Control functionality.
A network connection is required between the Poly unit and the Lightware unit running the
Poly UI Control Panel module instance on LARA.
Requirements
For a fully functional system the Poly UI Control Panel module instance requires additional
driver modules’ instances to communicate with.
List of driver module instances required
• Poly VideoOS LARA driver module instance, which initiates changes on the Poly Android
videoconferencing unit and retrieves status information, e.g. mode status (Teams /
Device), mode switch (Teams / Device) and A/V Control page close.
• Taurus UCX/TPX/MMX2 driver module instance, which initiates changes and retrieves
status information on the Lightware unit. Used to have source selection list for BYOD
sources to be selected and switched to the video input connector of the Poly
videoconferencing unit.
• Room control driver modules’ instances, which initiates changes and retrieves status
information on the corresponding room device such as lights, displays, projectors,
screens, shades and so. Used to have room control selection list for device control.
The Poly UI Control Panel module uses the Poly / Taurus / Room control driver’s status variables,
events and methods to take action on status changes and or on UI interaction.
The Poly UI Control Panel module’s Status Variable, Events, Methods, Rules section are empty.
Rules are made in the custom code. Modifying the custom code by the end user and or
integrator is not recommended. In case of modifications, we reserve the right to decline support.
5. Parameters
The Poly UI Control Panel parameters organized into sections for easier navigation, as shown
below:
Section Description
name
Source Section to set up the source selection in case of video input selection
Selection needed.
Leave the fields blank in case you do not need source selection.
• Name of the source group (default: “Source Selection”)
o This name will appear on top of the source selection group on
the right side of the touch controller.
• Name of the source 1 to 4 (default: empty)
o This name will appear under the source selection on the right
side of the touch controller. Leave empty if you do not use
external source for here.
o The numbers from 1 to 4 represents the input numbers.
Name of the source 1 is for IN1 connector on the Lightware
device.
Name of the source 2 is for IN2 connector on the Lightware
device.
Name of the source 3 is for IN3 connector on the Lightware
device.
Name of the source 4 is for IN4 connector on the Lightware
device.
Room Section to set up the room control names in case room control needed.
Control Leave blank when no need for control.
Name(s)
• Name of the control group (default: “Room Control”)
o This name will appear on top of the room control group on the
left side of the touch controller.
• Name of the room control 1 to 4 (default: empty)
o This name will appear under the room control section on the
left side of the touch controller. Leave empty if you do not use
control here.
o The numbers from 1 to 4 represents the numbers of the
controlled room devices.
Name of the room control 1 is for
the 1st controlled room device.
Name of the room control 2 is for
the 2nd controlled room device.
Name of the room control 3 is for
the 3rd controlled room device.
Name of the room control 4 is for
the 4th controlled room device.
Room Section to pair icon (e.g. light, display, etc.) and room control item (named in
Control the room control name section.
Type(s)
• Type of the room control 1 to 4 (default: “Not Used”)
o Presents the selected icon set for the room control. Also used
for standardized driver method calls, statuses and feedbacks.
o Options
▪ Light ON/OFF
▪ Display ON/OFF
▪ Display Audio MUTE/UNMUTE
▪ Display Audio VOLUME
▪ Projector ON/OFF
▪ Screen DOWN/UP
▪ Screen DOWN/HOLD/UP
▪ Shades OPEN/CLOSE
▪ Shades OPEN/HOLD/CLOSE
▪ Shure DSP speaker VOLUME
▪ Biamp DSP speaker VOLUME
▪ Shure DSP speaker MUTE/UNMUTE
▪ Biamp DSP speaker MUTE/UNMUTE
▪ Shure DSP microphone MUTE/UNMUTE
▪ Biamp DSP microphone MUTE/UNMUTE
▪ GPIO ON/OFF
▪ GPIO OPEN/HOLD/CLOSE
▪ Not Used
o Requirements detailed later in this document.
Device Section to change the default labels for the device mode control.
Mode
• Name of the provider mode
Control
o This name will appear under the device mode status icon.
(default: Microsoft Teams)
Source Section to set up the source selection types to pair the icons to the source
Selection named in the Source Selection Name(s) section.
(Types)
• Type of the source 1 to 4
o Presents the selected icon for the source.
o The icon will appear for the named source
o The numbers from 1 to 4 represents the input numbers.
Name of the source 1 is for IN1 connector
on the Lightware device. (default: “USB-C”)
Name of the source 2 is for IN2 connector
on the Lightware device. (default: “USB-C”)
Name of the source 3 is for IN3 connector
on the Lightware device. (default: “HDMI”)
Name of the source 4 is for IN4 connector
on the Lightware device. (default: “HDMI”)
o Options: “USB-C” and “HDMI”
Parameter Description
Name
Source Instance Section to set up the instance for source selection for Taurus UCX/TPX.
• Instance ID of the source group
o Enter the Instance id of the Taurus UCX, Taurus TPX or
MMX2 that controls the video switcher and receives
statuses and feedbacks.
• Source Selection (automatization setting for connected sources)
o First Detect Autoselect + Manual Selection (default)
o Last Detect Autoselect + Manual Selection
o Manual Selection
Poly Section to set up the instance for Poly video conference unit.
Videoconference
• Instance ID of the Poly videoconferencing unit
Unit
o Enter the Instance id of the Poly devicet that controls the
videoconferencing unit and receives statuses and
feedbacks.
6. Workflow
The web UI is generated according to the entered parameters.
Source Selection
o Source selection will be generated to the web UI only when the instance id given in the
“Source Instance” field exists and has the Lightware LW3 functionalities with video
crosspoint switching and video signal present status information.
o Unnamed sources will not present in the source selection list.
o Unnamed source selection group name will show the default name.
o Sources with active video signal are shown in a lighter shade.
o When the named source has no video signal, then the selection of the icon will be
disabled with the name and icon darker.
o Lightware units HDMI output 1 is used for source switching, therefore need to be
connected to the HDMI input of the Poly videoconferencing unit.
o The video crosspoint connection status for HDMI output 1 of the Lightware unit being
presented with a highlight border on the web UI.
o The named sources will be disabled for HDCP content on the Lightware unit.
o The Lightware HDMI output 1 set for “First detect” auto select for video.
o Manual source selection is possible via the web UI via tapping on a named source which
has active video signal.
o The Lightware USB host port is set for follow HDMI output 1.
Room Control
o To have room control section on the web UI, the name, instance and type fields need to
be set.
o Room control elements without a name will not be added to the room control section.
o Room control elements without an instance or with an invalid instance will not be added
to the room control section.
o Room control elements that have an instance but are missing the required methods will
not be included in the room control section.
o If the device corresponding to the icon has an established connection to LARA, the icon
will be enabled, indicated by a lighter shade of the icon and its label.
o If the device corresponding to the icon has no connection established to LARA, the icon
will be disabled, indicated by a darker shade of the icon and its label.
o When the room control item has the required status variable or event for status then the
status being presented with highlight border on the web UI.
Device Mode
o Device mode selection will always be available on the web UI.
o Closing the web UI can be done via the main menu of the Poly TC10 or TC8 by swiping
from right to left then tapping on the “Home” item. (or via the arrow icon on the web UI)
o Device mode status is shown on the top left of the opened web UI.
o Switching between device and provider (Teams, Zoom, etc.) modes can be done via the
main menu of the Poly TC10 or TC8 by swiping from right to left then tapping on the
“Device Mode” item.
o Switching between device mode and provider (Teams, Zoom, etc.) modes also possible
via an opened web UI tapping on the bottom left corner on the “switch” labeled modes
(which can be relabeled via the parameters).
o Switching between device mode is not possible in case of active call on the Poly unit.
Scroll for the specific sections inside the parameter window to find the sections described in
the following chapters.
Names
You have four fields for naming your sources. The number beside the Name of the source
represents the input connector number on the Taurus UCX/TPX.
For example Source 3 represents input connector 3 on the Taurus UCX/TPX.
In case you do not need a specific input then do not give a name. This way you will not have the
not named sources on the generated web UI.
Types
For the named sources you can pair icons.
USB-C and HDMI icons you can choose from to show on the generated web UI.
Types
The selected type defines the icon set and function set for the room control element.
Functionality
The room control section will be generated to the web UI only if you provide a name, select a
type other than “Not Used” and ensure the linked instance has the required methods for control.
Otherwise, the control buttons and names will not be displayed in the web UI.
Once the room control is displayed on the screen, additional feedback functionalities may be
available.
The status is also displayed on the web UI if the driver you are using has the required status
variables. If there is no related status variable or a different variable name is used, then the status
update will not be shown on the web UI.
In general you can use the following structure with the Taurus UCX/TPX IP address and the
instance ID of the Poly UI Control Panel:
https://[taurus-device-ipaddress]/laral/userpanel/[instanceid-of-the-poly-ui-control-panel]
example: https://192.168.1.120/lara/userpanel/poly-ui-control-panel-01
10. Example
10.1. Application Example
The following application provides an overview of what the Taurus TPX can do with Poly UI
Control Panel LARA module via the Poly TC10
List of peripherals
a. Poly Studio X52 paired with Poly TC10,
b. Lightware TPX-4x3-TX20-RX107 bundle,
c. P5 FNIP network controllable relay with lights connected to the network port of HDMI-
UCX-TPX-RX107 via CAT5e cable,
d. LG Signage display connected to HDMI-UCX-TPX-RX107 via RS232 cable,
e. Laptops as BYOD sources connected to UCX-4x3-TPX-TX20 via Lightware USB-C cables
System Schematic