Mesh Diagnostics#

otMeshDiagDiscoverConfig#

typedef struct otMeshDiagDiscoverConfig otMeshDiagDiscoverConfig

This structure represents the set of configurations used when discovering mesh topology indicating which items to discover.

otMeshDiagIp6AddrIterator#

typedef struct otMeshDiagIp6AddrIterator otMeshDiagIp6AddrIterator

This type is an opaque iterator to iterate over list of IPv6 addresses of a router.

Pointers to instance of this type are provided in otMeshDiagRouterInfo.

otMeshDiagChildIterator#

typedef struct otMeshDiagChildIterator otMeshDiagChildIterator

This type is an opaque iterator to iterate over list of children of a router.

Pointers to instance of this type are provided in otMeshDiagRouterInfo.

otMeshDiagRouterInfo#

typedef struct otMeshDiagRouterInfo otMeshDiagRouterInfo

This type represents information about a router in Thread mesh.

otMeshDiagChildInfo#

typedef struct otMeshDiagChildInfo otMeshDiagChildInfo

This type represents information about a discovered child in Thread mesh.

otMeshDiagDiscoverCallback#

typedef void(* otMeshDiagDiscoverCallback) (otError aError, otMeshDiagRouterInfo *aRouterInfo, void *aContext) )(otError aError, otMeshDiagRouterInfo *aRouterInfo, void *aContext)

This function pointer type represents the callback used by otMeshDiagDiscoverTopology() to provide information about a discovered router.

When aError is OT_ERROR_PENDING, it indicates that the discovery is not yet finished and there will be more routers to discover and the callback will be invoked again.

otMeshDiagDiscoverTopology#

otError otMeshDiagDiscoverTopology (otInstance * aInstance, const otMeshDiagDiscoverConfig * aConfig, otMeshDiagDiscoverCallback aCallback, void * aContext)

This function starts network topology discovery.

otMeshDiagCancel#

void otMeshDiagCancel (otInstance * aInstance)

This function cancels an ongoing topology discovery if there is one, otherwise no action.

When ongoing discovery is cancelled, the callback from otMeshDiagDiscoverTopology() will not be called anymore.

otMeshDiagGetNextIp6Address#

otError otMeshDiagGetNextIp6Address (otMeshDiagIp6AddrIterator * aIterator, otIp6Address * aIp6Address)

This function iterates through the discovered IPv6 address of a router.

otMeshDiagGetNextChildInfo#

otError otMeshDiagGetNextChildInfo (otMeshDiagChildIterator * aIterator, otMeshDiagChildInfo * aChildInfo)

This function iterates through the discovered children of a router.

OT_MESH_DIAG_VERSION_UNKNOWN#

#define OT_MESH_DIAG_VERSION_UNKNOWN

0xffff

This constant indicates that Thread Version is unknown.

This is used in otMeshDiagRouterInfo for mVersion property when device does not provide its version. This indicates that device is likely running 1.3.0 (version value 4) or earlier.