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.

Sign up for GitHub

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 UID register to protocol #39

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −1
Open

Add UID register to protocol #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion Device.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ 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\_UUID|No|YES|U8|016|b)|Stores an universally unique identifier (UUID) |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 @@ -322,6 +323,12 @@ gantt
This number should be unique for each unit of the same Device ID.
To write to this register a two-step write command is needed. First, write the value `0xFFFF`, and then the desired serial number (as a `U16`). The device will reset after the second write command is received.

> **Note**
>
> This register is to be deprecated in the near future in favor of the `R_UUID` register. Until then, we strongly encourage the value of this register to duplicate the first two bytes of `R_UUID`.



#### **`R_CLOCK_CONFIG` (U8) – Synchronization clock configuration**

Address: `014`
Expand Down Expand Up @@ -407,6 +414,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_UUID` (16 Bytes) – Universally Unique Identifier**

Address: `016`

An array of 16 bytes that should contain a UUID (Universally Unique Identifier) of the current device. This register is non-volatile and should be read-only.


## Release notes:

- v0.2
Expand Down Expand Up @@ -452,4 +466,8 @@ 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 `UUID` register
* Add future deprecation warning to `R_SERIAL_NUMBER` register.