You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|[`R_HEARTBEAT`](#r_heartbeat-u16--heartbeat-register-reporting-the-current-status-of-the-device)|Yes|Yes|U16|018|b)|Monitors the state of the Device|Required|
69
-
|[`R_VERSION`](#r_version-u8--semantic-version-information)|-|Yes|U8|019|a)|Semantic version information for the Device|Required|
|[`R_VERSION`](#r_version-u8--device-version-information)|-|Yes|U8|019|a)|Device version information|Required|
70
70
71
71
||a) These values MUST be stored during the firmware build process and are persistent, i.e. they SHALL NOT be changeable by the Controller.<br>b) Check register notes on the specific register explanation |
72
72
| :- | :- |
@@ -76,7 +76,7 @@ Tables can be generated here https://www.tablesgenerator.com/html_tables
76
76
Mermaid plots can be generated here: https://mermaid.live/
77
77
--->
78
78
79
-
### **`R_WHO_AM_I` (U16) – Who Am I**
79
+
### **`R_WHO_AM_I` (U16) – Product identifier**
80
80
81
81
Address: `000`
82
82
@@ -233,7 +233,7 @@ b) `Standby` and `Active` modes are mandatory. `Speed` mode is deprecated.
233
233
>
234
234
> The Device MUST reply with `Error` in case this operation mode is not supported.
235
235
236
-
***HEARTBEAT_EN [Bit 2]:** If this bit is set, the Device MUST send an `Event` message every second with the contents of [`R_HEARTBEAT`](#r_heartbeat-u16--heartbeat-register-reporting-the-current-status-of-the-device). This allows the Controller to check the status of the Device periodically. If the `ALIVE_EN` bit is also set, this bit has precedence and the Device must send `R_HEARTBEAT` periodically instead of `R_TIMESTAMP_SECOND`.
236
+
***HEARTBEAT_EN [Bit 2]:** If this bit is set, the Device MUST send an `Event` message every second with the contents of [`R_HEARTBEAT`](#r_heartbeat-u16--device-status-information). This allows the Controller to check the status of the Device periodically. If the `ALIVE_EN` bit is also set, this bit has precedence and the Device must send `R_HEARTBEAT` periodically instead of `R_TIMESTAMP_SECOND`.
237
237
***DUMP [Bit 3]:** If this bit is set on a `Write` request, the Device SHALL send a sequence of `Read` messages to the Controller, one per register, with the current contents of all core and application registers. These messages MUST be sent following the `Write` reply to the request from the Controller. When sending a reply to a `Read` request, the Device MUST clear this bit in the message payload.
238
238
***MUTE_RPL [Bit 4]:** If this bit is set, the Device SHALL NOT send any messages in reply to a request from the Controller.
239
239
***VISUAL_EN [Bit 5]:** If this bit is set, any visual indicators, typically LEDs, available on the Device SHOULD be enabled. Otherwise, if the bit is cleared, all visual indicators SHOULD be turned off.
@@ -436,7 +436,7 @@ An array of 8 bytes that can be used to store a tag for a specific firmware buil
436
436
437
437
If not implemented, the Device MUST return a default value of `0` (Zero) for all bytes.
438
438
439
-
### **`R_HEARTBEAT` (U16) – Heartbeat register reporting the current status of the device**
439
+
### **`R_HEARTBEAT` (U16) – Device status information**
440
440
441
441
Address: `018`
442
442
@@ -471,7 +471,7 @@ This register is read-only and used to provide status information about the Devi
471
471
472
472
***IS_SYNCHRONIZED [Bit 1]:** If this bit is set, the Device MUST be synchronized with an external Harp clock generator. If the Device is itself a clock generator (see [`R_CLOCK_CONFIG`](#r_clock_config-u8--synchronization-clock-configuration) bit `CLK_GEN`), this bit MUST always be set.
473
473
474
-
### **`R_VERSION` (U8) – Semantic version information**
474
+
### **`R_VERSION` (U8) – Device version information**
475
475
476
476
Address: `019`
477
477
@@ -512,7 +512,7 @@ gantt
512
512
- :d4, after sdk_id, 32
513
513
```
514
514
515
-
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 Interface.
515
+
The bytes in this register specify the [semantic version](https://semver.org/) of the components making up the Device. 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 Interface.
516
516
517
517
***PROTOCOL:** The semantic version of the Harp protocol implemented by the Device.
518
518
@@ -532,7 +532,7 @@ The following registers are deprecated and their functionality SHOULD NOT be imp
532
532
533
533
> [!WARNING]
534
534
>
535
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `HARDWARE` version in `R_VERSION`.
535
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `HARDWARE` version in `R_VERSION`.
536
536
537
537
Address: `001`
538
538
@@ -562,7 +562,7 @@ Specifies the major hardware version number. The value of this register is persi
562
562
563
563
> [!WARNING]
564
564
>
565
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `HARDWARE` version in `R_VERSION`.
565
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `HARDWARE` version in `R_VERSION`.
566
566
567
567
Address: `002`
568
568
@@ -588,7 +588,7 @@ gantt
588
588
589
589
Specifies the minor hardware version number. The value of this register is persistent and MUST NOT be changeable by the Controller.
590
590
591
-
### **`R_ASSEMBLY_VERSION` (U8) – Version of the Assembled Components**
591
+
### **`R_ASSEMBLY_VERSION` (U8) – Version of Assembled Components**
592
592
593
593
> [!WARNING]
594
594
>
@@ -622,7 +622,7 @@ Specifies the version number of the assembled components. The value of this regi
622
622
623
623
> [!WARNING]
624
624
>
625
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `PROTOCOL` version in `R_VERSION`.
625
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `PROTOCOL` version in `R_VERSION`.
626
626
627
627
Address: `004`
628
628
@@ -652,7 +652,7 @@ Contains the major version of the Harp protocol specification. The value of this
652
652
653
653
> [!WARNING]
654
654
>
655
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `PROTOCOL` version in `R_VERSION`.
655
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `PROTOCOL` version in `R_VERSION`.
656
656
657
657
Address: `005`
658
658
@@ -682,7 +682,7 @@ Contains the minor version of the Harp Protocol specification. The value of this
682
682
683
683
> [!WARNING]
684
684
>
685
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the major `FIRMWARE` version in `R_VERSION`.
685
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the major `FIRMWARE` version in `R_VERSION`.
686
686
687
687
Address: `006`
688
688
@@ -712,7 +712,7 @@ Contains the major firmware version number. The value of this register is persis
712
712
713
713
> [!WARNING]
714
714
>
715
-
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--semantic-version-information). The value of this register MUST be equal to the minor `FIRMWARE` version in `R_VERSION`.
715
+
> This register is deprecated in favor of [`R_VERSION`](#r_version-u8--device-version-information). The value of this register MUST be equal to the minor `FIRMWARE` version in `R_VERSION`.
0 commit comments