View source for ICX-500 software upgrade

{{I}}
<br><br>
<div style="float:right;"> <youtube width="350" height="210">KLYJNVdX35Q</youtube>  </div>
This article describes how to upgrade the software of the [[ICX-500 Gateway|ICX-500 and ICX-510 Gateways]].
{{Note|ICX-500 with hardware revision .0102 requires minimum FW 1.2.3.3}}
During the upgrade process the users (intercom stations and other devices connected) will be out of service for approximately 35 seconds. Any ongoing conversations will be cancelled and not restored.

== Backup customer data ==
Customer data must be backed up by doing a '''[[Communicate_(alphaPro)|GetAll]]''' operation from [[AlphaPro]] before the upgrade is performed.

<br>

== Software Upgrade ==

* [[Downloads|Download]] the software image file, e.g. '''vsfx-1.4.3.0.swu'''. This file is a complete image, and includes both the Linux OS and all applications.
* Use an internet browser and log on to the [[ICX Web|ICX Web interface]] and select '''System Maintenance ''' > '''System Upgrade'''.
* '''Browse''' to the image file, and select '''Upload'''

[[File:ICX500 Sw Upgrade2.PNG|left|thumb|700px|Software Upgrade from the web interface]]
<br style="clear:both;" />

* Scroll down and select '''Install'''
* The upgrade status is shown in a separate window:

[[File:ICX500 Sw UpgradeStatus.PNG|left|thumb|500px|Software Upgrade status in the browser]]
<br style="clear:both;" />

* When the software installation is finished the system will restart with the new software image.

<br>

== Restore customer data ==
The customer data is normally automatically restored after the software upgrade.

If that is not the case, restore the customer data by doing a '''[[Communicate_(alphaPro)|SendAll]]''' operation from [[AlphaPro]]. Reset the gateway when the SendAll is finished.

<br>

== Roll back ==
The ICX Gateway has two memory partitions. When upgrading the software, the partition which is not currently in use will be updated. When the update is finished, the ICX Gateway will restart using the updated partition. 

If for some reason the newly updated partition doesn't work properly, it is possible to roll back to the other partition:

[[File:ICX500 RollBack.PNG|left|thumb|700px|Roll back to other partition]]
<br style="clear:both;" />

In '''System Monitoring''' > '''System Information''' you can see which partition is currently active (A or B). 

<br>

== Image recovery from SD Card ==
In the unlikely event of a system crash, it is possible to recover the system by inserting a SD Card with a recovery image.

{{obs| 
* ''All existing data on the ICX-500/510 Gateway will be erased by this process''
* ''Configuration data, licenses, log files and audio messages will be deleted''
* ''The new image will be written to both partitions A and B'' }}

=== Prerequisites ===
* Micro SD card, minimum 1 GB, FAT filesystem
* The PC must have the software [https://sourceforge.net/projects/win32diskimager/ Win32DiskImager] installed

=== Prepare the SD Card ===
* Download the zipped image file
** ICX-500: '''vsfx-prod-icx500-1.4.3.0.img.zip'''
** ICX-510: '''vsfx-prod-icx510-1.4.3.0.img.zip'''
* The zip file contains one file '''sdcard_archive.img'''. Unzip the file to a known location on the PC. 
* Insert the SD card in your computer
* Start Win32DiskImager
* Select the image file '''sdcard_archive.img'''

[[File:SD Card Image Select.PNG|left|thumb|700px|Selecting the image file '''sdcard_archive.img''']]
<br style="clear:both;" />
* Verify that correct "Device" is used for the SD card, in this example the SD card is available as drive  "E:"
* Press "Write" to start burning the SD card.
* Confirm overwrite by '''Yes''':

[[File:SD Card Image Confirm.PNG|left|thumb|700px|Confirm writing to the SD card]]
<br style="clear:both;" />

* A progress bar shows the write progress, it takes approx 30 seconds.
* When finished, remove the SD card from the computer

=== Flashing files to the ICX Gateway ===
* Power off the ICX Gateway
* [[ICX-500_Gateway#Accessing_the_SD_Card_and_Factory_Default_button|Open the lid]] to access the slot for the SD card
* Insert the SD card into the slot
* Open the top cover of the ICX Gateway (Four screws, two at top side, two at bottom. Tool: Torx T10)
* Turn DIP switch 6 to the ON position (leave all other switches as is)
* Insert a jumper on pinheader S2 (disables the watchdog)

[[File:SD Recovery DIPsw6ON.png|left|thumb|500px|DIP switch 6 ON: Force the ICX Gateway to start image recovery from the SD card<br>Jumper on pinheader S2: Disable the watchdog]]
<br style="clear:both;" />

* Press and hold the [[ICX-500_Gateway#Accessing_the_SD_Card_and_Factory_Default_button|factory reset (cold boot) button]] while powering on the ICX Gateway
* Wait until the orange Fault LED turns off, then release the button
* The ICX Gateway will now start flashing new files from the SD card. The process will normally take up to 5 minutes, depending on the speed of the SD card. The progress is indicated by LEDs. (If a PC is connected to the [[ICX-500_Gateway#Connectors|RS232 serial console port]], one can also follow the progress on the screen)
** First the green Status LED will blink intermittently to indicate NOR flashing, and finally go steady when finished
** Next the blue Active LED will blink intermittently to indicate NAND flashing, and finally go steady when finished
** If there is an error during the flashing process, the orange Fault LED will be turned on and flashing process will stop
* When the green Status LED and the blue Active LED are both ON, and the orange Fault LED is off, the flashing is correctly completed. (The serial console port will display " ''Turn off X500 and reset DIP switches to NOR boot''").

=== Finalize the ICX Gateway ===
* Power off the ICX Gateway
* Turn DIP switch 6 to the OFF position
* Remove the jumper on pinheader S2 

[[File:SD Recovery DIPsw6OFF.png|left|thumb|500px|DIP switch 6 OFF will force the ICX Gateway to boot from the internal flash memory]]
<br style="clear:both;" />

* Remove the SD card
* Power on the ICX Gateway. It will now boot from the internally flashed image
* Verify access to the web interface of the ICX Gateway at IP address '''169.254.1.5''' at Eth0 port
* If all is OK, power off the ICX-500, and replace the lid and the top cover.

[[Category: ICX-AlphaCom Platform]]
[[Category:Upgrade and Recovery]]

== Related Articles ==
* [[:Category: ICX Release notes|Software Release Notes]]

[[Category: ICX Release notes]]