Updating CX5100 and CX5500 Firmware
An earlier article entitled Polycom CX5100 for Lync 2013 introduced the newest RoundTable device for Lync, briefly discussing the firmware update process. As this product was brand new at the time there had been no newer firmware updates yet released to warrant covering that process in detail.
Now that the CX5100 and the nearly identical CX5500 have been out for some time a few firmware updates have been made available for them. As usual it is always a best practice to utilize the latest device firmware version available to provide for the best experience possible. And like the other Updates articles on this blog site the following table will be updated over time to capture any future releases for these two new products. For details on the older CX5000 models head over to this older article.
The same software release package is applicable to both the CX5100 and CX5500 models so there are no separate download files to worry about. The CX5500 does include additional Polycom UC software similar to what is found in the VVX phones which is already included in the package, but this additional code is simply unused by the CX5100 model.
For details on specific issues addressed in each update check the ‘Resolved Issues’ table listed near the end of the Release Notes for that specific version. Some of the new features provided in future releases are also covered at the end of this article.
|1.0.0||December 2013||Initial Release of CX5100 model||Control Panel|
|1.1.0-10114||4/2/2014||Hotfixes and support added for the CX5500 model||Release Notes
|1.1.1-10117||9/5/2014||Hotfixes and security related patches||Release Notes
|1.1.2-32157||11/10/2014||Hotfixes and new functionality:
– CX5500 touch interface call control options when USB tethered to Lync
– CX5500 embedded UCS firmware upgraded to 126.96.36.19980
|1.1.3-12||4/30/2015||Hotfixes and new functionality:
– CX5500 incoming call display localization
– CX5500 embedded UCS firmware upgraded to 188.8.131.5274
|1.1.4-50070||8/3/2015||Software downgrade option and new Fisheye Correction feature for the active speaker video stream||Release Notes
|1.1.5-50111||11/2/2015||Hotfixes and hardware driver updates
– Driver support for new CX5500 touchscreen hardware
– Added Hardware and Software Compatibility Check feature
|1.2.0-70232||4/15/2016||Hotfixes and new functionality:
– USB connectivity support for Mac OS X workstations
– Org ID support added for O365 registration with CX5500 UCS client
– Web Management UI enabled on the CX5100
– Firmware Upgrade supported directly from Web Management UI
|1.3.0-110230||3/20/2017||Hotfixes and new functionality
– Updated UI to match VVX series
– Caller details and optimized dial pad added to CX5500 interface
– Added video panorama support to supported Mac OS X clients
– Export configuration details or Wireshark trace data to USB Flash Drive
These new models include a few different available methods for updating the firmware on the device. Older models were basically limited to a single process which was not all that user-friendly. It required installing an application on a Windows PC, physically connecting a Windows computer via USB, reading the documentation to find a little known default device password, and then finally copying the package files to the device using a complicated command line utility.
The newest models have completely redesigned the upgrade process to provide for different requirements. For one-off, hands-on updates the software can simply be dropped on a standard USB flash drive and inserted into the system to trigger an instant upgrade. Yet for bulk updates the software can be retrieved from a central location and scheduled for periodic updates to automatically be applied.
The multicolored LEDs surrounding the three Mute buttons on the camera base of either model are used to indicate the current readiness status of the device when powered on.
- No Light – Device is ready to be used and mute is not enabled. (Or it is powered off.)
- Solid Red – Device is ready to be used and the microphones are muted.
- Flashing Green – Device is powering on or rebooting.
- Flashing Red/Green – Device is performing a firmware update process.
USB Flash Drive
By far the simplest method, and a welcome change over the previous generation device, a single file can be copied to a USB flash drive and inserted in the camera base to trigger an automatic update. This process can be used to perform either an upgrade or a downgrade as the device will apply whatever version firmware is provided. Do not store more than one firmware package on the drive, only copy over the desired version.
- Download the desired firmware package form the table above and then save the .tar file to the root of a USB flash drive. (Do not decompress the package or extract the files.)
- The USB drive should be formatted as FAT32 . (FAT partitions are also compatible but NTFS-formatted volumes are not.)
- Insert the USB drive into the USB Type-A slot located at the base of the tabletop camera unit.
The secondary USB port on the Power/Data Box can also be used but this port is typically the blocked with a small rubber plug. It is simply easier to just use the more accessible port on the camera base.
After inserting the USB flash disk the device (when idle and not actively in a Lync call) will look at the root directory of the volume and search for a valid firmware update package.
- On a CX5100 if a valid firmware file is located then the upgrade process begins automatically within a few seconds. The three mute buttons will begin to alternately flash red and green to indicate that the process has begun.
- On a CX5500 the display will report a successful discovery of the firmware package on the USB disk, prompting to either cancel or proceed with the upgrade. This screen will automatically advance to the upgrade process within a few seconds so there is no requirement to confirm by actually selecting OK. Tapping Cancel within those first few seconds though will interrupt the automatic process and return to the main menu.
On either model the process is the same from this point forward as the blinking red and green lights indicate the firmware is being updated and the process should not be interrupted.. The CX5500 will additionally report the current upgrade status on the integrated display
From this point on do not attempt to use the device, disconnect, or connect anything. Removing the USB flash drive could corrupt the firmware and damage the system.
The device will first download the files from the USB disk and then perform a reboot within one to two minutes. After the first reboot completes it will begin installing individual files in the firmware packages which typically takes about 10 minutes for the first batch of components. A second reboot may be triggered mid-way through this process potentially a third reboot to complete then entire process. The entire process should only take about 15-20 minutes.
After the final reboot the blinking lights will stop and the main screen will be displayed on a CX5500.
- Remove the USB drive.
Although not necessary, if desired the firmware version can be checked to validate the expected version was successfully applied. This is very easy on the CX5500 as it can be looked up on the device itself or via the integrated UCS web management interface (covered later in this article). But on the CX5100 only way to check without connecting from a separate PC would be to review the device log files. (Additionally the control panel application can also be used on either model as an alternative method, covered in the next section.)
The following process is valid for either model (CX5100 or CX5500).
- Connect the same USB flash drive which was just used for the update to a computer and look for a folder on the root directory named with the device’s Serial Number (e.g. 88142541B785DB).
- Open this folder and look for the most recent log file package (e.g. log_1411222116678.tgz) which should have been written to the USB drive after the last boot up process.
- Open the desired .tgz file with a compatible application (like WinRar) and then open the data\log\system_properties.txt file.
- Search for the string “polycom.ver” to locate the reported version (ro.build.polycom.ver) and build number (ro.build.polycom.num) strings in the file. In the example below the device’s current firmware is the 1.1.0-10117 release.
As mentioned a much easier way to do this on the CX5500 is to use the touch interface to browse to the Phone status menu.
- On the device’s home screen select Settings > Status > Platform > Phone and review the Device Software Version value.
Also briefly mentioned in a previous article was the new Polycom CX5100/CX5500 Control Panel application which provides the ability to manage, update, customize, and troubleshoot the devices in ways not possible with the older generation RoundTable models.
Fellow Lync MVP and Polycom employee Brennon Kwok has already posted an excellent article covering the various options in the Control Panel application so all aspects of the utility do not need to be rehashed here. As the focus of this article is on updating the firmware then only the Software Update sections will be covered.
Note that the update processes triggered by the control panel require that the CX5100 or the CX5500 is connected to an Ethernet network, the device has a valid IP address, and has access to the Internet (or to the network location of a custom update server if one is defined).
Also this process cannot be used to downgrade a device as it will only apply newer updates that are stored on the configured update server. The only supported method to downgrade a device is via the USB process shown in the previous section.
The control panel can be used to update the firmware in one of two ways: either immediately or scheduled for a future, reoccurring time.
- Download and install the latest version of the CX5100/CX5500 Control Panel Application from the Polycom Support site on an Windows workstation.
- Connect the CX device using the blue USB 3.0 Type A-to-B cable from the tabletop camera base to the workstation.
- Launch the CX5100/CX5500 Control Panel Application and the tool should connect to the device and default to the System Information screen under the System section.
Note that the current Device Software Version is displayed in the screen above. Clearly this is a much easier way to verify the current firmware on a CX5100 than the log-based approach shown in the previous section.
The following steps walk through the process of trigging an immediate update over the Internet and without having to download the firmware to a USB drive first.
- Switch to the Software Update menu under the System section and select the Update Now button to initiate an upgrade process.
The device will then connect to the currently configured update Server source and look for a package different than what is currently installed. By default the central Polycom update server which is available over the Internet is defined which always contains the latest publically available firmware package. The exact location is not listed on this menu but is simply shown as ‘polycom’. The next section of this article will show how to point the device to a custom distribution point instead of using the default Polycom server.
- Once the update process begins the control panel will change to show on the update status. Disconnecting the USB cable from the PC at this point will not cause any problems as the device is using it’s own Ethernet connection to retrieve the package directly from the server. The only thing the control panel is doing at this point is reporting the upgrade status.
The remainder of the upgrade process is exactly as described in the USB Flash Drive section earlier in this article. Once complete the control panel will reconnect to the device.
- If the focus changes to the Profile Editor section the device password may be prompted for. Simply hit Cancel and then switch back to the System > System Information screen where the new version can easily be confirmed.
These steps show how to schedule an automatic update using software currently posted to the Polycom update server.
In order to modify the configuration of the device the device password will be required. The default password is the serial number of the unit, but be aware that the tabletop camera unit and the main box typically placed on the floor have different, unique serial numbers. The serial number located on the main floor box is what should be entered here, not the serial number found on the camera base. An easier method to retrieve the serial number is to simply use the control panel as shown in the following steps.
- Launch the CX5100/CX5500 Control Panel Application and the tool should connect to the device and show the System Information screen under the System section.
- Record the Product Serial Number (e.g. 88142541B785DB) as this is also the default device password which will be prompted for in the next step.
- Switch to the Profile Editor section and the control panel application should request the device password. If it does not then either exit the control panel application and restart it, or go to the Load Profile menu in the bottom left corner and select Load from Device.
- Enter the current device password.
- Select the Software Update menu and then select a day under the Update Frequency menu and as well as a time under the Update Time menu.
The example above shows that at 4:00AM device local time every Tuesday the public Polycom update server will be contacted to check for any updates. If at that time a newer version is found on the update server then the same update process and behavior documented earlier in this article will begin.
- To optionally change the firmware distribution point simply replace the text ‘polycom’ with a valid URL of a web server hosting the desired firmware package (e.g. http://server.domain.com/directory/)
Point to the directory where the desired firmware package has been expanded. To prepare the source directory extract the .tar file into the desired location so that the ‘millennium’ folder created by the extraction process is located in the directory that pointed to. Do not point directly to the millennium directory in the update Server path as that is what the device looks for.
For example a subdirectory named ‘update’ was created at the root of the web server in this example and then the latest firmware package was extracted into that directory which automatically created a millennium subdirectory. For future updates make sure to delete all previous files before extracting the new package.
Note that if the Update Server path is changed this also changes the location that the device will go to get updates when the previously discussed Update Now process is manually triggered.
To return the configuration to the default Polycom server simply enter ‘polycom’ as the Update Server value and the device will recognize that name and utilize the hardcoded distribution URL.
- Click the Apply to Device button to write the configuration changes to the device. The update process will begin at the scheduled date and time.
Web Management Interface
This approach is only valid for the CX5500 model as the embedded UC Software stack includes the same web service that the Polycom VVX phones models utilize. Just as with those phones the CX5500 can be updated remotely by accessing the embedded web interface, signing as as an administrator, and then updating the device.
Note that the password used to remotely connect as an Admin or User to the Polycom Web Configuration Utility is not the same as the device password used in the previous step for the control panel application. The embedded UCS stack utilizes its own separate password which is identical to the VVX phones. The default Admin password is ‘456’ and the default User password is ‘123’.
- Connect to the device’s IP address in a web browser.
- Leave the Login As selection on Admin, enter the password (e.g. 456), and click Submit.
- Select the Utilities > Software Update menu.
Note that the options shown above are the same as what the control panel application provides. Whereas the control panel has the immediate update and scheduled update options in different locations the web management utility has them both on the same page.
- To trigger an immediate update process identical to what was covered in the previous section simply click Update Now.
- Alternatively to schedule the update process to be triggered at a later date and/or time configure the Update Frequency and Update Time as desired and click Save.
Additionally the Update Server URL can be changed here, as instructed in the control panel, when needing to utilize a central destitution server other than the public Polycom update server.
This section will include details on some of the more important capabilities added throughout the various updates.
- When a CX5500 model is USB tethered to a Windows workstation running the Lync 2013 desktop client the touch panel on the device can now be used to Answer or Reject an incoming Lync call. The established call can also be placed on Hold or Ended directly from the device.
- When simultaneous audio calls are active on both the tethered Lync client and via the embedded SIP telephony client then the calls can be individually managed using new Calls and PC Lync buttons at the top of the screen.
- The CX5500 model also contains newer embedded Unified Communications Software (UCS) to bring it in line with the current VVX firmware release of 5.2.0. Be aware that selecting the Lync Base Profile in this new release will disable the embedded web management interface as described in this previous article.
- The applicable new features provided in the recent UCS 5.3 release are now available on the CX5500 model. The most important is the inclusion of native Exchange Autodiscover and support for Centralized Conference Control Protocol (CCCP) to provide calendar access and touch-to-join for any Lync Meetings directly from the CX5500’s interface.
- This new version was released solely for adding hardware driver support for a new touchscreen unit. Brand new CX5500 units are now being manufactured using new touchscreen hardware which requires these new drivers. For any previously manufactured CX5500 units already purchased and deployed there is no need to install this update. As the CX5100 does not include a touchscreen there is also no reason to install this update on that model either.
- A major release which adds new functionality to both the CX5100 and CX5500 models. Both are now supported as USB devices with the Lync for Mac 2011 clients on Mac OS X based workstations.
- The web management UI previously available on only the CX5500 is now enabled on the CX5100 as well. Both models now also support the ability to apply new firmware updates directly from the Polycom Hosted Server in the same way that VVX and Trio phones can be updated.
- The CX5500 embedded UCS client is updated to the latest version which includes Org ID support to allow registration to Skype for Business Online in Office 365.
- A major release which adds new functionality to both the CX5100 and CX5500 models. Mac support has been extended to the new Skype for Business for Mac client as well as providing the additional panorama video stream.
- Several UI enhancements provided as part of the UCS 5.5.1 branch of software seen on the VVX 500/600 handsets. Additional UI improvements related to in-call information displayed on the CX5500 interface like Caller information.
- Device configuration information and Wireshark trace files can now be exported to a connected USB flash drive for troubleshooting purposes.