Skip to content

Commit efe79b9

Browse files
committed
Motivate heartbeat functionality in breakout
1 parent 38e44c5 commit efe79b9

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

articles/hardware/breakout/heartbeat.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,20 @@ hardware: true
55
device: heartbeat
66
---
77

8-
The following excerpt from the Breakout Board [example workflow](xref:breakout_workflow)
9-
demonstrates heartbeat functionality.
8+
The breakout board provides a heartbeat function that prevents the breakout board from blocking. It must be enabled so
9+
that the software doesn't wait forever to receive data if the hardware isn't transmitting data (i.e. if no data sources
10+
are enabled). In practice, you can ignore the Heartbeat functionality after confirming it's enabled. The following excerpt
11+
from the Breakout Board [example workflow](xref:breakout_workflow) demonstrates how to observe the heartbeat functionality.
1012

1113
::: workflow
1214
![/workflows/hardware/breakout/heartbeat.bonsai workflow](../../../workflows/hardware/breakout/heartbeat.bonsai)
1315
:::
1416

1517
The <xref:OpenEphys.Onix1.HeartbeatData> operator generates a sequence of
16-
<xref:OpenEphys.Onix1.HeartbeatDataFrame>s. `HeartbeatData` emits `HeartbeatDataFrame`s at a regular
17-
interval defined during <xref:breakout_configuration> using the
18-
<xref:OpenEphys.Onix1.ConfigureBreakoutBoard>'s `Heartbeat BeatsPerSecond` property (in our case 10
19-
Hz). In the Breakout Board example workflow, the `HeartbeatData`'s `DeviceName` property is set to
20-
"BreakoutBoard/Heartbeat". This links the `HeartbeatData` operator to the corresponding
21-
configuration operator. The
22-
[MemberSelector](https://bonsai-rx.org/docs/api/Bonsai.Expressions.MemberSelectorBuilder.html)
23-
operator selects the `Clock` member from the `HeartbeatDataFrame` so the user can visualize `Clock`
24-
data from the `HeartbeatDataFrame`.
18+
[HeartbeatDataFrames](xref:OpenEphys.Onix1.HeartbeatDataFrame). `HeartbeatData` emits `HeartbeatDataFrames` at a regular
19+
interval defined during <xref:breakout_configuration> using the <xref:OpenEphys.Onix1.ConfigureBreakoutBoard>'s
20+
`Heartbeat BeatsPerSecond` property (in our case 10 Hz). The `HeartbeatData`'s `DeviceName` property is set to
21+
"BreakoutBoard/Heartbeat". This links the `HeartbeatData` operator to the corresponding configuration operator. The
22+
[MemberSelector](https://bonsai-rx.org/docs/api/Bonsai.Expressions.MemberSelectorBuilder.html) operator selects the
23+
`Clock` member from the `HeartbeatDataFrame` so the user can visualize the number of clock cycles that have passed for
24+
a given heartbeat pulse if they double-click the `Clock` node.

0 commit comments

Comments
 (0)