diff --git a/include/openthread/border_agent.h b/include/openthread/border_agent.h index 7cd7f8d59..9038396b8 100644 --- a/include/openthread/border_agent.h +++ b/include/openthread/border_agent.h @@ -269,7 +269,7 @@ otError otBorderAgentGetMeshCoPServiceTxtData(otInstance *aInstance, otBorderAge * to be set after device initialization and at run-time. * * Per the Thread specification, the service instance should be a user-friendly name identifying the device model or - * product. A recommended format is " ". + * product. A recommended format is "VendorName ProductName". * * To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended * Address of the device (as 16-character hex digits) to the given base name. diff --git a/src/cli/README.md b/src/cli/README.md index 40efb1970..68bda6b86 100644 --- a/src/cli/README.md +++ b/src/cli/README.md @@ -418,7 +418,7 @@ Requires the `OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE` feature. The name can also be configured using the `OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME` configuration option (which is the recommended way to specify this name). This CLI command (and its corresponding API) is provided for projects where the name needs to be set after device initialization and at run-time. -Per the Thread specification, the service instance should be a user-friendly name identifying the device model or product. A recommended format is " ". To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended Address of the device (as 16-character hex digits) to the given base name. Note that the same name will be used for the ephemeral key service `_meshcop-e._udp` when the ephemeral key feature is enabled and used. +Per the Thread specification, the service instance should be a user-friendly name identifying the device model or product. A recommended format is "VendorName ProductName". To construct the full name and ensure name uniqueness, the OpenThread Border Agent module will append the Extended Address of the device (as 16-character hex digits) to the given base name. Note that the same name will be used for the ephemeral key service `_meshcop-e._udp` when the ephemeral key feature is enabled and used. ```bash ba servicebasename OpenThreadBorderAgent diff --git a/src/core/config/border_agent.h b/src/core/config/border_agent.h index e743ed827..2341a2c05 100644 --- a/src/core/config/border_agent.h +++ b/src/core/config/border_agent.h @@ -113,7 +113,7 @@ * The name can also be configured using the `otBorderAgentSetMeshCoPServiceBaseName()` API at run-time. * * Per the Thread specification, the service instance should be a user-friendly name identifying the device model or - * product. A recommended format is " ". + * product. A recommended format is "VendorName ProductName". * * The name MUST have a length less than or equal to `OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH` (47 chars). */