Skip to content

Commit e131f8a

Browse files
authored
Merge pull request #38 from harp-tech/17-firmware-git-hash
Add Tag register to protocol
2 parents 5b0a25a + 8c05bd4 commit e131f8a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

Device.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,8 @@ As an application example, devices using USB as the transport layer can poll for
4848
|R\_SERIAL\_NUMBER|No|No|U16|013|b)|Unique serial number of the device|Optional|
4949
|R\_CLOCK\_CONFIG|No|No|U8|014|b)|Synchronization clock configuration|Optional|
5050
|R\_TIMESTAMP\_OFFSET|No|No|U8|015|b)|Adds an offset if user updates the Timestamp|Optional|
51-
|R\_UID|No|YES|U8|016|b)|Stores a unique identifier (UID) |Optional|
51+
|R\_UID|No|Yes|U8|016|b)|Stores a unique identifier (UID) |Optional|
52+
|R\_TAG|-|Yes|U8|017|b)|Firmware tag|Optional|
5253

5354
||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.|
5455
| :- | :- |
@@ -422,6 +423,12 @@ Address: `016`
422423

423424
An array of 16 bytes that should contain a (128bit) UID (Unique Identifier) of the current device. This register is non-volatile and should be read-only. The byte-order is little-endian.
424425

426+
#### **`R_TAG` (8 bytes) – Firmware tag**
427+
428+
Address: `017`
429+
430+
An array of 8 bytes that can be used to store a tag for a specific firmware version. For instance, it could be used to store the git hash of a specific release/commit. If not used, all bytes should be set to 0. The byte-order is little-endian.
431+
425432

426433
## Release notes:
427434

@@ -476,3 +483,6 @@ An array of 16 bytes that should contain a (128bit) UID (Unique Identifier) of t
476483
- v1.10.0
477484
* Add `UID` register
478485
* Add future deprecation warning to `R_SERIAL_NUMBER` register.
486+
487+
- v1.11.0
488+
* Add new `Tag` register.

0 commit comments

Comments
 (0)