Skip to content

Commit 73dda78

Browse files
authored
Fix diagram layout for R_HEARTBEAT and R_VERSION (#179)
Mermaid rendering was broken due to insufficient specification of the diagram bit sequence.
1 parent 2125d0f commit 73dda78

File tree

1 file changed

+25
-25
lines changed

1 file changed

+25
-25
lines changed

Device.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -447,18 +447,18 @@ gantt
447447
448448
section Bit
449449
15-2 :reserved, 0, 1
450-
1 :bit1, 1, 2
451-
0 :bit0, 2, 3
450+
1 :bit1, after reserved, 2
451+
0 :bit0, after bit1, 3
452452
453453
section Id
454454
- :idr, 0, 1
455-
IS_ACTIVE :id0, 1, 2
456-
IS_SYNCHRONIZED :id1, 2, 3
455+
IS_ACTIVE :id0, after reserved, 2
456+
IS_SYNCHRONIZED :id1, after bit1, 3
457457
458458
section Default
459459
- :dr, 0, 1
460-
- :d7, 1, 2
461-
- :d6, 2, 3
460+
- :d7, after reserved, 2
461+
- :d6, after bit1, 3
462462
```
463463

464464
This register is read-only and used to provide status information about the device. Any changes to the below bits are controlled by the device and sent to the host through a periodic `Event` message. If periodic reporting is enabled by setting [`R_OPERATION_CTRL`](#r_operation_ctrl-u8--operation-mode-configuration) bit `HEARTBEAT_EN`, the event will be periodically emitted at a rate of 1 Hz, in sync with updates to the [`R_TIMESTAMP_SECOND`](#r_timestamp_second-u32--system-timestamp-seconds) register.
@@ -482,30 +482,30 @@ gantt
482482
483483
section Byte
484484
0 :prot_major, 0, 1
485-
1 :prot_minor, 1, 2
486-
2 :prot_patch, 2, 3
487-
3 :fw_major, 3, 4
488-
4 :fw_minor, 4, 5
489-
5 :fw_patch, 5, 6
490-
6 :hw_major, 6, 7
491-
7 :hw_minor, 7, 8
492-
8 :hw_patch, 8, 9
493-
9-11 :sdk_id, 9, 12
494-
12-31 :interface_hash, 12, 32
485+
1 :prot_minor, after prot_major, 2
486+
2 :prot_patch, after prot_minor, 3
487+
3 :fw_major, after prot_patch, 4
488+
4 :fw_minor, after fw_major, 5
489+
5 :fw_patch, after fw_minor, 6
490+
6 :hw_major, after fw_patch, 7
491+
7 :hw_minor, after hw_major, 8
492+
8 :hw_patch, after hw_minor, 9
493+
9-11 :sdk_id, after hw_patch, 12
494+
12-31 :interface_hash, after sdk_id, 32
495495
496496
section Id
497497
PROTOCOL :protocol, 0, 3
498-
FIRMWARE :firmware, 3, 6
499-
HARDWARE :hardware, 6, 9
500-
SDK_ID :sdk, 9, 12
501-
INTERFACE_HASH :protocol, 12, 32
498+
FIRMWARE :firmware, after prot_patch, 6
499+
HARDWARE :hardware, after fw_patch, 9
500+
SDK_ID :sdk, after hw_patch, 12
501+
INTERFACE_HASH :protocol, after sdk_id, 32
502502
503503
section Default
504504
- :d0, 0, 3
505-
- :d1, 3, 6
506-
- :d2, 6, 9
507-
- :d3, 9, 12
508-
- :d4, 12, 32
505+
- :d1, after prot_patch, 6
506+
- :d2, after fw_patch, 9
507+
- :d3, after hw_patch, 12
508+
- :d4, after sdk_id, 32
509509
```
510510

511511
The bytes in this register specify the [semantic version](https://semver.org/) of different device components. Each component version is made up of three bytes, following the order `major`, `minor`, `patch`. The register also includes a unique identifier of the core microcontroller SDK and a hash digest of the interface schema file describing the device capabilities.
@@ -867,4 +867,4 @@ When the value of this register is greater than `0` (Zero), the device’s times
867867
* Deprecate legacy version registers and `R_TIMESTAMP_OFFSET`
868868
* Clarify meaning of optional registers
869869
* Add device interface clarifications
870-
* Adopt requirement key words from RFC 2119
870+
* Adopt requirement key words from RFC 2119

0 commit comments

Comments
 (0)