Skip to content

Commit c5dffe4

Browse files
committed
Remove error bit from proposal
1 parent 382883b commit c5dffe4

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

Device.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ As an application example, devices using USB as the transport layer can poll for
5050
|R\_TIMESTAMP\_OFFSET|No|No|U8|015|b)|Adds an offset if user updates the Timestamp|Optional|
5151
|R\_UID|No|Yes|U8|016|b)|Stores a unique identifier (UID) |Optional|
5252
|R\_TAG|-|Yes|U8|017|b)|Firmware tag|Optional|
53+
|R\_HEARTBEAT|Yes|Yes|U16|018|b)|Provides information about the state of the device|Yes|
5354

5455
||a) These values are stored during factory process and are persistent, i.e., they cannot be changed by the user.<br>b) Check register notes on the specific register explanation<br>c) Only parts of the functionality is mandatory. Check register notes on the explanation.|
5556
| :- | :- |
@@ -225,7 +226,7 @@ a) Standby Mode and Active Mode are mandatory. Speed Mode is optional.
225226
| 1 | Speed Mode. |
226227
| 0.1 | A critical error occurred. Only a hardware reset or a new power up can remove the device from this Mode. |
227228

228-
* **ALIVE_EN [Bit 7]:** If set to 1, the device sends an `Event` Message with the `R_HEARTBEAT` content each second. This allows the host to check the status of the device periodically. Although this is an optional feature, it’s strongly recommended to be implemented.
229+
* **ALIVE_EN [Bit 7]:** If set to 1, the device sends an `Event` Message with the `R_HEARTBEAT` content each second. This allows the host to check the status of the device periodically. This is a required feature.
229230

230231

231232

@@ -462,28 +463,24 @@ gantt
462463
463464
section Id
464465
IS_ACTIVE :id0, 15, 16
465-
IS_ERROR_STATE :id1, 14, 15
466-
IS_SYNCHRONIZED :id2, 13, 14
466+
IS_SYNCHRONIZED :id1, 14, 15
467467
468468
section Default
469469
- :d7, 15, 16
470470
- :d6, 14 , 15
471-
- :d5, 13 , 14
472471
```
473472

474473
> **Note**
475474
>
476-
> This register is read-only and is used to provide status information about the device. The bits are set by the device and sent through a period event. If enabled (via `R_OPERATION_CTRL` bit `ALIVE_EN`), the event will be periodically emitted at a rate of 1Hz, triggered by updates to the `R_TIMESTAMP_SECOND` register.
475+
> This register is read-only and is used to provide status information about the device. The bits are set by the device and sent through a period event. If enabled (via `R_OPERATION_CTRL` bit `ALIVE_EN`), the event will be periodically emitted at a rate of 1Hz, triggered by updates to the `R_TIMESTAMP_SECOND` register.
477476
478477

479478
The status of the device is given by the following bits:
480479

481480

482481
* **IS_STANDBY [Bit 0]:** If 1, the device will be in Standby Mode. Any other modes will be coded as 0. (See `R_OPERATION_CTRL` bit `OP_MODE` for more information).
483482

484-
* **IS_ERROR_STATE [Bit 1]:** This bit will be read as 1 if the device is in an error state. The implementation of an error state is expected largely implementation specific, however this state should be entered when the device is in a state where it cannot recover without manual intervention.
485-
486-
* **IS_SYNCHRONIZED [Bit 3]:** If set to 1, the device is synchronized with the Harp Synchronization Clock. If the device is a clock generator (see `R_CLOCK_CONFIG` bit `CLK_GEN`), by definition, this bit will always be set to 1.
483+
* **IS_SYNCHRONIZED [Bit 1]:** If set to 1, the device is synchronized with a Harp Synchronization Clock. If the device is a clock generator (see `R_CLOCK_CONFIG` bit `CLK_GEN`), by definition, this bit will always be set to 1.
487484

488485

489486
## Release notes:

0 commit comments

Comments
 (0)