Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Tag register to protocol #38

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion Device.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.<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.|
| :- | :- |
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
* Minor improvements to clarity of introduction.

- v1.9.2
* Add new `Tag` register.