Skip to content

Commit c2b68c8

Browse files
committed
Minor edits to breakout board heartbeat explanation
1 parent efe79b9 commit c2b68c8

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

articles/hardware/breakout/heartbeat.md

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

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.
8+
ONIX has a single special devce, called a heartbeat, that produces data at regular intervals and is always enabled.
9+
When data is read from the hardware by software, the reading thread will block until enough data has been produced
10+
by the hardware. If no devices are enabled, the sofware would block forever. The heartbeat prevents this from happening
11+
since it is always enabled and always producing data. In practice, you can ignore the Heartbeat functionality. The
12+
following excerpt from the Breakout Board [example workflow](xref:breakout_workflow) demonstrates how to observe the
13+
heartbeat functionality.
1214

1315
::: workflow
1416
![/workflows/hardware/breakout/heartbeat.bonsai workflow](../../../workflows/hardware/breakout/heartbeat.bonsai)
@@ -21,4 +23,4 @@ interval defined during <xref:breakout_configuration> using the <xref:OpenEphys.
2123
"BreakoutBoard/Heartbeat". This links the `HeartbeatData` operator to the corresponding configuration operator. The
2224
[MemberSelector](https://bonsai-rx.org/docs/api/Bonsai.Expressions.MemberSelectorBuilder.html) operator selects the
2325
`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.
26+
a given heartbeat pulse if they double-click the `Clock` node.

0 commit comments

Comments
 (0)