Quelltext der Seite HX3.5 Firmware 5.8 Migration Guide (english)

[[Datei:HX35_1.JPG|400px|thumb|right|'''HX3.5 Board''']]

== Features ==

Compared to the HX3.5 firmware #5.7xx, configurable organ and speaker models (16 different ones each) have now been added, which can be customized to your own taste. Instead of the individual values responsible for this, only the organ or rotary/speaker number is now stored in the preset. Menu entries have been added for selection of predefined organ and speaker models. If a menu value is stored in the currently selected organ or rotary/speaker model instead of preset or defaults, the menu will display the code letters "O" or "R". FPGA (Sound Engine), Scan Driver, Presets, CC Sets, Taperings and Wavesets remain the same, so you can continue to use your own presets or taperings.

=== Software ===

For firmware #5.808 and up you need the new ''HX3 Manager'' version #6.06, which is included in the update package. Firmware #5.8xx uses the same parameters (see ''HX3 Editor'' table) as firmware #5.7xx with some exceptions; some now redundant ones (like various vibrato presets) have been dropped. Check the following values carefully and correct them if necessary:

* Some '''System Inits''' parameter numbers have moved: "2nd DB Set Voice Number" has moved to #1505. #1504 should be "0" (the 1st DB Set number has no effect on the HX3.5 yet)
* '''System Inits''' "Preset Save/Restore Mask" #1498 has changed bit coding (see parameter help text in editor).
* The '''Switch Remap''' codes for the Voice and Preset buttons starting with parameter #5100 have been changed to make room for the now possible buttons of the new Organ and Speaker models. The "Adding" preset mode was changed from value 100 to 104, as was Upper from 102 to 101, Lower from 103 to 102, and so on. This was necessary to implement organ and speaker preset key groups.
* As with presets and drawbar voices, you can define '''related button groups''' for organ and speaker models on Panel16/Preset16/Extend16 boards. You assign the organ and speaker models assigned to each button using the ''Model Btn Assign'' groups (#5400 and up). It is thus possible to select only the models you are interested in from the 16 available, which reduces the number of buttons required.
* All older presets with non-B3 settings (H100, EG mode) should be revised for organ model and speaker model values. For these, the old preset settings are no longer valid. A preset now stores the respective organ model and speaker model used instead of the individual values for these.
* Some other button assingment values have shifted: For the '''Transpose Up/Down''' buttons, select values 76 and 77, for example to perform a quick key change. Press both transpose buttons at the same time to cancel the transposition.
* Added '''Inc/Dec Buttons''' in ''Switch Remap'': You may assign buttons on Panel16/Preset16/Extend16 to increment/decrement Preset, Drawbar Voice, Organ and Speaker Model number. Press both Inc/Dec buttons of an assignment simultaneously to reset the controlled value (e.g. voice number) to 0.
* New '''MIDI Send Only''' analog controls: An analog control (drawbar, pot) assigned to values 200..211 "MIDI CC Send #0..#11" in ''Analog Remap'' will send MIDI control change only and will perform no other function. The channel and CC# has to be defined in CC Set Editor, group MIDI CC Send Function". Assigned channel numbers are fixed in this case and will not move with HX3 MIDI channel. You can thus use drawbars or potentiometers on the HX3 to control other MIDI equipment.
* Preset names can be edited directly on the device/instrument
* Small change: The vibrato button mode "3 Buttons" (set in ''System Inits'' #1497) has changed in operation. Press V1 and V2 buttons simultaneously to get V3 or C3.

=== Updates ===

The ''HX3 Manager'' in version #6.0x does no longer perform automatic updates for HX3.5 devices. The parts needed for the update are listed in the changelog on our update page instead. Normally, an update should be limited to the firmware (file "firmware.bin"), unless the changelog explicitly refers to other parts. Use ''HX3 Updater'' menu "Update via USB or FTDI cable".

With updates from older versions below #5.730 quite a lot of default parameters (EEPROM) may have changed; the organ may sound bad with it. It is then advisable to also perform an EEPROM update and manually perform the settings required for your own device (e.g. button, switch and drawbar assignments) in the HX3 Editor.

'''Update procedure with SD card'''

* Copy the files needed for the update including the ''update.ini'' file from the ''update'' directory to a freshly formatted SD card with FAT32 and default settings. These are for example the files ''firmware.bin, organs.dat, speakers.dat'' and ''presets.dat''.
* Navigate to the ''SD File Exec'' entry in the main menu of the HX3 and execute the UPDATE.INI file.

'''Update procedure with HX3 Manager (short form)'''

* Start HX3 Manager app, connect to device (by USB or FTDI cable) and open ''Updater''. Check versions.
* Upload new firmware with menu ''Update via USB or FTDI cable''. HX3 will restart.
* On firmwares prior to 5.730, upload EEPROM file as well (means loss of some personal default settings!). HX3 will restart.
* If previous FPGA sound engine version ist not #21102022, also update FPGA (hx3_main.bin).
* HX3 Updater will request a reset after each step. Please follow instructions in dialog boxes.
* If previous DSP version is below #x1.23, connect USB and update DSP with menu Update via USB or FTDI cable/DSP firmware.
* If previous firmware was belov version # 5.08xx, upload ''Organ Models'' and ''Speaker Models'' with menu ''Update via USB or FTDI cable''. Organ and speaker presets will not work without. However, settings in these files are not final yet.
* Disconnect and power cycle HX3.5 and re-connect before making any changes in HX3 Editor.

== First Aid ==

You have installed a new board or new firmware and there is no sound or some functions are faulty? Check the following settings with the HX3 Manager:

=== HX3 Manager does not start or with error message ===

* Hold down the SHIFT key when starting (double click ''hx3_manager.exe''). This resets possibly faulty screen positions. This works only from HX3 Manager version #6.06.
* The HX3 Manager should be installed (unpacked/copied) in a directory whose path does not contain spaces or diacritical characters/umlauts, so for example ''D:\documents\hx3_stuff\'' would be OK.

===No/erraneous connection===

* Is a scan board connected? Operation without scan board is only possible with HX3 Expander or MIDI scan driver installed.
* In normal operation, the blue LED on the HX3 mainboard flashes about once per second, as well as when sending MIDI data. If it is lit continuously, an analog control input is probably open and "floating", which is why MIDI data is being sent all the time. In this case, connect the HX3 Manager with "Disable Analog Inputs on Connect" checked. This will temporarily set System Inits parameter #1503 to 0. '''Do not store System Inits with wrong #1503 value''', otherwise analog controllers, swell pedal and foot switches '''will not work'''.

===Version Check===
* Is valid board information displayed in the HX3 Updater (version and serial numbers, min. activation Organ Licence OK)?
* Does the displayed scan driver match your scan board? If not, install matching Scan Driver.

===No Sound===

* Are the manual enables in MIDI Setup #1373 set to 7?
* Are the volume pots set to plausible values?
* Are the System Inits correctly set in the HX3 Editor? Typical for an organ with 2 drawbar sets per manual is the following configuration:
 1496 = 0     / (not used)
 1497 = 0     / Vibrato Knob Mode
 1498 = 23    / CommonPreset Save/Restore Mask
 1499 = 0     / (RFU)
 1500 = 0     / (RFU)
 1501 = 23    / Various Configurations 1
 1502 = 5     / Various Configurations 2
 1503 = 2     / ADC Configuration
 1504 = 0     / 1st DB Set Voice Number (enabled when 0..15)
 1505 = 1     / 2nd DB Set Voice Number (enabled when 1..15)
 1506 = 0     / Pedal Drawbar Configuration
 1507 = 100   / ADC Scaling
 1508 = 4     / ADC Hysteresis
 1509 = 3     / HX3 Device Type

===Pot/Drawbar Assignments===

* When moving the (in case of 2 DB sets of the active) drawbars, the corresponding values of the ''Upper DB'', ''Lower DB'' etc. must change. If not: Are the analog inputs activated (''System Inits'' #1503) and correctly assigned (''Analog Remap'')? If necessary, check the raw values of the analog inputs in the editor tab "Input Monitor". 
 5000 = 0     / Analog Input 0 (UPR PL22-1) Function
 5001 = 1     / Analog Input 1 (UPR PL22-2) Function
 5002 = 2     / Analog Input 2 (UPR PL22-3) Function
 5003 = 3     / Analog Input 3 (UPR PL22-4) Function
 5004 = 4     / Analog Input 4 (UPR PL22-5) Function
 5005 = 5     / Analog Input 5 (UPR PL22-6) Function
 5006 = 6     / Analog Input 6 (UPR PL22-7) Function
 5007 = 7     / Analog Input 7 (UPR PL22-8) Function
 5008 = 8     / Analog Input 8 (UPR PL22-9) Function
 5009 = 80    / Analog Input 9 (UPR PL22-10) Function
 5010 = 81    / Analog Input 10 (UPR PL22-11) Function
 ...
 5024 = 255   / MPX Input 0 Function

===Button Assignments===

* Are buttons and switches in Switch Remap assigned correctly? The button codes for Upper/Lower/Pedal Voices and Common Presets '''have changed''' to make room for the new Organ and Speaker models. Check all preset and voice assignments (values from 100 to 121) of the ''Switch Remap'' parameters #5100..5195 in the editor.
* Here is an example for the default assignment '''with 4 preset buttons on Panel16''':

 5132 = 0     / Input 32 (onboard Pin PL25-1) Function
 5133 = 1     / Input 33 (onboard Pin PL25-2) Function
 5134 = 2     / Input 34 (onboard Pin PL25-3) Function
 5135 = 3     / Input 35 (onboard Pin PL25-4) Function
 5136 = 4     / Input 36 (onboard Pin PL25-5) Function
 5137 = 5     / Input 37 (onboard Pin PL25-6) Function
 5138 = 6     / Input 38 (onboard Pin PL25-7) Function
 5139 = 7     / Input 39 (onboard Pin PL25-8) Function
 5140 = 104   / Input 40 (onboard Pin PL26-1) Function
 5141 = 104   / Input 41 (onboard Pin PL26-2) Function
 5142 = 104   / Input 42 (onboard Pin PL26-3) Function
 5143 = 104   / Input 43 (onboard Pin PL26-4) Function
 5144 = 12    / Input 44 (onboard Pin PL26-5) Function
 5145 = 13    / Input 45 (onboard Pin PL26-6) Function
 5146 = 14    / Input 46 (onboard Pin PL26-7) Function
 5147 = 15    / Input 47 (onboard Pin PL26-8) Function

=== Shifted Octaves ===

* When using '''Fatar keybeds''': Are the ''Octave Shifts'' (parameters #1174 and #1175 under *Tabs*) turned off? An older ''presets.dat'' contained wrong settings here. In this case set parameter #1174 and #1175 in the editor to 0 (OFF) and save with ''Store Defaults'', also in the ''HX3 Panel'' or the MenuPanel under preset 0. As long as no own presets have been created, it is best to update the complete presets with the ''presets.dat'' file from a current HX3 manager (Updater menu ''Update via USB or FTDI Cable'').