History Tracker

This module includes configuration variables for History Tracker.

Summary

Macros
OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE 0	Define as 1 to enable History Tracker module.
OPENTHREAD_CONFIG_HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES 1	Define as 1 to exclude Thread Control message (e.g., MLE, TMF) from TX and RX history.
OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE 32	Specifies the maximum number of entries in Network Data External Route history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_MULTICAST_ADDRESS_LIST_SIZE 20	Specifies the maximum number of entries in multicast IPv6 address history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_NEIGHBOR_LIST_SIZE 64	Specifies the maximum number of entries in neighbor table history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE 32	Specifies the maximum number of entries in Network Info (role, mode, partition ID, RLOC16) history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_MESH_PREFIX_LIST_SIZE 32	Specifies the maximum number of entries in Network Data On Mesh Prefix history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_ROUTER_LIST_SIZE 256	Specifies the maximum number of entries in router table history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_RX_LIST_SIZE 32	Specifies the maximum number of entries in RX history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_TX_LIST_SIZE 32	Specifies the maximum number of entries in TX history list.
OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE 20	Specifies the maximum number of entries in unicast IPv6 address history list.

Macros

OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_ENABLE 0

Define as 1 to enable History Tracker module.

OPENTHREAD_CONFIG_HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES

 OPENTHREAD_CONFIG_HISTORY_TRACKER_EXCLUDE_THREAD_CONTROL_MESSAGES 1

Define as 1 to exclude Thread Control message (e.g., MLE, TMF) from TX and RX history.

OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_EXTERNAL_ROUTE_LIST_SIZE 32

Specifies the maximum number of entries in Network Data External Route history list.

Can be set to zero to configure History Tracker module not to collect route info.

OPENTHREAD_CONFIG_HISTORY_TRACKER_MULTICAST_ADDRESS_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_MULTICAST_ADDRESS_LIST_SIZE 20

Specifies the maximum number of entries in multicast IPv6 address history list.

Can be set to zero to configure History Tracker module not to collect any entries.

OPENTHREAD_CONFIG_HISTORY_TRACKER_NEIGHBOR_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_NEIGHBOR_LIST_SIZE 64

Specifies the maximum number of entries in neighbor table history list.

Can be set to zero to configure History Tracker module not to collect any neighbor table history.

OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_NET_INFO_LIST_SIZE 32

Specifies the maximum number of entries in Network Info (role, mode, partition ID, RLOC16) history list.

Can be set to zero to configure History Tracker module not to collect any entries.

OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_MESH_PREFIX_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_ON_MESH_PREFIX_LIST_SIZE 32

Specifies the maximum number of entries in Network Data On Mesh Prefix history list.

Can be set to zero to configure History Tracker module not to collect prefix info.

OPENTHREAD_CONFIG_HISTORY_TRACKER_ROUTER_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_ROUTER_LIST_SIZE 256

Specifies the maximum number of entries in router table history list.

Can be set to zero to configure History Tracker module not to collect any router table history.

OPENTHREAD_CONFIG_HISTORY_TRACKER_RX_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_RX_LIST_SIZE 32

Specifies the maximum number of entries in RX history list.

Can be set to zero to configure History Tracker module not to collect any RX history.

OPENTHREAD_CONFIG_HISTORY_TRACKER_TX_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_TX_LIST_SIZE 32

Specifies the maximum number of entries in TX history list.

Can be set to zero to configure History Tracker module not to collect any TX history.

OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE

 OPENTHREAD_CONFIG_HISTORY_TRACKER_UNICAST_ADDRESS_LIST_SIZE 20

Specifies the maximum number of entries in unicast IPv6 address history list.

Can be set to zero to configure History Tracker module not to collect any entries.

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.