Merge pull request #39 from harp-tech/31-increase-the-size-of-the-r_serial_number-to-match-128bit-uuid

Add UID register to protocol

Author: glopesdev

Device.md

@@ -48,6 +48,7 @@ As an application example, devices using USB as the transport layer can poll for
 |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\_UID|No|YES|U8|016|b)|Stores a unique identifier (UID) |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.|
 | :- | :- |
@@ -324,6 +325,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_UID` register. Until then, we strongly encourage the value of this register to duplicate the first two bytes of `R_UID`. In this case, similarly to the harp protocol specification, the two bytes should be packed in little-endian order.
+
+
+
 #### **`R_CLOCK_CONFIG` (U8) – Synchronization clock configuration**
 
 Address: `014`
@@ -409,6 +416,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_UID` (16 Bytes) – Unique Identifier**
+
+Address: `016`
+
+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.
+
+
 ## Release notes:
 
 - v0.2
@@ -455,5 +469,10 @@ 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.
+
 - v1.9.2
   * Clarify `Connected` behavior between host and device and add application examples.
+
+- v1.10.0
+  * Add `UID` register
+  * Add future deprecation warning to `R_SERIAL_NUMBER` register.