HX3 Flash for OEMs

Information given here is intended for OEM use only.

Due to some demand I changed the HX3 Flash Application behaviour.

Former versions of HX3 Flash Application checked what firmware was installed on the HX3 board and tried to determine what might be adequate to install. That often lead to unwanted results if parameters in new firmware changed significantly. Or I had a lot of work implementing minor parameter changes for various OEM *.hex files.

The new HX3 Flash is customizable by OEMs like you, so it might be completely adapted to your needs. You might prepare a package for your customers like the Flash_*.ZIPs on our Github repository, containing only the necessary files for a specific instrument. The behaviour of HX3 Flash is controlled by an INI file named hx3_flash_config.ini which is human-readable and may be customized by a simple text editor. Content of INI looks like this example:

/// Configuration file for HX3 MIDI Expander      ///
/// Extend to other parameters at own discretion  ///
/// Disable lines with comment char '/' at start  ///

[BoardInfo]=

/// Disable update of user info or licences by commenting.
/// WARNING: old licence numbers will be overwritten if enabled. 
new_user_name=Hans Wurst
/new_organ_licence=7654321
/new_rotary_licence=1234567

[Files]=

/// this name is showed in HX3 Flash window, nothing else.
firmware_name=HX3 Expander

/// Disable loading/update of particular file by commenting.
avr_filename=HX3mk3_expander.hex
fpga_filename=fpga_20122015.bit

/// If FPGA is updated, all taper_levels files, 
/// fir_coeff and dsp_rev must be activated as well.
taper1_filename=taper_levels1.dat
taper2_filename=taper_levels2.dat
taper3_filename=taper_levels3.dat
taper4_filename=taper_levels4.dat
fir_coeff_filename=fir_coeff.dat
dsp_rev_filename=dsp_rev.bin

/// If FPGA is updated, at least MIDI and the scan core 
/// used in your instrument must be activated.
/scancore0_filename=HX_CHAIN.DAT
scancore1_filename=HX_MIDI.DAT
scancore2_filename=HX_FATAR.DAT
/scancore3_filename=HX_SR44.DAT
/scancore4_filename=HX_SR49.DAT
/scancore5_filename=HX_SR61.DAT
/scancore6_filename=HX_TEST.DAT
/scancore7_filename=HX_XB2.DAT

[ButtonEnables]=

/// Disable buttons that should not be used

restore_organ=false
restore_presets=true
restore_midi=true

[Parameters]=

/// parameters that must be restored to old value end with '=?'
/// Boolean on/off values are 255 or 0
/// Disable lines with comment char '/' at start

/ MIDI Channel:
433=?
/ Split default mode:
/436=?
/ Jack config A:
438=?
/ Jack config B:
439=?
/ ScanCore:
477=?
/ Analog input Enable:
478=?
/ Button mask PL7:
479=?
/ Button mask PL11:
480=?
/ Preset number to select second drawbar set:
483=?
/ No splitted Preset16 panel:
484=?
/ Save tabs to presets:
485=?

/// parameters to set do have a value
/// Boolean values are 0 or 255
/// Disable lines with comment char '/' at start

/ Jack config A:
/438=1
/ Jack config B:
/439=18
/ ScanCore:
477=0
/ Button mask PL7:
479=255
/ Button mask PL11:
480=240
/ Preset number to select second drawbar set:
483=1
/ No splitted Preset16 panel:
/484=0
/ Save tabs to presets:
/485=1

[End]

Lines can be disabled by placing a comment character '/' in first column. As you see, you can decide which buttons are enabled and which parameters have to be tweaked after the new firmware was installed. User Name and Licences are always restored to olde values. You may force HX3 Flash to write new user/licence info by new_user_name, new_organ_licence= and new_rotary_licence= command.

Therefore, you may adjust parameters to your taste or to requirements of your instrument - without urging me to re-compile just for some parameter issues. All parameter numbers given in HX3 Remote pages are valid, so you may even change rotary params or MIDI CCs.

For your convenience, I left some parameters in which are disabled by '/' comment character. You may enable them just by removing the leading '/'. Please note: Valid parameter commands must start with a digit, no spaces or comments are allowed in a command line.