Blueototh: UUID: add string to uuid #98784

chengkai15 · 2025-11-03T13:06:54Z

Bluetooth: UUID: add string to UUID conversion function

Summary

This PR adds a new bt_str_to_uuid() function to convert string representations to Bluetooth UUID structures, complementing the existing bt_uuid_to_str() function. This provides bidirectional conversion between UUID structures and their string representations.

Changes

New API: Add bt_str_to_uuid() function in uuid.h header
Implementation: Implement string parsing for all UUID formats in uuid.c
Format Support: Handle 16-bit, 32-bit, and 128-bit UUID string formats

Technical Details

16-bit UUID: Parses 4-character hexadecimal strings (e.g., "1800")
32-bit UUID: Parses 8-character hexadecimal strings (e.g., "00001800")
128-bit UUID: Parses standard UUID format (e.g., "00001800-0000-1000-8000-00805f9b34fb")
Validation: Returns true on success, false on invalid input format
Error Handling: Comprehensive format validation with proper return codes

Features

Bidirectional Conversion: Complements existing bt_uuid_to_str() function
Flexible Input: Supports all standard UUID string formats
Type Detection: Automatically detects and sets appropriate UUID type (16/32/128-bit)
Robust Parsing: Uses sscanf with exact format matching for reliable parsing

Usage Example

struct bt_uuid uuid; const char *uuid_str = "1800"; if (bt_str_to_uuid(uuid_str, &uuid)) { // Successfully converted string to UUID // uuid.type will be BT_UUID_TYPE_16 // BT_UUID_16(&uuid)->val will be 0x1800 }

Testing

Verified conversion of 16-bit, 32-bit, and 128-bit UUID strings
Tested edge cases and invalid input formats
Confirmed proper type detection and value assignment
Validated round-trip conversion with bt_uuid_to_str()

Impact

New Feature: Adds missing string-to-UUID conversion capability
Backward Compatible: No changes to existing APIs
Minimal Overhead: Small footprint with comprehensive functionality
Utility Enhancement: Useful for configuration, debugging, and dynamic UUID handling

This function fills an important gap in the Bluetooth UUID utilities, enabling applications to easily convert user-input or configuration strings into proper UUID structures for Bluetooth operations.

subsys/bluetooth/host/uuid.c

Thalley · 2025-11-04T10:08:40Z

include/zephyr/bluetooth/uuid.h

+ *
+ * @return true if the string was valid and the UUID was successfully created.
+ */
+bool bt_str_to_uuid(const char *str, struct bt_uuid *uuid);


I feel like this should use the bt_uuid prefix, but

Suggested change

bool bt_str_to_uuid(const char *str, struct bt_uuid *uuid);

bool bt_uuid_str_to_uuid(const char *str, struct bt_uuid *uuid);

Also sounds kinda off

I suggest using from and also reversing the parameters. That way, we both get bt_uuid as a namespace, and we get bt_uuid as a self (to borrow terminology from Python).

Suggested change

bool bt_str_to_uuid(const char *str, struct bt_uuid *uuid);

bool bt_uuid_from_str(struct bt_uuid *uuid, const char *str);

include/zephyr/bluetooth/uuid.h

subsys/bluetooth/host/uuid.c

Thalley · 2025-11-04T10:16:58Z

Please expand https://github.com/zephyrproject-rtos/zephyr/tree/main/tests/bluetooth/uuid to test this new function :)

alwa-nordic · 2025-11-04T11:33:21Z

include/zephyr/bluetooth/uuid.h

+ * UUID can be in any format, 16-bit, 32-bit or 128-bit.
+ *
+ * @param str pointer to string to convert
+ * @param uuid pointer where to put converted UUID


The downcasts (BT_UUID_16, BT_UUID_32, BT_UUID_128) are not safe in the implementation. The documentation here should at least mention this, e.g. specify that uuid parameter is reinterpreted to one of bt_uuid_16, bt_uuid_32, bt_uuid_128, matching the string format.

But I would instead prefer three type-safe variants of this function, one for each bt_uuid subtype.

We can optionally have a C11 _Generic-based macro that automatically selects between the functions.

This makes even more sense considering that a 16-bit BT UUID is representable as an 128-bit UUID.

We can also create a type compatible with all the subtypes and make a parsing function that selects the variant tag corresponding to the string format, or to the smallest type that can represent the BT UUID. Maybe one function for each of those options.

Thanks for your suggestion. Perhaps this is a good practice to keep the function and its implementation consistent with bt_uuid_to_str. Use a single function that is compatible with all types and prompt the user to note the length of the output type.

and help note updated

chengkai15 · 2025-11-04T13:39:12Z

Please expand https://github.com/zephyrproject-rtos/zephyr/tree/main/tests/bluetooth/uuid to test this new function :)

I add it with 4ed0d20

However, I'm not sure how to set up the test environment.

Copilot

Pull Request Overview

This PR adds a new function bt_uuid_from_str() to convert string representations of UUIDs into bt_uuid structures. The function supports 16-bit, 32-bit, and 128-bit UUID formats.

Implements bt_uuid_from_str() function in subsys/bluetooth/host/uuid.c
Adds function declaration and documentation to include/zephyr/bluetooth/uuid.h
Adds comprehensive test suite in tests/bluetooth/uuid/src/test_bt_uuid_from_str.c

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.

File	Description
subsys/bluetooth/host/uuid.c	Implements the `bt_uuid_from_str()` function to parse UUID strings
include/zephyr/bluetooth/uuid.h	Adds function declaration and documentation
tests/bluetooth/uuid/src/test_bt_uuid_from_str.c	Adds test cases for 16-bit, 32-bit, 128-bit, and invalid UUID parsing

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

subsys/bluetooth/host/uuid.c

tests/bluetooth/uuid/src/test_bt_uuid_from_str.c

include/zephyr/bluetooth/uuid.h

subsys/bluetooth/host/uuid.c

Implement bt_uuid_from_str() function to convert string representations to Bluetooth UUID structures. This provides bidirectional conversion between UUID structures and their string representations, complementing the existing bt_uuid_to_str() function. Features: - Supports 16-bit UUID format (4 hex characters, e.g., "180d") - Supports 32-bit UUID format (8 hex characters, e.g., "abcdef12") - Supports 128-bit UUID standard format (with hyphens) - Comprehensive input validation and error handling - Automatic UUID type detection based on string length The function automatically detects the UUID type (16/32/128-bit) based on the input string length and format, setting the appropriate type in the output UUID structure. Signed-off-by: Kai Cheng <chengkai@xiaomi.com>

Add comprehensive unit tests for the new bt_str_to_uuid function to ensure proper conversion of string representations to Bluetooth UUID structures. Tests cover: - 16-bit UUID string conversion (e.g., "180d") - 32-bit UUID string conversion (e.g., "abcdef12") - 128-bit UUID string conversion with standard format - Invalid input cases (malformed strings, empty strings, wrong lengths) Includes proper validation of converted UUID values against expected results using bt_uuid_cmp(). Signed-off-by: Kai Cheng <chengkai@xiaomi.com>

sonarqubecloud · 2025-11-04T15:26:23Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

alwa-nordic · 2025-11-04T15:32:48Z

I'm not sure how to set up the test environment.

Try this:

/zephyrproject$ uv venv --clear && uv pip install -r zephyr/scripts/requirements.txt && uv run -- bash -c 'source zephyr/zephyr-env.sh && west twister -ciT zephyr/tests/bluetooth/uuid/'

Thalley · 2025-11-05T11:52:58Z

include/zephyr/bluetooth/uuid.h

+ * Converts string to Bluetooth UUID. The string must be in the standard
+ * UUID format, which could be 16 bit, 32 bit or 128 bit format. And the


Might be a bit tricky to say "standard UUID format", as there are several ways to represent a UUID as a string. Bluetooth seemingly uses the 8-4-4-4-12 format from https://www.rfc-editor.org/rfc/rfc9562.html, so we could possibly refer to that RFC for the string format, or simply omit this part as bt_uuid_to_str also does.

Thalley · 2025-11-05T11:53:09Z

include/zephyr/bluetooth/uuid.h

+ * UUID format, which could be 16 bit, 32 bit or 128 bit format. And the
+ * uuid pointer must point to a bt_uuid large enough to hold the converted
+ * UUID. If the string uuid is 16 bit, the converted bt_uuid will be
+ * bt_uuid_16 type. If the string uuid is 32 bt uuid, the converted bt_uuid


Suggested change

* bt_uuid_16 type. If the string uuid is 32 bt uuid, the converted bt_uuid

* bt_uuid_16 type. If the string uuid is 32 bit uuid, the converted bt_uuid

or did you mean to use BT/Bluetooth?

Thalley · 2025-11-05T11:53:33Z

include/zephyr/bluetooth/uuid.h

+ * Converts string to Bluetooth UUID. The string must be in the standard
+ * UUID format, which could be 16 bit, 32 bit or 128 bit format. And the
+ * uuid pointer must point to a bt_uuid large enough to hold the converted
+ * UUID. If the string uuid is 16 bit, the converted bt_uuid will be


Suggested change

* UUID. If the string uuid is 16 bit, the converted bt_uuid will be

* UUID. If the string UUID is 16 bit, the converted bt_uuid will be

All uses of UUID should be in caps

Thalley · 2025-11-05T11:54:27Z

include/zephyr/bluetooth/uuid.h

+ * @note The string uuid must be in the standard UUID format, which could be
+ * 16 bit, 32 bit or 128 bit format.


This seems like duplicate text of previous text

Thalley · 2025-11-05T11:55:02Z

include/zephyr/bluetooth/uuid.h

+ * 16 bit, 32 bit or 128 bit format.
+ * For example: 128 bit format "00001101-0000-1000-8000-00805F9B34FB"
+ *
+ * @param uuid pointer where to put converted UUID


Suggested change

* @param uuid pointer where to put converted UUID

* @param uuid Pointer where to put converted UUID

Thalley · 2025-11-05T11:55:10Z

include/zephyr/bluetooth/uuid.h

+ * For example: 128 bit format "00001101-0000-1000-8000-00805F9B34FB"
+ *
+ * @param uuid pointer where to put converted UUID
+ * @param str pointer to string to convert


Suggested change

* @param str pointer to string to convert

* @param str Pointer to string to convert

Thalley · 2025-11-05T11:55:37Z

include/zephyr/bluetooth/uuid.h

+ *
+ * @return 0 if the string was converted successfully, otherwise negative error
+ */
+int bt_uuid_from_str(struct bt_uuid *uuid, const char *str);


Consider switching the order, so it's input, output

Suggested change

int bt_uuid_from_str(struct bt_uuid *uuid, const char *str);

int bt_uuid_from_str(const char *str, struct bt_uuid *uuid);

But you gave a thumbs-up on this: #98784 (comment)

The reasoning was to prefer a self-like order. It's OK if we change our minds, but maybe we should write something in the style guide.

Ah, missed that it used to be like that. I don't have a strong opinion about this, and I guess it's also a widely debated topic (src, dst or dst, src)

Thalley · 2025-11-05T11:59:10Z

tests/bluetooth/uuid/src/test_bt_uuid_from_str.c

+#include <zephyr/ztest.h>
+#include <zephyr/bluetooth/uuid.h>
+
+ZTEST_SUITE(bt_uuid_from_str, NULL, NULL, NULL, NULL, NULL);


Consider adding one or more tests where you compare the output from both bt_uuid_from_str and bt_uuid_to_str

Basically if you have a UUID and put it through bt_uuid_to_str and then through bt_uuid_from_str you should get the same UUID, and vice versa

zephyrbot added area: Bluetooth Host Bluetooth Host (excluding BR/EDR) area: Bluetooth labels Nov 3, 2025

zephyrbot requested review from HaavardRei, PavelVPV, Thalley, alwa-nordic, cvinayak, hermabe, jhedberg, rugeGerritsen and sjanc November 3, 2025 13:08

zephyrbot assigned jhedberg and alwa-nordic Nov 3, 2025

chengkai15 mentioned this pull request Nov 3, 2025

Bluetooth: Classic: SPP: Add shell SPP command set #94523

Open

carlescufi reviewed Nov 3, 2025

View reviewed changes

subsys/bluetooth/host/uuid.c Show resolved Hide resolved

Thalley reviewed Nov 4, 2025

View reviewed changes

alwa-nordic requested changes Nov 4, 2025

View reviewed changes

chengkai15 force-pushed the dev_uuid branch from 9a06462 to 107895c Compare November 4, 2025 12:52

zephyrbot added the area: Tests Issues related to a particular existing or missing test label Nov 4, 2025

zephyrbot requested a review from nashif November 4, 2025 13:38

chengkai15 requested review from Thalley, alwa-nordic and carlescufi November 4, 2025 13:39

alwa-nordic requested a review from Copilot November 4, 2025 14:06

Copilot AI reviewed Nov 4, 2025

View reviewed changes

chengkai15 force-pushed the dev_uuid branch from 4ed0d20 to 0fa2f3d Compare November 4, 2025 15:02

chengkai15 added 2 commits November 4, 2025 23:17

chengkai15 force-pushed the dev_uuid branch from 0fa2f3d to 3959dd7 Compare November 4, 2025 15:19

alwa-nordic added the Bluetooth Review Discussion in the Bluetooth WG meeting required label Nov 4, 2025

Thalley requested changes Nov 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Blueototh: UUID: add string to uuid #98784

Blueototh: UUID: add string to uuid #98784

chengkai15 commented Nov 3, 2025 •

edited

Loading

Uh oh!

Thalley Nov 4, 2025

alwa-nordic Nov 4, 2025

Uh oh!

Uh oh!

Uh oh!

Thalley commented Nov 4, 2025

alwa-nordic Nov 4, 2025

alwa-nordic Nov 4, 2025

chengkai15 Nov 4, 2025 •

edited

Loading

chengkai15 commented Nov 4, 2025

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 4, 2025

alwa-nordic commented Nov 4, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

alwa-nordic Nov 5, 2025

Thalley Nov 5, 2025

Thalley Nov 5, 2025

Labels

6 participants

	bool bt_str_to_uuid(const char str, struct bt_uuid uuid);
	bool bt_uuid_str_to_uuid(const char str, struct bt_uuid uuid);

	bool bt_str_to_uuid(const char str, struct bt_uuid uuid);
	bool bt_uuid_from_str(struct bt_uuid uuid, const char str);

		* Converts string to Bluetooth UUID. The string must be in the standard
		* UUID format, which could be 16 bit, 32 bit or 128 bit format. And the

	* bt_uuid_16 type. If the string uuid is 32 bt uuid, the converted bt_uuid
	* bt_uuid_16 type. If the string uuid is 32 bit uuid, the converted bt_uuid

	* UUID. If the string uuid is 16 bit, the converted bt_uuid will be
	* UUID. If the string UUID is 16 bit, the converted bt_uuid will be

		* @note The string uuid must be in the standard UUID format, which could be
		* 16 bit, 32 bit or 128 bit format.

	* @param uuid pointer where to put converted UUID
	* @param uuid Pointer where to put converted UUID

	* @param str pointer to string to convert
	* @param str Pointer to string to convert

	int bt_uuid_from_str(struct bt_uuid uuid, const char str);
	int bt_uuid_from_str(const char str, struct bt_uuid uuid);

Blueototh: UUID: add string to uuid #98784

Are you sure you want to change the base?

Blueototh: UUID: add string to uuid #98784

Conversation

chengkai15 commented Nov 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bluetooth: UUID: add string to UUID conversion function

Summary

Changes

Technical Details

Features

Usage Example

Testing

Impact

Uh oh!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Thalley commented Nov 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chengkai15 Nov 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

chengkai15 commented Nov 4, 2025

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 4, 2025

Quality Gate passed

alwa-nordic commented Nov 4, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Labels

6 participants

chengkai15 commented Nov 3, 2025 •

edited

Loading

chengkai15 Nov 4, 2025 •

edited

Loading