Skip to content

Commit 4c5153b

Browse files
committed
Update documentation
1 parent e34ebd2 commit 4c5153b

File tree

3 files changed

+22
-22
lines changed

3 files changed

+22
-22
lines changed

User-Manual/Plugins/Neuropixels-PXI.html

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -774,45 +774,45 @@ <h2>Built-in self tests<a class="headerlink" href="#built-in-self-tests" title="
774774
<tbody>
775775
<tr class="row-even"><td><p>Test probe signal</p></td>
776776
<td><p>30 s</p></td>
777-
<td><p>Analyzes if the probe performance falls within a specified tolerance range, based on a signal generated by the headstage</p></td>
777+
<td><p>Analyzes if the probe performance falls within a specified tolerance range, based on a signal generated by the headstage. Probes that are fully functional can still fail this test, so it’s not a definitive indicator of probe health.</p></td>
778778
</tr>
779779
<tr class="row-odd"><td><p>Test probe noise</p></td>
780780
<td><p>30 s</p></td>
781-
<td><p>Calculates probe noise levels when electrode inputs are shorted to ground</p></td>
781+
<td><p>Calculates probe noise levels when electrode inputs are shorted to ground. Similar to the probe signal test, this test is not a definitive indicator of probe health, so failures can be safely ignored.</p></td>
782782
</tr>
783783
<tr class="row-even"><td><p>Test PSB bus</p></td>
784784
<td><p>&lt;1 s</p></td>
785-
<td><p>Verifies whether signals are transmitted accurately to the headstage</p></td>
785+
<td><p>Verifies whether signals are transmitted accurately to the headstage via the parallel serial bus. If this test fails, it usually indicates that the probe is not properly seated in the headstage.</p></td>
786786
</tr>
787787
<tr class="row-odd"><td><p>Test shift registers</p></td>
788788
<td><p>1 s</p></td>
789-
<td><p>Verifies the functionality of the shank and base shift registers</p></td>
789+
<td><p>Verifies the functionality of the shank and base shift registers. If this test fails, it means the probe electronics have become critically damaged. Even if data is being transmitted, there’s a possibility that it may be corrupted.</p></td>
790790
</tr>
791791
<tr class="row-even"><td><p>Test EEPROM</p></td>
792792
<td><p>1 s</p></td>
793-
<td><p>Tests the EEPROM memory storage on the flex, headstage, and BSC</p></td>
793+
<td><p>Tests the EEPROM memory storage on the flex, headstage, and BSC.</p></td>
794794
</tr>
795795
<tr class="row-odd"><td><p>Test I2C</p></td>
796796
<td><p>&lt;1 s</p></td>
797-
<td><p>Verifies the functionality of the I2C memory map</p></td>
797+
<td><p>Verifies the functionality of the probe’s I2C interface. This interface must be intact for proper functioning of the probe.</p></td>
798798
</tr>
799799
<tr class="row-even"><td><p>Test Serdes</p></td>
800800
<td><p>&lt;1 s</p></td>
801-
<td><p>Tests the integrity of the serial communication over the probe cable</p></td>
801+
<td><p>Tests the integrity of the serial communication over the probe cable.</p></td>
802802
</tr>
803803
<tr class="row-odd"><td><p>Test Heartbeat</p></td>
804804
<td><p>3 s</p></td>
805-
<td><p>Tests whether the heartbeat signal between the headstage and BSC is working properly</p></td>
805+
<td><p>Checks for a 1 Hz heartbeat signal between the headstage and BSC. This test indicates whether basic communication between the headstage and basestation is working.</p></td>
806806
</tr>
807807
<tr class="row-even"><td><p>Test Basestation</p></td>
808808
<td><p>&lt;1 s</p></td>
809-
<td><p>Tests the BSC board</p></td>
809+
<td><p>Tests the connectivity between the computer and the basestation FPGA board via the PXIe interface.</p></td>
810810
</tr>
811811
</tbody>
812812
</table>
813813
<div class="admonition note">
814814
<p class="admonition-title">Note</p>
815-
<p>If the “probe signal” and “probe noise” tests fail, it does not necessarily indicate that the probe is broken. If your probe is successfully transmitting data, the outcome of these tests can be ignored.</p>
815+
<p>If the “probe signal” and “probe noise” tests fail, it does not necessarily indicate that the probe is broken. If your probe is successfully transmitting data, the outcome of all of these tests (except the shift register test) can be safely ignored.</p>
816816
</div>
817817
</section>
818818
<section id="headstage-tests">

_sources/User-Manual/Plugins/Neuropixels-PXI.rst.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -270,17 +270,17 @@ To run each test, select one from the drop-down menu, and click the "RUN" button
270270
:header: "Name", "Duration", "Purpose"
271271
:widths: 20, 20, 70
272272

273-
"Test probe signal", "30 s", "Analyzes if the probe performance falls within a specified tolerance range, based on a signal generated by the headstage"
274-
"Test probe noise", "30 s", "Calculates probe noise levels when electrode inputs are shorted to ground"
275-
"Test PSB bus", "<1 s", "Verifies whether signals are transmitted accurately to the headstage"
276-
"Test shift registers", "1 s", "Verifies the functionality of the shank and base shift registers"
277-
"Test EEPROM", "1 s", "Tests the EEPROM memory storage on the flex, headstage, and BSC"
278-
"Test I2C", "<1 s", "Verifies the functionality of the I2C memory map"
279-
"Test Serdes", "<1 s", "Tests the integrity of the serial communication over the probe cable"
280-
"Test Heartbeat", "3 s", "Tests whether the heartbeat signal between the headstage and BSC is working properly"
281-
"Test Basestation", "<1 s", "Tests the BSC board"
282-
283-
.. note:: If the "probe signal" and "probe noise" tests fail, it does not necessarily indicate that the probe is broken. If your probe is successfully transmitting data, the outcome of these tests can be ignored.
273+
"Test probe signal", "30 s", "Analyzes if the probe performance falls within a specified tolerance range, based on a signal generated by the headstage. Probes that are fully functional can still fail this test, so it's not a definitive indicator of probe health."
274+
"Test probe noise", "30 s", "Calculates probe noise levels when electrode inputs are shorted to ground. Similar to the probe signal test, this test is not a definitive indicator of probe health, so failures can be safely ignored."
275+
"Test PSB bus", "<1 s", "Verifies whether signals are transmitted accurately to the headstage via the parallel serial bus. If this test fails, it usually indicates that the probe is not properly seated in the headstage."
276+
"Test shift registers", "1 s", "Verifies the functionality of the shank and base shift registers. If this test fails, it means the probe electronics have become critically damaged. Even if data is being transmitted, there's a possibility that it may be corrupted."
277+
"Test EEPROM", "1 s", "Tests the EEPROM memory storage on the flex, headstage, and BSC."
278+
"Test I2C", "<1 s", "Verifies the functionality of the probe's I2C interface. This interface must be intact for proper functioning of the probe."
279+
"Test Serdes", "<1 s", "Tests the integrity of the serial communication over the probe cable."
280+
"Test Heartbeat", "3 s", "Checks for a 1 Hz heartbeat signal between the headstage and BSC. This test indicates whether basic communication between the headstage and basestation is working."
281+
"Test Basestation", "<1 s", "Tests the connectivity between the computer and the basestation FPGA board via the PXIe interface."
282+
283+
.. note:: If the "probe signal" and "probe noise" tests fail, it does not necessarily indicate that the probe is broken. If your probe is successfully transmitting data, the outcome of all of these tests (except the shift register test) can be safely ignored.
284284

285285
Headstage tests
286286
#################

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)