Crate openthread_sys

Source
Expand description

§Raw OpenThread API Bindings

This crate provides the raw OpenThread API bindings to Rust. The entire API surface is unsafe and, in general, should not be used directly. Instead, you should use a safe wrapper crate such as [::openthread_rust].

Modules§

spinel

Structs§

__BindgenBitfieldUnit
__va_list_tag
otActiveScanResult
Represents a received IEEE 802.15.4 Beacon.
otBackboneRouterConfig
Represents Backbone Router configuration.
otBackboneRouterMulticastListenerInfo
Represents a Backbone Router Multicast Listener info.
otBackboneRouterNdProxyInfo
Represents the Backbone Router ND Proxy info.
otBorderAgentCounters
Defines Border Agent counters.
otBorderAgentId
Represents a Border Agent Identifier.
otBorderAgentSessionInfo
Represents information about a Border Agent session.
otBorderAgentSessionIterator
Represents an iterator for Border Agent sessions.
otBorderRouterConfig
Represents a Border Router configuration.
otBorderRoutingCounters
Represents the counters of packets forwarded via Border Routing.
otBorderRoutingPeerBorderRouterEntry
Represents information about a peer Border Router found in the Network Data.
otBorderRoutingPrefixTableEntry
Represents an entry from the discovered prefix table.
otBorderRoutingPrefixTableIterator
Represents an iterator to iterate through the Border Router’s discovered prefix table.
otBorderRoutingRouterEntry
Represents a discovered router on the infrastructure link.
otBufferInfo
Represents the message buffer information for different queues used by OpenThread stack.
otCacheEntryInfo
Represents an EID cache entry.
otCacheEntryIterator
Represents an iterator used for iterating through the EID cache table entries.
otChildInfo
Holds diagnostic information for a Thread Child
otCliCommand
Represents a CLI command.
otCoapBlockwiseResource
Represents a CoAP resource with block-wise transfer.
otCoapOption
Represents a CoAP option.
otCoapOptionIterator
Acts as an iterator for CoAP options
otCoapResource
Represents a CoAP resource.
otCoapTxParameters
Represents the CoAP transmission parameters.
otCommissioningDataset
Represents a Commissioning Dataset.
otCryptoContext
@struct otCryptoContext
otCryptoKey
@struct otCryptoKey
otDeviceProperties
Represents the device properties which are used for calculating the local leader weight on a device.
otDnsAddressResponse
otDnsBrowseResponse
otDnsQueryConfig
Represents a DNS query configuration.
otDnsServiceInfo
Provides info for a DNS service instance.
otDnsServiceResponse
otDnsTxtEntry
Represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
otDnsTxtEntryIterator
Represents an iterator for TXT record entries (key/value pairs).
otDnssdCounters
Contains the counters of DNS-SD server.
otDnssdHostInfo
Represents information of a discovered host for a DNS-SD query.
otDnssdServiceInstanceInfo
Represents information of a discovered service instance for a DNS-SD query.
otEnergyScanResult
Represents an energy scan result.
otExtAddress
@struct otExtAddress
otExtendedPanId
Represents an Extended PAN ID.
otExternalRouteConfig
Represents an External Route configuration.
otIcmp6Handler
Implements ICMPv6 message handler.
otIcmp6Header
@struct otIcmp6Header
otInstance
otIp4Address
@struct otIp4Address
otIp4Cidr
@struct otIp4Cidr
otIp6Address
@struct otIp6Address
otIp6AddressComponents
@struct otIp6AddressComponents
otIp6AddressInfo
Represents IPv6 address information.
otIp6InterfaceIdentifier
@struct otIp6InterfaceIdentifier
otIp6NetworkPrefix
@struct otIp6NetworkPrefix
otIp6Prefix
@struct otIp6Prefix
otIpCounters
Represents the IP level counters.
otJoinerDiscerner
Represents a Joiner Discerner.
otJoinerInfo
Represents a Joiner Info.
otJoinerPskd
Represents a Joiner PSKd.
otLeaderData
Represents the Thread Leader Data.
otLinkMetrics
Represents what metrics are specified to query.
otLinkMetricsSeriesFlags
Represents which frames are accounted in a Forward Tracking Series.
otLinkMetricsValues
Represents the result (value) for a Link Metrics query.
otLinkModeConfig
Represents an MLE Link Mode configuration.
otLinkedBuffer
A linked buffer structure for use with TCP.
otLogHexDumpInfo
Represents information used for generating hex dump output.
otLowpanContextInfo
Represents 6LoWPAN Context ID information associated with a prefix in Network Data.
otMacCounters
Represents the MAC layer counters.
otMacFilterEntry
Represents a Mac Filter entry.
otMacKey
@struct otMacKey
otMacKeyMaterial
@struct otMacKeyMaterial
otMessage
otMessageBuffer
Represents an OpenThread message buffer.
otMessageInfo
Represents the local and peer IPv6 socket addresses.
otMessageQueue
Represents an OpenThread message queue.
otMessageQueueInfo
Represents information about a message queue.
otMessageSettings
Represents a message settings.
otMleCounters
Represents the Thread MLE counters.
otMultiRadioNeighborInfo
Represents multi radio link information associated with a neighbor.
otNat64AddressMapping
Represents an address mapping record for NAT64.
otNat64AddressMappingIterator
Used to iterate through NAT64 address mappings.
otNat64Counters
Represents the counters for NAT64.
otNat64ErrorCounters
Represents the counters of dropped packets due to errors when handling NAT64 packets.
otNat64ProtocolCounters
Represents the counters for the protocols supported by NAT64.
otNeighborInfo
Holds diagnostic information for a neighboring Thread node
otNeighborTableEntryInfo
Represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table callback otNeighborTableCallback.
otNetifAddress
Represents an IPv6 network interface unicast address.
otNetifMulticastAddress
Represents an IPv6 network interface multicast address.
otNetworkDiagChildEntry
Represents a Network Diagnostic Child Table Entry.
otNetworkDiagConnectivity
Represents a Network Diagnostic Connectivity value.
otNetworkDiagMacCounters
Represents a Network Diagnostic Mac Counters value.
otNetworkDiagMleCounters
Represents a Network Diagnostics MLE Counters value.
otNetworkDiagRoute
Represents a Network Diagnostic Route64 TLV value.
otNetworkDiagRouteData
Represents a Network Diagnostic Route data.
otNetworkDiagTlv
Represents a Network Diagnostic TLV.
otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_1
otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_2
otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_3
otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_4
otNetworkKey
@struct otNetworkKey
otNetworkName
Represents a Network Name.
otOperationalDataset
Represents an Active or Pending Operational Dataset.
otOperationalDatasetComponents
Represents presence of different components in Active or Pending Operational Dataset.
otOperationalDatasetTlvs
Represents an Active or Pending Operational Dataset.
otPacketsAndBytes
Represents the counters for packets and bytes.
otPdProcessedRaInfo
Represents a group of data of platform-generated RA messages processed.
otPingSenderConfig
Represents a ping request configuration.
otPingSenderReply
Represents a ping reply.
otPingSenderStatistics
Represents statistics of a ping request.
otPlatCryptoEcdsaKeyPair
@struct otPlatCryptoEcdsaKeyPair
otPlatCryptoEcdsaPublicKey
@struct otPlatCryptoEcdsaPublicKey
otPlatCryptoEcdsaSignature
@struct otPlatCryptoEcdsaSignature
otPlatCryptoSha256Hash
@struct otPlatCryptoSha256Hash
otPlatDnsUpstreamQuery
otPlatInfraIfLinkLayerAddress
Represents an InfraIf Link-Layer Address.
otPlatTrelCounters
Represents a group of TREL related counters in the platform layer.
otPlatTrelPeerInfo
Represents a TREL peer info discovered using DNS-SD browse on the service name “_trel._udp”.
otPskc
Represents PSKc.
otRadioCoexMetrics
Represents radio coexistence metrics.
otRadioFrame
Represents an IEEE 802.15.4 radio frame.
otRadioFrame__bindgen_ty_1__bindgen_ty_1
Structure representing radio frame transmit information.
otRadioFrame__bindgen_ty_1__bindgen_ty_2
Structure representing radio frame receive information.
otRadioIeInfo
Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
otRadioLinkInfo
Represents information associated with a radio link.
otRouterInfo
Holds diagnostic information for a Thread Router
otSecurityPolicy
Represent Security Policy.
otServerConfig
Represents a Server configuration.
otServiceConfig
Represents a Service configuration.
otSntpQuery
Implements SNTP Query parameters.
otSockAddr
Represents an IPv6 socket address.
otSrpClientBuffersServiceEntry
Represents a SRP client service pool entry.
otSrpClientHostInfo
Represents an SRP client host info.
otSrpClientService
Represents an SRP client service.
otSrpServerHost
otSrpServerLeaseConfig
Includes SRP server LEASE and KEY-LEASE configurations.
otSrpServerLeaseInfo
Includes SRP server lease information of a host/service.
otSrpServerResponseCounters
Includes the statistics of SRP server responses.
otSrpServerService
otSrpServerTtlConfig
Includes SRP server TTL configurations.
otSteeringData
Represents the steering data.
otTcpEndpoint
Represents a TCP endpoint.
otTcpEndpointInitializeArgs
Contains arguments to the otTcpEndpointInitialize() function.
otTcpListener
Represents a TCP listener.
otTcpListenerInitializeArgs
Contains arguments to the otTcpListenerInitialize() function.
otThreadDiscoveryRequestInfo
Represents the Thread Discovery Request data.
otThreadLinkInfo
Represents link-specific information for messages received from the Thread radio.
otThreadParentResponseInfo
Represents the MLE Parent Response data.
otTimestamp
Represents a Thread Dataset timestamp component.
otTrelPeer
Represents a TREL peer.
otUdpReceiver
Represents a UDP receiver.
otUdpSocket
Represents a UDP socket.
otUpstreamDnsCounters
Represents the count of queries, responses, failures handled by upstream DNS server.

Constants§

OPENTHREAD_API_VERSION
OPENTHREAD_LIB_SPINEL_RX_FRAME_BUFFER_SIZE
OPENTHREAD_POSIX_CONFIG_RCP_TIME_SYNC_INTERVAL
OPENTHREAD_SPINEL_CONFIG_ABORT_ON_UNEXPECTED_RCP_RESET_ENABLE
OT_ACK_IE_MAX_SIZE
< Max length for header IE in ACK.
OT_ADDRESS_ORIGIN_DHCPV6
< DHCPv6 assigned address
OT_ADDRESS_ORIGIN_MANUAL
< Manually assigned address
OT_ADDRESS_ORIGIN_SLAAC
< SLAAC assigned address
OT_ADDRESS_ORIGIN_THREAD
< Thread assigned address (ALOC, RLOC, MLEID, etc)
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_ADDED
< Domain Prefix was added.
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_CHANGED
< Domain Prefix was changed.
OT_BACKBONE_ROUTER_DOMAIN_PREFIX_REMOVED
< Domain Prefix was removed.
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ADDED
< Multicast Listener was added.
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_ITERATOR_INIT
OT_BACKBONE_ROUTER_MULTICAST_LISTENER_REMOVED
< Multicast Listener was removed or expired.
OT_BACKBONE_ROUTER_NDPROXY_ADDED
< ND Proxy was added.
OT_BACKBONE_ROUTER_NDPROXY_CLEARED
< All ND Proxies were cleared.
OT_BACKBONE_ROUTER_NDPROXY_REMOVED
< ND Proxy was removed.
OT_BACKBONE_ROUTER_NDPROXY_RENEWED
< ND Proxy was renewed.
OT_BACKBONE_ROUTER_STATE_DISABLED
< Backbone function is disabled.
OT_BACKBONE_ROUTER_STATE_PRIMARY
< The Primary Backbone Router.
OT_BACKBONE_ROUTER_STATE_SECONDARY
< Secondary Backbone Router.
OT_BORDER_AGENT_DEFAULT_EPHEMERAL_KEY_TIMEOUT
OT_BORDER_AGENT_ID_LENGTH
OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_LENGTH
OT_BORDER_AGENT_MAX_EPHEMERAL_KEY_TIMEOUT
OT_BORDER_AGENT_MIN_EPHEMERAL_KEY_LENGTH
OT_BORDER_AGENT_STATE_ACCEPTED
< Session is established and candidate is accepted as full commissioner.
OT_BORDER_AGENT_STATE_CONNECTED
< Session is established with an external commissioner candidate.
OT_BORDER_AGENT_STATE_DISABLED
< Ephemeral Key Manager is disabled.
OT_BORDER_AGENT_STATE_STARTED
< Ephemeral key is set. Listening to accept secure connections.
OT_BORDER_AGENT_STATE_STOPPED
< Enabled, but no ephemeral key is in use (not set or started).
OT_BORDER_ROUTING_DHCP6_PD_STATE_DISABLED
< DHCPv6 PD is disabled on the border router.
OT_BORDER_ROUTING_DHCP6_PD_STATE_IDLE
< DHCPv6 PD is idle; Higher-prf prefix published by other BRs.
OT_BORDER_ROUTING_DHCP6_PD_STATE_RUNNING
< DHCPv6 PD is enabled and will try to request and publish a prefix.
OT_BORDER_ROUTING_DHCP6_PD_STATE_STOPPED
< DHCPv6 PD in enabled but won’t try to request and publish a prefix.
OT_BORDER_ROUTING_STATE_DISABLED
< Routing Manager is initialized but disabled.
OT_BORDER_ROUTING_STATE_RUNNING
< Routing Manager is initialized, enabled, and running.
OT_BORDER_ROUTING_STATE_STOPPED
< Routing Manager in initialized and enabled but currently stopped.
OT_BORDER_ROUTING_STATE_UNINITIALIZED
< Routing Manager is uninitialized.
OT_CACHE_ENTRY_STATE_CACHED
OT_CACHE_ENTRY_STATE_QUERY
OT_CACHE_ENTRY_STATE_RETRY_QUERY
OT_CACHE_ENTRY_STATE_SNOOPED
OT_CHANGED_ACTIVE_DATASET
OT_CHANGED_CHANNEL_MANAGER_NEW_CHANNEL
OT_CHANGED_COMMISSIONER_STATE
OT_CHANGED_IP6_ADDRESS_ADDED
OT_CHANGED_IP6_ADDRESS_REMOVED
OT_CHANGED_IP6_MULTICAST_SUBSCRIBED
OT_CHANGED_IP6_MULTICAST_UNSUBSCRIBED
OT_CHANGED_JOINER_STATE
OT_CHANGED_NAT64_TRANSLATOR_STATE
OT_CHANGED_NETWORK_KEY
OT_CHANGED_PARENT_LINK_QUALITY
OT_CHANGED_PENDING_DATASET
OT_CHANGED_PSKC
OT_CHANGED_SECURITY_POLICY
OT_CHANGED_SUPPORTED_CHANNEL_MASK
OT_CHANGED_THREAD_BACKBONE_ROUTER_LOCAL
OT_CHANGED_THREAD_BACKBONE_ROUTER_STATE
OT_CHANGED_THREAD_CHANNEL
OT_CHANGED_THREAD_CHILD_ADDED
OT_CHANGED_THREAD_CHILD_REMOVED
OT_CHANGED_THREAD_EXT_PANID
OT_CHANGED_THREAD_KEY_SEQUENCE_COUNTER
OT_CHANGED_THREAD_LL_ADDR
OT_CHANGED_THREAD_ML_ADDR
OT_CHANGED_THREAD_NETDATA
OT_CHANGED_THREAD_NETIF_STATE
OT_CHANGED_THREAD_NETWORK_NAME
OT_CHANGED_THREAD_PANID
OT_CHANGED_THREAD_PARTITION_ID
OT_CHANGED_THREAD_RLOC_ADDED
OT_CHANGED_THREAD_RLOC_REMOVED
OT_CHANGED_THREAD_ROLE
OT_CHANNEL_1_MASK
OT_CHANNEL_2_MASK
OT_CHANNEL_3_MASK
OT_CHANNEL_4_MASK
OT_CHANNEL_5_MASK
OT_CHANNEL_6_MASK
OT_CHANNEL_7_MASK
OT_CHANNEL_8_MASK
OT_CHANNEL_9_MASK
OT_CHANNEL_10_MASK
OT_CHANNEL_11_MASK
OT_CHANNEL_12_MASK
OT_CHANNEL_13_MASK
OT_CHANNEL_14_MASK
OT_CHANNEL_15_MASK
OT_CHANNEL_16_MASK
OT_CHANNEL_17_MASK
OT_CHANNEL_18_MASK
OT_CHANNEL_19_MASK
OT_CHANNEL_20_MASK
OT_CHANNEL_21_MASK
OT_CHANNEL_22_MASK
OT_CHANNEL_23_MASK
OT_CHANNEL_24_MASK
OT_CHANNEL_25_MASK
OT_CHANNEL_26_MASK
OT_CHILD_IP6_ADDRESS_ITERATOR_INIT
OT_COAP_CODE_BAD_GATEWAY
< Bad Gateway
OT_COAP_CODE_BAD_OPTION
< Bad Option
OT_COAP_CODE_BAD_REQUEST
< Bad Request
OT_COAP_CODE_CHANGED
< Changed
OT_COAP_CODE_CONTENT
< Content
OT_COAP_CODE_CONTINUE
< RFC7959 Continue
OT_COAP_CODE_CREATED
< Created
OT_COAP_CODE_DELETE
< Delete
OT_COAP_CODE_DELETED
< Deleted
OT_COAP_CODE_EMPTY
< Empty message code
OT_COAP_CODE_FORBIDDEN
< Forbidden
OT_COAP_CODE_GATEWAY_TIMEOUT
< Gateway Timeout
OT_COAP_CODE_GET
< Get
OT_COAP_CODE_INTERNAL_ERROR
< Internal Server Error
OT_COAP_CODE_METHOD_NOT_ALLOWED
< Method Not Allowed
OT_COAP_CODE_NOT_ACCEPTABLE
< Not Acceptable
OT_COAP_CODE_NOT_FOUND
< Not Found
OT_COAP_CODE_NOT_IMPLEMENTED
< Not Implemented
OT_COAP_CODE_POST
< Post
OT_COAP_CODE_PRECONDITION_FAILED
< Precondition Failed
OT_COAP_CODE_PROXY_NOT_SUPPORTED
< Proxying Not Supported
OT_COAP_CODE_PUT
< Put
OT_COAP_CODE_REQUEST_INCOMPLETE
< RFC7959 Request Entity Incomplete
OT_COAP_CODE_REQUEST_TOO_LARGE
< Request Entity Too Large
OT_COAP_CODE_RESPONSE_MIN
< 2.00
OT_COAP_CODE_SERVICE_UNAVAILABLE
< Service Unavailable
OT_COAP_CODE_UNAUTHORIZED
< Unauthorized
OT_COAP_CODE_UNSUPPORTED_FORMAT
< Unsupported Content-Format
OT_COAP_CODE_VALID
< Valid
OT_COAP_DEFAULT_TOKEN_LENGTH
OT_COAP_MAX_RETRANSMIT
OT_COAP_MAX_TOKEN_LENGTH
OT_COAP_MIN_ACK_TIMEOUT
OT_COAP_OPTION_ACCEPT
< Accept
OT_COAP_OPTION_BLOCK1
< Block1 (RFC7959)
OT_COAP_OPTION_BLOCK2
< Block2 (RFC7959)
OT_COAP_OPTION_BLOCK_SZX_16
OT_COAP_OPTION_BLOCK_SZX_32
OT_COAP_OPTION_BLOCK_SZX_64
OT_COAP_OPTION_BLOCK_SZX_128
OT_COAP_OPTION_BLOCK_SZX_256
OT_COAP_OPTION_BLOCK_SZX_512
OT_COAP_OPTION_BLOCK_SZX_1024
OT_COAP_OPTION_CONTENT_FORMAT
< Content-Format
OT_COAP_OPTION_CONTENT_FORMAT_CBOR
application/cbor: [RFC7049]
OT_COAP_OPTION_CONTENT_FORMAT_COAP_GROUP_JSON
application/coap-group+json: [RFC7390]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT
application/cose; cose-type=“cose-encrypt”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_ENCRYPT0
application/cose; cose-type=“cose-encrypt0”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY
application/cose-key: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_KEY_SET
application/cose-key-set: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC
application/cose; cose-type=“cose-mac”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_MAC0
application/cose; cose-type=“cose-mac0”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN
application/cose; cose-type=“cose-sign”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_COSE_SIGN1
application/cose; cose-type=“cose-sign1”: [RFC8152]
OT_COAP_OPTION_CONTENT_FORMAT_CWT
application/cwt: [RFC8392]
OT_COAP_OPTION_CONTENT_FORMAT_EXI
application/exi: [“Efficient XML Interchange (EXI) Format 1.0 (Second Edition)”, February 2014]
OT_COAP_OPTION_CONTENT_FORMAT_JSON
application/json: [RFC7159]
OT_COAP_OPTION_CONTENT_FORMAT_JSON_PATCH_JSON
application/json-patch+json: [RFC6902]
OT_COAP_OPTION_CONTENT_FORMAT_LINK_FORMAT
application/link-format: [RFC6690]
OT_COAP_OPTION_CONTENT_FORMAT_MERGE_PATCH_JSON
application/merge-patch+json: [RFC7396]
OT_COAP_OPTION_CONTENT_FORMAT_OCTET_STREAM
application/octet-stream: [RFC2045][RFC2046]
OT_COAP_OPTION_CONTENT_FORMAT_SENML_CBOR
application/senml+cbor: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENML_EXI
application/senml-exi: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENML_JSON
application/senml+json: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENML_XML
application/senml+xml: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_CBOR
application/sensml+cbor: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_EXI
application/sensml-exi: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_JSON
application/sensml+json: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_SENSML_XML
application/sensml+xml: [RFC8428]
OT_COAP_OPTION_CONTENT_FORMAT_TEXT_PLAIN
text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147]
OT_COAP_OPTION_CONTENT_FORMAT_XML
application/xml: [RFC3023]
OT_COAP_OPTION_E_TAG
< ETag
OT_COAP_OPTION_IF_MATCH
< If-Match
OT_COAP_OPTION_IF_NONE_MATCH
< If-None-Match
OT_COAP_OPTION_LOCATION_PATH
< Location-Path
OT_COAP_OPTION_LOCATION_QUERY
< Location-Query
OT_COAP_OPTION_MAX_AGE
< Max-Age
OT_COAP_OPTION_OBSERVE
< Observe [RFC7641]
OT_COAP_OPTION_PROXY_SCHEME
< Proxy-Scheme
OT_COAP_OPTION_PROXY_URI
< Proxy-Uri
OT_COAP_OPTION_SIZE1
< Size1
OT_COAP_OPTION_SIZE2
< Size2 (RFC7959)
OT_COAP_OPTION_URI_HOST
< Uri-Host
OT_COAP_OPTION_URI_PATH
< Uri-Path
OT_COAP_OPTION_URI_PORT
< Uri-Port
OT_COAP_OPTION_URI_QUERY
< Uri-Query
OT_COAP_SECURE_CONNECTED
< Connection established
OT_COAP_SECURE_DISCONNECTED_ERROR
< Disconnected due to an error
OT_COAP_SECURE_DISCONNECTED_LOCAL_CLOSED
< Disconnected locally
OT_COAP_SECURE_DISCONNECTED_MAX_ATTEMPTS
< Disconnected due to reaching the max connection attempts
OT_COAP_SECURE_DISCONNECTED_PEER_CLOSED
< Disconnected by peer
OT_COAP_TYPE_ACKNOWLEDGMENT
< Acknowledgment
OT_COAP_TYPE_CONFIRMABLE
< Confirmable
OT_COAP_TYPE_NON_CONFIRMABLE
< Non-confirmable
OT_COAP_TYPE_RESET
< Reset
OT_COMMISSIONER_JOINER_CONNECTED
OT_COMMISSIONER_JOINER_END
OT_COMMISSIONER_JOINER_FINALIZE
OT_COMMISSIONER_JOINER_REMOVED
OT_COMMISSIONER_JOINER_START
OT_COMMISSIONER_STATE_ACTIVE
< Commissioner role is active.
OT_COMMISSIONER_STATE_DISABLED
< Commissioner role is disabled.
OT_COMMISSIONER_STATE_PETITION
< Currently petitioning to become a Commissioner.
OT_COMMISSIONING_PASSPHRASE_MAX_SIZE
OT_COMMISSIONING_PASSPHRASE_MIN_SIZE
OT_CRYPTO_ECDSA_MAX_DER_SIZE
OT_CRYPTO_ECDSA_PUBLIC_KEY_SIZE
OT_CRYPTO_ECDSA_SIGNATURE_SIZE
OT_CRYPTO_KEY_ALG_AES_ECB
< Key Algorithm: AES ECB.
OT_CRYPTO_KEY_ALG_ECDSA
< Key Algorithm: ECDSA.
OT_CRYPTO_KEY_ALG_HMAC_SHA_256
< Key Algorithm: HMAC SHA-256.
OT_CRYPTO_KEY_ALG_VENDOR
< Key Algorithm: Vendor Defined.
OT_CRYPTO_KEY_STORAGE_PERSISTENT
< Key Persistence: Key is persistent.
OT_CRYPTO_KEY_STORAGE_VOLATILE
< Key Persistence: Key is volatile.
OT_CRYPTO_KEY_TYPE_AES
< Key Type: AES.
OT_CRYPTO_KEY_TYPE_ECDSA
< Key Type: ECDSA.
OT_CRYPTO_KEY_TYPE_HMAC
< Key Type: HMAC.
OT_CRYPTO_KEY_TYPE_RAW
< Key Type: Raw Data.
OT_CRYPTO_KEY_USAGE_DECRYPT
< Key Usage: AES ECB.
OT_CRYPTO_KEY_USAGE_ENCRYPT
< Key Usage: Encryption (vendor defined).
OT_CRYPTO_KEY_USAGE_EXPORT
< Key Usage: Key can be exported.
OT_CRYPTO_KEY_USAGE_NONE
< Key Usage: Key Usage is empty.
OT_CRYPTO_KEY_USAGE_SIGN_HASH
< Key Usage: Sign Hash.
OT_CRYPTO_KEY_USAGE_VERIFY_HASH
< Key Usage: Verify Hash.
OT_CRYPTO_PBDKF2_MAX_SALT_SIZE
OT_CRYPTO_SHA256_HASH_SIZE
OT_CSL_IE_SIZE
< Size of CSL IE content in bytes.
OT_DEFAULT_COAP_PORT
OT_DEFAULT_COAP_SECURE_PORT
OT_DEVICE_ROLE_CHILD
< The Thread Child role.
OT_DEVICE_ROLE_DETACHED
< Not currently participating in a Thread network/partition.
OT_DEVICE_ROLE_DISABLED
< The Thread stack is disabled.
OT_DEVICE_ROLE_LEADER
< The Thread Leader role.
OT_DEVICE_ROLE_ROUTER
< The Thread Router role.
OT_DNSSD_QUERY_TYPE_BROWSE
< Service type browse service.
OT_DNSSD_QUERY_TYPE_NONE
< Service type unspecified.
OT_DNSSD_QUERY_TYPE_RESOLVE
< Service type resolve service instance.
OT_DNSSD_QUERY_TYPE_RESOLVE_HOST
< Service type resolve hostname.
OT_DNS_FLAG_NO_RECURSION
< Indicates DNS name server can not resolve the query recursively.
OT_DNS_FLAG_RECURSION_DESIRED
< Indicates DNS name server can resolve the query recursively.
OT_DNS_FLAG_UNSPECIFIED
< Indicates the flag is not specified.
OT_DNS_MAX_LABEL_SIZE
OT_DNS_MAX_NAME_SIZE
OT_DNS_NAT64_ALLOW
< Allow NAT64 address translation during DNS client address resolution.
OT_DNS_NAT64_DISALLOW
< Do not allow NAT64 address translation during DNS client address resolution.
OT_DNS_NAT64_UNSPECIFIED
< NAT64 mode is not specified. Use default NAT64 mode.
OT_DNS_SERVICE_MODE_SRV
< Query for SRV record only.
OT_DNS_SERVICE_MODE_SRV_TXT
< Query for both SRV and TXT records in same message.
OT_DNS_SERVICE_MODE_SRV_TXT_OPTIMIZE
< Query for TXT/SRV together first, if fails then query separately.
OT_DNS_SERVICE_MODE_SRV_TXT_SEPARATE
< Query in parallel for SRV and TXT using separate messages.
OT_DNS_SERVICE_MODE_TXT
< Query for TXT record only.
OT_DNS_SERVICE_MODE_UNSPECIFIED
< Mode is not specified. Use default service mode.
OT_DNS_TRANSPORT_TCP
DNS query should be sent via UDP.
OT_DNS_TRANSPORT_UDP
DNS transport is unspecified.
OT_DNS_TRANSPORT_UNSPECIFIED
OT_DNS_TXT_KEY_ITER_MAX_LENGTH
OT_DNS_TXT_KEY_MAX_LENGTH
OT_DNS_TXT_KEY_MIN_LENGTH
OT_DURATION_STRING_SIZE
OT_ECN_CAPABLE_0
< ECT(0)
OT_ECN_CAPABLE_1
< ECT(1)
OT_ECN_MARKED
< Congestion encountered (CE)
OT_ECN_NOT_CAPABLE
< Non-ECT
OT_ENH_PROBING_IE_DATA_MAX_SIZE
< Max length of Link Metrics data in Vendor-Specific IE.
OT_ERROR_ABORT
Operation was aborted.
OT_ERROR_ADDRESS_FILTERED
Received a frame filtered by the address filter (allowlisted or denylisted).
OT_ERROR_ADDRESS_QUERY
Address resolution requires an address query operation.
OT_ERROR_ALREADY
The operation is already in progress.
OT_ERROR_BUSY
Service is busy and could not service the operation.
OT_ERROR_CHANNEL_ACCESS_FAILURE
A transmission could not take place due to activity on the channel, i.e., the CSMA-CA mechanism has failed (IEEE 802.15.4-2006).
OT_ERROR_DESTINATION_ADDRESS_FILTERED
Received a frame filtered by the destination address check.
OT_ERROR_DETACHED
Not currently attached to a Thread Partition.
OT_ERROR_DROP
Message was dropped.
OT_ERROR_DUPLICATED
Received a duplicated frame.
OT_ERROR_FAILED
Operational failed.
OT_ERROR_FCS
FCS check failure while receiving.
OT_ERROR_GENERIC
Generic error (should not use).
OT_ERROR_INVALID_ARGS
Input arguments are invalid.
OT_ERROR_INVALID_COMMAND
Input (CLI) command is invalid.
OT_ERROR_INVALID_SOURCE_ADDRESS
Received a frame from an invalid source address.
OT_ERROR_INVALID_STATE
Cannot complete due to invalid state.
OT_ERROR_IP6_ADDRESS_CREATION_FAILURE
The creation of IPv6 address failed.
OT_ERROR_LINK_MARGIN_LOW
The link margin was too low.
OT_ERROR_NONE
No error.
OT_ERROR_NOT_CAPABLE
Operation prevented by mode flags
OT_ERROR_NOT_FOUND
The requested item could not be found.
OT_ERROR_NOT_IMPLEMENTED
Function or method is not implemented.
OT_ERROR_NOT_LOWPAN_DATA_FRAME
Received a non-lowpan data frame.
OT_ERROR_NOT_TMF
Message is not a TMF Message.
OT_ERROR_NO_ACK
No acknowledgment was received after macMaxFrameRetries (IEEE 802.15.4-2006).
OT_ERROR_NO_ADDRESS
Address is not in the source match table.
OT_ERROR_NO_BUFS
Insufficient buffers.
OT_ERROR_NO_FRAME_RECEIVED
No frame received.
OT_ERROR_NO_ROUTE
No route available.
OT_ERROR_PARSE
Failed to parse message.
OT_ERROR_PENDING
Special error code used to indicate success/error status is pending and not yet known.
OT_ERROR_REASSEMBLY_TIMEOUT
Message is being dropped from reassembly list due to timeout.
OT_ERROR_REJECTED
Request rejected.
OT_ERROR_RESPONSE_TIMEOUT
Coap response or acknowledgment or DNS, SNTP response not received.
OT_ERROR_SECURITY
Security checks failed.
OT_ERROR_UNKNOWN_NEIGHBOR
Received a frame from an unknown neighbor.
OT_EXT_ADDRESS_SIZE
OT_EXT_PAN_ID_SIZE
OT_GPIO_MODE_INPUT
< Input mode without pull resistor.
OT_GPIO_MODE_OUTPUT
< Output mode.
OT_ICMP6_CODE_DST_UNREACH_NO_ROUTE
< Destination Unreachable (Type 1) - No Route
OT_ICMP6_CODE_DST_UNREACH_PROHIBITED
< Destination Unreachable (Type 1) - Administratively Prohibited
OT_ICMP6_CODE_FRAGM_REAS_TIME_EX
< Time Exceeded (Type 3) - Fragment Reassembly
OT_ICMP6_ECHO_HANDLER_ALL
< ICMPv6 Echo processing enabled for unicast and multicast requests
OT_ICMP6_ECHO_HANDLER_DISABLED
< ICMPv6 Echo processing disabled
OT_ICMP6_ECHO_HANDLER_MULTICAST_ONLY
< ICMPv6 Echo processing enabled only for multicast requests only
OT_ICMP6_ECHO_HANDLER_RLOC_ALOC_ONLY
< ICMPv6 Echo processing enabled for RLOC/ALOC destinations only
OT_ICMP6_ECHO_HANDLER_UNICAST_ONLY
< ICMPv6 Echo processing enabled only for unicast requests only
OT_ICMP6_HEADER_DATA_SIZE
OT_ICMP6_ROUTER_ADVERT_MIN_SIZE
OT_ICMP6_TYPE_DST_UNREACH
< Destination Unreachable
OT_ICMP6_TYPE_ECHO_REPLY
< Echo Reply
OT_ICMP6_TYPE_ECHO_REQUEST
< Echo Request
OT_ICMP6_TYPE_NEIGHBOR_ADVERT
< Neighbor Advertisement
OT_ICMP6_TYPE_NEIGHBOR_SOLICIT
< Neighbor Solicitation
OT_ICMP6_TYPE_PACKET_TO_BIG
< Packet To Big
OT_ICMP6_TYPE_PARAMETER_PROBLEM
< Parameter Problem
OT_ICMP6_TYPE_ROUTER_ADVERT
< Router Advertisement
OT_ICMP6_TYPE_ROUTER_SOLICIT
< Router Solicitation
OT_ICMP6_TYPE_TIME_EXCEEDED
< Time Exceeded
OT_IE_HEADER_SIZE
< Size of IE header in bytes.
OT_IP4_ADDRESS_SIZE
OT_IP4_ADDRESS_STRING_SIZE
OT_IP4_CIDR_STRING_SIZE
OT_IP6_ADDRESS_BITSIZE
OT_IP6_ADDRESS_SIZE
OT_IP6_ADDRESS_STRING_SIZE
OT_IP6_HEADER_PROTO_OFFSET
OT_IP6_HEADER_SIZE
OT_IP6_IID_SIZE
OT_IP6_MAX_MLR_ADDRESSES
OT_IP6_PREFIX_BITSIZE
OT_IP6_PREFIX_SIZE
OT_IP6_PREFIX_STRING_SIZE
OT_IP6_PROTO_DST_OPTS
< Destination Options for IPv6
OT_IP6_PROTO_FRAGMENT
< Fragment Header for IPv6
OT_IP6_PROTO_HOP_OPTS
< IPv6 Hop-by-Hop Option
OT_IP6_PROTO_ICMP6
< ICMP for IPv6
OT_IP6_PROTO_IP6
< IPv6 encapsulation
OT_IP6_PROTO_NONE
< No Next Header for IPv6
OT_IP6_PROTO_ROUTING
< Routing Header for IPv6
OT_IP6_PROTO_TCP
< Transmission Control Protocol
OT_IP6_PROTO_UDP
< User Datagram
OT_IP6_SOCK_ADDR_STRING_SIZE
OT_JOINER_ADVDATA_MAX_LENGTH
OT_JOINER_INFO_TYPE_ANY
< Accept any Joiner (no EUI64 or Discerner is specified).
OT_JOINER_INFO_TYPE_DISCERNER
< Joiner Discerner is specified (mSharedId.mDiscerner in otJoinerInfo).
OT_JOINER_INFO_TYPE_EUI64
< Joiner EUI-64 is specified (mSharedId.mEui64 in otJoinerInfo).
OT_JOINER_MAX_DISCERNER_LENGTH
OT_JOINER_MAX_PSKD_LENGTH
OT_JOINER_STATE_CONNECT
OT_JOINER_STATE_CONNECTED
OT_JOINER_STATE_DISCOVER
OT_JOINER_STATE_ENTRUST
OT_JOINER_STATE_IDLE
OT_JOINER_STATE_JOINED
OT_KEY_TYPE_KEY_REF
< Use Reference to Key.
OT_KEY_TYPE_LITERAL_KEY
< Use Literal Keys.
OT_LINK_CSL_PERIOD_TEN_SYMBOLS_UNIT_IN_USEC
OT_LINK_METRICS_ENH_ACK_CLEAR
< Clear.
OT_LINK_METRICS_ENH_ACK_REGISTER
< Register.
OT_LINK_METRICS_STATUS_CANNOT_SUPPORT_NEW_SERIES
OT_LINK_METRICS_STATUS_NO_MATCHING_FRAMES_RECEIVED
OT_LINK_METRICS_STATUS_OTHER_ERROR
OT_LINK_METRICS_STATUS_SERIESID_ALREADY_REGISTERED
OT_LINK_METRICS_STATUS_SERIESID_NOT_RECOGNIZED
OT_LINK_METRICS_STATUS_SUCCESS
OT_LOG_HEX_DUMP_LINE_SIZE
OT_LOG_LEVEL_CRIT
OT_LOG_LEVEL_DEBG
OT_LOG_LEVEL_INFO
OT_LOG_LEVEL_NONE
OT_LOG_LEVEL_NOTE
OT_LOG_LEVEL_WARN
OT_LOG_REGION_API
< OpenThread API
OT_LOG_REGION_ARP
< EID-to-RLOC mapping.
OT_LOG_REGION_BBR
< Backbone Router (available since Thread 1.2)
OT_LOG_REGION_BR
< Border Router
OT_LOG_REGION_CLI
< CLI
OT_LOG_REGION_COAP
< CoAP
OT_LOG_REGION_CORE
< OpenThread Core
OT_LOG_REGION_DNS
< DNS
OT_LOG_REGION_DUA
< Domain Unicast Address (available since Thread 1.2)
OT_LOG_REGION_ICMP
< ICMPv6
OT_LOG_REGION_IP6
< IPv6
OT_LOG_REGION_MAC
< IEEE 802.15.4 MAC
OT_LOG_REGION_MEM
< Memory
OT_LOG_REGION_MESH_COP
< Mesh Commissioning Protocol
OT_LOG_REGION_MLE
< MLE
OT_LOG_REGION_MLR
< Multicast Listener Registration (available since Thread 1.2)
OT_LOG_REGION_NCP
< NCP
OT_LOG_REGION_NET_DATA
< Network Data
OT_LOG_REGION_NET_DIAG
< Network Diagnostic
OT_LOG_REGION_PLATFORM
< Platform
OT_LOG_REGION_SRP
< Service Registration Protocol (SRP)
OT_LOG_REGION_TCP
< TCP
OT_LOG_REGION_UTIL
< Utility module
OT_MAC_FILTER_ADDRESS_MODE_ALLOWLIST
< Allowlist address filter mode is enabled.
OT_MAC_FILTER_ADDRESS_MODE_DENYLIST
< Denylist address filter mode is enabled.
OT_MAC_FILTER_ADDRESS_MODE_DISABLED
< Address filter is disabled.
OT_MAC_FILTER_FIXED_RSS_DISABLED
OT_MAC_FILTER_ITERATOR_INIT
OT_MAC_KEY_SIZE
OT_MESHCOP_TLV_ACTIVETIMESTAMP
< meshcop Active Timestamp TLV
OT_MESHCOP_TLV_BORDER_AGENT_RLOC
< meshcop Border Agent Locator TLV
OT_MESHCOP_TLV_CHANNEL
< meshcop Channel TLV
OT_MESHCOP_TLV_CHANNELMASK
< meshcop Channel Mask TLV
OT_MESHCOP_TLV_COMMISSIONER_ID
< meshcop Commissioner ID TLV
OT_MESHCOP_TLV_COMMISSIONER_UDP_PORT
< meshcop Commissioner UDP Port TLV
OT_MESHCOP_TLV_COMM_SESSION_ID
< meshcop Commissioner Session ID TLV
OT_MESHCOP_TLV_COUNT
< meshcop Count TLV
OT_MESHCOP_TLV_DELAYTIMER
< meshcop Delay Timer TLV
OT_MESHCOP_TLV_DISCOVERYREQUEST
< meshcop Discovery Request TLV
OT_MESHCOP_TLV_DISCOVERYRESPONSE
< meshcop Discovery Response TLV
OT_MESHCOP_TLV_ENERGY_LIST
< meshcop Energy List TLV
OT_MESHCOP_TLV_EXTPANID
< meshcop Extended Pan Id TLV
OT_MESHCOP_TLV_GET
< meshcop Get TLV
OT_MESHCOP_TLV_IPV6_ADDRESS_TLV
< meshcop IPv6 address TLV
OT_MESHCOP_TLV_JOINERADVERTISEMENT
< meshcop Joiner Advertisement TLV
OT_MESHCOP_TLV_JOINER_DTLS
< meshcop Joiner DTLS Encapsulation 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_JOINER_UDP_PORT
< meshcop Joiner UDP Port TLV
OT_MESHCOP_TLV_MESHLOCALPREFIX
< meshcop Mesh Local Prefix TLV
OT_MESHCOP_TLV_NETWORKKEY
< meshcop Network Key TLV
OT_MESHCOP_TLV_NETWORKNAME
< meshcop Network Name TLV
OT_MESHCOP_TLV_NETWORK_KEY_SEQUENCE
< meshcop Network Key Sequence TLV
OT_MESHCOP_TLV_PANID
< meshcop Pan Id TLV
OT_MESHCOP_TLV_PENDINGTIMESTAMP
< meshcop Pending Timestamp TLV
OT_MESHCOP_TLV_PERIOD
< meshcop Period TLV
OT_MESHCOP_TLV_PROVISIONING_URL
< meshcop Provisioning URL TLV
OT_MESHCOP_TLV_PSKC
< meshcop PSKc TLV
OT_MESHCOP_TLV_SCAN_DURATION
< meshcop Scan Duration TLV
OT_MESHCOP_TLV_SECURITYPOLICY
< meshcop Security Policy TLV
OT_MESHCOP_TLV_STATE
< meshcop State TLV
OT_MESHCOP_TLV_STEERING_DATA
< meshcop Steering Data TLV
OT_MESHCOP_TLV_THREAD_DOMAIN_NAME
< meshcop Thread Domain Name TLV
OT_MESHCOP_TLV_UDP_ENCAPSULATION_TLV
< meshcop UDP encapsulation TLV
OT_MESHCOP_TLV_VENDOR_DATA_TLV
< meshcop Vendor Data TLV
OT_MESHCOP_TLV_VENDOR_MODEL_TLV
< meshcop Vendor Model TLV
OT_MESHCOP_TLV_VENDOR_NAME_TLV
< meshcop Vendor Name TLV
OT_MESHCOP_TLV_VENDOR_STACK_VERSION_TLV
< meshcop Vendor Stack Version TLV
OT_MESHCOP_TLV_VENDOR_SW_VERSION_TLV
< meshcop Vendor SW Version TLV
OT_MESHCOP_TLV_WAKEUP_CHANNEL
< meshcop Wake-up Channel TLV
OT_MESH_LOCAL_PREFIX_SIZE
OT_MESSAGE_ORIGIN_HOST_TRUSTED
< Message from a trusted source on host.
OT_MESSAGE_ORIGIN_HOST_UNTRUSTED
< Message from an untrusted source on host.
OT_MESSAGE_ORIGIN_THREAD_NETIF
< Message from Thread Netif.
OT_MESSAGE_PRIORITY_HIGH
< High priority level.
OT_MESSAGE_PRIORITY_LOW
< Low priority level.
OT_MESSAGE_PRIORITY_NORMAL
< Normal priority level.
OT_MS_PER_S
OT_NAT64_DROP_REASON_COUNT
OT_NAT64_DROP_REASON_ILLEGAL_PACKET
< Packet drop due to failed to parse the datagram.
OT_NAT64_DROP_REASON_NO_MAPPING
< Packet drop due to no mappings found or mapping pool exhausted.
OT_NAT64_DROP_REASON_UNKNOWN
< Packet drop for unknown reasons.
OT_NAT64_DROP_REASON_UNSUPPORTED_PROTO
< Packet drop due to unsupported IP protocol.
OT_NAT64_STATE_ACTIVE
< The BR is publishing a NAT64 prefix and/or translating packets.
OT_NAT64_STATE_DISABLED
< NAT64 is disabled.
OT_NAT64_STATE_IDLE
< NAT64 is enabled, but this BR is not an active NAT64 BR.
OT_NAT64_STATE_NOT_RUNNING
< NAT64 is enabled, but one or more dependencies of NAT64 are not running.
OT_NEIGHBOR_INFO_ITERATOR_INIT
OT_NEIGHBOR_TABLE_EVENT_CHILD_ADDED
< A child is being added.
OT_NEIGHBOR_TABLE_EVENT_CHILD_MODE_CHANGED
< An existing child’s mode is changed.
OT_NEIGHBOR_TABLE_EVENT_CHILD_REMOVED
< A child is being removed.
OT_NEIGHBOR_TABLE_EVENT_ROUTER_ADDED
< A router is being added.
OT_NEIGHBOR_TABLE_EVENT_ROUTER_REMOVED
< A router is being removed.
OT_NETIF_BACKBONE
< The Backbone interface.
OT_NETIF_THREAD_HOST
< The host Thread interface - allow use of platform UDP.
OT_NETIF_THREAD_INTERNAL
< The internal Thread interface (within OpenThread) - do not use platform UDP.
OT_NETIF_UNSPECIFIED
< Unspecified network interface.
OT_NETWORK_BASE_TLV_MAX_LENGTH
OT_NETWORK_DATA_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_ITERATOR_INIT
OT_NETWORK_DIAGNOSTIC_MAX_THREAD_STACK_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_APP_URL_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_MODEL_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_NAME_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_MAX_VENDOR_SW_VERSION_TLV_LENGTH
OT_NETWORK_DIAGNOSTIC_TLV_ANSWER
OT_NETWORK_DIAGNOSTIC_TLV_BATTERY_LEVEL
OT_NETWORK_DIAGNOSTIC_TLV_CHANNEL_PAGES
OT_NETWORK_DIAGNOSTIC_TLV_CHILD
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_IP6_ADDR_LIST
OT_NETWORK_DIAGNOSTIC_TLV_CHILD_TABLE
OT_NETWORK_DIAGNOSTIC_TLV_CONNECTIVITY
OT_NETWORK_DIAGNOSTIC_TLV_EUI64
OT_NETWORK_DIAGNOSTIC_TLV_EXT_ADDRESS
OT_NETWORK_DIAGNOSTIC_TLV_IP6_ADDR_LIST
OT_NETWORK_DIAGNOSTIC_TLV_LEADER_DATA
OT_NETWORK_DIAGNOSTIC_TLV_MAC_COUNTERS
OT_NETWORK_DIAGNOSTIC_TLV_MAX_CHILD_TIMEOUT
OT_NETWORK_DIAGNOSTIC_TLV_MLE_COUNTERS
OT_NETWORK_DIAGNOSTIC_TLV_MODE
OT_NETWORK_DIAGNOSTIC_TLV_NETWORK_DATA
OT_NETWORK_DIAGNOSTIC_TLV_QUERY_ID
OT_NETWORK_DIAGNOSTIC_TLV_ROUTE
OT_NETWORK_DIAGNOSTIC_TLV_ROUTER_NEIGHBOR
OT_NETWORK_DIAGNOSTIC_TLV_SHORT_ADDRESS
OT_NETWORK_DIAGNOSTIC_TLV_SUPPLY_VOLTAGE
OT_NETWORK_DIAGNOSTIC_TLV_THREAD_STACK_VERSION
OT_NETWORK_DIAGNOSTIC_TLV_TIMEOUT
OT_NETWORK_DIAGNOSTIC_TLV_TYPE_LIST
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_APP_URL
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_MODEL
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_NAME
OT_NETWORK_DIAGNOSTIC_TLV_VENDOR_SW_VERSION
OT_NETWORK_DIAGNOSTIC_TLV_VERSION
OT_NETWORK_KEY_SIZE
OT_NETWORK_MAX_ROUTER_ID
OT_NETWORK_NAME_MAX_SIZE
OT_NETWORK_TIME_RESYNC_NEEDED
< The device hasn’t received time sync for more than two periods time.
OT_NETWORK_TIME_SYNCHRONIZED
< The device network time is synchronized.
OT_NETWORK_TIME_UNSYNCHRONIZED
< The device hasn’t attached to a network.
OT_NS_PER_US
OT_NUM_ERRORS
The number of defined errors.
OT_OPERATIONAL_DATASET_MAX_LENGTH
OT_PANID_BROADCAST
OT_PLAT_INFRA_IF_MAX_LINK_LAYER_ADDR_LENGTH
OT_PLAT_MCU_POWER_STATE_LOW_POWER
NCP’s MCU can enter low-power (energy-saving) state.
OT_PLAT_MCU_POWER_STATE_OFF
NCP is fully off.
OT_PLAT_MCU_POWER_STATE_ON
NCP’s MCU stays on and active all the time.
OT_PLAT_RESET_REASON_ASSERT
OT_PLAT_RESET_REASON_COUNT
OT_PLAT_RESET_REASON_CRASH
OT_PLAT_RESET_REASON_EXTERNAL
OT_PLAT_RESET_REASON_FAULT
OT_PLAT_RESET_REASON_OTHER
OT_PLAT_RESET_REASON_POWER_ON
OT_PLAT_RESET_REASON_SOFTWARE
OT_PLAT_RESET_REASON_UNKNOWN
OT_PLAT_RESET_REASON_WATCHDOG
OT_POWER_SUPPLY_BATTERY
< Battery powered.
OT_POWER_SUPPLY_EXTERNAL
< Externally powered (mains-powered).
OT_POWER_SUPPLY_EXTERNAL_STABLE
< Stable external power with a battery backup or UPS.
OT_POWER_SUPPLY_EXTERNAL_UNSTABLE
< Potentially unstable ext power (e.g. light bulb powered via a switch).
OT_PROVISIONING_URL_MAX_SIZE
OT_PSKC_MAX_SIZE
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MASK
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MAX
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_2P4GHZ_OQPSK_CHANNEL_MIN
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MASK
< 915 MHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MAX
< 915 MHz IEEE 802.15.4-2006
OT_RADIO_915MHZ_OQPSK_CHANNEL_MIN
< 915 MHz IEEE 802.15.4-2006
OT_RADIO_BITS_PER_OCTET
< Number of bits per octet
OT_RADIO_BIT_RATE
< 2.4 GHz IEEE 802.15.4 (bits per second)
OT_RADIO_BROADCAST_SHORT_ADDR
< Broadcast short address.
OT_RADIO_CAPS_ACK_TIMEOUT
< Radio supports AckTime event.
OT_RADIO_CAPS_ALT_SHORT_ADDR
< Radio supports setting alternate short address.
OT_RADIO_CAPS_CSMA_BACKOFF
< Radio supports CSMA backoff for frame tx (but no retry).
OT_RADIO_CAPS_ENERGY_SCAN
< Radio supports Energy Scans.
OT_RADIO_CAPS_NONE
< Radio supports no capability.
OT_RADIO_CAPS_RECEIVE_TIMING
< Radio supports rx at specific time.
OT_RADIO_CAPS_RX_ON_WHEN_IDLE
< Radio supports RxOnWhenIdle handling.
OT_RADIO_CAPS_SLEEP_TO_TX
< Radio supports direct transition from sleep to TX with CSMA.
OT_RADIO_CAPS_TRANSMIT_FRAME_POWER
< Radio supports setting per-frame transmit power.
OT_RADIO_CAPS_TRANSMIT_RETRIES
< Radio supports tx retry logic with collision avoidance (CSMA).
OT_RADIO_CAPS_TRANSMIT_SEC
< Radio supports tx security.
OT_RADIO_CAPS_TRANSMIT_TIMING
< Radio supports tx at specific time.
OT_RADIO_CHANNEL_PAGE_0
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_0_MASK
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_2
< 915 MHz IEEE 802.15.4-2006
OT_RADIO_CHANNEL_PAGE_2_MASK
< 915 MHz IEEE 802.15.4-2006
OT_RADIO_FRAME_MAX_SIZE
< aMaxPHYPacketSize (IEEE 802.15.4-2006)
OT_RADIO_FRAME_MIN_SIZE
< Minimal size of frame FCS + CONTROL
OT_RADIO_INVALID_SHORT_ADDR
< Invalid short address.
OT_RADIO_LQI_NONE
< LQI measurement not supported
OT_RADIO_POWER_INVALID
< Invalid or unknown power value
OT_RADIO_RSSI_INVALID
< Invalid or unknown RSSI value
OT_RADIO_STATE_DISABLED
OT_RADIO_STATE_INVALID
OT_RADIO_STATE_RECEIVE
OT_RADIO_STATE_SLEEP
OT_RADIO_STATE_TRANSMIT
OT_RADIO_SYMBOLS_PER_OCTET
< 2.4 GHz IEEE 802.15.4-2006
OT_RADIO_SYMBOL_RATE
< The O-QPSK PHY symbol rate when operating in the 780MHz, 915MHz, 2380MHz, 2450MHz
OT_RADIO_SYMBOL_TIME
< Symbol duration time in unit of microseconds
OT_RADIO_TEN_SYMBOLS_TIME
< Time for 10 symbols in unit of microseconds
OT_ROUTE_PREFERENCE_HIGH
< High route preference.
OT_ROUTE_PREFERENCE_LOW
< Low route preference.
OT_ROUTE_PREFERENCE_MED
< Medium route preference.
OT_SERVER_DATA_MAX_SIZE
OT_SERVICE_DATA_MAX_SIZE
OT_SETTINGS_KEY_ACTIVE_DATASET
< Active Operational Dataset.
OT_SETTINGS_KEY_BORDER_AGENT_ID
< Unique Border Agent/Router ID.
OT_SETTINGS_KEY_BR_ON_LINK_PREFIXES
< BR local on-link prefixes.
OT_SETTINGS_KEY_BR_ULA_PREFIX
< BR ULA prefix.
OT_SETTINGS_KEY_CHILD_INFO
< Child information.
OT_SETTINGS_KEY_DAD_INFO
< Duplicate Address Detection (DAD) information.
OT_SETTINGS_KEY_NETWORK_INFO
< Thread network information.
OT_SETTINGS_KEY_PARENT_INFO
< Parent information.
OT_SETTINGS_KEY_PENDING_DATASET
< Pending Operational Dataset.
OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY
< SLAAC key to generate semantically opaque IID.
OT_SETTINGS_KEY_SRP_CLIENT_INFO
< The SRP client info (selected SRP server address).
OT_SETTINGS_KEY_SRP_ECDSA_KEY
< SRP client ECDSA public/private key pair.
OT_SETTINGS_KEY_SRP_SERVER_INFO
< The SRP server info (UDP port).
OT_SETTINGS_KEY_TCAT_COMMR_CERT
< TCAT Commissioner certificate
OT_SETTINGS_KEY_VENDOR_RESERVED_MAX
OT_SETTINGS_KEY_VENDOR_RESERVED_MIN
OT_SNTP_DEFAULT_SERVER_IP
OT_SNTP_DEFAULT_SERVER_PORT
OT_SRP_CLIENT_ITEM_STATE_ADDING
< Item is being added/registered.
OT_SRP_CLIENT_ITEM_STATE_REFRESHING
< Item is being refreshed.
OT_SRP_CLIENT_ITEM_STATE_REGISTERED
< Item is registered with server.
OT_SRP_CLIENT_ITEM_STATE_REMOVED
< Item is removed.
OT_SRP_CLIENT_ITEM_STATE_REMOVING
< Item is being removed.
OT_SRP_CLIENT_ITEM_STATE_TO_ADD
< Item to be added/registered.
OT_SRP_CLIENT_ITEM_STATE_TO_REFRESH
< Item to be refreshed (re-register to renew lease).
OT_SRP_CLIENT_ITEM_STATE_TO_REMOVE
< Item to be removed.
OT_SRP_SERVER_ADDRESS_MODE_ANYCAST
< Anycast address mode.
OT_SRP_SERVER_ADDRESS_MODE_UNICAST
< Unicast address mode.
OT_SRP_SERVER_STATE_DISABLED
< The SRP server is disabled.
OT_SRP_SERVER_STATE_RUNNING
< The SRP server is enabled and running.
OT_SRP_SERVER_STATE_STOPPED
< The SRP server is enabled but stopped.
OT_STEERING_DATA_MAX_LENGTH
OT_TCP_CONNECT_NO_FAST_OPEN
OT_TCP_DISCONNECTED_REASON_NORMAL
OT_TCP_DISCONNECTED_REASON_REFUSED
OT_TCP_DISCONNECTED_REASON_RESET
OT_TCP_DISCONNECTED_REASON_TIMED_OUT
OT_TCP_DISCONNECTED_REASON_TIME_WAIT
OT_TCP_ENDPOINT_TCB_NUM_PTR
OT_TCP_ENDPOINT_TCB_SIZE_BASE
OT_TCP_INCOMING_CONNECTION_ACTION_ACCEPT
< Accept the incoming connection.
OT_TCP_INCOMING_CONNECTION_ACTION_DEFER
< Defer (silently ignore) the incoming connection.
OT_TCP_INCOMING_CONNECTION_ACTION_REFUSE
< Refuse the incoming connection.
OT_TCP_LISTENER_TCB_NUM_PTR
OT_TCP_LISTENER_TCB_SIZE_BASE
OT_TCP_RECEIVE_BUFFER_SIZE_FEW_HOPS
OT_TCP_RECEIVE_BUFFER_SIZE_MANY_HOPS
OT_TCP_SEND_MORE_TO_COME
OT_THREAD_VERSION_1_1
OT_THREAD_VERSION_1_2
OT_THREAD_VERSION_1_3
OT_THREAD_VERSION_1_4
OT_THREAD_VERSION_1_3_1
OT_THREAD_VERSION_INVALID
OT_TIME_SYNC_INVALID_SEQ
OT_UPTIME_STRING_SIZE
OT_US_PER_MS
OT_US_PER_S

Functions§

otBackboneRouterConfigNextDuaRegistrationResponse
Configures response status for next DUA registration.
otBackboneRouterConfigNextMulticastListenerRegistrationResponse
Configures the response status for the next Multicast Listener Registration.
otBackboneRouterGetConfig
Gets the local Backbone Router configuration.
otBackboneRouterGetDomainPrefix
Gets the local Domain Prefix configuration.
otBackboneRouterGetNdProxyInfo
Gets the Backbone Router ND Proxy info.
otBackboneRouterGetPrimary
Gets the Primary Backbone Router information in the Thread Network.
otBackboneRouterGetRegistrationJitter
Returns the Backbone Router registration jitter value.
otBackboneRouterGetState
Gets the Backbone Router #otBackboneRouterState.
otBackboneRouterMulticastListenerAdd
Adds a Multicast Listener with a timeout value, in seconds.
otBackboneRouterMulticastListenerClear
Clears the Multicast Listeners.
otBackboneRouterMulticastListenerGetNext
Gets the next Multicast Listener info (using an iterator).
otBackboneRouterRegister
Explicitly registers local Backbone Router configuration.
otBackboneRouterSetConfig
Sets the local Backbone Router configuration #otBackboneRouterConfig.
otBackboneRouterSetDomainPrefixCallback
Sets the Backbone Router Domain Prefix callback.
otBackboneRouterSetEnabled
Enables or disables Backbone functionality.
otBackboneRouterSetMulticastListenerCallback
Sets the Backbone Router Multicast Listener callback.
otBackboneRouterSetNdProxyCallback
Sets the Backbone Router ND Proxy callback.
otBackboneRouterSetRegistrationJitter
Sets the Backbone Router registration jitter value.
otBorderAgentEphemeralKeyGetState
Gets the state of Border Agent’s Ephemeral Key Manager.
otBorderAgentEphemeralKeyGetUdpPort
Gets the UDP port used by Border Agent’s Ephemeral Key Manager.
otBorderAgentEphemeralKeySetCallback
Sets the callback function to notify state changes of Border Agent’s Ephemeral Key Manager.
otBorderAgentEphemeralKeySetEnabled
Enables/disables the Border Agent’s Ephemeral Key Manager.
otBorderAgentEphemeralKeyStart
Starts using an ephemeral key for a given timeout duration.
otBorderAgentEphemeralKeyStateToString
Converts a given otBorderAgentEphemeralKeyState to a human-readable string.
otBorderAgentEphemeralKeyStop
Stops the ephemeral key use and disconnects any session using it.
otBorderAgentGetCounters
Gets the counters of the Thread Border Agent.
otBorderAgentGetId
Gets the randomly generated Border Agent ID.
otBorderAgentGetNextSessionInfo
Retrieves the next Border Agent session information.
otBorderAgentGetUdpPort
Gets the UDP port of the Thread Border Agent service.
otBorderAgentInitSessionIterator
Initializes a session iterator.
otBorderAgentIsActive
Indicates whether or not the Border Agent service is active and running.
otBorderAgentSetId
Sets the Border Agent ID.
otBorderAgentSetMeshCoPServiceChangedCallback
Sets the callback function used by the Border Agent to notify of any changes to the state of the MeshCoP service.
otBorderRouterAddOnMeshPrefix
Add a border router configuration to the local network data.
otBorderRouterAddRoute
Add an external route configuration to the local network data.
otBorderRouterGetNetData
Provides a full or stable copy of the local Thread Network Data.
otBorderRouterGetNextOnMeshPrefix
Gets the next On Mesh Prefix in the local Network Data.
otBorderRouterGetNextRoute
Gets the next external route in the local Network Data.
otBorderRouterRegister
Immediately register the local network data with the Leader.
otBorderRouterRemoveOnMeshPrefix
Remove a border router configuration from the local network data.
otBorderRouterRemoveRoute
Remove an external route configuration from the local network data.
otBorderRouterSetNetDataFullCallback
Sets the callback to indicate when Network Data gets full.
otBorderRoutingClearRouteInfoOptionPreference
Clears a previously set preference value for advertised Route Info Options.
otBorderRoutingClearRoutePreference
Clears a previously set preference value for published routes in Network Data.
otBorderRoutingCountPeerBrs
Returns the number of peer BRs found in the Network Data.
otBorderRoutingDhcp6PdGetState
Gets the current state of DHCPv6 Prefix Delegation.
otBorderRoutingDhcp6PdSetEnabled
Enables / Disables DHCPv6 Prefix Delegation.
otBorderRoutingDhcp6PdSetRequestCallback
Sets the callback whenever the DHCPv6 PD state changes on the Thread interface.
otBorderRoutingGetFavoredNat64Prefix
Gets the currently favored NAT64 prefix.
otBorderRoutingGetFavoredOmrPrefix
Gets the currently favored Off-Mesh-Routable (OMR) Prefix.
otBorderRoutingGetFavoredOnLinkPrefix
Gets the currently favored On-Link Prefix.
otBorderRoutingGetNat64Prefix
Gets the local NAT64 Prefix of the Border Router.
otBorderRoutingGetNextPeerBrEntry
Iterates over the peer BRs found in the Network Data.
otBorderRoutingGetNextPrefixTableEntry
Iterates over the entries in the Border Router’s discovered prefix table.
otBorderRoutingGetNextRouterEntry
Iterates over the discovered router entries on the infrastructure link.
otBorderRoutingGetOmrPrefix
Gets the local Off-Mesh-Routable (OMR) Prefix, for example fdfc:1ff5:1512:5622::/64.
otBorderRoutingGetOnLinkPrefix
Gets the local On-Link Prefix for the adjacent infrastructure link.
otBorderRoutingGetPdOmrPrefix
Gets the DHCPv6 Prefix Delegation (PD) provided off-mesh-routable (OMR) prefix.
otBorderRoutingGetPdProcessedRaInfo
Gets the data of platform generated RA message processed..
otBorderRoutingGetRouteInfoOptionPreference
Gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
otBorderRoutingGetRoutePreference
Gets the current preference used for published routes in Network Data.
otBorderRoutingGetState
Gets the current state of Border Routing Manager.
otBorderRoutingInit
Initializes the Border Routing Manager on given infrastructure interface.
otBorderRoutingPrefixTableInitIterator
Initializes an otBorderRoutingPrefixTableIterator.
otBorderRoutingSetEnabled
Enables or disables the Border Routing Manager.
otBorderRoutingSetExtraRouterAdvertOptions
Sets additional options to append at the end of emitted Router Advertisement (RA) messages.
otBorderRoutingSetOnLinkPrefix
Sets the local on-link prefix.
otBorderRoutingSetRouteInfoOptionPreference
Explicitly sets the preference to use when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
otBorderRoutingSetRoutePreference
Explicitly sets the preference of published routes in Network Data.
otChannelManagerGetAutoChannelSelectionEnabled
Indicates whether the auto-channel-selection functionality for a network channel is enabled or not.
otChannelManagerGetAutoChannelSelectionInterval
Gets the period interval (in seconds) used by auto-channel-selection functionality.
otChannelManagerGetAutoCslChannelSelectionEnabled
Indicates whether the auto-csl-channel-selection functionality is enabled or not.
otChannelManagerGetCcaFailureRateThreshold
Gets the CCA failure rate threshold.
otChannelManagerGetDelay
Gets the delay (in seconds) used by Channel Manager for a network channel change.
otChannelManagerGetFavoredChannels
Gets the favored channel mask.
otChannelManagerGetRequestedChannel
Gets the channel from the last successful call to otChannelManagerRequestChannelChange()
otChannelManagerGetSupportedChannels
Gets the supported channel mask.
otChannelManagerRequestChannelChange
Requests a Thread network channel change.
otChannelManagerRequestChannelSelect
Requests that ChannelManager checks and selects a new channel and starts a channel change.
otChannelManagerRequestCslChannelSelect
Requests that ChannelManager checks and selects a new CSL channel and starts a CSL channel change.
otChannelManagerSetAutoChannelSelectionEnabled
Enables or disables the auto-channel-selection functionality for network channel.
otChannelManagerSetAutoChannelSelectionInterval
Sets the period interval (in seconds) used by auto-channel-selection functionality.
otChannelManagerSetAutoCslChannelSelectionEnabled
Enables or disables the auto-channel-selection functionality for a CSL channel.
otChannelManagerSetCcaFailureRateThreshold
Sets the CCA failure rate threshold.
otChannelManagerSetDelay
Sets the delay (in seconds) used for a network channel change.
otChannelManagerSetFavoredChannels
Sets the favored channel mask.
otChannelManagerSetSupportedChannels
Sets the supported channel mask.
otChannelMonitorGetChannelOccupancy
Gets the current channel occupancy for a given channel.
otChannelMonitorGetRssiThreshold
Get channel monitoring RSSI threshold in dBm.
otChannelMonitorGetSampleCount
Get channel monitoring total number of RSSI samples (per channel).
otChannelMonitorGetSampleInterval
Get channel monitoring sample interval in milliseconds.
otChannelMonitorGetSampleWindow
Get channel monitoring averaging sample window length (number of samples).
otChannelMonitorIsEnabled
Indicates whether the Channel Monitoring operation is enabled and running.
otChannelMonitorSetEnabled
Enables or disables the Channel Monitoring operation.
otChildSupervisionGetCheckFailureCounter
Get the value of supervision check timeout failure counter.
otChildSupervisionGetCheckTimeout
Gets the supervision check timeout interval (in seconds) on the child.
otChildSupervisionGetInterval
Gets the Child Supervision interval (in seconds) on a child.
otChildSupervisionResetCheckFailureCounter
Reset the supervision check timeout failure counter to zero.
otChildSupervisionSetCheckTimeout
Sets the supervision check timeout interval (in seconds) on the child.
otChildSupervisionSetInterval
Sets the child supervision interval (in seconds) on the child.
otCliAppendResult
Write error code to the CLI console
otCliInit
Initialize the CLI module.
otCliInputLine
Is called to feed in a console input line.
otCliOutputBytes
Write a number of bytes to the CLI console as a hex string.
otCliOutputFormat
Write formatted string to the CLI console
otCliPlatLogv
Callback to write the OpenThread Log to the CLI console
otCliSetUserCommands
Set a user command table.
otCliVendorSetUserCommands
Callback to allow vendor specific commands to be added to the user command table.
otCoapAddBlockWiseResource
Adds a block-wise resource to the CoAP server.
otCoapAddResource
Adds a resource to the CoAP server.
otCoapBlockSizeFromExponent
Converts a CoAP Block option SZX field to the actual block size
otCoapMessageAppendBlock1Option
Appends a Block1 option
otCoapMessageAppendBlock2Option
Appends a Block2 option
otCoapMessageAppendContentFormatOption
Appends the Content Format CoAP option as specified in https://tools.ietf.org/html/rfc7252#page-92. This must be called before setting otCoapMessageSetPayloadMarker if a payload is to be included in the message.
otCoapMessageAppendMaxAgeOption
Appends a Max-Age option.
otCoapMessageAppendObserveOption
Appends an Observe option.
otCoapMessageAppendOption
Appends a CoAP option in a header.
otCoapMessageAppendProxyUriOption
Appends a Proxy-Uri option.
otCoapMessageAppendUintOption
Appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2
otCoapMessageAppendUriPathOptions
Appends a Uri-Path option.
otCoapMessageAppendUriQueryOption
Appends a single Uri-Query option.
otCoapMessageAppendUriQueryOptions
Appends a Uri-Query option.
otCoapMessageCodeToString
Returns the CoAP Code as human readable string.
otCoapMessageGenerateToken
Sets the Token length and randomizes its value.
otCoapMessageGetCode
Returns the Code value.
otCoapMessageGetMessageId
Returns the Message ID value.
otCoapMessageGetToken
Returns a pointer to the Token value.
otCoapMessageGetTokenLength
Returns the Token length.
otCoapMessageGetType
Returns the Type value.
otCoapMessageInit
Initializes the CoAP header.
otCoapMessageInitResponse
Initializes a response message.
otCoapMessageSetCode
Sets the Code value.
otCoapMessageSetPayloadMarker
Adds Payload Marker indicating beginning of the payload to the CoAP header.
otCoapMessageSetToken
Sets the Token value and length in a header.
otCoapNewMessage
Creates a new CoAP message.
otCoapOptionIteratorGetFirstOption
Returns a pointer to the first option.
otCoapOptionIteratorGetFirstOptionMatching
Returns a pointer to the first option matching the specified option number.
otCoapOptionIteratorGetNextOption
Returns a pointer to the next option.
otCoapOptionIteratorGetNextOptionMatching
Returns a pointer to the next option matching the specified option number.
otCoapOptionIteratorGetOptionUintValue
Fills current option value into @p aValue assuming the current value is an unsigned integer encoded according to https://tools.ietf.org/html/rfc7252#section-3.2
otCoapOptionIteratorGetOptionValue
Fills current option value into @p aValue.
otCoapOptionIteratorInit
Initialises an iterator for the options in the given message.
otCoapRemoveBlockWiseResource
Removes a block-wise resource from the CoAP server.
otCoapRemoveResource
Removes a resource from the CoAP server.
otCoapSecureAddBlockWiseResource
Adds a block-wise resource to the CoAP Secure server.
otCoapSecureAddResource
Adds a resource to the CoAP Secure server.
otCoapSecureConnect
Initializes DTLS session with a peer.
otCoapSecureDisconnect
Stops the DTLS connection.
otCoapSecureGetPeerCertificateBase64
Returns the peer x509 certificate base64 encoded.
otCoapSecureIsClosed
Indicates whether or not the DTLS session is closed.
otCoapSecureIsConnected
Indicates whether or not the DTLS session is connected.
otCoapSecureIsConnectionActive
Indicates whether or not the DTLS session is active.
otCoapSecureRemoveBlockWiseResource
Removes a block-wise resource from the CoAP Secure server.
otCoapSecureRemoveResource
Removes a resource from the CoAP Secure server.
otCoapSecureSendRequest
Sends a CoAP request over secure DTLS connection.
otCoapSecureSendRequestBlockWise
Sends a CoAP request block-wise over secure DTLS connection.
otCoapSecureSendResponse
Sends a CoAP response from the CoAP Secure server.
otCoapSecureSendResponseBlockWise
Sends a CoAP response block-wise from the CoAP Secure server.
otCoapSecureSetCaCertificateChain
Sets the trusted top level CAs. It is needed for validating the certificate of the peer.
otCoapSecureSetCertificate
Sets the local device’s X509 certificate with corresponding private key for DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
otCoapSecureSetClientConnectEventCallback
Sets the connect event callback to indicate when a Client connection to the CoAP Secure server has changed.
otCoapSecureSetDefaultHandler
Sets the default handler for unhandled CoAP Secure requests.
otCoapSecureSetPsk
Sets the Pre-Shared Key (PSK) and cipher suite DTLS_PSK_WITH_AES_128_CCM_8.
otCoapSecureSetSslAuthMode
Sets the authentication mode for the coap secure connection.
otCoapSecureStart
Starts the CoAP Secure service.
otCoapSecureStartWithMaxConnAttempts
Starts the CoAP secure service and sets the maximum number of allowed connection attempts before stopping the agent automatically.
otCoapSecureStop
Stops the CoAP Secure server.
otCoapSendRequestBlockWiseWithParameters
Sends a CoAP request block-wise with custom transmission parameters.
otCoapSendRequestWithParameters
Sends a CoAP request with custom transmission parameters.
otCoapSendResponseBlockWiseWithParameters
Sends a CoAP response block-wise from the server with custom transmission parameters.
otCoapSendResponseWithParameters
Sends a CoAP response from the server with custom transmission parameters.
otCoapSetDefaultHandler
Sets the default handler for unhandled CoAP requests.
otCoapStart
Starts the CoAP server.
otCoapStop
Stops the CoAP server.
otCommissionerAddJoiner
Adds a Joiner entry.
otCommissionerAddJoinerWithDiscerner
Adds a Joiner entry with a given Joiner Discerner value.
otCommissionerAnnounceBegin
Sends an Announce Begin message.
otCommissionerEnergyScan
Sends an Energy Scan Query message.
otCommissionerGetId
Returns the Commissioner Id.
otCommissionerGetNextJoinerInfo
Get joiner info at aIterator position.
otCommissionerGetProvisioningUrl
Gets the Provisioning URL.
otCommissionerGetSessionId
Returns the Commissioner Session ID.
otCommissionerGetState
Returns the Commissioner State.
otCommissionerPanIdQuery
Sends a PAN ID Query message.
otCommissionerRemoveJoiner
Removes a Joiner entry.
otCommissionerRemoveJoinerWithDiscerner
Removes a Joiner entry.
otCommissionerSendMgmtGet
Sends MGMT_COMMISSIONER_GET.
otCommissionerSendMgmtSet
Sends MGMT_COMMISSIONER_SET.
otCommissionerSetId
Sets the Commissioner Id.
otCommissionerSetProvisioningUrl
Sets the Provisioning URL.
otCommissionerStart
Enables the Thread Commissioner role.
otCommissionerStop
Disables the Thread Commissioner role.
otConvertDurationInSecondsToString
Converts an uint32_t duration (in seconds) to a human-readable string.
otDatasetConvertToTlvs
Converts a given Operational Dataset to otOperationalDatasetTlvs.
otDatasetCreateNewNetwork
For FTD only, creates a new Operational Dataset to use when forming a new network.
otDatasetGeneratePskc
Generates PSKc from a given pass-phrase, network name, and extended PAN ID.
otDatasetGetActive
Gets the Active Operational Dataset.
otDatasetGetActiveTlvs
Gets the Active Operational Dataset.
otDatasetGetDelayTimerMinimal
For FTD only, gets a minimal delay timer.
otDatasetGetPending
Gets the Pending Operational Dataset.
otDatasetGetPendingTlvs
Gets the Pending Operational Dataset.
otDatasetIsCommissioned
Indicates whether a valid network is present in the Active Operational Dataset or not.
otDatasetParseTlvs
Parses an Operational Dataset from a given otOperationalDatasetTlvs.
otDatasetSendMgmtActiveGet
Sends MGMT_ACTIVE_GET.
otDatasetSendMgmtActiveSet
Sends MGMT_ACTIVE_SET.
otDatasetSendMgmtPendingGet
Sends MGMT_PENDING_GET.
otDatasetSendMgmtPendingSet
Sends MGMT_PENDING_SET.
otDatasetSetActive
Sets the Active Operational Dataset.
otDatasetSetActiveTlvs
Sets the Active Operational Dataset.
otDatasetSetDelayTimerMinimal
For FTD only, sets a minimal delay timer.
otDatasetSetPending
Sets the Pending Operational Dataset.
otDatasetSetPendingTlvs
Sets the Pending Operational Dataset.
otDatasetUpdateTlvs
Updates a given Operational Dataset.
otDatasetUpdaterCancelUpdate
Cancels an ongoing (if any) Operational Dataset update request.
otDatasetUpdaterIsUpdateOngoing
Indicates whether there is an ongoing Operation Dataset update request.
otDatasetUpdaterRequestUpdate
Requests an update to Operational Dataset.
otDiagIsEnabled
Indicates whether or not the factory diagnostics mode is enabled.
otDiagProcessCmd
Processes a factory diagnostics command line.
otDiagProcessCmdLine
Processes a factory diagnostics command line.
otDiagSetOutputCallback
Sets the diag output callback.
otDnsAddressResponseGetAddress
Gets an IPv6 address associated with an address resolution DNS response.
otDnsAddressResponseGetHostName
Gets the full host name associated with an address resolution DNS response.
otDnsBrowseResponseGetHostAddress
Gets the host IPv6 address from a DNS browse (service instance enumeration) response.
otDnsBrowseResponseGetServiceInfo
Gets info for a service instance from a DNS browse (service instance enumeration) response.
otDnsBrowseResponseGetServiceInstance
Gets a service instance associated with a DNS browse (service instance enumeration) response.
otDnsBrowseResponseGetServiceName
Gets the service name associated with a DNS browse (service instance enumeration) response.
otDnsClientBrowse
Sends a DNS browse (service instance enumeration) query for a given service name.
otDnsClientGetDefaultConfig
Gets the current default query config used by DNS client.
otDnsClientResolveAddress
Sends an address resolution DNS query for AAAA (IPv6) record(s) for a given host name.
otDnsClientResolveIp4Address
Sends an address resolution DNS query for A (IPv4) record(s) for a given host name.
otDnsClientResolveService
Starts a DNS service instance resolution for a given service instance.
otDnsClientResolveServiceAndHostAddress
Starts a DNS service instance resolution for a given service instance, with a potential follow-up address resolution for the host name discovered for the service instance.
otDnsClientSetDefaultConfig
Sets the default query config on DNS client.
otDnsEncodeTxtData
Encodes a given list of TXT record entries (key/value pairs) into TXT data (following format specified by RFC 6763).
otDnsGetNextTxtEntry
Parses the TXT data from an iterator and gets the next TXT record entry (key/value pair).
otDnsInitTxtEntryIterator
Initializes a TXT record iterator.
otDnsIsNameCompressionEnabled
Indicates whether the “DNS name compression” mode is enabled or not.
otDnsServiceResponseGetHostAddress
Gets the host IPv6 address from a DNS service instance resolution response.
otDnsServiceResponseGetServiceInfo
Gets info for a service instance from a DNS service instance resolution response.
otDnsServiceResponseGetServiceName
Gets the service instance name associated with a DNS service instance resolution response.
otDnsSetNameCompressionEnabled
Enables/disables the “DNS name compression” mode.
otDnssdGetCounters
Returns the counters of the DNS-SD server.
otDnssdGetNextQuery
Acquires the next query in the DNS-SD server.
otDnssdGetQueryTypeAndName
Acquires the DNS-SD query type and name for a specific query.
otDnssdQueryHandleDiscoveredHost
Notifies a discovered host.
otDnssdQueryHandleDiscoveredServiceInstance
Notifies a discovered service instance.
otDnssdQuerySetCallbacks
Sets DNS-SD server query callbacks.
otDnssdUpstreamQueryIsEnabled
Returns whether the DNSSD server will forward DNS queries to the platform DNS upstream API.
otDnssdUpstreamQuerySetEnabled
Enable or disable forwarding DNS queries to platform DNS upstream API.
otDumpCritPlat
Generates a memory dump at critical log level.
otDumpDebgPlat
Generates a memory dump at debug log level.
otDumpInfoPlat
Generates a memory dump at info log level.
otDumpNotePlat
Generates a memory dump at note log level.
otDumpWarnPlat
Generates a memory dump at warning log level.
otGetRadioVersionString
Gets the OpenThread radio version string.
otGetVersionString
Gets the OpenThread version string.
otHeapCAlloc
@note This API is deprecated and use of it is discouraged.
otHeapFree
@note This API is deprecated and use of it is discouraged.
otIcmp6GetEchoMode
Indicates whether or not ICMPv6 Echo processing is enabled.
otIcmp6RegisterHandler
Registers a handler to provide received ICMPv6 messages.
otIcmp6SendEchoRequest
Sends an ICMPv6 Echo Request via the Thread interface.
otIcmp6SetEchoMode
Sets whether or not ICMPv6 Echo processing is enabled.
otInstanceErasePersistentInfo
Erases all the OpenThread persistent info (network settings) stored on non-volatile memory. Erase is successful only if the device is in disabled state/role.
otInstanceFactoryReset
Deletes all the settings stored on non-volatile memory, and then triggers a platform reset.
otInstanceFinalize
Disables the OpenThread library.
otInstanceGetId
Gets the instance identifier.
otInstanceGetUptime
Returns the current instance uptime (in msec).
otInstanceGetUptimeAsString
Returns the current instance uptime as a human-readable string.
otInstanceInit
Initializes the OpenThread library.
otInstanceInitMultiple
Initializes the OpenThread instance.
otInstanceInitSingle
Initializes the static single instance of the OpenThread library.
otInstanceIsInitialized
Indicates whether or not the instance is valid/initialized.
otInstanceReset
Triggers a platform reset.
otInstanceResetRadioStack
Resets the internal states of the OpenThread radio stack.
otInstanceResetToBootloader
Triggers a platform reset to bootloader mode, if supported.
otIp4AddressFromString
Converts a human-readable IPv4 address string into a binary representation.
otIp4AddressToString
Converts the address to a string.
otIp4CidrFromString
Converts a human-readable IPv4 CIDR string into a binary representation.
otIp4CidrToString
Converts the IPv4 CIDR to a string.
otIp4ExtractFromIp6Address
Set @p aIp4Address by performing NAT64 address translation from @p aIp6Address as specified in RFC 6052.
otIp4FromIp4MappedIp6Address
Extracts the IPv4 address from a given IPv4-mapped IPv6 address.
otIp4IsAddressEqual
Test if two IPv4 addresses are the same.
otIp4NewMessage
Allocate a new message buffer for sending an IPv4 message to the NAT64 translator.
otIp4ToIp4MappedIp6Address
Converts a given IP4 address to an IPv6 address following the IPv4-mapped IPv6 address format.
otIp6AddUnicastAddress
Adds a Network Interface Address to the Thread interface.
otIp6AddUnsecurePort
Adds a port to the allowed unsecured port list.
otIp6AddressFromString
Converts a human-readable IPv6 address string into a binary representation.
otIp6AddressToString
Converts a given IPv6 address to a human-readable string.
otIp6ArePrefixesEqual
Test if two IPv6 prefixes are the same.
otIp6GetBorderRoutingCounters
Gets the Border Routing counters.
otIp6GetMulticastAddresses
Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
otIp6GetPrefix
Gets a prefix with @p aLength from @p aAddress.
otIp6GetUnicastAddresses
Gets the list of IPv6 addresses assigned to the Thread interface.
otIp6GetUnsecurePorts
Returns a pointer to the unsecure port list.
otIp6HasUnicastAddress
Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
otIp6IsAddressEqual
Test if two IPv6 addresses are the same.
otIp6IsAddressUnspecified
Indicates whether or not a given IPv6 address is the Unspecified Address.
otIp6IsEnabled
Indicates whether or not the IPv6 interface is up.
otIp6IsReceiveFilterEnabled
Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
otIp6IsSlaacEnabled
Indicates whether the SLAAC module is enabled or not.
otIp6NewMessage
Allocate a new message buffer for sending an IPv6 message.
otIp6NewMessageFromBuffer
Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message.
otIp6PrefixFromString
Converts a human-readable IPv6 prefix string into a binary representation.
otIp6PrefixMatch
Returns the prefix match length (bits) for two IPv6 addresses.
otIp6PrefixToString
Converts a given IPv6 prefix to a human-readable string.
otIp6ProtoToString
Converts a given IP protocol number to a human-readable string.
otIp6RegisterMulticastListeners
Registers Multicast Listeners to Primary Backbone Router.
otIp6RemoveAllUnsecurePorts
Removes all ports from the allowed unsecure port list.
otIp6RemoveUnicastAddress
Removes a Network Interface Address from the Thread interface.
otIp6RemoveUnsecurePort
Removes a port from the allowed unsecure port list.
otIp6ResetBorderRoutingCounters
Resets the Border Routing counters.
otIp6SelectSourceAddress
Perform OpenThread source address selection.
otIp6Send
Sends an IPv6 datagram via the Thread interface.
otIp6SetAddressCallback
Registers a callback to notify internal IPv6 address changes.
otIp6SetEnabled
Brings the IPv6 interface up or down.
otIp6SetMeshLocalIid
Sets the Mesh Local IID (for test purpose).
otIp6SetReceiveCallback
Registers a callback to provide received IPv6 datagrams.
otIp6SetReceiveFilterEnabled
Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
otIp6SetSlaacEnabled
Enables/disables the SLAAC module.
otIp6SetSlaacPrefixFilter
Sets the SLAAC module filter handler.
otIp6SockAddrToString
Converts a given IPv6 socket address to a human-readable string.
otIp6SubscribeMulticastAddress
Subscribes the Thread interface to a Network Interface Multicast Address.
otIp6UnsubscribeMulticastAddress
Unsubscribes the Thread interface to a Network Interface Multicast Address.
otJamDetectionGetBusyPeriod
Get the Jam Detection Busy Period (in seconds)
otJamDetectionGetHistoryBitmap
Get the current history bitmap.
otJamDetectionGetRssiThreshold
Get the Jam Detection RSSI Threshold (in dBm).
otJamDetectionGetState
Get the Jam Detection State
otJamDetectionGetWindow
Get the Jam Detection Detection Window (in seconds).
otJamDetectionIsEnabled
Get the Jam Detection Status (enabled/disabled)
otJamDetectionSetBusyPeriod
Set the Jam Detection Busy Period (in seconds).
otJamDetectionSetRssiThreshold
Set the Jam Detection RSSI Threshold (in dBm).
otJamDetectionSetWindow
Set the Jam Detection Detection Window (in seconds).
otJamDetectionStart
Start the jamming detection.
otJamDetectionStop
Stop the jamming detection.
otJoinerGetDiscerner
Gets the Joiner Discerner. For more information, refer to #otJoinerSetDiscerner.
otJoinerGetId
Gets the Joiner ID.
otJoinerGetState
Gets the Joiner State.
otJoinerSetDiscerner
Sets the Joiner Discerner.
otJoinerStart
Enables the Thread Joiner role.
otJoinerStateToString
Converts a given joiner state enumeration value to a human-readable string.
otJoinerStop
Disables the Thread Joiner role.
otLinkActiveScan
Starts an IEEE 802.15.4 Active Scan
otLinkConvertLinkQualityToRss
Converts link quality to typical received signal strength.
otLinkConvertRssToLinkQuality
Converts received signal strength to link quality.
otLinkEnergyScan
Starts an IEEE 802.15.4 Energy Scan
otLinkFilterAddAddress
Adds an Extended Address to MAC filter.
otLinkFilterAddRssIn
Adds the specified Extended Address to the RssIn list (or modifies an existing address in the RssIn list) and sets the received signal strength (in dBm) entry for messages from that address. The Extended Address does not necessarily have to be in the address allowlist/denylist filter to set the rss. @note The RssIn list contains Extended Addresses whose rss or link quality indicator (lqi) values have been set to be different from the defaults.
otLinkFilterClearAddresses
Clears all the Extended Addresses from MAC filter.
otLinkFilterClearAllRssIn
Clears all the received signal strength (rss) and link quality indicator (lqi) entries (including defaults) from the RssIn list. Performing this action means that all Extended Addresses will use the on-air signal.
otLinkFilterClearDefaultRssIn
Clears any previously set default received signal strength (in dBm) on MAC Filter.
otLinkFilterGetAddressMode
Gets the address mode of MAC filter.
otLinkFilterGetNextAddress
Gets an in-use address filter entry.
otLinkFilterGetNextRssIn
Gets an in-use RssIn filter entry.
otLinkFilterRemoveAddress
Removes an Extended Address from MAC filter.
otLinkFilterRemoveRssIn
Removes the specified Extended Address from the RssIn list. Once removed from the RssIn list, this MAC address will instead use the default rss and lqi settings, assuming defaults have been set. (If no defaults have been set, the over-air signal is used.)
otLinkFilterSetAddressMode
Sets the address mode of MAC filter.
otLinkFilterSetDefaultRssIn
Sets the default received signal strength (in dBm) on MAC Filter.
otLinkGetAlternateShortAddress
Get the IEEE 802.15.4 alternate short address.
otLinkGetCcaFailureRate
Returns the current CCA (Clear Channel Assessment) failure rate.
otLinkGetChannel
Get the IEEE 802.15.4 channel.
otLinkGetCounters
Get the MAC layer counters.
otLinkGetCslChannel
Gets the CSL channel.
otLinkGetCslPeriod
Gets the CSL period in microseconds
otLinkGetCslTimeout
Gets the CSL timeout.
otLinkGetExtendedAddress
Gets the IEEE 802.15.4 Extended Address.
otLinkGetFactoryAssignedIeeeEui64
Get the factory-assigned IEEE EUI-64.
otLinkGetFrameCounter
Gets the current MAC frame counter value.
otLinkGetMaxFrameRetriesDirect
Returns the maximum number of frame retries during direct transmission.
otLinkGetMaxFrameRetriesIndirect
Returns the maximum number of frame retries during indirect transmission.
otLinkGetPanId
Get the IEEE 802.15.4 PAN ID.
otLinkGetPollPeriod
Get the data poll period of sleepy end device.
otLinkGetRegion
Get the region code.
otLinkGetShortAddress
Get the IEEE 802.15.4 Short Address.
otLinkGetSupportedChannelMask
Get the supported channel mask of MAC layer.
otLinkGetTxDirectRetrySuccessHistogram
Gets histogram of retries for a single direct packet until success.
otLinkGetTxIndirectRetrySuccessHistogram
Gets histogram of retries for a single indirect packet until success.
otLinkGetWakeupChannel
Gets the Wake-up channel.
otLinkGetWakeupListenParameters
Get the wake-up listen parameters.
otLinkIsActiveScanInProgress
Indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
otLinkIsCslEnabled
Indicates whether or not CSL is enabled.
otLinkIsCslSupported
Indicates whether the device is connected to a parent which supports CSL.
otLinkIsEnabled
Indicates whether or not the link layer is enabled.
otLinkIsEnergyScanInProgress
Indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
otLinkIsInTransmitState
Indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
otLinkIsPromiscuous
Indicates whether or not promiscuous mode is enabled at the link layer.
otLinkIsRadioFilterEnabled
Indicates whether the IEEE 802.15.4 radio filter is enabled or not.
otLinkIsWakeupListenEnabled
Returns whether listening for wake-up frames is enabled.
otLinkMetricsConfigEnhAckProbing
Sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing. This functionality requires OT_LINK_METRICS_INITIATOR feature enabled.
otLinkMetricsConfigForwardTrackingSeries
Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.
otLinkMetricsManagerGetMetricsValueByExtAddr
Get Link Metrics data of a neighbor by its extended address.
otLinkMetricsManagerIsEnabled
If Link Metrics Manager is enabled.
otLinkMetricsManagerSetEnabled
Enable or disable Link Metrics Manager.
otLinkMetricsQuery
Sends an MLE Data Request to query Link Metrics.
otLinkMetricsSendLinkProbe
Sends an MLE Link Probe message.
otLinkRawEnergyScan
Begins the energy scan sequence on the radio.
otLinkRawGetCaps
Get the radio capabilities.
otLinkRawGetPromiscuous
Gets the status of promiscuous mode.
otLinkRawGetRadioTime
Get current platform time (64bits width) of the radio chip.
otLinkRawGetRssi
Get the most recent RSSI measurement.
otLinkRawGetTransmitBuffer
The radio transitions from Transmit to Receive. Returns a pointer to the transmit buffer.
otLinkRawIsEnabled
Indicates whether or not the raw link-layer is enabled.
otLinkRawReceive
Transitioning the radio from Sleep to Receive. Turn on the radio.
otLinkRawSetAlternateShortAddress
Set the alternate short address.
otLinkRawSetMacFrameCounter
Sets the current MAC frame counter value.
otLinkRawSetMacFrameCounterIfLarger
Sets the current MAC frame counter value only if the new value is larger than the current one.
otLinkRawSetMacKey
Update MAC keys and key index.
otLinkRawSetPromiscuous
Enables or disables promiscuous mode.
otLinkRawSetReceiveDone
Enables/disables the raw link-layer.
otLinkRawSetShortAddress
Set the Short Address for address filtering.
otLinkRawSleep
Transition the radio from Receive to Sleep. Turn off the radio.
otLinkRawSrcMatchAddExtEntry
Adding extended address to the source match table.
otLinkRawSrcMatchAddShortEntry
Adding short address to the source match table.
otLinkRawSrcMatchClearExtEntries
Removing all the extended addresses from the source match table.
otLinkRawSrcMatchClearExtEntry
Removing extended address to the source match table of the radio.
otLinkRawSrcMatchClearShortEntries
Removing all the short addresses from the source match table.
otLinkRawSrcMatchClearShortEntry
Removing short address to the source match table.
otLinkRawSrcMatchEnable
Enable/Disable source match for frame pending.
otLinkRawTransmit
Begins the transmit sequence on the radio.
otLinkResetCounters
Resets the MAC layer counters.
otLinkResetTxRetrySuccessHistogram
Clears histogram statistics for direct and indirect transmissions.
otLinkSendDataRequest
Enqueues an IEEE 802.15.4 Data Request message for transmission.
otLinkSendEmptyData
Instructs the device to send an empty IEEE 802.15.4 data frame.
otLinkSetChannel
Set the IEEE 802.15.4 channel
otLinkSetCslChannel
Sets the CSL channel.
otLinkSetCslPeriod
Sets the CSL period in microseconds. Disable CSL by setting this parameter to 0.
otLinkSetCslTimeout
Sets the CSL timeout in seconds.
otLinkSetEnabled
Enables or disables the link layer.
otLinkSetExtendedAddress
Sets the IEEE 802.15.4 Extended Address.
otLinkSetMaxFrameRetriesDirect
Sets the maximum number of frame retries during direct transmission.
otLinkSetMaxFrameRetriesIndirect
Sets the maximum number of frame retries during indirect transmission.
otLinkSetPanId
Set the IEEE 802.15.4 PAN ID.
otLinkSetPcapCallback
Registers a callback to provide received raw IEEE 802.15.4 frames.
otLinkSetPollPeriod
Set/clear user-specified/external data poll period for sleepy end device.
otLinkSetPromiscuous
Enables or disables the link layer promiscuous mode.
otLinkSetRadioFilterEnabled
Enables/disables IEEE 802.15.4 radio filter mode.
otLinkSetRegion
Sets the region code.
otLinkSetRxOnWhenIdle
Sets the rx-on-when-idle state.
otLinkSetSupportedChannelMask
Set the supported channel mask of MAC layer.
otLinkSetWakeUpListenEnabled
Enables or disables listening for wake-up frames.
otLinkSetWakeupChannel
Sets the Wake-up channel.
otLinkSetWakeupListenParameters
Set the wake-up listen parameters.
otLogCli
Emits a log message at a given log level.
otLogCritPlat
Emits a log message at critical log level.
otLogDebgPlat
Emits a log message at debug log level.
otLogGenerateNextHexDumpLine
Generates the next hex dump line.
otLogInfoPlat
Emits a log message at info log level.
otLogNotePlat
Emits a log message at note log level.
otLogPlat
Emits a log message at given log level using a platform module name.
otLogPlatArgs
Emits a log message at given log level using a platform module name.
otLogWarnPlat
Emits a log message at warning log level.
otLoggingGetLevel
Returns the current log level.
otLoggingSetLevel
Sets the log level.
otMessageAppend
Append bytes to a message.
otMessageFree
Free an allocated message buffer.
otMessageGetBufferInfo
Get the Message Buffer information.
otMessageGetLength
Get the message length in bytes.
otMessageGetOffset
Get the message offset in bytes.
otMessageGetOrigin
Gets the message origin.
otMessageGetRss
Returns the average RSS (received signal strength) associated with the message.
otMessageGetThreadLinkInfo
Retrieves the link-specific information for a message received over Thread radio.
otMessageIsLinkSecurityEnabled
Indicates whether or not link security is enabled for the message.
otMessageIsLoopbackToHostAllowed
Indicates whether or not the message is allowed to be looped back to host.
otMessageIsMulticastLoopEnabled
Indicates whether the given message may be looped back in a case of a multicast destination address.
otMessageQueueDequeue
Removes a message from the given message queue.
otMessageQueueEnqueue
Adds a message to the end of the given message queue.
otMessageQueueEnqueueAtHead
Adds a message at the head/front of the given message queue.
otMessageQueueGetHead
Returns a pointer to the message at the head of the queue.
otMessageQueueGetNext
Returns a pointer to the next message in the queue by iterating forward (from head to tail).
otMessageQueueInit
Initialize the message queue.
otMessageRead
Read bytes from a message.
otMessageResetBufferInfo
Reset the Message Buffer information counter tracking the maximum number buffers in use at the same time.
otMessageSetDirectTransmission
Sets/forces the message to be forwarded using direct transmission. Default setting for a new message is false.
otMessageSetLength
Set the message length in bytes.
otMessageSetLoopbackToHostAllowed
Sets whether or not the message is allowed to be looped back to host.
otMessageSetMulticastLoopEnabled
Controls whether the given message may be looped back in a case of a multicast destination address.
otMessageSetOffset
Set the message offset in bytes.
otMessageSetOrigin
Sets the message origin.
otMessageWrite
Write bytes to a message.
otMultiRadioGetNeighborInfo
Gets the multi radio link information associated with a neighbor with a given Extended Address.
otNat64ClearIp4Cidr
Clears the CIDR used when setting the source address of the outgoing translated IPv4 packets.
otNat64GetCidr
Gets the IPv4 CIDR configured in the NAT64 translator.
otNat64GetCounters
Gets NAT64 translator counters.
otNat64GetErrorCounters
Gets the NAT64 translator error counters.
otNat64GetNextAddressMapping
Gets the next AddressMapping info (using an iterator).
otNat64GetPrefixManagerState
Gets the state of NAT64 prefix manager.
otNat64GetTranslatorState
Gets the state of NAT64 translator.
otNat64InitAddressMappingIterator
Initializes an otNat64AddressMappingIterator.
otNat64Send
Translates an IPv4 datagram to an IPv6 datagram and sends via the Thread interface.
otNat64SetEnabled
Enable or disable NAT64 functions.
otNat64SetIp4Cidr
Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.
otNat64SetReceiveIp4Callback
Registers a callback to provide received IPv4 datagrams.
otNat64SynthesizeIp6Address
Sets the IPv6 address by performing NAT64 address translation from the preferred NAT64 prefix and the given IPv4 address as specified in RFC 6052.
otNcpHdlcInit
Initialize the NCP based on HDLC framing.
otNcpHdlcInitMulti
Initialize the NCP based on HDLC framing.
otNcpHdlcReceive
Is called after HDLC encoded NCP data received.
otNcpHdlcSendDone
Is called after NCP send finished.
otNcpPlatLogv
Writes OpenThread Log using otNcpStreamWrite.
otNcpRegisterPeekPokeDelegates
Registers peek/poke delegate functions with NCP module.
otNcpSpiInit
Initialize the NCP based on SPI framing.
otNcpStreamWrite
@brief Send data to the host via a specific stream.
otNetDataContainsOmrPrefix
Check whether a given Prefix can act as a valid OMR prefix and also the Leader’s Network Data contains this prefix.
otNetDataGet
Provide full or stable copy of the Partition’s Thread Network Data.
otNetDataGetCommissioningDataset
Gets the Commissioning Dataset from the partition’s Network Data.
otNetDataGetLength
Get the current length (number of bytes) of Partition’s Thread Network Data.
otNetDataGetMaxLength
Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to otNetDataResetMaxLength().
otNetDataGetNextLowpanContextInfo
Get the next 6LoWPAN Context ID info in the partition’s Network Data.
otNetDataGetNextOnMeshPrefix
Get the next On Mesh Prefix in the partition’s Network Data.
otNetDataGetNextRoute
Get the next external route in the partition’s Network Data.
otNetDataGetNextService
Get the next service in the partition’s Network Data.
otNetDataGetStableVersion
Get the Stable Network Data Version.
otNetDataGetVersion
Get the Network Data Version.
otNetDataResetMaxLength
Reset the tracked maximum length of the Thread Network Data.
otNetDataSteeringDataCheckJoiner
Check if the steering data includes a Joiner.
otNetDataSteeringDataCheckJoinerWithDiscerner
Check if the steering data includes a Joiner with a given discerner value.
otNetworkNameFromString
Sets an otNetworkName instance from a given null terminated C string.
otNetworkTimeGet
Get the Thread network time.
otNetworkTimeGetSyncPeriod
Get the time synchronization period.
otNetworkTimeGetXtalThreshold
Get the time synchronization XTAL accuracy threshold for Router.
otNetworkTimeSetSyncPeriod
Set the time synchronization period.
otNetworkTimeSetXtalThreshold
Set the time synchronization XTAL accuracy threshold for Router-Capable device.
otNetworkTimeSyncSetCallback
Set a callback to be called when a network time sync or status change occurs
otPingSenderPing
Starts a ping.
otPingSenderStop
Stops an ongoing ping.
otPlatAlarmMicroFired
Signal that the alarm has fired.
otPlatAlarmMicroGetNow
Get the current time.
otPlatAlarmMicroStartAt
Set the alarm to fire at @p aDt microseconds after @p aT0.
otPlatAlarmMicroStop
Stop the alarm.
otPlatAlarmMilliFired
Signal that the alarm has fired.
otPlatAlarmMilliGetNow
Get the current time.
otPlatAlarmMilliStartAt
Set the alarm to fire at @p aDt milliseconds after @p aT0.
otPlatAlarmMilliStop
Stop the alarm.
otPlatAssertFail
Provides a platform specific implementation for assert.
otPlatBorderRoutingProcessDhcp6PdPrefix
Process a prefix received from the DHCPv6 PD Server. The prefix is received on the DHCPv6 PD client callback and provided to the Routing Manager via this API.
otPlatBorderRoutingProcessIcmp6Ra
Handles ICMP6 RA messages received on the Thread interface on the platform.
otPlatCAlloc
Dynamically allocates new memory. On platforms that support it, should just redirect to calloc. For those that don’t support calloc, should support the same functionality:
otPlatCryptoAesEncrypt
Encrypt the given data.
otPlatCryptoAesFree
Free the AES context.
otPlatCryptoAesInit
Initialise the AES operation.
otPlatCryptoAesSetKey
Set the key for AES operation.
otPlatCryptoDestroyKey
Destroy a key stored in PSA ITS.
otPlatCryptoEcdsaExportPublicKey
Get the associated public key from the key reference passed.
otPlatCryptoEcdsaGenerateAndImportKey
Generate and import a new ECDSA key-pair at reference passed.
otPlatCryptoEcdsaGenerateKey
Generate and populate the output buffer with a new ECDSA key-pair.
otPlatCryptoEcdsaGetPublicKey
Get the associated public key from the input context.
otPlatCryptoEcdsaSign
Calculate the ECDSA signature for a hashed message using the private key from the input context.
otPlatCryptoEcdsaSignUsingKeyRef
Calculate the ECDSA signature for a hashed message using the Key reference passed.
otPlatCryptoEcdsaVerify
Use the key from the input context to verify the ECDSA signature of a hashed message.
otPlatCryptoEcdsaVerifyUsingKeyRef
Use the keyref to verify the ECDSA signature of a hashed message.
otPlatCryptoExportKey
Export a key stored in PSA ITS.
otPlatCryptoHasKey
Check if the key ref passed has an associated key in PSA ITS.
otPlatCryptoHkdfDeinit
Uninitialize the HKDF context.
otPlatCryptoHkdfExpand
Perform HKDF Expand step.
otPlatCryptoHkdfExtract
Perform HKDF Extract step.
otPlatCryptoHkdfInit
Initialise the HKDF context.
otPlatCryptoHmacSha256Deinit
Uninitialize the HMAC operation.
otPlatCryptoHmacSha256Finish
Complete the HMAC operation.
otPlatCryptoHmacSha256Init
Initialize the HMAC operation.
otPlatCryptoHmacSha256Start
Start HMAC operation.
otPlatCryptoHmacSha256Update
Update the HMAC operation with new input.
otPlatCryptoImportKey
Import a key into PSA ITS.
otPlatCryptoInit
Initialize the Crypto module.
otPlatCryptoPbkdf2GenerateKey
Perform PKCS#5 PBKDF2 using CMAC (AES-CMAC-PRF-128).
otPlatCryptoRandomDeinit
Deinitialize cryptographically-secure pseudorandom number generator (CSPRNG).
otPlatCryptoRandomGet
Fills a given buffer with cryptographically secure random bytes.
otPlatCryptoRandomInit
Initialize cryptographically-secure pseudorandom number generator (CSPRNG).
otPlatCryptoSha256Deinit
Uninitialize the SHA-256 operation.
otPlatCryptoSha256Finish
Finish SHA-256 operation.
otPlatCryptoSha256Init
Initialise the SHA-256 operation.
otPlatCryptoSha256Start
Start SHA-256 operation.
otPlatCryptoSha256Update
Update SHA-256 operation with new input.
otPlatDebugUart_getc
Poll/Read a byte from the debug uart
otPlatDebugUart_kbhit
Poll/test debug uart if a key has been pressed. It would be common to a stub function that returns 0.
otPlatDebugUart_logfile
Some platforms (simulation) can log to a file.
otPlatDebugUart_printf
Standard printf() to the debug uart with no log decoration.
otPlatDebugUart_putchar
Write byte to the uart, expand cr/lf as need.
otPlatDebugUart_putchar_raw
Platform specific write single byte to Debug Uart This should not perform CR/LF mapping.
otPlatDebugUart_puts
identical to “man 3 puts” - terminates with lf Which is then mapped to cr/lf as required
otPlatDebugUart_puts_no_nl
puts() without a terminal newline. see: “man 3 puts”, without a adding a terminal lf
otPlatDebugUart_vprintf
Standard vprintf() to the debug uart, with no log decoration.
otPlatDebugUart_write_bytes
Write N bytes to the UART, mapping cr/lf
otPlatDiagAlarmCallback
Processes the alarm event.
otPlatDiagAlarmFired
Signal diagnostics module that the alarm has fired.
otPlatDiagChannelSet
Sets the channel to use for factory diagnostics.
otPlatDiagGpioGet
Gets the gpio value.
otPlatDiagGpioGetMode
Gets the gpio mode.
otPlatDiagGpioSet
Sets the gpio value.
otPlatDiagGpioSetMode
Sets the gpio mode.
otPlatDiagModeGet
Indicates whether or not factory diagnostics mode is enabled.
otPlatDiagModeSet
Enables/disables the factory diagnostics mode.
otPlatDiagProcess
Processes a factory diagnostics command line.
otPlatDiagRadioGetPowerSettings
Get the power settings for the given channel.
otPlatDiagRadioGetRawPowerSetting
Get the radio raw power setting for diagnostics module.
otPlatDiagRadioRawPowerSettingEnable
Enable/disable the platform layer to use the raw power setting set by otPlatDiagRadioSetRawPowerSetting().
otPlatDiagRadioReceiveDone
The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
otPlatDiagRadioReceived
Processes the received radio frame.
otPlatDiagRadioSetRawPowerSetting
Set the radio raw power setting for diagnostics module.
otPlatDiagRadioTransmitCarrier
Start/stop the platform layer to transmit continuous carrier wave.
otPlatDiagRadioTransmitDone
The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.
otPlatDiagRadioTransmitStream
Start/stop the platform layer to transmit stream of characters.
otPlatDiagSetOutputCallback
Sets the platform diag output callback.
otPlatDiagTxPowerSet
Sets the transmit power to use for factory diagnostics.
otPlatDnsCancelUpstreamQuery
Cancels a transaction of upstream query.
otPlatDnsStartUpstreamQuery
Starts an upstream query transaction.
otPlatDnsUpstreamQueryDone
The platform calls this function to finish DNS query.
otPlatEntropyGet
Fill buffer with entropy.
otPlatFlashErase
Erases the swap space indicated by @p aSwapIndex.
otPlatFlashGetSwapSize
Gets the size of the swap space.
otPlatFlashInit
Initializes the flash driver.
otPlatFlashRead
Reads @p aSize bytes into @p aData.
otPlatFlashWrite
Writes @p aSize bytes from @p aData.
otPlatFree
Frees memory that was dynamically allocated.
otPlatGetInfraIfLinkLayerAddress
Get the link-layer address of the infrastructure interface.
otPlatGetMcuPowerState
Gets the current desired MCU power state.
otPlatGetResetReason
Returns the reason for the last platform reset.
otPlatInfraIfDiscoverNat64Prefix
Send a request to discover the NAT64 prefix on the infrastructure interface with @p aInfraIfIndex.
otPlatInfraIfDiscoverNat64PrefixDone
The infra interface driver calls this method to notify OpenThread that the discovery of NAT64 prefix is done.
otPlatInfraIfHasAddress
Tells whether an infra interface has the given IPv6 address assigned.
otPlatInfraIfRecvIcmp6Nd
The infra interface driver calls this method to notify OpenThread that an ICMPv6 Neighbor Discovery message is received.
otPlatInfraIfSendIcmp6Nd
Sends an ICMPv6 Neighbor Discovery message on given infrastructure interface.
otPlatInfraIfStateChanged
The infra interface driver calls this method to notify OpenThread of the interface state changes.
otPlatLog
Outputs logs.
otPlatLogCrashDump
Logs a crash dump using OpenThread logging APIs
otPlatLogHandleLevelChanged
This function handles OpenThread log level changes.
otPlatMessagePoolFree
Is used to free a buffer back to the platform managed buffer pool.
otPlatMessagePoolInit
Initialize the platform implemented message pool.
otPlatMessagePoolNew
Allocate a buffer from the platform managed buffer pool.
otPlatMessagePoolNumFreeBuffers
Get the number of free buffers.
otPlatOtnsStatus
Exports status information to OTNS.
otPlatRadioAddCalibratedPower
Add a calibrated power of the specified channel to the power calibration table.
otPlatRadioAddSrcMatchExtEntry
Add an extended address to the source address match table.
otPlatRadioAddSrcMatchShortEntry
Add a short address to the source address match table.
otPlatRadioBusLatencyChanged
The radio driver calls this method to notify OpenThread that the spinel bus latency has been changed.
otPlatRadioClearCalibratedPowers
Clear all calibrated powers from the power calibration table.
otPlatRadioClearSrcMatchExtEntries
Clear all the extended/long addresses from source address match table.
otPlatRadioClearSrcMatchExtEntry
Remove an extended address from the source address match table.
otPlatRadioClearSrcMatchShortEntries
Clear all short addresses from the source address match table.
otPlatRadioClearSrcMatchShortEntry
Remove a short address from the source address match table.
otPlatRadioConfigureEnhAckProbing
Enable/disable or update Enhanced-ACK Based Probing in radio for a specific Initiator.
otPlatRadioDisable
Disable the radio.
otPlatRadioEnable
Enable the radio.
otPlatRadioEnableCsl
Enable or disable CSL receiver.
otPlatRadioEnableSrcMatch
Enable/Disable source address match feature.
otPlatRadioEnergyScan
Begin the energy scan sequence on the radio.
otPlatRadioEnergyScanDone
The radio driver calls this method to notify OpenThread that the energy scan is complete.
otPlatRadioGetBusLatency
Get the bus latency in microseconds between the host and the radio chip.
otPlatRadioGetBusSpeed
Get the bus speed in bits/second between the host and the radio chip.
otPlatRadioGetCaps
Get the radio capabilities.
otPlatRadioGetCcaEnergyDetectThreshold
Get the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
otPlatRadioGetCoexMetrics
Get the radio coexistence metrics.
otPlatRadioGetCslAccuracy
Get the current estimated worst case accuracy (maximum ± deviation from the nominal frequency) of the local radio clock in units of PPM. This is the clock used to schedule CSL operations.
otPlatRadioGetCslUncertainty
The fixed uncertainty (i.e. random jitter) of the arrival time of CSL transmissions received by this device in units of 10 microseconds.
otPlatRadioGetFemLnaGain
Gets the external FEM’s Rx LNA gain in dBm.
otPlatRadioGetIeeeEui64
Gets the factory-assigned IEEE EUI-64 for this interface.
otPlatRadioGetNow
Get the current time in microseconds referenced to a continuous monotonic local radio clock (64 bits width).
otPlatRadioGetPreferredChannelMask
Gets the radio preferred channel mask that the device prefers to form on.
otPlatRadioGetPromiscuous
Get the status of promiscuous mode.
otPlatRadioGetRawPowerSetting
Get the raw power setting for the given channel.
otPlatRadioGetReceiveSensitivity
Get the radio receive sensitivity value.
otPlatRadioGetRegion
Get the region code.
otPlatRadioGetRssi
Get the most recent RSSI measurement.
otPlatRadioGetState
Get current state of the radio.
otPlatRadioGetSupportedChannelMask
Get the radio supported channel mask that the device is allowed to be on.
otPlatRadioGetTransmitBuffer
Get the radio transmit frame buffer.
otPlatRadioGetTransmitPower
Get the radio’s transmit power in dBm.
otPlatRadioGetVersionString
Get the radio version string.
otPlatRadioIsCoexEnabled
Check whether radio coex is enabled or not.
otPlatRadioIsEnabled
Check whether radio is enabled or not.
otPlatRadioReceive
Transition the radio from Sleep to Receive (turn on the radio).
otPlatRadioReceiveAt
Schedule a radio reception window at a specific time and duration.
otPlatRadioReceiveDone
The radio driver calls this method to notify OpenThread of a received frame.
otPlatRadioResetCsl
Reset CSL receiver in the platform.
otPlatRadioSetAlternateShortAddress
Set the alternate short address.
otPlatRadioSetCcaEnergyDetectThreshold
Set the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
otPlatRadioSetChannelMaxTransmitPower
Set the max transmit power for a specific channel.
otPlatRadioSetChannelTargetPower
Set the target power for the given channel.
otPlatRadioSetCoexEnabled
Enable the radio coex.
otPlatRadioSetExtendedAddress
Set the Extended Address for address filtering.
otPlatRadioSetFemLnaGain
Sets the external FEM’s Rx LNA gain in dBm.
otPlatRadioSetMacFrameCounter
Sets the current MAC frame counter value.
otPlatRadioSetMacFrameCounterIfLarger
Sets the current MAC frame counter value only if the new given value is larger than the current value.
otPlatRadioSetMacKey
Update MAC keys and key index
otPlatRadioSetPanId
Set the PAN ID for address filtering.
otPlatRadioSetPromiscuous
Enable or disable promiscuous mode.
otPlatRadioSetRegion
Set the region code.
otPlatRadioSetRxOnWhenIdle
Sets the rx-on-when-idle state to the radio platform.
otPlatRadioSetShortAddress
Set the Short Address for address filtering.
otPlatRadioSetTransmitPower
Set the radio’s transmit power in dBm for all channels.
otPlatRadioSleep
Transition the radio from Receive to Sleep (turn off the radio).
otPlatRadioTransmit
Begin the transmit sequence on the radio.
otPlatRadioTxDone
The radio driver calls this function to notify OpenThread that the transmit operation has completed, providing both the transmitted frame and, if applicable, the received ack frame.
otPlatRadioTxStarted
The radio driver calls this method to notify OpenThread that the transmission has started.
otPlatRadioUpdateCslSampleTime
Update CSL sample time in radio driver.
otPlatReset
Performs a software reset on the platform, if supported.
otPlatResetToBootloader
Performs a hardware reset on the platform to launch bootloader mode, if supported.
otPlatSetMcuPowerState
Sets the desired MCU power state.
otPlatSettingsAdd
Adds a value to a setting.
otPlatSettingsDeinit
Performs any de-initialization for the settings subsystem, if necessary.
otPlatSettingsDelete
Removes a setting from the setting store.
otPlatSettingsGet
Fetches the value of a setting.
otPlatSettingsInit
Performs any initialization for the settings subsystem, if necessary.
otPlatSettingsSet
Sets or replaces the value of a setting.
otPlatSettingsWipe
Removes all settings from the setting store.
otPlatSpiSlaveDisable
Shutdown and disable the SPI slave interface.
otPlatSpiSlaveEnable
Initialize the SPI slave interface.
otPlatSpiSlavePrepareTransaction
Prepare data for the next SPI transaction. Data pointers MUST remain valid until the transaction complete callback is called by the SPI slave driver, or until after the next call to otPlatSpiSlavePrepareTransaction().
otPlatTimeGet
Get the current platform time in microseconds referenced to a continuous monotonic local clock (64 bits width).
otPlatTimeGetXtalAccuracy
Get the current estimated worst case accuracy (maximum ± deviation from the nominal frequency) of the local platform clock in units of PPM.
otPlatTrelDisable
Disables TREL platform layer.
otPlatTrelEnable
Initializes and enables TREL platform layer.
otPlatTrelGetCounters
Gets the pointer to the TREL counters in the platform layer.
otPlatTrelHandleDiscoveredPeerInfo
This is a callback function from platform layer to report a discovered TREL peer info.
otPlatTrelHandleReceived
Is a callback from platform to notify of a received TREL UDP packet.
otPlatTrelNotifyPeerSocketAddressDifference
Notifies platform that a TREL packet is received from a peer using a different socket address than the one reported earlier from otPlatTrelHandleDiscoveredPeerInfo().
otPlatTrelRegisterService
Registers a new service to be advertised using DNS-SD [RFC6763].
otPlatTrelResetCounters
Resets the TREL counters in the platform layer.
otPlatTrelSend
Requests a TREL UDP packet to be sent to a given destination.
otPlatUdpBind
Binds the UDP socket by platform.
otPlatUdpBindToNetif
Binds the UDP socket to a platform network interface.
otPlatUdpClose
Closes the UDP socket by platform.
otPlatUdpConnect
Connects UDP socket by platform.
otPlatUdpJoinMulticastGroup
Configures the UDP socket to join a UDP multicast group.
otPlatUdpLeaveMulticastGroup
Configures the UDP socket to leave a UDP multicast group.
otPlatUdpSend
Sends UDP payload by platform.
otPlatUdpSocket
Initializes the UDP socket by platform.
otPlatWakeHost
Performs a platform specific operation to wake the host MCU. This is used only for NCP configurations.
otRandomNonCryptoAddJitter
Adds a random jitter within a given range to a given value.
otRandomNonCryptoFillBuffer
Fills a given buffer with random bytes.
otRandomNonCryptoGetUint8
Generates and returns a random byte.
otRandomNonCryptoGetUint8InRange
Generates and returns a random uint8_t value within a given range [aMin, aMax).
otRandomNonCryptoGetUint16
Generates and returns a random uint16_t value.
otRandomNonCryptoGetUint32
Generates and returns a random uint32_t value.
otRandomNonCryptoGetUint16InRange
Generates and returns a random uint16_t value within a given range [aMin, aMax).
otRandomNonCryptoGetUint32InRange
Generates and returns a random uint32_t value within a given range [aMin, aMax).
otRemoveStateChangeCallback
Removes a callback to indicate when certain configuration or state changes within OpenThread.
otServerAddService
Add a service configuration to the local network data.
otServerGetNetDataLocal
Provides a full or stable copy of the local Thread Network Data.
otServerGetNextService
Gets the next service in the local Network Data.
otServerRegister
Immediately register the local network data with the Leader.
otServerRemoveService
Remove a service configuration from the local network data.
otSetStateChangedCallback
Registers a callback to indicate when certain configuration or state changes within OpenThread.
otSntpClientQuery
Sends a SNTP query.
otSntpClientSetUnixEra
Sets the unix era number.
otSrpClientAddService
Adds a service to be registered with server.
otSrpClientBuffersAllocateService
Allocates a new service entry from the pool.
otSrpClientBuffersFreeAllServices
Frees all previously allocated service entries.
otSrpClientBuffersFreeService
Frees a previously allocated service entry.
otSrpClientBuffersGetHostAddressesArray
Gets the array of IPv6 address entries to use as SRP client host address list.
otSrpClientBuffersGetHostNameString
Gets the string buffer to use for SRP client host name.
otSrpClientBuffersGetServiceEntryInstanceNameString
Gets the string buffer for service instance name from a service entry.
otSrpClientBuffersGetServiceEntryServiceNameString
Gets the string buffer for service name from a service entry.
otSrpClientBuffersGetServiceEntryTxtBuffer
Gets the buffer for TXT record from a service entry.
otSrpClientBuffersGetSubTypeLabelsArray
Gets the array for service subtype labels from the service entry.
otSrpClientClearHostAndServices
Clears all host info and all the services.
otSrpClientClearService
Clears a service, immediately removing it from the client service list.
otSrpClientDisableAutoStartMode
Disables the auto-start mode.
otSrpClientEnableAutoHostAddress
Enables auto host address mode.
otSrpClientEnableAutoStartMode
Enables the auto-start mode.
otSrpClientGetDomainName
Gets the domain name being used by SRP client.
otSrpClientGetHostInfo
Gets the host info.
otSrpClientGetKeyLeaseInterval
Gets the default key lease interval used in SRP update requests.
otSrpClientGetLeaseInterval
Gets the default lease interval used in SRP update requests.
otSrpClientGetServerAddress
Gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP client.
otSrpClientGetServices
Gets the list of services being managed by client.
otSrpClientGetTtl
Gets the TTL value in every record included in SRP update requests.
otSrpClientIsAutoStartModeEnabled
Indicates the current state of auto-start mode (enabled or disabled).
otSrpClientIsRunning
Indicates whether the SRP client is running or not.
otSrpClientIsServiceKeyRecordEnabled
Indicates whether the “service key record inclusion” mode is enabled or disabled.
otSrpClientItemStateToString
Converts a otSrpClientItemState to a string.
otSrpClientRemoveHostAndServices
Starts the remove process of the host info and all services.
otSrpClientRemoveService
Requests a service to be unregistered with server.
otSrpClientSetCallback
Sets the callback to notify caller of events/changes from SRP client.
otSrpClientSetDomainName
Sets the domain name to be used by SRP client.
otSrpClientSetHostAddresses
Sets/updates the list of host IPv6 address.
otSrpClientSetHostName
Sets the host name label.
otSrpClientSetKeyLeaseInterval
Sets the default key lease interval used in SRP update requests.
otSrpClientSetLeaseInterval
Sets the default lease interval used in SRP update requests.
otSrpClientSetServiceKeyRecordEnabled
Enables/disables “service key record inclusion” mode.
otSrpClientSetTtl
Sets the TTL value in every record included in SRP update requests.
otSrpClientStart
Starts the SRP client operation.
otSrpClientStop
Stops the SRP client operation.
otSrpServerGetAddressMode
Returns the address mode being used by the SRP server.
otSrpServerGetAnycastModeSequenceNumber
Returns the sequence number used with anycast address mode.
otSrpServerGetDomain
Returns the domain authorized to the SRP server.
otSrpServerGetLeaseConfig
Returns SRP server LEASE and KEY-LEASE configurations.
otSrpServerGetNextHost
Returns the next registered host on the SRP server.
otSrpServerGetPort
Returns the port the SRP server is listening to.
otSrpServerGetResponseCounters
Returns the response counters of the SRP server.
otSrpServerGetState
Returns the state of the SRP server.
otSrpServerGetTtlConfig
Returns SRP server TTL configuration.
otSrpServerHandleServiceUpdateResult
Reports the result of processing a SRP update to the SRP server.
otSrpServerHostGetAddresses
Returns the addresses of given host.
otSrpServerHostGetFullName
Returns the full name of the host.
otSrpServerHostGetLeaseInfo
Returns the LEASE and KEY-LEASE information of a given host.
otSrpServerHostGetNextService
Returns the next service of given host.
otSrpServerHostIsDeleted
Tells if the SRP service host has been deleted.
otSrpServerHostMatchesFullName
Indicates whether the host matches a given host name.
otSrpServerIsAutoEnableMode
Indicates whether the auto-enable mode is enabled or disabled.
otSrpServerParseSubTypeServiceName
Parses a sub-type service name (full name) and extracts the sub-type label.
otSrpServerServiceGetHost
Returns the host which the service instance reside on.
otSrpServerServiceGetInstanceLabel
Returns the service instance label (first label in instance name) of the service.
otSrpServerServiceGetInstanceName
Returns the full service instance name of the service.
otSrpServerServiceGetLeaseInfo
Returns the LEASE and KEY-LEASE information of a given service.
otSrpServerServiceGetNumberOfSubTypes
Gets the number of sub-types of the service.
otSrpServerServiceGetPort
Returns the port of the service instance.
otSrpServerServiceGetPriority
Returns the priority of the service instance.
otSrpServerServiceGetServiceName
Returns the full service name of the service.
otSrpServerServiceGetSubTypeServiceNameAt
Gets the sub-type service name (full name) of the service at a given index
otSrpServerServiceGetTtl
Returns the TTL of the service instance.
otSrpServerServiceGetTxtData
Returns the TXT record data of the service instance.
otSrpServerServiceGetWeight
Returns the weight of the service instance.
otSrpServerServiceHasSubTypeServiceName
Indicates whether or not the service has a given sub-type.
otSrpServerServiceIsDeleted
Indicates whether or not the SRP service has been deleted.
otSrpServerServiceMatchesInstanceName
Indicates whether this service matches a given service instance name.
otSrpServerServiceMatchesServiceName
Indicates whether this service matches a given service name.
otSrpServerSetAddressMode
Sets the address mode to be used by the SRP server.
otSrpServerSetAnycastModeSequenceNumber
Sets the sequence number used with anycast address mode.
otSrpServerSetAutoEnableMode
Enables/disables the auto-enable mode on SRP server.
otSrpServerSetDomain
Sets the domain on the SRP server.
otSrpServerSetEnabled
Enables/disables the SRP server.
otSrpServerSetLeaseConfig
Sets SRP server LEASE and KEY-LEASE configurations.
otSrpServerSetServiceUpdateHandler
Sets the SRP service updates handler on SRP server.
otSrpServerSetTtlConfig
Sets SRP server TTL configuration.
otTaskletsArePending
Indicates whether or not OpenThread has tasklets pending.
otTaskletsProcess
Run all queued OpenThread tasklets at the time this is called.
otTaskletsSignalPending
OpenThread calls this function when the tasklet queue transitions from empty to non-empty.
otTcpAbort
Forcibly ends the TCP connection associated with this TCP endpoint.
otTcpBind
Binds the TCP endpoint to an IP address and port.
otTcpCommitReceive
Informs the TCP stack that the application has finished processing @p aNumBytes bytes of data at the start of the receive buffer and that the TCP stack need not continue maintaining those bytes in the receive buffer.
otTcpConnect
Records the remote host and port for this connection.
otTcpEndpointDeinitialize
Deinitializes this TCP endpoint.
otTcpEndpointGetContext
Obtains the context pointer that was associated with @p aEndpoint upon initialization.
otTcpEndpointGetInstance
Obtains the otInstance that was associated with @p aEndpoint upon initialization.
otTcpEndpointInitialize
Initializes a TCP endpoint.
otTcpGetLocalAddress
Obtains a pointer to a TCP endpoint’s local host and port.
otTcpGetPeerAddress
Obtains a pointer to a TCP endpoint’s peer’s host and port.
otTcpListen
Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener’s callbacks.
otTcpListenerDeinitialize
Deinitializes this TCP listener.
otTcpListenerGetContext
Obtains the context pointer that was associated with @p aListener upon initialization.
otTcpListenerGetInstance
Obtains the otInstance that was associated with @p aListener upon initialization.
otTcpListenerInitialize
Initializes a TCP listener.
otTcpReceiveByReference
Provides the application with a linked buffer chain referencing data currently in the TCP receive buffer.
otTcpReceiveContiguify
Reorganizes the receive buffer to be entirely contiguous in memory.
otTcpSendByExtension
Adds data to the send buffer by extending the length of the final otLinkedBuffer in the send buffer by the specified amount.
otTcpSendByReference
Adds data referenced by the linked buffer pointed to by @p aBuffer to the send buffer.
otTcpSendEndOfStream
Informs the connection peer that this TCP endpoint will not send more data.
otTcpStopListening
Causes this TCP listener to stop listening for incoming connections.
otThreadBecomeChild
Attempt to reattach as a child.
otThreadBecomeDetached
Detach from the Thread network.
otThreadBecomeLeader
Become a leader and start a new partition.
otThreadBecomeRouter
Attempt to become a router.
otThreadDetachGracefully
Notifies other nodes in the network (if any) and then stops Thread protocol operation.
otThreadDeviceRoleToString
Convert the device role to human-readable string.
otThreadDiscover
Starts a Thread Discovery scan.
otThreadErrorToString
Converts an otError enum into a string.
otThreadGetAdvertisementTrickleIntervalMax
Gets the current Interval Max value used by Advertisement trickle timer.
otThreadGetChildInfoById
Gets diagnostic information for an attached Child by its Child ID or RLOC16.
otThreadGetChildInfoByIndex
The function retains diagnostic information for an attached Child by the internal table index.
otThreadGetChildNextIp6Address
Gets the next IPv6 address (using an iterator) for a given child.
otThreadGetChildRouterLinks
Get the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
otThreadGetChildTimeout
Gets the Thread Child Timeout (in seconds) used when operating in the Child role.
otThreadGetContextIdReuseDelay
Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadGetCurrentAttachDuration
Gets the current attach duration (number of seconds since the device last attached).
otThreadGetDeviceProperties
Get the current device properties.
otThreadGetDeviceRole
Get the device role.
otThreadGetDomainName
Gets the Thread Domain Name.
otThreadGetExtendedPanId
Gets the IEEE 802.15.4 Extended PAN ID.
otThreadGetFixedDuaInterfaceIdentifier
Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.
otThreadGetIp6Counters
Gets the IPv6 counters.
otThreadGetJoinerUdpPort
Gets the Joiner UDP Port.
otThreadGetKeySequenceCounter
Gets the thrKeySequenceCounter.
otThreadGetKeySwitchGuardTime
Gets the thrKeySwitchGuardTime (in hours).
otThreadGetLeaderData
Get the Thread Leader Data.
otThreadGetLeaderRloc
Returns a pointer to the Leader’s RLOC.
otThreadGetLeaderRouterId
Get the Leader’s Router ID.
otThreadGetLeaderWeight
Get the Leader’s Weight.
otThreadGetLinkLocalAllThreadNodesMulticastAddress
Gets the Thread Link-Local All Thread Nodes multicast address.
otThreadGetLinkLocalIp6Address
Gets the Thread link-local IPv6 address.
otThreadGetLinkMode
Get the MLE Link Mode configuration.
otThreadGetLocalLeaderWeight
Gets the Thread Leader Weight used when operating in the Leader role.
otThreadGetMaxAllowedChildren
Gets the maximum number of children currently allowed.
otThreadGetMaxChildIpAddresses
Gets the maximum number of IP addresses that each MTD child may register with this device as parent.
otThreadGetMaxRouterId
The function returns the maximum allowed router ID
otThreadGetMaxTimeInQueue
Gets the maximum time-in-queue for messages in the TX queue.
otThreadGetMeshLocalEid
Gets the Mesh Local EID address.
otThreadGetMeshLocalPrefix
Returns a pointer to the Mesh Local Prefix.
otThreadGetMleCounters
Gets the Thread MLE counters.
otThreadGetNetworkIdTimeout
Get the NETWORK_ID_TIMEOUT parameter.
otThreadGetNetworkKey
Get the Thread Network Key.
otThreadGetNetworkKeyRef
Get the otNetworkKeyRef for Thread Network Key.
otThreadGetNetworkName
Get the Thread Network Name.
otThreadGetNextCacheEntry
Gets the next EID cache entry (using an iterator).
otThreadGetNextDiagnosticTlv
Gets the next Network Diagnostic TLV in the message.
otThreadGetNextHopAndPathCost
Gets the next hop and path cost towards a given RLOC16 destination.
otThreadGetNextNeighborInfo
Gets the next neighbor information. It is used to go through the entries of the neighbor table.
otThreadGetParentAverageRssi
The function retrieves the average RSSI for the Thread Parent.
otThreadGetParentInfo
The function retrieves diagnostic information for a Thread Router as parent.
otThreadGetParentLastRssi
The function retrieves the RSSI of the last packet from the Thread Parent.
otThreadGetParentPriority
Get the assigned parent priority.
otThreadGetPartitionId
Get the Partition ID.
otThreadGetPreferredLeaderPartitionId
Get the preferred Thread Leader Partition Id used when operating in the Leader role.
otThreadGetPskc
Get the Thread PSKc
otThreadGetPskcRef
Get Key Reference to Thread PSKc stored
otThreadGetRealmLocalAllThreadNodesMulticastAddress
Gets the Thread Realm-Local All Thread Nodes multicast address.
otThreadGetRloc
Gets the Thread Routing Locator (RLOC) address.
otThreadGetRloc16
Get the RLOC16.
otThreadGetRouterDowngradeThreshold
Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.
otThreadGetRouterIdRange
Gets the range of router IDs that are allowed to assign to nodes within the thread network.
otThreadGetRouterIdSequence
Get the current Router ID Sequence.
otThreadGetRouterInfo
The function retains diagnostic information for a given Thread Router.
otThreadGetRouterSelectionJitter
Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadGetRouterUpgradeThreshold
Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.
otThreadGetServiceAloc
Retrieves the Service ALOC for given Service ID.
otThreadGetStoreFrameCounterAhead
Gets the store frame counter ahead.
otThreadGetTimeInQueueHistogram
Gets the time-in-queue histogram for messages in the TX queue.
otThreadGetVendorAppUrl
Get the vendor app URL string.
otThreadGetVendorModel
Get the vendor model string.
otThreadGetVendorName
Get the vendor name string.
otThreadGetVendorSwVersion
Get the vendor software version string.
otThreadGetVersion
Gets the Thread protocol version.
otThreadIsAnycastLocateInProgress
Indicates whether an anycast locate request is currently in progress.
otThreadIsDiscoverInProgress
Determines if an MLE Thread Discovery is currently in progress.
otThreadIsRouterEligible
Indicates whether or not the device is router-eligible.
otThreadIsRouterIdAllocated
Indicates whether or not a Router ID is currently allocated.
otThreadIsSingleton
Indicates whether a node is the only router on the network.
otThreadIsTmfOriginFilterEnabled
Indicates whether the filter that drops TMF UDP messages from untrusted origin is enabled or not.
otThreadLocateAnycastDestination
Requests the closest destination of a given anycast address to be located.
otThreadRegisterNeighborTableCallback
Registers a neighbor table callback function.
otThreadRegisterParentResponseCallback
Registers a callback to receive MLE Parent Response data.
otThreadReleaseRouterId
Release a Router ID that has been allocated by the device in the Leader role.
otThreadResetIp6Counters
Resets the IPv6 counters.
otThreadResetMleCounters
Resets the Thread MLE counters.
otThreadResetTimeInQueueStat
Resets the TX queue time-in-queue statistics.
otThreadSearchForBetterParent
Starts the process for child to search for a better parent while staying attached to its current parent.
otThreadSendAddressNotification
Sends a Proactive Address Notification (ADDR_NTF.ntf) message.
otThreadSendDiagnosticGet
Send a Network Diagnostic Get request.
otThreadSendDiagnosticReset
Send a Network Diagnostic Reset request.
otThreadSendProactiveBackboneNotification
Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
otThreadSetCcmEnabled
Sets whether the device was commissioned using CCM.
otThreadSetChildRouterLinks
Set the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
otThreadSetChildTimeout
Sets the Thread Child Timeout (in seconds) used when operating in the Child role.
otThreadSetContextIdReuseDelay
Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
otThreadSetDeviceProperties
Set the device properties which are then used to determine and set the Leader Weight.
otThreadSetDiscoveryRequestCallback
Sets a callback to receive MLE Discovery Request data.
otThreadSetDomainName
Sets the Thread Domain Name. Only succeeds when Thread protocols are disabled.
otThreadSetEnabled
Starts Thread protocol operation.
otThreadSetExtendedPanId
Sets the IEEE 802.15.4 Extended PAN ID.
otThreadSetFixedDuaInterfaceIdentifier
Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.
otThreadSetJoinerAdvertisement
Sets the Thread Joiner Advertisement when discovering Thread network.
otThreadSetJoinerUdpPort
Sets the Joiner UDP Port.
otThreadSetKeySequenceCounter
Sets the thrKeySequenceCounter.
otThreadSetKeySwitchGuardTime
Sets the thrKeySwitchGuardTime (in hours).
otThreadSetLinkMode
Set the MLE Link Mode configuration.
otThreadSetLocalLeaderWeight
Sets the Thread Leader Weight used when operating in the Leader role.
otThreadSetMaxAllowedChildren
Sets the maximum number of children currently allowed.
otThreadSetMaxChildIpAddresses
Sets or restores the maximum number of IP addresses that each MTD child may register with this device as parent.
otThreadSetMeshLocalPrefix
Sets the Mesh Local Prefix.
otThreadSetNetworkIdTimeout
Set the NETWORK_ID_TIMEOUT parameter.
otThreadSetNetworkKey
Set the Thread Network Key.
otThreadSetNetworkKeyRef
Set the Thread Network Key as a otNetworkKeyRef.
otThreadSetNetworkName
Set the Thread Network Name.
otThreadSetParentPriority
Set the parent priority.
otThreadSetPreferredLeaderPartitionId
Set the preferred Thread Leader Partition Id used when operating in the Leader role.
otThreadSetPreferredRouterId
Set the preferred Router Id.
otThreadSetPskc
Set the Thread PSKc
otThreadSetPskcRef
Set the Key Reference to the Thread PSKc
otThreadSetRouterDowngradeThreshold
Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetRouterEligible
Sets whether or not the device is router-eligible.
otThreadSetRouterIdRange
Sets the range of router IDs that are allowed to assign to nodes within the thread network.
otThreadSetRouterSelectionJitter
Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
otThreadSetRouterUpgradeThreshold
Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.
otThreadSetSteeringData
Set Steering data out of band.
otThreadSetStoreFrameCounterAhead
Sets the store frame counter ahead.
otThreadSetThreadVersionCheckEnabled
Sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.
otThreadSetTmfOriginFilterEnabled
Enables or disables the filter to drop TMF UDP messages from untrusted origin.
otThreadSetVendorAppUrl
Set the vendor app URL string.
otThreadSetVendorModel
Set the vendor model string.
otThreadSetVendorName
Set the vendor name string.
otThreadSetVendorSwVersion
Set the vendor software version string.
otThreadWakeup
Attempts to wake a Wake-up End Device.
otTrelGetCounters
Gets the TREL counters.
otTrelGetNextPeer
Iterates over the peer table entries and get the next entry from the table
otTrelGetNumberOfPeers
Returns the number of TREL peers.
otTrelGetUdpPort
Gets the UDP port of the TREL interface.
otTrelInitPeerIterator
Initializes a peer table iterator.
otTrelIsEnabled
Indicates whether the TREL operation is enabled.
otTrelIsFilterEnabled
Indicates whether or not the filter mode is enabled.
otTrelResetCounters
Resets the TREL counters.
otTrelSetEnabled
Enables or disables TREL operation.
otTrelSetFilterEnabled
Sets the filter mode (enables/disables filtering).
otUdpAddReceiver
Adds a UDP receiver.
otUdpBind
Bind a UDP/IPv6 socket.
otUdpClose
Close a UDP/IPv6 socket.
otUdpConnect
Connect a UDP/IPv6 socket.
otUdpForwardReceive
Handle a UDP packet received from host.
otUdpForwardSetForwarder
Set UDP forward callback to deliver UDP packets to host.
otUdpGetSockets
Gets the head of linked list of UDP Sockets.
otUdpIsOpen
Check if a UDP socket is open.
otUdpIsPortInUse
Determines if the given UDP port is exclusively opened by OpenThread API.
otUdpNewMessage
Allocate a new message buffer for sending a UDP message.
otUdpOpen
Open a UDP/IPv6 socket.
otUdpRemoveReceiver
Removes a UDP receiver.
otUdpSend
Send a UDP/IPv6 message.
otUdpSendDatagram
Sends a UDP message without socket.

Type Aliases§

__builtin_va_list
_bindgen_ty_1
Defines the key usage flags.
_bindgen_ty_2
@defgroup radio-types Radio Types
_bindgen_ty_3
Defines the channel page.
_bindgen_ty_4
Defines the frequency band channel range.
_bindgen_ty_5
Defines constants that are used to indicate different radio capabilities. See otRadioCaps.
_bindgen_ty_6
Defines constants about size of header IE in ACK.
_bindgen_ty_7
IPv6 Address origins
_bindgen_ty_8
ECN statuses, represented as in the IP header.
_bindgen_ty_9
Internet Protocol Numbers.
_bindgen_ty_10
Defines the keys of settings.
_bindgen_ty_11
Defines flags passed to otTcpConnect().
_bindgen_ty_12
Defines flags passed to @p otTcpSendByReference.
otBackboneRouterDomainPrefixCallback
Pointer is called whenever the Domain Prefix changed.
otBackboneRouterDomainPrefixEvent
Represents the Domain Prefix events.
otBackboneRouterMulticastListenerCallback
Pointer is called whenever the Multicast Listeners change.
otBackboneRouterMulticastListenerEvent
Represents the Multicast Listener events.
otBackboneRouterMulticastListenerIterator
otBackboneRouterNdProxyCallback
Pointer is called whenever the Nd Proxy changed.
otBackboneRouterNdProxyEvent
Represents the ND Proxy events.
otBackboneRouterState
Represents the Backbone Router Status.
otBorderAgentEphemeralKeyCallback
Callback function pointer to signal state changes to the Border Agent’s Ephemeral Key Manager.
otBorderAgentEphemeralKeyState
Represents Border Agent’s Ephemeral Key Manager state.
otBorderAgentMeshCoPServiceChangedCallback
This callback informs the application of the changes in the state of the MeshCoP service.
otBorderRouterNetDataFullCallback
Function pointer callback which is invoked when Network Data (local or leader) gets full.
otBorderRoutingDhcp6PdState
This enumeration represents the state of DHCPv6 Prefix Delegation State.
otBorderRoutingRequestDhcp6PdCallback
When the state of a DHCPv6 Prefix Delegation (PD) on the Thread interface changes, this callback notifies processes in the OS of this changed state.
otBorderRoutingState
Represents the state of Border Routing Manager.
otCacheEntryState
Defines the EID cache entry state.
otChangedFlags
Represents a bit-field indicating specific state/configuration that has changed. See OT_CHANGED_* definitions.
otChannelMask
Represents Channel Mask.
otChildIp6AddressIterator
otCliOutputCallback
Pointer is called to notify about Console output.
otCoapBlockSzx
CoAP Block Size Exponents
otCoapBlockwiseReceiveHook
Pointer is called when a CoAP message with a block-wise transfer option is received.
otCoapBlockwiseTransmitHook
Pointer is called before the next block in a block-wise transfer is sent.
otCoapCode
CoAP Code values.
otCoapOptionContentFormat
CoAP Content Format codes. The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats
otCoapOptionType
CoAP Option Numbers
otCoapRequestHandler
Pointer is called when a CoAP request with a given Uri-Path is received.
otCoapResponseHandler
Pointer is called when a CoAP response is received or on the request timeout.
otCoapSecureAutoStopCallback
Callback function pointer to notify when the CoAP secure agent is automatically stopped due to reaching the maximum number of connection attempts.
otCoapSecureConnectEvent
CoAP secure connection event types.
otCoapType
CoAP Type values (2 bit unsigned integer).
otCommissionerEnergyReportCallback
Pointer is called when the Commissioner receives an Energy Report.
otCommissionerJoinerCallback
Pointer is called whenever the joiner state changes.
otCommissionerJoinerEvent
Defines a Joiner Event on the Commissioner.
otCommissionerPanIdConflictCallback
Pointer is called when the Commissioner receives a PAN ID Conflict message.
otCommissionerState
Defines the Commissioner State.
otCommissionerStateCallback
Pointer is called whenever the commissioner state changes.
otCryptoKeyAlgorithm
Defines the key algorithms.
otCryptoKeyRef
This datatype represents the key reference.
otCryptoKeyStorage
Defines the key storage types.
otCryptoKeyType
Defines the key types.
otDatasetMgmtSetCallback
Pointer is called when a response to a MGMT_SET request is received or times out.
otDatasetUpdaterCallback
This callback function pointer is called when a Dataset update request finishes, reporting success or failure status of the Dataset update request.
otDetachGracefullyCallback
This callback informs the application that the detaching process has finished.
otDeviceRole
Represents a Thread device role.
otDiagOutputCallback
@addtogroup api-factory-diagnostics
otDnsAddressCallback
Pointer is called when a DNS response is received for an address resolution query.
otDnsBrowseCallback
Pointer is called when a DNS response is received for a browse (service instance enumeration) query.
otDnsNat64Mode
Type represents the NAT64 mode in an otDnsQueryConfig.
otDnsRecursionFlag
Type represents the “Recursion Desired” (RD) flag in an otDnsQueryConfig.
otDnsServiceCallback
Pointer is called when a DNS response is received for a service instance resolution query.
otDnsServiceMode
Type represents the service resolution mode in an otDnsQueryConfig.
otDnsTransportProto
Type represents the DNS transport protocol in an otDnsQueryConfig.
otDnssdQuery
This opaque type represents a DNS-SD query.
otDnssdQuerySubscribeCallback
Is called when a DNS-SD query subscribes one of: 1. a service name. 2. a service instance name. 3. a host name.
otDnssdQueryType
Specifies a DNS-SD query type.
otDnssdQueryUnsubscribeCallback
Is called when a DNS-SD query unsubscribes one of: 1. a service name. 2. a service instance name. 3. a host name.
otError
Represents error codes used throughout OpenThread.
otGpioMode
Defines the gpio modes.
otHandleActiveScanResult
Pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes.
otHandleCoapSecureClientConnect
Pointer is called when the DTLS connection state changes.
otHandleEnergyScanResult
Pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes.
otIcmp6Code
ICMPv6 Message Codes
otIcmp6EchoMode
ICMPv6 Echo Reply Modes
otIcmp6ReceiveCallback
This callback allows OpenThread to inform the application of a received ICMPv6 message.
otIcmp6Type
ICMPv6 Message Types
otIp6AddressCallback
Pointer is called when an internal IPv6 address is added or removed.
otIp6ReceiveCallback
Pointer is called when an IPv6 datagram is received.
otIp6RegisterMulticastListenersCallback
Pointer is called with results of otIp6RegisterMulticastListeners.
otIp6SlaacPrefixFilter
Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
otJamDetectionCallback
Pointer is called if signal jam detection is enabled and a jam is detected.
otJoinerCallback
Pointer is called to notify the completion of a join operation.
otJoinerInfoType
Defines a Joiner Info Type.
otJoinerState
Defines the Joiner State.
otLinkMetricsEnhAckFlags
Enhanced-ACK Flags.
otLinkMetricsEnhAckProbingIeReportCallback
Pointer is called when Enh-ACK Probing IE is received.
otLinkMetricsMgmtResponseCallback
Pointer is called when a Link Metrics Management Response is received.
otLinkMetricsReportCallback
Pointer is called when a Link Metrics report is received.
otLinkMetricsStatus
Link Metrics Status values.
otLinkPcapCallback
Pointer is called when an IEEE 802.15.4 frame is received.
otLinkRawEnergyScanDone
Pointer on receipt of a IEEE 802.15.4 frame.
otLinkRawReceiveDone
Pointer on receipt of a IEEE 802.15.4 frame.
otLinkRawTransmitDone
Pointer on receipt of a IEEE 802.15.4 frame.
otLogLevel
Represents the log level.
otLogRegion
Represents log regions.
otMacFilterAddressMode
Defines address mode of the mac filter.
otMacFilterIterator
otMacKeyRef
Represents a MAC Key Ref used by PSA.
otMeshLocalPrefix
Represents a Mesh Local Prefix.
otMeshcopTlvType
Represents meshcop TLV types.
otMessageOrigin
Defines the OpenThread message origins.
otMessagePriority
Defines the OpenThread message priority levels.
otNat64DropReason
Packet drop reasons.
otNat64ReceiveIp4Callback
Pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.
otNat64State
States of NAT64.
otNcpDelegateAllowPeekPoke
Defines delegate (function pointer) type to control behavior of peek/poke operation.
otNcpHdlcSendCallback
Pointer is called to send HDLC encoded NCP data.
otNeighborInfoIterator
otNeighborTableCallback
Pointer is called to notify that there is a change in the neighbor table.
otNeighborTableEvent
Defines the constants used in otNeighborTableCallback to indicate changes in neighbor table.
otNetifIdentifier
Defines the OpenThread network interface identifiers.
otNetworkDataIterator
otNetworkDiagIterator
otNetworkKeyRef
This datatype represents KeyRef to NetworkKey.
otNetworkTimeStatus
Represents OpenThread time synchronization status.
otNetworkTimeSyncCallbackFn
Pointer is called when a network time sync or status change occurs.
otPanId
Represents the IEEE 802.15.4 PAN ID.
otPingSenderReplyCallback
Pointer type specifies the callback to notify receipt of a ping reply.
otPingSenderStatisticsCallback
Pointer type specifies the callback to report the ping statistics.
otPlatDiagOutputCallback
Pointer to callback to output platform diag messages.
otPlatMcuPowerState
Enumeration of micro-controller’s power states.
otPlatResetReason
Enumeration of possible reset reason codes.
otPlatSpiSlaveTransactionCompleteCallback
Indicates that a SPI transaction has completed with the given length. The data written to the slave has been written to the pointer indicated by the aInputBuf argument to the previous call to otPlatSpiSlavePrepareTransaction().
otPlatSpiSlaveTransactionProcessCallback
Invoked after a transaction complete callback is called and returns TRUE to do any further processing required. Unlike otPlatSpiSlaveTransactionCompleteCallback which can be called from any OS context (e.g., ISR), this callback MUST be called from the same OS context as any other OpenThread API/callback.
otPowerSupply
Represents the power supply property on a device.
otPskcRef
This datatype represents KeyRef to PSKc.
otRadioCaps
Represents radio capabilities.
otRadioKeyType
Defines constants about key types.
otRadioState
Represents the state of a radio. Initially, a radio is in the Disabled state.
otReceiveDiagnosticGetCallback
Pointer is called when Network Diagnostic Get response is received.
otRoutePreference
Defines valid values for mPreference in otExternalRouteConfig and otBorderRouterConfig.
otShortAddress
Represents the IEEE 802.15.4 Short Address.
otSntpResponseHandler
Pointer is called when a SNTP response is received.
otSrpClientAutoStartCallback
Pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
otSrpClientCallback
Pointer type defines the callback used by SRP client to notify user of changes/events/errors.
otSrpClientItemState
Specifies an SRP client item (service or host info) state.
otSrpServerAddressMode
Represents the address mode used by the SRP server.
otSrpServerServiceUpdateHandler
Handles SRP service updates.
otSrpServerServiceUpdateId
The ID of a SRP service update transaction on the SRP Server.
otSrpServerState
Represents the state of the SRP server.
otStateChangedCallback
Pointer is called to notify certain configuration or state changes within OpenThread.
otTcpAcceptDone
This callback indicates that the TCP connection is now ready for two-way communication.
otTcpAcceptReady
This callback indicates that an incoming connection that matches this TCP listener has arrived.
otTcpDisconnected
This callback indicates that the connection was broken and should no longer be used, or that a connection has entered the TIME-WAIT state.
otTcpDisconnectedReason
otTcpEstablished
This callback informs the application that the TCP 3-way handshake is complete and that the connection is now established.
otTcpForwardProgress
This callback informs the application if forward progress has been made in transferring data from the send buffer to the recipient. This callback is not necessary for correct TCP operation. Most applications can just rely on the otTcpSendDone() callback to reclaim linked buffers once the TCP stack is done using them. The purpose of this callback is to support advanced applications that benefit from finer-grained information about how the the connection is making forward progress in transferring data to the connection peer.
otTcpIncomingConnectionAction
Defines incoming connection actions.
otTcpReceiveAvailable
This callback indicates the number of bytes available for consumption from the receive buffer.
otTcpSendDone
This callback informs the application that data in the provided @p aData have been acknowledged by the connection peer and that @p aData and the data it contains can be reclaimed by the application.
otThreadAnycastLocatorCallback
Pointer type defines the callback to notify the outcome of a otThreadLocateAnycastDestination() request.
otThreadDiscoveryRequestCallback
Pointer is called every time an MLE Discovery Request message is received.
otThreadParentResponseCallback
Pointer is called every time an MLE Parent Response message is received.
otTrelCounters
Represents a group of TREL related counters.
otTrelPeerIterator
Represents an iterator for iterating over TREL peer table entries.
otUdpForwarder
Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
otUdpHandler
This callback allows OpenThread to provide specific handlers for certain UDP messages.
otUdpReceive
This callback allows OpenThread to inform the application of a received UDP message.
otWakeupCallback
Informs the application about the result of waking a Wake-up End Device.
va_list

Unions§

otIcmp6Header__bindgen_ty_1
otIp4Address__bindgen_ty_1
otIp6Address__bindgen_ty_1
otIp6InterfaceIdentifier__bindgen_ty_1
otJoinerInfo__bindgen_ty_1
otMacKeyMaterial__bindgen_ty_1
otNeighborTableEntryInfo__bindgen_ty_1
otNetworkDiagTlv__bindgen_ty_1
otRadioFrame__bindgen_ty_1
The union of transmit and receive information for a radio frame.
otTcpEndpoint__bindgen_ty_1
otTcpListener__bindgen_ty_1