Skip to content

Update ONIX plugin documentation for gateware version #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bparks13 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update ONIX plugin documentation for gateware version #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
264aae7
Update ONIX plugin documentation for gateware version
bparks13 Apr 2, 2026
fd48196
Add links to ignore, and redirects
bparks13 Apr 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions source/User-Manual/Plugins/Onix-Source.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,11 @@ Plugin Configuration
please consider adding them to the `GitHub repo <https://github.com/open-ephys-plugins/onix-source/issues>`__.

.. note::
The ONIX Source plugin requires the ONIX PCIe Host Firmware to be version 2.0 or higher. If you have an
older version of the firmware, you will need to upgrade it to use this plugin. Please follow the
`Updating Firmware in Windows
<https://open-ephys.github.io/onix-docs/Hardware%20Guide/PCIe%20Host/updating-firmware.html#pcie-host-firmware-update>`__
portion of the hardware documentation to update your PCIe controller firmware.
The ONIX Source plugin requires the ONIX PCIe Host Gateware to be version 2.0 or higher. If you have an
older version of the gateware, you will need to upgrade it to use this plugin. Please follow the
`Updating Gateware in Windows
<https://open-ephys.github.io/onix-docs/Hardware%20Guide/PCIe%20Controller/updating-gateware.html#updating-pcie-controller-gateware-in-windows>`__
portion of the hardware documentation to update your PCIe controller gateware.

The ONIX Source plugin allows you to stream data from the ONIX acquisition system. This plugin
assumes that you have an ONIX Breakout Board connected and powered on before adding the plugin to
Expand Down
6 changes: 4 additions & 2 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,11 +238,13 @@
'https://labstreaminglayer.org/#/',
'https://discord.gg/jmnneS85CY',
'https://store-usa.arduino.cc/*',
'https://openbci.com/*'
'https://openbci.com/*',
'https://elifesciences.org/*'
]

linkcheck_allowed_redirects = {
r"https://iopscience.iop.org/article/.*": r"https://validate.perfdrive.com/.*"
r"https://iopscience.iop.org/article/.*": r"https://validate.perfdrive.com/.*",
"https://help.kontex.io/portal/en/home": "https://erp.kontex.io/helpcenter"
}

extensions.append("sphinx_tabs.tabs")
Expand Down
Loading