Network Diagnostics

This module includes configuration variables for Network Diagnostics.

Summary

Macros

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE 0
Define as 1 to add APIs to allow Vendor Name, Model, SW Version to change at run-time.
OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL ""
Specifies the default Vendor Model string.
OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME ""
Specifies the default Vendor Name string.
OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION ""
Specifies the default Vendor SW Version string.

Macros

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE

 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_INFO_SET_API_ENABLE 0

Define as 1 to add APIs to allow Vendor Name, Model, SW Version to change at run-time.

It is recommended that Vendor Name, Model, and SW Version are set at build time using the OpenThread configurations OPENTHREAD_CONFIG_NET_DIAG_VENDOR_*. This way they are treated as constants and won't consume RAM.

However, for situations where the OpenThread stack is integrated as a library into different projects/products, this config can be used to add API to change Vendor Name, Model, and SW Version at run-time. In this case, the strings in OPENTHREAD_CONFIG_NET_DIAG_VENDOR_* are treated as the default values (used when OT stack is initialized).

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL

 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_MODEL ""

Specifies the default Vendor Model string.

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME

 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_NAME ""

Specifies the default Vendor Name string.

OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION

 OPENTHREAD_CONFIG_NET_DIAG_VENDOR_SW_VERSION ""

Specifies the default Vendor SW Version string.

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.