Test

This module includes functions that manage configuration parameters required for Thread Certification testing. More...

Data Structures
struct	otMacWhitelistEntry
struct	otMacBlacklistEntry

Typedefs
typedef enum otMleAttachFilter	otMleAttachFilter
typedef struct otMacWhitelistEntry	otMacWhitelistEntry
typedef struct otMacBlacklistEntry	otMacBlacklistEntry

Enumerations
enum	otMleAttachFilter { kMleAttachAnyPartition = 0, kMleAttachSamePartition1 = 1, kMleAttachSamePartition2 = 2, kMleAttachBetterPartition = 3 }

Functions
OTAPI uint32_t OTCALL	otThreadGetContextIdReuseDelay (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetContextIdReuseDelay (otInstance *aInstance, uint32_t aDelay)
OTAPI uint32_t OTCALL	otThreadGetKeySequenceCounter (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetKeySequenceCounter (otInstance *aInstance, uint32_t aKeySequenceCounter)
OTAPI uint32_t OTCALL	otThreadGetKeySwitchGuardTime (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetKeySwitchGuardTime (otInstance *aInstance, uint32_t aKeySwitchGuardTime)
OTAPI uint8_t OTCALL	otThreadGetNetworkIdTimeout (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetNetworkIdTimeout (otInstance *aInstance, uint8_t aTimeout)
OTAPI uint8_t OTCALL	otThreadGetRouterUpgradeThreshold (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetRouterUpgradeThreshold (otInstance *aInstance, uint8_t aThreshold)
OTAPI ThreadError OTCALL	otThreadReleaseRouterId (otInstance *aInstance, uint8_t aRouterId)
OTAPI ThreadError OTCALL	otThreadBecomeDetached (otInstance *aInstance)
OTAPI ThreadError OTCALL	otThreadBecomeChild (otInstance *aInstance, otMleAttachFilter aFilter)
OTAPI ThreadError OTCALL	otThreadBecomeRouter (otInstance *aInstance)
OTAPI ThreadError OTCALL	otThreadBecomeLeader (otInstance *aInstance)
OTAPI uint8_t OTCALL	otThreadGetRouterDowngradeThreshold (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetRouterDowngradeThreshold (otInstance *aInstance, uint8_t aThreshold)
OTAPI uint8_t OTCALL	otThreadGetRouterSelectionJitter (otInstance *aInstance)
OTAPI void OTCALL	otThreadSetRouterSelectionJitter (otInstance *aInstance, uint8_t aRouterJitter)

Detailed Description

This module includes functions that manage configuration parameters required for Thread Certification testing.

Typedef Documentation

typedef struct otMacBlacklistEntry otMacBlacklistEntry

This structure represents a blacklist entry.

typedef struct otMacWhitelistEntry otMacWhitelistEntry

This structure represents a whitelist entry.

typedef enum otMleAttachFilter otMleAttachFilter

Represents any restrictions on the attach process.

Enumeration Type Documentation

enum otMleAttachFilter

Represents any restrictions on the attach process.

Enumerator
kMleAttachAnyPartition	Attach to any Thread partition.
kMleAttachSamePartition1	Attach to the same Thread partition (attempt 1).
kMleAttachSamePartition2	Attach to the same Thread partition (attempt 2).
kMleAttachBetterPartition	Attach to a better (i.e. higher weight/partition id) Thread partition.

Function Documentation

OTAPI ThreadError OTCALL otThreadBecomeChild	(	otInstance *	aInstance,
		otMleAttachFilter	aFilter
	)

Attempt to reattach as a child.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aFilter	Identifies whether to join any, same, or better partition.

Return values

kThreadErrorNone	Successfully begin attempt to become a child.
kThreadErrorInvalidState	Thread is disabled.

OTAPI ThreadError OTCALL otThreadBecomeDetached

(

otInstance *

aInstance

)

Detach from the Thread network.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Return values

kThreadErrorNone	Successfully detached from the Thread network.
kThreadErrorInvalidState	Thread is disabled.

OTAPI ThreadError OTCALL otThreadBecomeLeader

(

otInstance *

aInstance

)

Become a leader and start a new partition.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Return values

kThreadErrorNone	Successfully became a leader and started a new partition.
kThreadErrorInvalidState	Thread is disabled.

OTAPI ThreadError OTCALL otThreadBecomeRouter

(

otInstance *

aInstance

)

Attempt to become a router.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Return values

kThreadErrorNone	Successfully begin attempt to become a router.
kThreadErrorInvalidState	Thread is disabled.

OTAPI uint32_t OTCALL otThreadGetContextIdReuseDelay

(

otInstance *

aInstance

)

Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The CONTEXT_ID_REUSE_DELAY value.

See Also

otThreadSetContextIdReuseDelay

OTAPI uint32_t OTCALL otThreadGetKeySequenceCounter

(

otInstance *

aInstance

)

Get the thrKeySequenceCounter.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The thrKeySequenceCounter value.

See Also

otThreadSetKeySequenceCounter

OTAPI uint32_t OTCALL otThreadGetKeySwitchGuardTime

(

otInstance *

aInstance

)

Get the thrKeySwitchGuardTime

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The thrKeySwitchGuardTime value (in hours).

See Also

otThreadSetKeySwitchGuardTime

OTAPI uint8_t OTCALL otThreadGetNetworkIdTimeout

(

otInstance *

aInstance

)

Get the NETWORK_ID_TIMEOUT parameter used in the Router role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The NETWORK_ID_TIMEOUT value.

See Also

otThreadSetNetworkIdTimeout

OTAPI uint8_t OTCALL otThreadGetRouterDowngradeThreshold

(

otInstance *

aInstance

)

Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The ROUTER_DOWNGRADE_THRESHOLD value.

See Also

otThreadSetRouterDowngradeThreshold

OTAPI uint8_t OTCALL otThreadGetRouterSelectionJitter

(

otInstance *

aInstance

)

Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The ROUTER_SELECTION_JITTER value.

See Also

otThreadSetRouterSelectionJitter

OTAPI uint8_t OTCALL otThreadGetRouterUpgradeThreshold

(

otInstance *

aInstance

)

Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.

Parameters

[in]

aInstance

A pointer to an OpenThread instance.

Returns

The ROUTER_UPGRADE_THRESHOLD value.

See Also

otThreadSetRouterUpgradeThreshold

OTAPI ThreadError OTCALL otThreadReleaseRouterId	(	otInstance *	aInstance,
		uint8_t	aRouterId
	)

Release a Router ID that has been allocated by the device in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aRouterId	The Router ID to release. Valid range is [0, 62].

Return values

kThreadErrorNone

Successfully released the Router ID specified by aRouterId.

OTAPI void OTCALL otThreadSetContextIdReuseDelay	(	otInstance *	aInstance,
		uint32_t	aDelay
	)

Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aDelay	The CONTEXT_ID_REUSE_DELAY value.

See Also

otThreadGetContextIdReuseDelay

OTAPI void OTCALL otThreadSetKeySequenceCounter	(	otInstance *	aInstance,
		uint32_t	aKeySequenceCounter
	)

Set the thrKeySequenceCounter.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aKeySequenceCounter	The thrKeySequenceCounter value.

See Also

otThreadGetKeySequenceCounter

OTAPI void OTCALL otThreadSetKeySwitchGuardTime	(	otInstance *	aInstance,
		uint32_t	aKeySwitchGuardTime
	)

Set the thrKeySwitchGuardTime

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aKeySwitchGuardTime	The thrKeySwitchGuardTime value (in hours).

See Also

otThreadGetKeySwitchGuardTime

OTAPI void OTCALL otThreadSetNetworkIdTimeout	(	otInstance *	aInstance,
		uint8_t	aTimeout
	)

Set the NETWORK_ID_TIMEOUT parameter used in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aTimeout	The NETWORK_ID_TIMEOUT value.

See Also

otThreadGetNetworkIdTimeout

OTAPI void OTCALL otThreadSetRouterDowngradeThreshold	(	otInstance *	aInstance,
		uint8_t	aThreshold
	)

Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aThreshold	The ROUTER_DOWNGRADE_THRESHOLD value.

See Also

otThreadGetRouterDowngradeThreshold

OTAPI void OTCALL otThreadSetRouterSelectionJitter	(	otInstance *	aInstance,
		uint8_t	aRouterJitter
	)

Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aRouterJitter	The ROUTER_SELECTION_JITTER value.

See Also

otThreadGetRouterSelectionJitter

OTAPI void OTCALL otThreadSetRouterUpgradeThreshold	(	otInstance *	aInstance,
		uint8_t	aThreshold
	)

Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.

Parameters

[in]	aInstance	A pointer to an OpenThread instance.
[in]	aThreshold	The ROUTER_UPGRADE_THRESHOLD value.

See Also

otThreadGetRouterUpgradeThreshold