Operational Dataset#

otMeshcopTlvType#

otMeshcopTlvType

Represents meshcop TLV types.

otNetworkKey#

typedef struct otNetworkKey otNetworkKey

Represents a Thread Network Key.

otNetworkKeyRef#

typedef otCryptoKeyRef otNetworkKeyRef

This datatype represents KeyRef to NetworkKey.

Reference to Key

otNetworkName#

typedef struct otNetworkName otNetworkName

Represents a Network Name.

The otNetworkName is a null terminated C string (i.e., m8 char array MUST end with null char \0).

otExtendedPanId#

typedef struct otExtendedPanId otExtendedPanId

Represents an Extended PAN ID.

otMeshLocalPrefix#

typedef otIp6NetworkPrefix otMeshLocalPrefix

Represents a Mesh Local Prefix.

otPskc#

typedef struct otPskc otPskc

Represents a PSKc.

otPskcRef#

typedef otCryptoKeyRef otPskcRef

This datatype represents KeyRef to PSKc.

Reference to Key

otSecurityPolicy#

typedef struct otSecurityPolicy otSecurityPolicy

Represent Security Policy.

otChannelMask#

typedef uint32_t otChannelMask

Represents Channel Mask.

otOperationalDatasetComponents#

typedef struct otOperationalDatasetComponents otOperationalDatasetComponents

Represents presence of different components in Active or Pending Operational Dataset.

otTimestamp#

typedef struct otTimestamp otTimestamp

Represents a Thread Dataset timestamp component.

otOperationalDataset#

typedef struct otOperationalDataset otOperationalDataset

Represents an Active or Pending Operational Dataset.

Components in Dataset are optional. mComponents structure specifies which components are present in the Dataset.

otOperationalDatasetTlvs#

typedef struct otOperationalDatasetTlvs otOperationalDatasetTlvs

Represents an Active or Pending Operational Dataset.

The Operational Dataset is TLV encoded as specified by Thread.

otMeshcopTlvType#

typedef enum otMeshcopTlvType otMeshcopTlvType

Represents meshcop TLV types.

otDatasetMgmtSetCallback#

typedef void(* otDatasetMgmtSetCallback) (otError aResult, void *aContext) )(otError aResult, void *aContext)

Pointer is called when a response to a MGMT_SET request is received or times out.

otDatasetUpdaterCallback#

typedef void(* otDatasetUpdaterCallback) (otError aError, void *aContext) )(otError aError, void *aContext)

This callback function pointer is called when a Dataset update request finishes, reporting success or failure status of the Dataset update request.

Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE is enabled.

OT_TOOL_PACKED_END#

OT_TOOL_PACKED_BEGIN struct otPskc OT_TOOL_PACKED_END

otDatasetIsCommissioned#

bool otDatasetIsCommissioned (otInstance * aInstance)

Indicates whether a valid network is present in the Active Operational Dataset or not.

Returns

• TRUE if a valid network is present in the Active Operational Dataset, FALSE otherwise.

otDatasetGetActive#

otError otDatasetGetActive (otInstance * aInstance, otOperationalDataset * aDataset)

Gets the Active Operational Dataset.

otDatasetGetActiveTlvs#

otError otDatasetGetActiveTlvs (otInstance * aInstance, otOperationalDatasetTlvs * aDataset)

Gets the Active Operational Dataset.

otDatasetSetActive#

otError otDatasetSetActive (otInstance * aInstance, const otOperationalDataset * aDataset)

Sets the Active Operational Dataset.

If the dataset does not include an Active Timestamp, the dataset is only partially complete.

If Thread is enabled on a device that has a partially complete Active Dataset, the device will attempt to attach to an existing Thread network using any existing information in the dataset. Only the Thread Network Key is needed to attach to a network.

If channel is not included in the dataset, the device will send MLE Announce messages across different channels to find neighbors on other channels.

If the device successfully attaches to a Thread network, the device will then retrieve the full Active Dataset from its Parent. Note that a router-capable device will not transition to the Router or Leader roles until it has a complete Active Dataset.

This function consistently returns OT_ERROR_NONE and can effectively be treated as having a void return type. Previously, other errors (e.g., OT_ERROR_NOT_IMPLEMENTED) were allowed for legacy reasons. However, as non-volatile storage is now mandatory for Thread operation, any failure to save the dataset will trigger an assertion. The otError return type is retained for backward compatibility.

otDatasetSetActiveTlvs#

otError otDatasetSetActiveTlvs (otInstance * aInstance, const otOperationalDatasetTlvs * aDataset)

Sets the Active Operational Dataset.

If the dataset does not include an Active Timestamp, the dataset is only partially complete.

If Thread is enabled on a device that has a partially complete Active Dataset, the device will attempt to attach to an existing Thread network using any existing information in the dataset. Only the Thread Network Key is needed to attach to a network.

If channel is not included in the dataset, the device will send MLE Announce messages across different channels to find neighbors on other channels.

If the device successfully attaches to a Thread network, the device will then retrieve the full Active Dataset from its Parent. Note that a router-capable device will not transition to the Router or Leader roles until it has a complete Active Dataset.

otDatasetGetPending#

otError otDatasetGetPending (otInstance * aInstance, otOperationalDataset * aDataset)

Gets the Pending Operational Dataset.

otDatasetGetPendingTlvs#

otError otDatasetGetPendingTlvs (otInstance * aInstance, otOperationalDatasetTlvs * aDataset)

Gets the Pending Operational Dataset.

otDatasetSetPending#

otError otDatasetSetPending (otInstance * aInstance, const otOperationalDataset * aDataset)

Sets the Pending Operational Dataset.

This function consistently returns OT_ERROR_NONE and can effectively be treated as having a void return type. Previously, other errors (e.g., OT_ERROR_NOT_IMPLEMENTED) were allowed for legacy reasons. However, as non-volatile storage is now mandatory for Thread operation, any failure to save the dataset will trigger an assertion. The otError return type is retained for backward compatibility.

otDatasetSetPendingTlvs#

otError otDatasetSetPendingTlvs (otInstance * aInstance, const otOperationalDatasetTlvs * aDataset)

Sets the Pending Operational Dataset.

otDatasetSendMgmtActiveGet#

otError otDatasetSendMgmtActiveGet (otInstance * aInstance, const otOperationalDatasetComponents * aDatasetComponents, const uint8_t * aTlvTypes, uint8_t aLength, const otIp6Address * aAddress)

Sends MGMT_ACTIVE_GET.

otDatasetSendMgmtActiveSet#

otError otDatasetSendMgmtActiveSet (otInstance * aInstance, const otOperationalDataset * aDataset, const uint8_t * aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void * aContext)

Sends MGMT_ACTIVE_SET.

otDatasetSendMgmtPendingGet#

otError otDatasetSendMgmtPendingGet (otInstance * aInstance, const otOperationalDatasetComponents * aDatasetComponents, const uint8_t * aTlvTypes, uint8_t aLength, const otIp6Address * aAddress)

Sends MGMT_PENDING_GET.

otDatasetSendMgmtPendingSet#

otError otDatasetSendMgmtPendingSet (otInstance * aInstance, const otOperationalDataset * aDataset, const uint8_t * aTlvs, uint8_t aLength, otDatasetMgmtSetCallback aCallback, void * aContext)

Sends MGMT_PENDING_SET.

otDatasetGeneratePskc#

otError otDatasetGeneratePskc (const char * aPassPhrase, const otNetworkName * aNetworkName, const otExtendedPanId * aExtPanId, otPskc * aPskc)

Generates PSKc from a given pass-phrase, network name, and extended PAN ID.

PSKc is used to establish the Commissioner Session.

otNetworkNameFromString#

otError otNetworkNameFromString (otNetworkName * aNetworkName, const char * aNameString)

Sets an otNetworkName instance from a given null terminated C string.

aNameString must follow UTF-8 encoding and the Network Name length must not be longer than OT_NETWORK_NAME_MAX_SIZE.

otDatasetParseTlvs#

otError otDatasetParseTlvs (const otOperationalDatasetTlvs * aDatasetTlvs, otOperationalDataset * aDataset)

Parses an Operational Dataset from a given otOperationalDatasetTlvs.

otDatasetConvertToTlvs#

void otDatasetConvertToTlvs (const otOperationalDataset * aDataset, otOperationalDatasetTlvs * aDatasetTlvs)

Converts a given Operational Dataset to otOperationalDatasetTlvs.

otDatasetUpdateTlvs#

otError otDatasetUpdateTlvs (const otOperationalDataset * aDataset, otOperationalDatasetTlvs * aDatasetTlvs)

Updates a given Operational Dataset.

aDataset contains the fields to be updated and their new value.

otDatasetCreateNewNetwork#

otError otDatasetCreateNewNetwork (otInstance * aInstance, otOperationalDataset * aDataset)

For FTD only, creates a new Operational Dataset to use when forming a new network.

otDatasetGetDelayTimerMinimal#

uint32_t otDatasetGetDelayTimerMinimal (otInstance * aInstance)

For FTD only, gets a minimal delay timer.

otDatasetSetDelayTimerMinimal#

otError otDatasetSetDelayTimerMinimal (otInstance * aInstance, uint32_t aDelayTimerMinimal)

For FTD only, sets a minimal delay timer.

Note

• This API is reserved for testing and demo purposes only. Changing settings with this API will render a production application non-compliant with the Thread Specification.

otDatasetUpdaterRequestUpdate#

otError otDatasetUpdaterRequestUpdate (otInstance * aInstance, const otOperationalDataset * aDataset, otDatasetUpdaterCallback aCallback, void * aContext)

Requests an update to Operational Dataset.

Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE is enabled.

aDataset should contain the fields to be updated and their new value. It must not contain Active or Pending Timestamp fields. The Delay field is optional, if not provided a default value (1000 ms) would be used.

otDatasetUpdaterCancelUpdate#

void otDatasetUpdaterCancelUpdate (otInstance * aInstance)

Cancels an ongoing (if any) Operational Dataset update request.

Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE is enabled.

otDatasetUpdaterIsUpdateOngoing#

bool otDatasetUpdaterIsUpdateOngoing (otInstance * aInstance)

Indicates whether there is an ongoing Operation Dataset update request.

Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE is enabled.

OT_NETWORK_KEY_SIZE#

#define OT_NETWORK_KEY_SIZE

16

Size of the Thread Network Key (bytes)

OT_NETWORK_NAME_MAX_SIZE#

#define OT_NETWORK_NAME_MAX_SIZE

16

Maximum size of the Thread Network Name field (bytes)

OT_EXT_PAN_ID_SIZE#

#define OT_EXT_PAN_ID_SIZE

8

Size of a Thread PAN ID (bytes)

OT_MESH_LOCAL_PREFIX_SIZE#

#define OT_MESH_LOCAL_PREFIX_SIZE

OT_IP6_PREFIX_SIZE

Size of the Mesh Local Prefix (bytes)

OT_PSKC_MAX_SIZE#

#define OT_PSKC_MAX_SIZE

16

Maximum size of the PSKc (bytes)

OT_CHANNEL_1_MASK#

#define OT_CHANNEL_1_MASK

(1 << 1)

Channel 1.

OT_CHANNEL_2_MASK#

#define OT_CHANNEL_2_MASK

(1 << 2)

Channel 2.

OT_CHANNEL_3_MASK#

#define OT_CHANNEL_3_MASK

(1 << 3)

Channel 3.

OT_CHANNEL_4_MASK#

#define OT_CHANNEL_4_MASK

(1 << 4)

Channel 4.

OT_CHANNEL_5_MASK#

#define OT_CHANNEL_5_MASK

(1 << 5)

Channel 5.

OT_CHANNEL_6_MASK#

#define OT_CHANNEL_6_MASK

(1 << 6)

Channel 6.

OT_CHANNEL_7_MASK#

#define OT_CHANNEL_7_MASK

(1 << 7)

Channel 7.

OT_CHANNEL_8_MASK#

#define OT_CHANNEL_8_MASK

(1 << 8)

Channel 8.

OT_CHANNEL_9_MASK#

#define OT_CHANNEL_9_MASK

(1 << 9)

Channel 9.

OT_CHANNEL_10_MASK#

#define OT_CHANNEL_10_MASK

(1 << 10)

Channel 10.

OT_CHANNEL_11_MASK#

#define OT_CHANNEL_11_MASK

(1 << 11)

Channel 11.

OT_CHANNEL_12_MASK#

#define OT_CHANNEL_12_MASK

(1 << 12)

Channel 12.

OT_CHANNEL_13_MASK#

#define OT_CHANNEL_13_MASK

(1 << 13)

Channel 13.

OT_CHANNEL_14_MASK#

#define OT_CHANNEL_14_MASK

(1 << 14)

Channel 14.

OT_CHANNEL_15_MASK#

#define OT_CHANNEL_15_MASK

(1 << 15)

Channel 15.

OT_CHANNEL_16_MASK#

#define OT_CHANNEL_16_MASK

(1 << 16)

Channel 16.

OT_CHANNEL_17_MASK#

#define OT_CHANNEL_17_MASK

(1 << 17)

Channel 17.

OT_CHANNEL_18_MASK#

#define OT_CHANNEL_18_MASK

(1 << 18)

Channel 18.

OT_CHANNEL_19_MASK#

#define OT_CHANNEL_19_MASK

(1 << 19)

Channel 19.

OT_CHANNEL_20_MASK#

#define OT_CHANNEL_20_MASK

(1 << 20)

Channel 20.

OT_CHANNEL_21_MASK#

#define OT_CHANNEL_21_MASK

(1 << 21)

Channel 21.

OT_CHANNEL_22_MASK#

#define OT_CHANNEL_22_MASK

(1 << 22)

Channel 22.

OT_CHANNEL_23_MASK#

#define OT_CHANNEL_23_MASK

(1 << 23)

Channel 23.

OT_CHANNEL_24_MASK#

#define OT_CHANNEL_24_MASK

(1 << 24)

Channel 24.

OT_CHANNEL_25_MASK#

#define OT_CHANNEL_25_MASK

(1 << 25)

Channel 25.

OT_CHANNEL_26_MASK#

#define OT_CHANNEL_26_MASK

(1 << 26)

Channel 26.

OT_OPERATIONAL_DATASET_MAX_LENGTH#

#define OT_OPERATIONAL_DATASET_MAX_LENGTH

254

Maximum length of Operational Dataset in bytes.