HX3 Flash Application: Unterschied zwischen den Versionen

Aus KeyboardPartner Wiki
Zur Navigation springenZur Suche springen
 
(47 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
[[Datei:Hx3_update.png|400px|thumb|right|'''HX3 Update main window, connection established''']]
[[Datei:Hx3_flash.png|400px|thumb|right|'''HX3 Flash main window, connection to DrawbarExpander established''']]


== HX3 Update ==
'''Important:''' Some older HX3 Plexi Expanders had been equipped inadvertently with forged FTDI interface boards which apparently came from a shady chinese company. If HX3 Flash fails, please check if you have a '''blue USB interface board''' installed in your HX3 Plexi Expander. We will exchange them at no cost. Red USB interface boards should not be affected.


'''HX3 Update for Windows''' application (named ''HX3_update.exe'' in [https://github.com/keyboardpartner/HX3/ Github LATEST and BETA] ZIPs) is a "one click solution" to update your '''HX3 mk3/mk4''' board or expander with installed firmware #3.6 and up. You will need an HX3 Expander equipped with USB port, or an USB adaptor cable [http://shop.keyboardpartner.de/epages/13705466.sf/de_DE/?ObjectPath=/Shops/13705466/Products/usbcable FTDI TTL232R 5V], or any USB to serial converter based on FTDI FT232R chipset.


Note: USB-Serial adaptors of other makes will not work with ''HX3 Update''! HX3 Update is not intended for HX3 mk2 boards (marked 3.2 on PCB). Automatic update functions require '''HX3 firmware #3.6''' and up.
== HX3 Flash ==
 
'''HX3 Flash for Windows''' application (named ''HX3_flash.exe'' in [https://github.com/keyboardpartner/HX3/ Github LATEST] ZIPs) is a "one click solution" to update your '''HX3 mk2/mk3/mk4''' board or expander. You will need an HX3 device equipped with USB port, or an USB adaptor cable [http://shop.keyboardpartner.de/epages/13705466.sf/de_DE/?ObjectPath=/Shops/13705466/Products/usbcable FTDI TTL232R 5V], or any USB to serial converter based on FTDI FT232R chipset. We recommend using Windows 7 and newer as it automatically installs FTDI drivers on your computer as needed.
 
Download one of the following ZIPs '''appropriate for your instrument''':
 
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_DrawbarExpander.zip?raw=true Flash_DrawbarExpander.zip]''' - for new HX3 DrawbarExpander
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_ExpanderPlexi_mk2.zip?raw=true Flash_ExpanderPlexi_mk2.zip]''' - for HX3 MIDI Expander Plexi, older mk2 version up to 1/2014
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_ExpanderPlexi_mk3_4.zip?raw=true Flash_ExpanderPlexi_mk3_4.zip]''' - for HX3 MIDI Expander Plexi USB, current mk3/mk4 versions
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_OrganMag.zip?raw=true Flash_OrganMag.zip]''' - for MAG custom organs. Has different drawbar tapering
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_OrganStandard_mk2.zip?raw=true Flash_OrganStandard_mk2.zip]''' - for HX3 standard organ installations with Panel16 or pushbuttons, older mk2 board
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_OrganStandard_mk3_4.zip?raw=true Flash_OrganStandard_mk3_4.zip]''' - for HX3 standard organ installations with Panel16 or pushbuttons, current mk3/mk4 versions
* '''[https://github.com/keyboardpartner/HX3/blob/master/LATEST/Flash_XB2_mk3.zip?raw=true Flash_XB2_mk3.zip]''' - for newer XB2 kits (stereo rotary sim) with mk3/mk4 boards
 
Unzip archive contents to a local folder on your hard disk. It will contain all files needed to update your HX3. '''Update will fail if started directly from ZIP window. Do only use files contained.''' Older files or applications may not work.
 
Note: USB-serial adaptors of other makes will not work with ''HX3 Flash''. Automatic update functions require installed '''HX3 firmware #3.51''' and up. ''HX3 Flash '' will update HX3 boards and expanders with responding firmware, even with corrupted FPGA images or faulty behaviour. In this case, uncheck all '''Restore''' checkboxes prior to '''Update''' click.


== Installation ==
== Installation ==


* This manual assumes you have downloaded and installed the FTDI serial driver package from our Github or FTDI website.
This manual assumes you have downloaded and installed the FTDI serial driver package from our Github or FTDI website. Windows 7 and up will do that automatically for you when you attach the FTDI cable or your USB-equipped HX3 the first time to your PC.
* Click on firmware ZIP from [https://github.com/keyboardpartner/HX3 Github LATEST or BETA] directory you want to download. File download will start by clicking "View Raw" in next window.
 
* Unzip ZIP file to your local harddisk. Use only files and executables in this folder!
* Unzip ZIP file to your local harddisk. Use only files and executables in this folder!
* Unplug your FTDI or USB cable from computer again. It is advisable to plug in '''FTDI cable to HX3 pin header first''', then USB plug of cable to computer, then start ''HX3 Remote''. Always quit ''HX3 Remote'' '''before''' unplugging the FTDI or USB cable.
* Plug in USB or FTDI adaptor cable to your PC.
* Switch on your instrument.
* Double-click ''HX3 Flash'' icon to start.


=== Connect to HX3 Expander with USB ===
=== Connect to HX3 Expander with USB ===


* Power up HX3 Expander. Insert a standard mini USB cable to HX3 Expander and plug in to your PC.  
* Insert a standard mini USB cable to HX3 Expander and plug in to your PC. Wait until Windows has finished driver installation if plugged in the first time.
* Start ''HX3 Update'' and click on '''Connect''' button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click '''OK'''.  
* Power up your HX3 Expander.  
* HX3 should respond to the Console window at bottom and show startup info. '''Update''' button will be enabled if everything is OK.  
* Start '''HX3 Flash''' and click on '''Connect''' button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click '''OK'''.  
* Move mouse over some items; the bottom hint line will show help info.
* HX3 should respond to the Console window at bottom and show startup and licence info. '''Update''' button will be enabled if everything is OK.
* Move mouse over some items; the bottom hint line will show help info. Proceed to '''Update Procedure''' section below.
 
=== Connect to HX3 organ with USB on Extension board ===
 
* Insert a standard USB A/B cable to HX3 Extension board USB and plug in to your PC. Wait until Windows has finished driver installation if plugged in the first time.
* Power up your HX3 organ.
* Start '''HX3 Flash''' and click on '''Connect''' button. A dialog window appears whichs asks to select one of the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click '''OK'''.
* HX3 should respond to the Console window at bottom and show startup and licence info. '''Update''' button will be enabled if everything is OK.  
* Move mouse over some items; the bottom hint line will show help info. Proceed to '''Update Procedure''' section below.


=== Connect to HX3 Mainboard ===
=== Connect to HX3 Mainboard ===


[[Datei:ftdi_reset.jpg|400px|thumb|right|'''FTDI cable connected to HX3, reset jumper (green) in place for updating very old firmwares.''']]
[[Datei:ftdi_reset.jpg|400px|thumb|right|'''FTDI cable connected to HX3 (your pin header may be straight and not angled), reset jumper (green) in place for updating very old firmwares before 3.51''']]


[[Datei:Deviceview.png|400px|thumb|right|'''HX3 Remote Select Device dialog''']]
[[Datei:Deviceview.png|400px|thumb|right|'''HX3 Remote Select Device dialog''']]


For updating a bare HX3 board, you will need the FTDI USB adaptor cable or our small red USB interface board which basically does the same as the FTDI cable. It is advisable to plug in '''FTDI cable to HX3 pin header first''', then USB plug of cable to computer, then start ''HX3 Flash''.
* Make sure jumpers '''JP7 and JP8 are removed'''.
* Connect header of FTDI USB adaptor cable to your HX3 board as shown in picture.
* Connect header of FTDI USB adaptor cable to your HX3 board as shown in picture.
* Power up HX3 board. Plug in FTDI cable to your Windows PC.  
* Power up HX3 board. Plug in FTDI cable to your Windows PC.  
* Start ''HX3_update.exe'' by double click. The application is completely self-contained and does not need any installation.
* Start '''hx3_flash.exe''' by double click. The application is completely self-contained and does not need any installation.
* Click on '''Connect''' button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click '''OK'''.  
* Click on '''Connect''' button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click '''OK'''.  
* HX3 should respond to the Console window at bottom and show startup info. '''Update''' button will be enabled if everything is OK.  
* HX3 should respond to the Console window at bottom and show startup info. '''Update''' button will be enabled if everything is OK.  
* Move mouse over some items; the bottom hint line will show help info.
* Move mouse over some items; the bottom hint line will show help info. Proceed to '''Update Procedure''' section below.


== Update Procedure ==
== Update Procedure ==


* Download newest HX3_firmw_xxx ZIP, unpack to new folder. Use only files/applications contained.
* Click '''Update'''. ''HX3 Flash'' will read previous settings from board.
* Plug in USB and power supply cable, start ''HX3 Update'' and click '''Connect'''.
* Firmware update procedure takes about two minutes. If HX3 does not recover from flash process and ''HX3 Flash'' waits for reboot, switch HX3 board off and on again. Leave USB cable connected.
* Click '''Update'''. ''HX3 Update'' will read previous settings if checkboxes are enabled. Note: Retaining old information may cause problems if current firmware on HX3 is more than .1 version step older than new firmware. If in doubt, uncheck '''Restore Organ Defaults'''. You may have to restore your personal defaults manually by MenuPanel.
* After firmware update, ''HX3 Flash'' will restore licence numbers. It will also restore ''Presets'' and ''MIDI CCs''.
* Firmware update procedure takes about one minute, programming progress shown in separate command window. ''HX3 Update'' will determine your firmware type (expander, standard mainboard, single drawbars etc.) automatically.
* ''HX3 Flash'' checks if FPGA sound engine is up-to-date. If not, it will update all necessary files in HX3. This may take a few minutes.
* After firmware update, ''HX3 Update'' will restore licence numbers. It will also restore ''Presets'', ''Organ Defaults'' and ''MIDI CCs'' if corresponding checkbox is enabled.
* ''HX3 Update'' checks if FPGA sound engine is up-to-date. If not, it will update all necessary files in HX3. This may take a few minutes.
* Check your serials/licences, user and FW information and indicators near licence fields are both light green, showing "OK". Done.
* Check your serials/licences, user and FW information and indicators near licence fields are both light green, showing "OK". Done.
''HX3 Flash'' creates a licence backup and a log file (both text format) in its own directory. If your HX3 lost its licence information for any reason, you may enter valid licence numbers (and new User Name) before clicking "Update" button. We can create new licences at any time at no cost, just email to info [at] keyboardpartner.de regarding "LICENCE LOST".
'''Note for OEMs:''' HX3 Flash might be customized to your specific needs. See wiki page '''[[HX3 Flash for OEMs]]'''.

Aktuelle Version vom 31. Mai 2016, 13:17 Uhr

HX3 Flash main window, connection to DrawbarExpander established

Important: Some older HX3 Plexi Expanders had been equipped inadvertently with forged FTDI interface boards which apparently came from a shady chinese company. If HX3 Flash fails, please check if you have a blue USB interface board installed in your HX3 Plexi Expander. We will exchange them at no cost. Red USB interface boards should not be affected.


HX3 Flash

HX3 Flash for Windows application (named HX3_flash.exe in Github LATEST ZIPs) is a "one click solution" to update your HX3 mk2/mk3/mk4 board or expander. You will need an HX3 device equipped with USB port, or an USB adaptor cable FTDI TTL232R 5V, or any USB to serial converter based on FTDI FT232R chipset. We recommend using Windows 7 and newer as it automatically installs FTDI drivers on your computer as needed.

Download one of the following ZIPs appropriate for your instrument:

Unzip archive contents to a local folder on your hard disk. It will contain all files needed to update your HX3. Update will fail if started directly from ZIP window. Do only use files contained. Older files or applications may not work.

Note: USB-serial adaptors of other makes will not work with HX3 Flash. Automatic update functions require installed HX3 firmware #3.51 and up. HX3 Flash will update HX3 boards and expanders with responding firmware, even with corrupted FPGA images or faulty behaviour. In this case, uncheck all Restore checkboxes prior to Update click.

Installation

This manual assumes you have downloaded and installed the FTDI serial driver package from our Github or FTDI website. Windows 7 and up will do that automatically for you when you attach the FTDI cable or your USB-equipped HX3 the first time to your PC.

  • Unzip ZIP file to your local harddisk. Use only files and executables in this folder!
  • Plug in USB or FTDI adaptor cable to your PC.
  • Switch on your instrument.
  • Double-click HX3 Flash icon to start.

Connect to HX3 Expander with USB

  • Insert a standard mini USB cable to HX3 Expander and plug in to your PC. Wait until Windows has finished driver installation if plugged in the first time.
  • Power up your HX3 Expander.
  • Start HX3 Flash and click on Connect button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click OK.
  • HX3 should respond to the Console window at bottom and show startup and licence info. Update button will be enabled if everything is OK.
  • Move mouse over some items; the bottom hint line will show help info. Proceed to Update Procedure section below.

Connect to HX3 organ with USB on Extension board

  • Insert a standard USB A/B cable to HX3 Extension board USB and plug in to your PC. Wait until Windows has finished driver installation if plugged in the first time.
  • Power up your HX3 organ.
  • Start HX3 Flash and click on Connect button. A dialog window appears whichs asks to select one of the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click OK.
  • HX3 should respond to the Console window at bottom and show startup and licence info. Update button will be enabled if everything is OK.
  • Move mouse over some items; the bottom hint line will show help info. Proceed to Update Procedure section below.

Connect to HX3 Mainboard

FTDI cable connected to HX3 (your pin header may be straight and not angled), reset jumper (green) in place for updating very old firmwares before 3.51
HX3 Remote Select Device dialog

For updating a bare HX3 board, you will need the FTDI USB adaptor cable or our small red USB interface board which basically does the same as the FTDI cable. It is advisable to plug in FTDI cable to HX3 pin header first, then USB plug of cable to computer, then start HX3 Flash.

  • Make sure jumpers JP7 and JP8 are removed.
  • Connect header of FTDI USB adaptor cable to your HX3 board as shown in picture.
  • Power up HX3 board. Plug in FTDI cable to your Windows PC.
  • Start hx3_flash.exe by double click. The application is completely self-contained and does not need any installation.
  • Click on Connect button. A dialog window appears whichs asks to select the FTDI USB cable from the FTDI devices it has found; normally, it should be named "TTL232R", "FT232R USB UART" or similar, and only one is shown. Select it and click OK.
  • HX3 should respond to the Console window at bottom and show startup info. Update button will be enabled if everything is OK.
  • Move mouse over some items; the bottom hint line will show help info. Proceed to Update Procedure section below.

Update Procedure

  • Click Update. HX3 Flash will read previous settings from board.
  • Firmware update procedure takes about two minutes. If HX3 does not recover from flash process and HX3 Flash waits for reboot, switch HX3 board off and on again. Leave USB cable connected.
  • After firmware update, HX3 Flash will restore licence numbers. It will also restore Presets and MIDI CCs.
  • HX3 Flash checks if FPGA sound engine is up-to-date. If not, it will update all necessary files in HX3. This may take a few minutes.
  • Check your serials/licences, user and FW information and indicators near licence fields are both light green, showing "OK". Done.

HX3 Flash creates a licence backup and a log file (both text format) in its own directory. If your HX3 lost its licence information for any reason, you may enter valid licence numbers (and new User Name) before clicking "Update" button. We can create new licences at any time at no cost, just email to info [at] keyboardpartner.de regarding "LICENCE LOST".

Note for OEMs: HX3 Flash might be customized to your specific needs. See wiki page HX3 Flash for OEMs.

Abgerufen von „https://wiki.keyboardpartner.de/index.php?title=HX3_Flash_Application&oldid=2909“