- use zephyr-app-commands - fix bullet list formatting - cross-reference UUID doxygen group Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
39 lines
938 B
ReStructuredText
39 lines
938 B
ReStructuredText
.. zephyr:code-sample:: uuid
|
|
:name: UUID
|
|
|
|
Manipulate UUID v4 and v5 compliant with IETF RFC 9562.
|
|
|
|
Overview
|
|
********
|
|
|
|
This sample app demonstrates the use of the :c:group:`uuid` utilities to generate and manipulate
|
|
UUIDs accordingly to IETF RFC 9562.
|
|
|
|
The following functionality is demonstrated:
|
|
|
|
- UUIDv4 generation
|
|
- UUIDv5 generation from namespace and data
|
|
- UUID conversion from/to string and to base64 and base64 URL safe formats
|
|
|
|
Requirements
|
|
************
|
|
|
|
This sample relies on the following modules:
|
|
|
|
- MbedTLS for the UUIDv5 hash functions
|
|
- Base64 for the base64 encoding of UUIDs
|
|
- Entropy source for the pseudo-random generation of UUIDv4
|
|
|
|
Building and Running
|
|
********************
|
|
|
|
Use the standard ``west`` commands to build and flash this application.
|
|
For example, for ``native_sim``:
|
|
|
|
.. zephyr-app-commands::
|
|
:zephyr-app: samples/subsys/uuid
|
|
:host-os: unix
|
|
:board: native_sim
|
|
:goals: run
|
|
:compact:
|