From 092ec1bbb9a6f820a7696fab8be9248af0edc53c Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Wed, 21 Feb 2024 20:25:27 +0000 Subject: [PATCH] Update documentation --- Getting Started/index.html | 46 +- Getting Started/troubleshooting.html | 36 +- Getting Started/warnings.html | 183 +++-- Getting Started/whatisonix.html | 29 +- .../Adapters & EIBs/eib-64-large.html | 32 +- Hardware Guide/Adapters & EIBs/eib-64.html | 32 +- Hardware Guide/Adapters & EIBs/index.html | 29 +- .../Adapters & EIBs/nano-z-adapter-64.html | 31 +- .../Adapters & EIBs/omnetics-adapter-64.html | 29 +- Hardware Guide/Breakout Board/index.html | 37 +- Hardware Guide/Breakout Board/setup.html | 31 +- Hardware Guide/Commutators/index.html | 45 +- .../Connections & Cables/index.html | 35 +- Hardware Guide/Datasheets/bno055.html | 31 +- Hardware Guide/Datasheets/ds90ub9x-raw.html | 29 +- Hardware Guide/Datasheets/estim-hs64.html | 29 +- Hardware Guide/Datasheets/fmc-analog-io.html | 29 +- Hardware Guide/Datasheets/fmc-clock-out.html | 29 +- Hardware Guide/Datasheets/fmc-digital-io.html | 29 +- .../Datasheets/fmc-link-control.html | 29 +- Hardware Guide/Datasheets/heartbeat.html | 29 +- Hardware Guide/Datasheets/index.html | 29 +- Hardware Guide/Datasheets/load-test.html | 29 +- Hardware Guide/Datasheets/memory-usage.html | 29 +- Hardware Guide/Datasheets/neuropixels-v1.html | 29 +- Hardware Guide/Datasheets/ostim-hs64.html | 29 +- Hardware Guide/Datasheets/rhd2164.html | 29 +- .../Datasheets/rhs2116-trigger.html | 29 +- Hardware Guide/Datasheets/rhs2116.html | 31 +- Hardware Guide/Datasheets/test-0.html | 29 +- .../Datasheets/ts4231-v1-array.html | 33 +- .../Headstages/headstage-64/index.html | 33 +- .../headstage-64/test-board-64.html | 29 +- .../Headstages/headstage-neuropix-1.html | 31 +- .../Headstages/headstage-neuropix-1e.html | 31 +- Hardware Guide/Headstages/index.html | 31 +- Hardware Guide/Headstages/serialization.html | 31 +- Hardware Guide/Headstages/setup.html | 29 +- Hardware Guide/Headstages/tether-voltage.html | 29 +- Hardware Guide/Headstages/tethers.html | 31 +- Hardware Guide/Lighthouses/index.html | 35 +- Hardware Guide/Lighthouses/setup.html | 29 +- Hardware Guide/Miniscopes/index.html | 29 +- .../PCIe Host/bracket-assembly.html | 129 +--- Hardware Guide/PCIe Host/index.html | 29 +- .../PCIe Host/multi-board-sync.html | 41 +- Hardware Guide/PCIe Host/overview.html | 35 +- .../PCIe Host/programming-with-jtag.html | 30 +- Hardware Guide/PCIe Host/setup-windows.html | 37 +- .../PCIe Host/updating-firmware.html | 41 +- Hardware Guide/index.html | 53 +- Resources/downloads.html | 663 ++++++++++++++++++ Resources/faq.html | 591 ++++++++++++++++ Resources/index.html | 572 +++++++++++++++ Resources/support.html | 571 +++++++++++++++ .../Bonsai Examples/CameraSync.html | 38 +- .../Bonsai Examples/Commutator.html | 38 +- .../Bonsai Examples/Headstage64.html | 38 +- .../Bonsai Examples/HeadstageNP1e.html | 38 +- .../Bonsai Examples/LatencyTest.html | 38 +- .../Bonsai.ONIX/Bonsai Examples/index.html | 38 +- .../Bonsai.ONIX/GettingStarted.html | 46 +- Software Guide/Bonsai.ONIX/Installation.html | 38 +- .../Bonsai.ONIX/Nodes/AnalogIODevice.html | 50 +- .../Bonsai.ONIX/Nodes/BNO055Device.html | 38 +- .../Bonsai.ONIX/Nodes/ClockOutputDevice.html | 38 +- .../Bonsai.ONIX/Nodes/DigitalIODevice.html | 38 +- .../Nodes/ElectricalStimulationDevice.html | 38 +- .../Nodes/HeadstagePortControlDevice.html | 38 +- .../Bonsai.ONIX/Nodes/HeartbeatDevice.html | 38 +- .../Bonsai.ONIX/Nodes/MiniscopeV3Device.html | 38 +- .../Nodes/MiniscopeV4BNO055Device.html | 38 +- .../Bonsai.ONIX/Nodes/MiniscopeV4Device.html | 38 +- .../Nodes/NeuropixelsV1Device.html | 38 +- .../Nodes/NeuropixelsV1eDevice.html | 75 +- .../Bonsai.ONIX/Nodes/ONIContext.html | 44 +- .../Nodes/OpticalStimulationDevice.html | 38 +- .../Bonsai.ONIX/Nodes/RHD2164Device.html | 38 +- .../Bonsai.ONIX/Nodes/RHS2116Device.html | 38 +- .../Nodes/RHS2116TriggerDevice.html | 38 +- .../Bonsai.ONIX/Nodes/TS4231V1Device.html | 38 +- Software Guide/Bonsai.ONIX/Nodes/index.html | 38 +- Software Guide/Bonsai.ONIX/index.html | 45 +- Software Guide/Open Ephys GUI/index.html | 52 +- Software Guide/index.html | 52 +- Software Guide/oni-repl/index.html | 63 +- Software Guide/oni-repl/usage.html | 46 +- _sources/Getting Started/index.rst.txt | 24 +- .../Getting Started/troubleshooting.rst.txt | 8 + _sources/Getting Started/warnings.rst.txt | 75 +- _sources/Getting Started/whatisonix.rst.txt | 3 + .../Adapters & EIBs/eib-64-large.rst.txt | 3 +- .../Adapters & EIBs/eib-64.rst.txt | 3 +- .../Adapters & EIBs/nano-z-adapter-64.rst.txt | 2 +- .../Breakout Board/index.rst.txt | 2 +- .../Breakout Board/setup.rst.txt | 2 +- .../Hardware Guide/Commutators/index.rst.txt | 13 +- .../Hardware Guide/Datasheets/bno055.rst.txt | 2 +- .../Hardware Guide/Datasheets/rhs2116.rst.txt | 2 +- .../Datasheets/ts4231-v1-array.rst.txt | 4 +- .../Headstages/headstage-64/index.rst.txt | 4 +- .../Headstages/headstage-neuropix-1.rst.txt | 2 +- .../Headstages/headstage-neuropix-1e.rst.txt | 2 +- .../Headstages/serialization.rst.txt | 2 +- .../Hardware Guide/Headstages/tethers.rst.txt | 2 +- .../PCIe Host/bracket-assembly.rst.txt | 7 +- .../Hardware Guide/PCIe Host/index.rst.txt | 1 - .../PCIe Host/multi-board-sync.rst.txt | 3 + .../Hardware Guide/PCIe Host/overview.rst.txt | 3 + .../PCIe Host/programming-with-jtag.rst.txt | 163 ++--- .../PCIe Host/setup-windows.rst.txt | 3 + .../PCIe Host/updating-firmware.rst.txt | 193 ++--- _sources/Hardware Guide/index.rst.txt | 14 +- _sources/Resources/downloads.rst.txt | 97 +++ _sources/Resources/faq.rst.txt | 60 ++ _sources/Resources/index.rst.txt | 34 + _sources/Resources/support.rst.txt | 34 + .../Bonsai.ONIX/GettingStarted.rst.txt | 6 +- .../Bonsai.ONIX/Nodes/AnalogIODevice.rst.txt | 16 +- .../Nodes/NeuropixelsV1eDevice.rst.txt | 6 +- .../Bonsai.ONIX/Nodes/ONIContext.rst.txt | 6 +- .../Software Guide/Bonsai.ONIX/index.rst.txt | 7 +- .../Open Ephys GUI/index.rst.txt | 2 +- _sources/Software Guide/index.rst.txt | 6 +- .../Software Guide/oni-repl/index.rst.txt | 23 +- .../Software Guide/oni-repl/usage.rst.txt | 9 +- _sources/index.rst.txt | 36 +- genindex.html | 407 +---------- index.html | 38 +- objects.inv | Bin 9515 -> 4410 bytes search.html | 16 +- searchindex.js | 2 +- 132 files changed, 4492 insertions(+), 2487 deletions(-) create mode 100644 Resources/downloads.html create mode 100644 Resources/faq.html create mode 100644 Resources/index.html create mode 100644 Resources/support.html create mode 100644 _sources/Resources/downloads.rst.txt create mode 100644 _sources/Resources/faq.rst.txt create mode 100644 _sources/Resources/index.rst.txt create mode 100644 _sources/Resources/support.rst.txt diff --git a/Getting Started/index.html b/Getting Started/index.html index 50bada72..e30b0d28 100644 --- a/Getting Started/index.html +++ b/Getting Started/index.html @@ -148,15 +148,15 @@
  • - - API Reference + + Software Guide
  • - - Software Guide + + Resources
    • @@ -288,15 +288,15 @@
  • - - API Reference + + Software Guide
  • - - Software Guide + + Resources
    • @@ -366,6 +366,7 @@

    Section Navigation

    @@ -420,25 +421,34 @@
    -
    -

    Getting Started#

    -
    +
    +
    +

    Getting Started#

    Understanding the System#

    • Read ‘What is ONIX?’ for a high-level introduction to this hardware and how it differs from other neuroscience acquisition systems.

      • -

    • Our FAQ contains answers to general questions about the system.

      • +

    • Our FAQ contains answers to general questions about the system.

    • See the Hardware Guide for a description of each ONIX hardware component and decide which you will need.

    +
    +

    Note

    +

    To understand the underlying hardware specifications, check out the ONI Hardware Specification.

    +
    +
    +

    Note

    +

    For developers who want to dig into the API, check out the ONI API Documentation.

    +
    -

    Usage warnings#

    -
      -

    • Read Usage Warnings before starting to work with the system to avoid causing damage to system components.

      • -
    +

    Usage Warnings#

    +
    +

    Warning

    +

    Read Usage Warnings before starting to work with the system to avoid causing damage to system components.

    +

    Setting up ONIX#

    @@ -468,7 +478,7 @@

    Setting up ONIXSetup Guide for Windows.

  • Mount and connect the 3D-Tracking Lighthouses

    • -

  • Mount and connect the commutator

    • +

  • Mount and connect the commutator

  • Connect the Breakout Board to the PCIe host board.

  • Connect a headstage, Miniscope V4 or other ONI compliant recording device by following these steps. Be sure to read this @@ -543,7 +553,7 @@

    Using ONIX diff --git a/Getting Started/troubleshooting.html b/Getting Started/troubleshooting.html index 51091379..178a2438 100644 --- a/Getting Started/troubleshooting.html +++ b/Getting Started/troubleshooting.html @@ -8,7 +8,7 @@ - <no title> — ONIX Docs + Troubleshooting — ONIX Docs @@ -146,15 +146,15 @@
  • - - API Reference + + Software Guide
  • - - Software Guide + + Resources
    • @@ -286,15 +286,15 @@
  • - - API Reference + + Software Guide
  • - - Software Guide + + Resources
    • @@ -390,7 +390,7 @@

    • -
  • <no title>
    • +
  • Troubleshooting

    • @@ -407,10 +407,14 @@
    -

    Troubleshooting

    +
    +
    +
    +

    Troubleshooting#

    Reset breakout board using tiny hole

    Turn headstage off and on again

    Headstage light is weak = Check voltages. How to measure voltage on Neuropixel headstage? Npix also needs more voltage with npix attached than without.

    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + + + +
    +
    + +
    + + + +
    + + +
    + +
    + +
    + + + +
    + +
    + +
    + +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +
    +

    Downloads#

    +
    +

    oni-repl Console Application#

    +
    +

    Note

    +

    Please see the oni-repl guide for instructions on +how to use this software. When using mac or linux, you will need to compile +from source. See compilation instructions in the Makefile.

    +
    + + +++++ + + + + + + + + + + + + +
    oni-repl Windows downloads#

    Version

    Release Date

    Release Notes

    1.0.0

    2022.11.27

    Initial release.

    +
    +
    +

    PCIe Host Updater#

    +
    +

    Note

    +

    Please see Updating PCIe Host Firmware for instructions on how to use these files. When +using mac or linux, you will need to compile from source.

    +
    + + +++++ + + + + + + + + + + + + +
    PCIe Host update tools#

    Version

    Release Date

    Release Notes

    1.0.0

    2022.11.27

    Initial release.

    +
    +
    +
    +

    RIFFA Device Driver#

    +
    +

    Note

    +

    Please see Updating PCIe Host Firmware for instructions on how to use these files. When +using mac or linux, you will need to compile from source.

    +
    + + +++++ + + + + + + + + + + + + +
    RIFFA PCIe driver#

    Version

    Release Date

    Release Notes

    6.0.1.3

    2022.11.29

    Fix race condition in the RIFFA kernel driver for windows.

    +
    +
    +
    +

    PCIe Host Firmware#

    +
    +

    Note

    +

    Please see Updating PCIe Host Firmware for instructions on how to use these files.

    +
    +
    +
    +

    Hardware Revision 1.4#

    +
    +

    Important

    +

    Please get in touch so that we can provide the latest firmware +for your board.

    +
    +
    +
    + + + +
    + + + + + +
    + + + +
    + +
    +
    + On this page +
    +
    + +
    + +
    + + + + + + Edit on GitHub + + + +
    +
    + +
    +
    + + Show Source + +
    +
    + +
    + + +
    +
    + +
    + +
    +
    +
    + + + + + +
    +
    + +
    + +
    +

    + + © Copyright 2010-2024, Open Ephys & Contributors. +
    + +

    +
    + +
    + + +
    + +

    + Built with the PyData Sphinx Theme 0.13.3. +

    + +
    + +
    + +
    + + \ No newline at end of file diff --git a/Resources/faq.html b/Resources/faq.html new file mode 100644 index 00000000..3cef9286 --- /dev/null +++ b/Resources/faq.html @@ -0,0 +1,591 @@ + + + + + + + + + + + FAQ — ONIX Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + + + +
    +
    + +
    + + + +
    + + +
    + +
    + +
    + + + +
    + +
    + +
    + +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +
    +

    FAQ#

    +
    +
    What is ONIX?#

    Read this page for a high-level introduction to this hardware and how it differs from classic neuroscience acquisition systems.

    +
    +
    What does ONIX stand for?#

    Open Neuro Interface X, the Open Ephys implementation of the Open +Neuro Interface specification.

    +
    +
    How is ONI different than ONIX?#

    Open Neuro Interface is a hardware and +API specification designed to meet the needs of experimental neuroscientists. +ONIX hardware and liboni are +implementations of the ONI specification.

    +
    +
    What is Open Ephys?#

    Open Ephys is a company and team of neuroscientists, engineers, and +hackers who believe that neuroscience benefits greatly from advanced, +well-documented, open-source hardware and software. Have a look at the +Open Ephys Website for a +comprehensive overview of our mission and projects.

    +
    +
    Is ONIX hardware available for purchase?#

    The system is currently in a beta test phase and will be made available on +the Open Ephys Store following that.

    +
    +
    Where do I get help when using the system?#

    Have a look at the Contact page.

    +
    +
    Can I use Headstage-64 with a silicon probe instead of tetrodes?#

    Yes. Have a look at Adapters & EIBs to see if an option exists for +your probe. If not, get in touch because making an adapter +is quite simple.

    +
    +
    Can I use my older Intan headstages with the system?#

    No. ONIX headstages use serialization hardware to allow mixtures of +devices to exist on the headstage. This is incompatible with older, +SPI-based headstages. Have a look at Coaxial Data Serialization & Power for more +information on why.

    +
    +
    Why is there no Open Ephys GUI plugin for ONIX hardware?#

    Have a look at the Open Ephys GUI page.

    +
    +
    I have existing acquisition hardware. Can I can use your API and software to acquire data from it?#

    Yes. We tried to design our API so that it decouples hardware details +from software in a generic way. Have a look at the +Driver Translators page +for more information on how to use the ONIX API with your hardware. +Depending on how your device communicates with the computer it may only +take 10’s of lines of C.

    +
    +
    I have existing acquisition software. Can I integrate support for ONIX hardware using your API?#

    Yes. Have a look at the ONI API Documentation +to get started. Also let us know if you want help.

    +
    +
    +
    + + + +
    + + + + + +
    + + + +
    + +
    + +
    + + + + + + Edit on GitHub + + + +
    +
    + +
    +
    + + Show Source + +
    +
    + +
    + + +
    +
    + +
    + +
    +
    +
    + + + + + +
    +
    + +
    + +
    +

    + + © Copyright 2010-2024, Open Ephys & Contributors. +
    + +

    +
    + +
    + + +
    + +

    + Built with the PyData Sphinx Theme 0.13.3. +

    + +
    + +
    + +
    + + \ No newline at end of file diff --git a/Resources/index.html b/Resources/index.html new file mode 100644 index 00000000..6843fd8a --- /dev/null +++ b/Resources/index.html @@ -0,0 +1,572 @@ + + + + + + + + + + + Resources — ONIX Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + + + +
    +
    + +
    + + + +
    + + +
    + +
    + +
    + + + +
    + +
    + +
    + +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +
    +
    +
    +

    resources_logo Resources#

    +

    List of resources that might be useful for using ONIX.

    +
    +

    Downloads#

    +

    Browse a list of applications, drivers, and updaters related to ONIX.

    +
    +
    +

    FAQ#

    +

    Check out some commonly asked questions.

    +
    +
    +

    Support#

    +

    Need to contact us? There are a number of methods available for questions, +comments, and concerns.

    +
    +
    + + + +
    + + + + + +
    + + + +
    + +
    +
    + On this page +
    +
    + +
    + +
    + + + + + + Edit on GitHub + + + +
    +
    + +
    +
    + + Show Source + +
    +
    + +
    + + +
    +
    + +
    + +
    +
    +
    + + + + + +
    +
    + +
    + +
    +

    + + © Copyright 2010-2024, Open Ephys & Contributors. +
    + +

    +
    + +
    + + +
    + +

    + Built with the PyData Sphinx Theme 0.13.3. +

    + +
    + +
    + +
    + + \ No newline at end of file diff --git a/Resources/support.html b/Resources/support.html new file mode 100644 index 00000000..c1772479 --- /dev/null +++ b/Resources/support.html @@ -0,0 +1,571 @@ + + + + + + + + + + + Contact — ONIX Docs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    +
    +
    + + + Ctrl+K +
    +
    + + + +
    +
    + +
    + + + +
    + + +
    + +
    + +
    + + + +
    + +
    + +
    + +
    + +
    +
    +
    + + +
    +
    + + + + +
    + +
    + + +
    +
    + +
    +
    + +
    + +
    + + + + +
    + +
    + + +
    +
    + + + + + +
    + +
    +

    Contact#

    +

    Contact Open Ephys here: https://open-ephys.org/contact

    +

    For purchasing questions, warranty queries, hardware repair, etc

    + +

    For bug reports and feature requests, do not hesitate to create an issue on +the appropriate repository:

    + +

    You can also ask questions on the Open Ephys Google Group or Slack channel

    + +

    For general information on ephys techniques, have a look at the the following resources:

    + +
    + + + +
    + + + + + +
    + + + +
    + +
    + +
    + + + + + + Edit on GitHub + + + +
    +
    + +
    +
    + + Show Source + +
    +
    + +
    + + +
    +
    + +
    + +
    +
    +
    + + + + + +
    +
    + +
    + +
    +

    + + © Copyright 2010-2024, Open Ephys & Contributors. +
    + +

    +
    + +
    + + +
    + +

    + Built with the PyData Sphinx Theme 0.13.3. +

    + +
    + +
    + +
    + + \ No newline at end of file diff --git a/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html b/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html index d65ab165..a66808e7 100644 --- a/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html +++ b/Software Guide/Bonsai.ONIX/Bonsai Examples/CameraSync.html @@ -147,16 +147,16 @@ -
  • - - API Reference +
  • + + Software Guide
    • -
  • - - Software Guide +
  • + + Resources
    • @@ -287,16 +287,16 @@ -
  • - - API Reference +
  • + + Software Guide
    • -
  • - - Software Guide +
  • + + Resources
    • @@ -366,17 +366,13 @@

    Section Navigation