Heartbeat#
- Authors:
Jonathan P. Newman
- Version:
1
- IO:
Frame Source, Register Access
- ONIX ID:
12
- ONIX Hubs:
Description#
The Heartbeat device produces periodic samples containing the hub clock count. It is useful for generating keep-alive signal for various communication channels.
Register Programming#
Address |
Name |
Access |
Time of Effect |
POR Value |
Reset Action |
Description |
|---|---|---|---|---|---|---|
0x00 |
ENABLE |
R/W |
On Reset |
Implementation dependent, see hub documentation |
None |
The LSB is used to enable or disable the device data stream:
|
0x01 |
CLK_DIV |
R/W |
Immediate |
CLK_HZ / HB_HZ where HB_HZ is a implementation dependent default rate |
None |
Heartbeat clock divider ratio. Minimum value is CLK_HZ / 10e6 |
0x02 |
CLK_HZ |
R |
N/A |
N/A |
None |
The frequency parameter, CLK_HZ, used in the calculation of CLK_DIV. |
Device To Host Data Frames#
Each frame transmitted to the host is structured as follows:
Host To Device Data Frames#
This device does not accept input frames. All write attempts will fail with an error.