diff --git a/source/Hardware Guide/Headstages/index.rst b/source/Hardware Guide/Headstages/index.rst index b63c732..b4bba0b 100644 --- a/source/Hardware Guide/Headstages/index.rst +++ b/source/Hardware Guide/Headstages/index.rst @@ -11,6 +11,7 @@ Here you will find information on **ONIX headstages**. serialization tethers tether-voltage + updating-firmware headstage-64/index headstage-neuropix-1f headstage-neuropix-1e diff --git a/source/Hardware Guide/Headstages/updating-firmware.rst b/source/Hardware Guide/Headstages/updating-firmware.rst new file mode 100644 index 0000000..5f79334 --- /dev/null +++ b/source/Hardware Guide/Headstages/updating-firmware.rst @@ -0,0 +1,71 @@ +.. toctree:: + :hidden: + +Updating Headstage Firmware +###################################### + +#. If you have not already, download and unzip the + :ref:`headstage_updater_download`. + +#. Download the latest :ref:`firmware image ` for + the headstage you want to update. + +#. Connect the headstage that you want to update to either Port A or Port B of + your breakout board. + +#. Flip on the corresponding switch. + +#. Open the "ONIX Hub Updater" dialog by double-clicking the "CsHubUpdater.exe" + file in file explorer. + + .. image:: /_static/images/hub-updater/onix-hub-updater_fields-empty.webp + +#. Populate the fields in the "ONIX Hub Updater" dialog. + + - Select the firmware image by clicking on the :kbd:`...` button and + navigating to where the firmware image was downloaded or entering its + directory directly into the "Firmware File" field. The image should have + a .onix file extension. + - Select the port where the headstage you want to update is connected. + + For example: + + .. image:: /_static/images/hub-updater/onix-hub-updater_fields-populated.webp + +#. Click the :kbd:`program` button in the "ONIX Hub Updater" dialog. This + should open the "Update ready" dialog. + + .. image:: /_static/images/hub-updater/update-ready_matching-fields.webp + + Confirm the "Hub Name", "HW revision", and "FW Version" match in both + columns. + + .. note:: + + - If you click :kbd:`program` and receive the following error message: + + .. image:: /_static/images/hub-updater/no-onix-system.webp + + Make sure your :ref:`PCIe Controller ` and + :ref:`Breakout Board ` are properly setup. + + - If you click :kbd:`program` and receive the following error message: + + .. image:: /_static/images/hub-updater/mismatched-image&hardware.webp + + Confirm: + + - The headstage you want to update is connected to the selected port. + - The firmware image you selected is for the headstage you want to update. + +#. Click the :kbd:`program` button in the "Update ready" dialog to initiate the + firmware flash process. The progress bar indicates that the flash process is + underway. Do not touch the headstage, its port, or its port's power switch + while waiting for this headstage to finish being updated. + + .. image:: /_static/images/hub-updater/update-ready_progress-bar.webp + + A "Success" dialog will appear when this process is completed, indicating + your headstage is now updated. + + .. image:: /_static/images/hub-updater/success.webp diff --git a/source/Resources/downloads.rst b/source/Resources/downloads.rst index ee94002..69c420a 100644 --- a/source/Resources/downloads.rst +++ b/source/Resources/downloads.rst @@ -160,3 +160,42 @@ ______________________________________________ | Hardware Revision 1.6 (two headstage ports) | :download:`Firmware version 1.3 <../_static/downloads/onix-gateware-images/breakout-rev1.6-fw1.3.bin>` | +--------------------------------------------------------------+-------------------------------------------------------------------------------------------------------------+ +Headstage Firmware +---------------------------------------------- + +.. note:: Please see :doc:`/Hardware Guide/Headstages/updating-firmware` + for instructions on how to use these files. + +.. _headstage_updater_download: + +Headstage Firmware Upload Tool +______________________________________________ +Software for updating headstage firmware. + +.. list-table:: + :widths: 15 25 60 + :header-rows: 1 + + * - Version + - Release Date + - Release Notes + * - :download:`0.0.0 <../_static/downloads/onix-software-releases/hub-updater_v0.0.0.zip>` + - 2025.11.10 + - Initial release. + +.. _headstage_image_download: + +Headstage Firmware Images +______________________________________________ + +.. warning:: + Make sure you choose the right file for your hardware. + +.. table:: + + +------------------------------+-------------------------------------------------------------------------------------------------------------+ + | Hardware | Latest Firmware | + +==============================+=============================================================================================================+ + | Headstage 64 | :download:`Firmware version 0.4.0 <../_static/downloads/onix-gateware-images/hs64-fw0.4.0.onix>` | + +------------------------------+-------------------------------------------------------------------------------------------------------------+ + diff --git a/source/_static/downloads/onix-software-releases/hub-updater_v0.0.0.zip b/source/_static/downloads/onix-software-releases/hub-updater_v0.0.0.zip new file mode 100644 index 0000000..d6b2f92 Binary files /dev/null and b/source/_static/downloads/onix-software-releases/hub-updater_v0.0.0.zip differ diff --git a/source/_static/images/hub-updater/mismatched-image&hardware.webp b/source/_static/images/hub-updater/mismatched-image&hardware.webp new file mode 100644 index 0000000..deeca3b Binary files /dev/null and b/source/_static/images/hub-updater/mismatched-image&hardware.webp differ diff --git a/source/_static/images/hub-updater/no-onix-system.webp b/source/_static/images/hub-updater/no-onix-system.webp new file mode 100644 index 0000000..9bce6b8 Binary files /dev/null and b/source/_static/images/hub-updater/no-onix-system.webp differ diff --git a/source/_static/images/hub-updater/onix-hub-updater_fields-empty.webp b/source/_static/images/hub-updater/onix-hub-updater_fields-empty.webp new file mode 100644 index 0000000..bc6627f Binary files /dev/null and b/source/_static/images/hub-updater/onix-hub-updater_fields-empty.webp differ diff --git a/source/_static/images/hub-updater/onix-hub-updater_fields-populated.webp b/source/_static/images/hub-updater/onix-hub-updater_fields-populated.webp new file mode 100644 index 0000000..03a65f9 Binary files /dev/null and b/source/_static/images/hub-updater/onix-hub-updater_fields-populated.webp differ diff --git a/source/_static/images/hub-updater/success.webp b/source/_static/images/hub-updater/success.webp new file mode 100644 index 0000000..9f4dce8 Binary files /dev/null and b/source/_static/images/hub-updater/success.webp differ diff --git a/source/_static/images/hub-updater/update-ready_matching-fields.webp b/source/_static/images/hub-updater/update-ready_matching-fields.webp new file mode 100644 index 0000000..60072e5 Binary files /dev/null and b/source/_static/images/hub-updater/update-ready_matching-fields.webp differ diff --git a/source/_static/images/hub-updater/update-ready_progress-bar.webp b/source/_static/images/hub-updater/update-ready_progress-bar.webp new file mode 100644 index 0000000..3ed76e7 Binary files /dev/null and b/source/_static/images/hub-updater/update-ready_progress-bar.webp differ