README.rst
1.. zephyr:code-sample:: uuid
2 :name: UUID
3
4 Manipulate UUID v4 and v5 compliant with IETF RFC 9562.
5
6Overview
7********
8
9This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate
10UUIDs accordingly to :rfc:`9562`.
11
12The following functionality is demonstrated:
13
14- UUIDv4 generation
15- UUIDv5 generation from namespace and data
16- UUID conversion from/to string and to base64 and base64 URL safe formats
17
18Requirements
19************
20
21This sample relies on the following modules:
22
23- MbedTLS for the UUIDv5 hash functions
24- Base64 for the base64 encoding of UUIDs
25- Entropy source for the pseudo-random generation of UUIDv4
26
27Building and Running
28********************
29
30Use the standard ``west`` commands to build and flash this application.
31For example, for ``native_sim``:
32
33.. zephyr-app-commands::
34 :zephyr-app: samples/subsys/uuid
35 :host-os: unix
36 :board: native_sim
37 :goals: run
38 :compact:
39
