Thread Management Framework Service

This module includes configuration variables for the Thread Management Framework service.

Summary

Macros

OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES 32
The number of EID-to-RLOC cache entries.
OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_MAX_SNOOP_ENTRIES (OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES / 16)
The maximum number of EID-to-RLOC cache entries that can be used for "snoop optimization" where an entry is created by inspecting a received message.
OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_INITIAL_RETRY_DELAY 15
Initial retry delay for address query (in seconds).
OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_MAX_RETRY_DELAY 120
Maximum retry delay for address query (in seconds).
OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_TIMEOUT 3
The timeout value (in seconds) waiting for a address notification response after sending an address query.
OPENTHREAD_CONFIG_TMF_ALLOW_ADDRESS_RESOLUTION_USING_NET_DATA_SERVICES 1
Define as 1 to allow address resolution of on-mesh addresses using Thread Network Data DNS/SRP Service entries.
OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE 0
Define to 1 to enable TMF anycast locator functionality.
OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_SEND_RESPONSE 1
Define to 1 to require the device to listen and respond to TMF_ANYCAST_LOCATE requests.
OPENTHREAD_CONFIG_TMF_ENERGY_SCAN_MAX_RESULTS 64
The maximum number of Energy List entries.
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 0
Define to 1 to support injecting Service entries into the Thread Network Data.
OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_MAX_ALOCS 1
The maximum number of supported Service ALOCs registrations for this device.
OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE
Define to 1 to enable TMF network diagnostics client.
OPENTHREAD_CONFIG_TMF_PENDING_DATASET_DEFAULT_DELAY 300000
Default Delay Timer value for a Pending Operational Dataset (in ms).
OPENTHREAD_CONFIG_TMF_PENDING_DATASET_MINIMUM_DELAY 30000
Minimum Delay Timer value for a Pending Operational Dataset (in ms).
OPENTHREAD_CONFIG_TMF_PROXY_DUA_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
Define to 1 for Thread 1.2 FTD device to register DUA of its MTD children registered even if it doesn't enable DUA feature itself.
OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)
This setting configures the Multicast Listener Registration parent proxying in Thread 1.2.
OPENTHREAD_CONFIG_TMF_SNOOP_CACHE_ENTRY_TIMEOUT 3
The timeout value (in seconds) blocking eviction of an address cache entry created through snoop optimization (i.e., inspection of a received message).

Macros

OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES

 OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES 32

The number of EID-to-RLOC cache entries.

OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_MAX_SNOOP_ENTRIES

 OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_MAX_SNOOP_ENTRIES (OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES / 16)

The maximum number of EID-to-RLOC cache entries that can be used for "snoop optimization" where an entry is created by inspecting a received message.

By default a 1/16 fraction of OPENTHREAD_CONFIG_TMF_ADDRESS_CACHE_ENTRIES is used.

OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_INITIAL_RETRY_DELAY

 OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_INITIAL_RETRY_DELAY 15

Initial retry delay for address query (in seconds).

Default: 15 seconds

OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_MAX_RETRY_DELAY

 OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_MAX_RETRY_DELAY 120

Maximum retry delay for address query (in seconds).

Default: 120 seconds

OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_TIMEOUT

 OPENTHREAD_CONFIG_TMF_ADDRESS_QUERY_TIMEOUT 3

The timeout value (in seconds) waiting for a address notification response after sending an address query.

Default: 3 seconds

OPENTHREAD_CONFIG_TMF_ALLOW_ADDRESS_RESOLUTION_USING_NET_DATA_SERVICES

 OPENTHREAD_CONFIG_TMF_ALLOW_ADDRESS_RESOLUTION_USING_NET_DATA_SERVICES 1

Define as 1 to allow address resolution of on-mesh addresses using Thread Network Data DNS/SRP Service entries.

OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE

 OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE 0

Define to 1 to enable TMF anycast locator functionality.

This feature allows a device to determine the mesh local EID and RLOC16 of the closest destination of an anycast address (if any) through sending TMF_ANYCAST_LOCATE requests.

OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_SEND_RESPONSE

 OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_SEND_RESPONSE 1

Define to 1 to require the device to listen and respond to TMF_ANYCAST_LOCATE requests.

This config is used only when OPENTHREAD_CONFIG_TMF_ANYCAST_LOCATOR_ENABLE is enabled. It is enabled by default.

OPENTHREAD_CONFIG_TMF_ENERGY_SCAN_MAX_RESULTS

 OPENTHREAD_CONFIG_TMF_ENERGY_SCAN_MAX_RESULTS 64

The maximum number of Energy List entries.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE

 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_ENABLE 0

Define to 1 to support injecting Service entries into the Thread Network Data.

OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_MAX_ALOCS

 OPENTHREAD_CONFIG_TMF_NETDATA_SERVICE_MAX_ALOCS 1

The maximum number of supported Service ALOCs registrations for this device.

OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE

 OPENTHREAD_CONFIG_TMF_NETDIAG_CLIENT_ENABLE OPENTHREAD_CONFIG_BORDER_ROUTING_ENABLE

Define to 1 to enable TMF network diagnostics client.

The network diagnostic client add API to send diagnostic requests and queries to other node and process the response. It is enabled by default on Border Routers.

OPENTHREAD_CONFIG_TMF_PENDING_DATASET_DEFAULT_DELAY

 OPENTHREAD_CONFIG_TMF_PENDING_DATASET_DEFAULT_DELAY 300000

Default Delay Timer value for a Pending Operational Dataset (in ms).

Thread specification defines this value as 300,000 ms. Changing from the specified value should be done for testing only.

OPENTHREAD_CONFIG_TMF_PENDING_DATASET_MINIMUM_DELAY

 OPENTHREAD_CONFIG_TMF_PENDING_DATASET_MINIMUM_DELAY 30000

Minimum Delay Timer value for a Pending Operational Dataset (in ms).

Thread specification defines this value as 30,000 ms. Changing from the specified value should be done for testing only.

OPENTHREAD_CONFIG_TMF_PROXY_DUA_ENABLE

 OPENTHREAD_CONFIG_TMF_PROXY_DUA_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)

Define to 1 for Thread 1.2 FTD device to register DUA of its MTD children registered even if it doesn't enable DUA feature itself.

OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE

 OPENTHREAD_CONFIG_TMF_PROXY_MLR_ENABLE (OPENTHREAD_CONFIG_THREAD_VERSION >= OT_THREAD_VERSION_1_2)

This setting configures the Multicast Listener Registration parent proxying in Thread 1.2.

OPENTHREAD_CONFIG_TMF_SNOOP_CACHE_ENTRY_TIMEOUT

 OPENTHREAD_CONFIG_TMF_SNOOP_CACHE_ENTRY_TIMEOUT 3

The timeout value (in seconds) blocking eviction of an address cache entry created through snoop optimization (i.e., inspection of a received message).

After the timeout expires the entry can be reclaimed again. This timeout allows a longer response delay for a received message giving more chance that a snooped entry will be used (avoiding sending Address Query when a response message is sent to same destination from which the message was received earlier).

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.