Border Agent

This module includes configuration variables for Border Agent.

Summary

Macros
`OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE 0`	Define to 1 to enable Border Agent support.
`OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_4)`	Define to 1 to enable ephemeral key mechanism and its APIs in Border Agent.
`OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_FEATURE_ENABLED_BY_DEFAULT OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE`	Whether or not the ephemeral key feature is enabled by default at run-time.
`OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE 1`	Define to 1 to enable Border Agent ID support.
`OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME "OpenThread BR (unspecified vendor) "`	Specifies the base name to construct the service instance name used when advertising the mDNS `_meshcop._udp` service by the Border Agent.
`OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE (OPENTHREAD_CONFIG_PLATFORM_DNSSD_ENABLE \|\| OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE)`	Define to 1 to enable Border Agent to manage registering/updating of the mDNS MeshCoP service(s) on the infrastructure link.
`OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT 0`	Specifies the Border Agent UDP port, and use 0 for ephemeral port.

Macros

OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE

 OPENTHREAD_CONFIG_BORDER_AGENT_ENABLE 0

Define to 1 to enable Border Agent support.

OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE

 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_4)

Define to 1 to enable ephemeral key mechanism and its APIs in Border Agent.

OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_FEATURE_ENABLED_BY_DEFAULT

 OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_FEATURE_ENABLED_BY_DEFAULT OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE

Whether or not the ephemeral key feature is enabled by default at run-time.

OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE

 OPENTHREAD_CONFIG_BORDER_AGENT_ID_ENABLE 1

Define to 1 to enable Border Agent ID support.

OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME

 OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME "OpenThread BR (unspecified vendor) "

Specifies the base name to construct the service instance name used when advertising the mDNS _meshcop._udp service by the Border Agent.

Applicable when the OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE feature is enabled.

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 " ".

The name MUST have a length less than or equal to OT_BORDER_AGENT_MESHCOP_SERVICE_BASE_NAME_MAX_LENGTH (47 chars).

OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE

 OPENTHREAD_CONFIG_BORDER_AGENT_MESHCOP_SERVICE_ENABLE (OPENTHREAD_CONFIG_PLATFORM_DNSSD_ENABLE || OPENTHREAD_CONFIG_MULTICAST_DNS_ENABLE)

Define to 1 to enable Border Agent to manage registering/updating of the mDNS MeshCoP service(s) on the infrastructure link.

This includes the ephemeral key service when the OPENTHREAD_CONFIG_BORDER_AGENT_EPHEMERAL_KEY_ENABLE is enabled.

OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT

 OPENTHREAD_CONFIG_BORDER_AGENT_UDP_PORT 0

Specifies the Border Agent UDP port, and use 0 for ephemeral port.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.