Modules#
otOperationalDatasetComponents
Operational Dataset#
Includes functions for the Operational Dataset API.
For FTD builds only, Dataset Updater includes functions to manage dataset updates.
For FTD and MTD builds, the Operational Dataset API includes functions to manage Active and Pending datasets and dataset TLVs.
Enumerations#
This enumeration represents meshcop TLV types.
Typedefs#
This structure represents a Thread Network Key.
This datatype represents KeyRef to NetworkKey.
This structure represents a Network Name.
This structure represents an Extended PAN ID.
This structure represents a Mesh Local Prefix.
This datatype represents KeyRef to PSKc.
This structure represent Security Policy.
This type represents Channel Mask.
This structure represents presence of different components in Active or Pending Operational Dataset.
This structure represents a Thread Dataset timestamp component.
This structure represents an Active or Pending Operational Dataset.
This structure represents an Active or Pending Operational Dataset.
This enumeration represents meshcop TLV types.
This function pointer is called when a response to a MGMT_SET request is received or times out.
This callback function pointer is called when a Dataset update request finishes, reporting success or failure status of the Dataset update request.
Variables#
Functions#
This function indicates whether a valid network is present in the Active Operational Dataset or not.
Gets the Active Operational Dataset.
This function gets the Active Operational Dataset.
Sets the Active Operational Dataset.
This function sets the Active Operational Dataset.
This function gets the Pending Operational Dataset.
This function gets the Pending Operational Dataset.
Sets the Pending Operational Dataset.
This function sets the Pending Operational Dataset.
Sends MGMT_ACTIVE_GET.
Sends MGMT_ACTIVE_SET.
Sends MGMT_PENDING_GET.
Sends MGMT_PENDING_SET.
This function generates PSKc from a given pass-phrase, network name, and extended PAN ID.
Sets an otNetworkName
instance from a given null terminated C string.
Parses an Operational Dataset from a given otOperationalDatasetTlvs
.
Converts a given Operational Dataset to otOperationalDatasetTlvs
.
Updates a given Operational Dataset.
For FTD only, creates a new Operational Dataset to use when forming a new network.
For FTD only, gets a minimal delay timer.
For FTD only, sets a minimal delay timer.
This function requests an update to Operational Dataset.
This function cancels an ongoing (if any) Operational Dataset update request.
This function indicates whether there is an ongoing Operation Dataset update request.
Macros#
Size of the Thread Network Key (bytes)
Maximum size of the Thread Network Name field (bytes)
Size of a Thread PAN ID (bytes)
Size of the Mesh Local Prefix (bytes)
Maximum size of the PSKc (bytes)
Channel 1.
Channel 2.
Channel 3.
Channel 4.
Channel 5.
Channel 6.
Channel 7.
Channel 8.
Channel 9.
Channel 10.
Channel 11.
Channel 12.
Channel 13.
Channel 14.
Channel 15.
Channel 16.
Channel 17.
Channel 18.
Channel 19.
Channel 20.
Channel 21.
Channel 22.
Channel 23.
Channel 24.
Channel 25.
Channel 26.
Maximum length of Operational Dataset in bytes.
Enumeration Documentation#
otMeshcopTlvType#
otMeshcopTlvType
This enumeration represents meshcop TLV types.
Enumerator | |
---|---|
OT_MESHCOP_TLV_CHANNEL | meshcop Channel TLV |
OT_MESHCOP_TLV_PANID | meshcop Pan Id TLV |
OT_MESHCOP_TLV_EXTPANID | meshcop Extended Pan Id TLV |
OT_MESHCOP_TLV_NETWORKNAME | meshcop Network Name TLV |
OT_MESHCOP_TLV_PSKC | meshcop PSKc TLV |
OT_MESHCOP_TLV_NETWORKKEY | meshcop Network Key TLV |
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE | meshcop Network Key Sequence TLV |
OT_MESHCOP_TLV_MESHLOCALPREFIX | meshcop Mesh Local Prefix TLV |
OT_MESHCOP_TLV_STEERING_DATA | meshcop Steering Data TLV |
OT_MESHCOP_TLV_BORDER_AGENT_RLOC | meshcop Border Agent Locator TLV |
OT_MESHCOP_TLV_COMMISSIONER_ID | meshcop Commissioner ID TLV |
OT_MESHCOP_TLV_COMM_SESSION_ID | meshcop Commissioner Session ID TLV |
OT_MESHCOP_TLV_SECURITYPOLICY | meshcop Security Policy TLV |
OT_MESHCOP_TLV_GET | meshcop Get TLV |
OT_MESHCOP_TLV_ACTIVETIMESTAMP | meshcop Active Timestamp TLV |
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT | meshcop Commissioner UDP Port TLV |
OT_MESHCOP_TLV_STATE | meshcop State TLV |
OT_MESHCOP_TLV_JOINER_DTLS | meshcop Joiner DTLS Encapsulation TLV |
OT_MESHCOP_TLV_JOINER_UDP_PORT | meshcop Joiner UDP Port TLV |
OT_MESHCOP_TLV_JOINER_IID | meshcop Joiner IID TLV |
OT_MESHCOP_TLV_JOINER_RLOC | meshcop Joiner Router Locator TLV |
OT_MESHCOP_TLV_JOINER_ROUTER_KEK | meshcop Joiner Router KEK TLV |
OT_MESHCOP_TLV_PROVISIONING_URL | meshcop Provisioning URL TLV |
OT_MESHCOP_TLV_VENDOR_NAME_TLV | meshcop Vendor Name TLV |
OT_MESHCOP_TLV_VENDOR_MODEL_TLV | meshcop Vendor Model TLV |
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV | meshcop Vendor SW Version TLV |
OT_MESHCOP_TLV_VENDOR_DATA_TLV | meshcop Vendor Data TLV |
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV | meshcop Vendor Stack Version TLV |
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV | meshcop UDP encapsulation TLV |
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV | meshcop IPv6 address TLV |
OT_MESHCOP_TLV_PENDINGTIMESTAMP | meshcop Pending Timestamp TLV |
OT_MESHCOP_TLV_DELAYTIMER | meshcop Delay Timer TLV |
OT_MESHCOP_TLV_CHANNELMASK | meshcop Channel Mask TLV |
OT_MESHCOP_TLV_COUNT | meshcop Count TLV |
OT_MESHCOP_TLV_PERIOD | meshcop Period TLV |
OT_MESHCOP_TLV_SCAN_DURATION | meshcop Scan Duration TLV |
OT_MESHCOP_TLV_ENERGY_LIST | meshcop Energy List TLV |
OT_MESHCOP_TLV_DISCOVERYREQUEST | meshcop Discovery Request TLV |
OT_MESHCOP_TLV_DISCOVERYRESPONSE | meshcop Discovery Response TLV |
OT_MESHCOP_TLV_JOINERADVERTISEMENT | meshcop Joiner Advertisement TLV |
274
of file include/openthread/dataset.h
Typedef Documentation#
otNetworkKey#
typedef struct otNetworkKey otNetworkKey
This structure represents a Thread Network Key.
74
of file include/openthread/dataset.h
otNetworkKeyRef#
typedef otCryptoKeyRef otNetworkKeyRef
This datatype represents KeyRef to NetworkKey.
Reference to Key
80
of file include/openthread/dataset.h
otNetworkName#
typedef struct otNetworkName otNetworkName
This structure represents a Network Name.
The otNetworkName
is a null terminated C string (i.e., m8
char array MUST end with null char \0
).
93
of file include/openthread/dataset.h
otExtendedPanId#
typedef struct otExtendedPanId otExtendedPanId
This structure represents an Extended PAN ID.
111
of file include/openthread/dataset.h
otMeshLocalPrefix#
typedef otIp6NetworkPrefix otMeshLocalPrefix
This structure represents a Mesh Local Prefix.
119
of file include/openthread/dataset.h
otPskc#
typedef struct otPskc otPskc
This structure represents a PSKc.
137
of file include/openthread/dataset.h
otPskcRef#
typedef otCryptoKeyRef otPskcRef
This datatype represents KeyRef to PSKc.
Reference to Key
143
of file include/openthread/dataset.h
otSecurityPolicy#
typedef struct otSecurityPolicy otSecurityPolicy
This structure represent Security Policy.
163
of file include/openthread/dataset.h
otChannelMask#
typedef uint32_t otChannelMask
This type represents Channel Mask.
169
of file include/openthread/dataset.h
otOperationalDatasetComponents#
typedef struct otOperationalDatasetComponents otOperationalDatasetComponents
This structure represents presence of different components in Active or Pending Operational Dataset.
216
of file include/openthread/dataset.h
otTimestamp#
typedef struct otTimestamp otTimestamp
This structure represents a Thread Dataset timestamp component.
227
of file include/openthread/dataset.h
otOperationalDataset#
typedef struct otOperationalDataset otOperationalDataset
This structure represents an Active or Pending Operational Dataset.
Components in Dataset are optional. mComponents
structure specifies which components are present in the Dataset.
250
of file include/openthread/dataset.h
otOperationalDatasetTlvs#
typedef struct otOperationalDatasetTlvs otOperationalDatasetTlvs
This structure represents an Active or Pending Operational Dataset.
The Operational Dataset is TLV encoded as specified by Thread.
268
of file include/openthread/dataset.h
otMeshcopTlvType#
typedef enum otMeshcopTlvType otMeshcopTlvType
This enumeration represents meshcop TLV types.
316
of file include/openthread/dataset.h
otDatasetMgmtSetCallback#
typedef void(* otDatasetMgmtSetCallback) (otError aResult, void *aContext) )(otError aResult, void *aContext)
This function pointer is called when a response to a MGMT_SET request is received or times out.
[in] | aResult | A result of the operation. |
[in] | aContext | A pointer to application-specific context. |
331
of file include/openthread/dataset.h
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.
[in] | aError | The error status. OT_ERROR_NONE indicates successful Dataset update. OT_ERROR_INVALID_STATE indicates failure due invalid state (MLE being disabled). OT_ERROR_ALREADY indicates failure due to another device within network requesting a conflicting Dataset update. |
[in] | aContext | A pointer to the arbitrary context (provided by user in |
Available when OPENTHREAD_CONFIG_DATASET_UPDATER_ENABLE
is enabled.
69
of file include/openthread/dataset_updater.h