Wiki source code of Updating Firmware

Version 21.1 by Alexander Mott on 2023/12/11 21:08

version	line-number	content
1.1	1	{{box cssClass="floatinginfobox" title="CONTENTS"}}
	2	{{toc/}}
	3	{{/box}}
	4
3.2	5	ShowRunnerCLC™ is tested against the latest Crestron firmware releases, and as such it is recommended to update all device firmware whenever starting up a job. While firmware updates can be performed at any time, it is recommended to update network devices after their network settings have been configured but before loading the ShowRunnerCLC™ program and starting up the job in order to avoid any potential bugs that may result from using outdated firmware. Controlled hardware should be updated once all devices on any given Cresnet/ZUMLINK bus or wireless gateway are online and uniquely addressed. Any communication issues on the bus or gateway should also be resolved prior to updating firmware.
1.1	6
3.2	7	Current Crestron firmware can be downloaded from [[Crestron's website>>https://www.crestron.com/Support/Search-Results?c=4]]. Old firmware releases can be downloaded using an SFTP client (such as FileZilla or WinSCP) and connecting to "ftp.crestron.com"
	8
1.1	9	= Network Devices =
	10
3.2	11	Networked devices (i.e. devices connected via Ethernet to the LAN or Control Subnet) should always be updated when starting up a job. You can check the current firmware version of most network devices by running the ##ver## command in Text Console or by exporting a Device Summary using the Device Discovery Tool.
1.1	12
3.2	13	While these devices can be updated over USB, it is recommended to update these devices over Ethernet whenever possible in order to take advantage of increased file transfer speed of Ethernet and to enable updating multiple devices at once. Since most network devices will reboot as a part of the firmware update process, it is important to be mindful of the order in which devices are updated to avoid losing connection to a device while in the middle of a file transfer. For example, if you have several CEN-GWEXERs that are connected to a CEN-SWPOE-16, it is important to either update the CEN-SWPOE-16 //before// starting the update for any of the CEN-GWEXERs, or wait to update the CEN-SWPOE-16 until //after// all of the CEN-GWEXERs are done updating. If you update all devices simultaneously, you risk damage to the CEN-GWEXERs as a result of losing power mid-update due to the CEN-SWPOE-16 rebooting.
1.1	14
3.2	15	== SFTP and SSH (Processors) ==
1.1	16
3.2	17	Due to the large file size for processor firmware, the most efficient method of updating firmware is to use dedicated third-party SFTP and SSH clients rather than built-in Toolbox functions. This allows for rapidly transferring the large firmware file to the device and then running the update without locking up Toolbox and preventing you from working on other devices while the firmware update is performed.
1.1	18
3.2	19	* Open an SFTP client such as FileZilla or WinSCP (pictured) and connect to the processor at port 22
20.1	20	[[image:sftp1.png\|\|height="309" width="507"]]
3.2	21	* Transfer the firmware file to the "firmware" folder on the processor
20.1	22	[[image:sftp2.png\|\|height="307" width="505"]]
8.1	23	* Connect to the processor using Text Console or an SSH client such as PuTTY and run the command ##puf##
20.1	24	[[image:sftp3.png\|\|height="307" width="502"]]
8.1	25	* Once the ##puf## command is run, you should see messages appear in the console indicating the status of the firmware update
1.1	26
3.2	27	== Package Update Tool (.puf) ==
	28
8.1	29	Crestron's Package Update Tool is the most convenient way of performing firmware updates for devices that use .puf files for firmware. The Package Update Tool can be opened from Toolbox, but doing this will lock Toolbox and only allow updating one device at a time, so we recommend instead that you double-click the .puf file directly. Double-clicking a .puf file will allow you to open multiple instance of the Package Update Tool and enable updating multiple devices simultaneously. Once again, be careful when updating multiple devices simultaneously not to do anything that would disrupt your connection to a device while transferring the .puf file, nor should you do anything that could result in the device rebooting while it is mid-update.
3.2	30
8.1	31	* Locate the firmware .puf file in Windows Explorer
	32	* Double-click the .puf file to open the Package Update Tool
20.1	33	[[image:put1.png\|\|height="386" width="416"]]
8.1	34	* Use the Address Book or the Pencil icon to connect to your processor and wait for it to connect
20.1	35	[[image:put2.png\|\|height="383" width="412"]]
	36	* Verify that the correct .puf file is selected by checking the fields under "Package Info", and re-select the .puf using the "Select..." button if the information is incorrect
8.1	37	* asdf
	38	* asdf
1.1	39
8.1	40	== Quick Function Firmware Updates ==
1.1	41
8.1	42	While most networked devices will use .puf files for firmware updates, some devices (such as DIN-DALI-2) will use .zip files. In these instances, there is no way to use the
	43
1.1	44	= Controlled Hardware =
	45
3.2	46	Controlled hardware such as Cresnet and infinetEX devices are less frequently updated, but nonetheless will occasionally require firmware updates. ZUMLINK devices should always be updated, but these devices are automatically updated whenever their host ZUMNET device is updated as long as the ZUMLINK device is online and uniquely addressed.
1.1	47
	48	== Sub 1 ==
	49
	50	Lorem
	51
	52	== Sub 2 ==
	53
	54	Lorem
	55
	56	== Sub 2 ==
	57
	58	Lorem