Skip to content

Document the purpose of the Rhs2116Trigger's double input #241

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

Merged
merged 5 commits into from
Jun 12, 2025
Merged

Document the purpose of the Rhs2116Trigger's double input #241

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
49edf47
Document the purpose of the Rhs2116Trigger's `double` input
cjsha May 29, 2025
eb5ec8e
Minor edit
cjsha May 30, 2025
8edaa38
Merge branch 'main' into issue-179
cjsha Jun 11, 2025
eecd635
Rephrase description of RHS2116 trigger input double
cjsha Jun 11, 2025
72d33aa
Add "from the upstream sequence"
cjsha Jun 11, 2025
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
14 changes: 10 additions & 4 deletions articles/hardware/rhs2116/rhs2116-stimulate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,16 @@ when the its internal conditional statement is evaluated is true. `Double` emits
<xref:System.Double> to <xref:OpenEphys.Onix1.Rhs2116StimulusTrigger> anytime it receives an item in
its upstream sequence.

When `Rhs2116StimulusTrigger` receives a double from the upstream sequence, a stimulus waveform is
triggered. Its DeviceName property is set to "HeadstageRhs2116/StimulusTrigger" to link this
operator to the Rhs2116s on the Headstage Rhs2116. [Open the Headstage RHS2116
GUI](xref:rhs2116_gui) to edit the stimulus waveform.
When `Rhs2116StimulusTrigger` receives a double from the upstream sequence, a stimulus is triggered.
The value of the double determines the duration of a precise hardware delay between triggering and
actually delivering the stimulus. If the double is zero, there is no hardware delay. The stimulus
waveform delivered is configured in the [Headstage RHS2116 GUI](xref:rhs2116_gui). If the sequencer
is busy or the stimulator is disarmed when the trigger occurs, stimulus won't be delivered. This can
be checked using the <xref: OpenEphys.Onix1.Rhs2116TriggerData> operator as demonstrated in the
<xref: rhs2116_trigger_data> page.

`Rhs2116StimulusTrigger`'s DeviceName property is set to "HeadstageRhs2116/StimulusTrigger" to link
this operator to the Rhs2116 devices on the Headstage Rhs2116.

> [!TIP]
> For more details about configuring the Rhs2116 and its stimulation capabilities, read the
Expand Down