From 70b3b11cd07cf1b841221bfa63aee7c67730b72d Mon Sep 17 00:00:00 2001
From: bruno-f-cruz <7049351+bruno-f-cruz@users.noreply.github.com>
Date: Thu, 29 Feb 2024 13:40:43 -0800
Subject: [PATCH] Add Tag register to protocol
---
Device.md | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/Device.md b/Device.md
index 09db6f2..a97053b 100644
--- a/Device.md
+++ b/Device.md
@@ -46,6 +46,8 @@ It’s strongly recommended that a Harp Device acting as peripheral should conti
|R\_SERIAL\_NUMBER|No|No|U16|013|b)|Unique serial number of the device|Optional|
|R\_CLOCK\_CONFIG|No|No|U8|014|b)|Synchronization clock configuration|Optional|
|R\_TIMESTAMP\_OFFSET|No|No|U8|015|b)|Adds an offset if user updates the Timestamp|Optional|
+|R\_TAG|-|Yes|U8|017|b)|Firmware tag|Optional|
+
||a) These values are stored during factory process and are persistent, i.e., they cannot be changed by the user.
b) Check register notes on the specific register explanation
c) Only parts of the functionality is mandatory. Check register notes on the explanation.|
| :- | :- |
@@ -407,6 +409,13 @@ gantt
```
When the value of this register is above 0 (zero), the device’s timestamp will be offset by this amount. The register is sensitive to 500 microsecond increments. This register is non-volatile.
+#### **`R_TAG` (8 bytes) – Device's name**
+
+Address: `017`
+
+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.
+
+
## Release notes:
- v0.2
@@ -452,4 +461,7 @@ When the value of this register is above 0 (zero), the device’s timestamp will
- v1.9.1
* Remove table of contents to avoid redundancy with doc generators.
- * Minor improvements to clarity of introduction.
\ No newline at end of file
+ * Minor improvements to clarity of introduction.
+
+- v1.9.2
+ * Add new `Tag` register.
\ No newline at end of file