@@ -5,10 +5,12 @@ hardware: true
5
5
device : heartbeat
6
6
---
7
7
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.
12
14
13
15
::: workflow
14
16
![ /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.
21
23
"BreakoutBoard/Heartbeat". This links the ` HeartbeatData ` operator to the corresponding configuration operator. The
22
24
[ MemberSelector] ( https://bonsai-rx.org/docs/api/Bonsai.Expressions.MemberSelectorBuilder.html ) operator selects the
23
25
` 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