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§
Structs§
- __
Bindgen Bitfield Unit - __
va_ list_ tag - otActive
Scan Result - Represents a received IEEE 802.15.4 Beacon.
- otBackbone
Router Config - Represents Backbone Router configuration.
- otBackbone
Router Multicast Listener Info - Represents a Backbone Router Multicast Listener info.
- otBackbone
Router NdProxy Info - Represents the Backbone Router ND Proxy info.
- otBorder
Agent Counters - Defines Border Agent counters.
- otBorder
Agent Id - Represents a Border Agent Identifier.
- otBorder
Agent Session Info - Represents information about a Border Agent session.
- otBorder
Agent Session Iterator - Represents an iterator for Border Agent sessions.
- otBorder
Router Config - Represents a Border Router configuration.
- otBorder
Routing Counters - Represents the counters of packets forwarded via Border Routing.
- otBorder
Routing Peer Border Router Entry - Represents information about a peer Border Router found in the Network Data.
- otBorder
Routing Prefix Table Entry - Represents an entry from the discovered prefix table.
- otBorder
Routing Prefix Table Iterator - Represents an iterator to iterate through the Border Router’s discovered prefix table.
- otBorder
Routing Router Entry - Represents a discovered router on the infrastructure link.
- otBuffer
Info - Represents the message buffer information for different queues used by OpenThread stack.
- otCache
Entry Info - Represents an EID cache entry.
- otCache
Entry Iterator - Represents an iterator used for iterating through the EID cache table entries.
- otChild
Info - Holds diagnostic information for a Thread Child
- otCli
Command - Represents a CLI command.
- otCoap
Blockwise Resource - Represents a CoAP resource with block-wise transfer.
- otCoap
Option - Represents a CoAP option.
- otCoap
Option Iterator - Acts as an iterator for CoAP options
- otCoap
Resource - Represents a CoAP resource.
- otCoap
TxParameters - Represents the CoAP transmission parameters.
- otCommissioning
Dataset - Represents a Commissioning Dataset.
- otCrypto
Context - @struct otCryptoContext
- otCrypto
Key - @struct otCryptoKey
- otDevice
Properties - Represents the device properties which are used for calculating the local leader weight on a device.
- otDns
Address Response - otDns
Browse Response - otDns
Query Config - Represents a DNS query configuration.
- otDns
Service Info - Provides info for a DNS service instance.
- otDns
Service Response - otDns
TxtEntry - Represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
- otDns
TxtEntry Iterator - Represents an iterator for TXT record entries (key/value pairs).
- otDnssd
Counters - Contains the counters of DNS-SD server.
- otDnssd
Host Info - Represents information of a discovered host for a DNS-SD query.
- otDnssd
Service Instance Info - Represents information of a discovered service instance for a DNS-SD query.
- otEnergy
Scan Result - Represents an energy scan result.
- otExt
Address - @struct otExtAddress
- otExtended
PanId - Represents an Extended PAN ID.
- otExternal
Route Config - Represents an External Route configuration.
- otIcmp6
Handler - Implements ICMPv6 message handler.
- otIcmp6
Header - @struct otIcmp6Header
- otInstance
- otIp4
Address - @struct otIp4Address
- otIp4
Cidr - @struct otIp4Cidr
- otIp6
Address - @struct otIp6Address
- otIp6
Address Components - @struct otIp6AddressComponents
- otIp6
Address Info - Represents IPv6 address information.
- otIp6
Interface Identifier - @struct otIp6InterfaceIdentifier
- otIp6
Network Prefix - @struct otIp6NetworkPrefix
- otIp6
Prefix - @struct otIp6Prefix
- otIp
Counters - Represents the IP level counters.
- otJoiner
Discerner - Represents a Joiner Discerner.
- otJoiner
Info - Represents a Joiner Info.
- otJoiner
Pskd - Represents a Joiner PSKd.
- otLeader
Data - Represents the Thread Leader Data.
- otLink
Metrics - Represents what metrics are specified to query.
- otLink
Metrics Series Flags - Represents which frames are accounted in a Forward Tracking Series.
- otLink
Metrics Values - Represents the result (value) for a Link Metrics query.
- otLink
Mode Config - Represents an MLE Link Mode configuration.
- otLinked
Buffer - A linked buffer structure for use with TCP.
- otLog
HexDump Info - Represents information used for generating hex dump output.
- otLowpan
Context Info - Represents 6LoWPAN Context ID information associated with a prefix in Network Data.
- otMac
Counters - Represents the MAC layer counters.
- otMac
Filter Entry - Represents a Mac Filter entry.
- otMac
Key - @struct otMacKey
- otMac
KeyMaterial - @struct otMacKeyMaterial
- otMessage
- otMessage
Buffer - Represents an OpenThread message buffer.
- otMessage
Info - Represents the local and peer IPv6 socket addresses.
- otMessage
Queue - Represents an OpenThread message queue.
- otMessage
Queue Info - Represents information about a message queue.
- otMessage
Settings - Represents a message settings.
- otMle
Counters - Represents the Thread MLE counters.
- otMulti
Radio Neighbor Info - Represents multi radio link information associated with a neighbor.
- otNat64
Address Mapping - Represents an address mapping record for NAT64.
- otNat64
Address Mapping Iterator - Used to iterate through NAT64 address mappings.
- otNat64
Counters - Represents the counters for NAT64.
- otNat64
Error Counters - Represents the counters of dropped packets due to errors when handling NAT64 packets.
- otNat64
Protocol Counters - Represents the counters for the protocols supported by NAT64.
- otNeighbor
Info - Holds diagnostic information for a neighboring Thread node
- otNeighbor
Table Entry Info - Represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table
callback
otNeighborTableCallback
. - otNetif
Address - Represents an IPv6 network interface unicast address.
- otNetif
Multicast Address - Represents an IPv6 network interface multicast address.
- otNetwork
Diag Child Entry - Represents a Network Diagnostic Child Table Entry.
- otNetwork
Diag Connectivity - Represents a Network Diagnostic Connectivity value.
- otNetwork
Diag MacCounters - Represents a Network Diagnostic Mac Counters value.
- otNetwork
Diag MleCounters - Represents a Network Diagnostics MLE Counters value.
- otNetwork
Diag Route - Represents a Network Diagnostic Route64 TLV value.
- otNetwork
Diag Route Data - Represents a Network Diagnostic Route data.
- otNetwork
Diag Tlv - Represents a Network Diagnostic TLV.
- otNetwork
Diag Tlv__ bindgen_ ty_ 1__ bindgen_ ty_ 1 - otNetwork
Diag Tlv__ bindgen_ ty_ 1__ bindgen_ ty_ 2 - otNetwork
Diag Tlv__ bindgen_ ty_ 1__ bindgen_ ty_ 3 - otNetwork
Diag Tlv__ bindgen_ ty_ 1__ bindgen_ ty_ 4 - otNetwork
Key - @struct otNetworkKey
- otNetwork
Name - Represents a Network Name.
- otOperational
Dataset - Represents an Active or Pending Operational Dataset.
- otOperational
Dataset Components - Represents presence of different components in Active or Pending Operational Dataset.
- otOperational
Dataset Tlvs - Represents an Active or Pending Operational Dataset.
- otPackets
AndBytes - Represents the counters for packets and bytes.
- otPd
Processed RaInfo - Represents a group of data of platform-generated RA messages processed.
- otPing
Sender Config - Represents a ping request configuration.
- otPing
Sender Reply - Represents a ping reply.
- otPing
Sender Statistics - Represents statistics of a ping request.
- otPlat
Crypto Ecdsa KeyPair - @struct otPlatCryptoEcdsaKeyPair
- otPlat
Crypto Ecdsa Public Key - @struct otPlatCryptoEcdsaPublicKey
- otPlat
Crypto Ecdsa Signature - @struct otPlatCryptoEcdsaSignature
- otPlat
Crypto Sha256 Hash - @struct otPlatCryptoSha256Hash
- otPlat
DnsUpstream Query - otPlat
Infra IfLink Layer Address - Represents an InfraIf Link-Layer Address.
- otPlat
Trel Counters - Represents a group of TREL related counters in the platform layer.
- otPlat
Trel Peer Info - Represents a TREL peer info discovered using DNS-SD browse on the service name “_trel._udp”.
- otPskc
- Represents PSKc.
- otRadio
Coex Metrics - Represents radio coexistence metrics.
- otRadio
Frame - Represents an IEEE 802.15.4 radio frame.
- otRadio
Frame__ bindgen_ ty_ 1__ bindgen_ ty_ 1 - Structure representing radio frame transmit information.
- otRadio
Frame__ bindgen_ ty_ 1__ bindgen_ ty_ 2 - Structure representing radio frame receive information.
- otRadio
IeInfo - Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
- otRadio
Link Info - Represents information associated with a radio link.
- otRouter
Info - Holds diagnostic information for a Thread Router
- otSecurity
Policy - Represent Security Policy.
- otServer
Config - Represents a Server configuration.
- otService
Config - Represents a Service configuration.
- otSntp
Query - Implements SNTP Query parameters.
- otSock
Addr - Represents an IPv6 socket address.
- otSrp
Client Buffers Service Entry - Represents a SRP client service pool entry.
- otSrp
Client Host Info - Represents an SRP client host info.
- otSrp
Client Service - Represents an SRP client service.
- otSrp
Server Host - otSrp
Server Lease Config - Includes SRP server LEASE and KEY-LEASE configurations.
- otSrp
Server Lease Info - Includes SRP server lease information of a host/service.
- otSrp
Server Response Counters - Includes the statistics of SRP server responses.
- otSrp
Server Service - otSrp
Server TtlConfig - Includes SRP server TTL configurations.
- otSteering
Data - Represents the steering data.
- otTcp
Endpoint - Represents a TCP endpoint.
- otTcp
Endpoint Initialize Args - Contains arguments to the otTcpEndpointInitialize() function.
- otTcp
Listener - Represents a TCP listener.
- otTcp
Listener Initialize Args - Contains arguments to the otTcpListenerInitialize() function.
- otThread
Discovery Request Info - Represents the Thread Discovery Request data.
- otThread
Link Info - Represents link-specific information for messages received from the Thread radio.
- otThread
Parent Response Info - Represents the MLE Parent Response data.
- otTimestamp
- Represents a Thread Dataset timestamp component.
- otTrel
Peer - Represents a TREL peer.
- otUdp
Receiver - Represents a UDP receiver.
- otUdp
Socket - Represents a UDP socket.
- otUpstream
DnsCounters - 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_ DHCP V6 - < 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_ BLOC K1 - < Block1 (RFC7959)
- OT_
COAP_ OPTION_ BLOC K2 - < 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_ ENCRYP T0 - 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_ PBDK F2_ 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
inotJoinerInfo
). - OT_
JOINER_ INFO_ TYPE_ EUI64 - < Joiner EUI-64 is specified (
mSharedId.mEui64
inotJoinerInfo
). - 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§
- otBackbone
Router ⚠Config Next DuaRegistration Response - Configures response status for next DUA registration.
- otBackbone
Router ⚠Config Next Multicast Listener Registration Response - Configures the response status for the next Multicast Listener Registration.
- otBackbone
Router ⚠GetConfig - Gets the local Backbone Router configuration.
- otBackbone
Router ⚠GetDomain Prefix - Gets the local Domain Prefix configuration.
- otBackbone
Router ⚠GetNd Proxy Info - Gets the Backbone Router ND Proxy info.
- otBackbone
Router ⚠GetPrimary - Gets the Primary Backbone Router information in the Thread Network.
- otBackbone
Router ⚠GetRegistration Jitter - Returns the Backbone Router registration jitter value.
- otBackbone
Router ⚠GetState - Gets the Backbone Router #otBackboneRouterState.
- otBackbone
Router ⚠Multicast Listener Add - Adds a Multicast Listener with a timeout value, in seconds.
- otBackbone
Router ⚠Multicast Listener Clear - Clears the Multicast Listeners.
- otBackbone
Router ⚠Multicast Listener GetNext - Gets the next Multicast Listener info (using an iterator).
- otBackbone
Router ⚠Register - Explicitly registers local Backbone Router configuration.
- otBackbone
Router ⚠SetConfig - Sets the local Backbone Router configuration #otBackboneRouterConfig.
- otBackbone
Router ⚠SetDomain Prefix Callback - Sets the Backbone Router Domain Prefix callback.
- otBackbone
Router ⚠SetEnabled - Enables or disables Backbone functionality.
- otBackbone
Router ⚠SetMulticast Listener Callback - Sets the Backbone Router Multicast Listener callback.
- otBackbone
Router ⚠SetNd Proxy Callback - Sets the Backbone Router ND Proxy callback.
- otBackbone
Router ⚠SetRegistration Jitter - Sets the Backbone Router registration jitter value.
- otBorder
Agent ⚠Ephemeral KeyGet State - Gets the state of Border Agent’s Ephemeral Key Manager.
- otBorder
Agent ⚠Ephemeral KeyGet UdpPort - Gets the UDP port used by Border Agent’s Ephemeral Key Manager.
- otBorder
Agent ⚠Ephemeral KeySet Callback - Sets the callback function to notify state changes of Border Agent’s Ephemeral Key Manager.
- otBorder
Agent ⚠Ephemeral KeySet Enabled - Enables/disables the Border Agent’s Ephemeral Key Manager.
- otBorder
Agent ⚠Ephemeral KeyStart - Starts using an ephemeral key for a given timeout duration.
- otBorder
Agent ⚠Ephemeral KeyState ToString - Converts a given
otBorderAgentEphemeralKeyState
to a human-readable string. - otBorder
Agent ⚠Ephemeral KeyStop - Stops the ephemeral key use and disconnects any session using it.
- otBorder
Agent ⚠GetCounters - Gets the counters of the Thread Border Agent.
- otBorder
Agent ⚠GetId - Gets the randomly generated Border Agent ID.
- otBorder
Agent ⚠GetNext Session Info - Retrieves the next Border Agent session information.
- otBorder
Agent ⚠GetUdp Port - Gets the UDP port of the Thread Border Agent service.
- otBorder
Agent ⚠Init Session Iterator - Initializes a session iterator.
- otBorder
Agent ⚠IsActive - Indicates whether or not the Border Agent service is active and running.
- otBorder
Agent ⚠SetId - Sets the Border Agent ID.
- otBorder
Agent ⚠SetMesh CoPService Changed Callback - Sets the callback function used by the Border Agent to notify of any changes to the state of the MeshCoP service.
- otBorder
Router ⚠AddOn Mesh Prefix - Add a border router configuration to the local network data.
- otBorder
Router ⚠AddRoute - Add an external route configuration to the local network data.
- otBorder
Router ⚠GetNet Data - Provides a full or stable copy of the local Thread Network Data.
- otBorder
Router ⚠GetNext OnMesh Prefix - Gets the next On Mesh Prefix in the local Network Data.
- otBorder
Router ⚠GetNext Route - Gets the next external route in the local Network Data.
- otBorder
Router ⚠Register - Immediately register the local network data with the Leader.
- otBorder
Router ⚠Remove OnMesh Prefix - Remove a border router configuration from the local network data.
- otBorder
Router ⚠Remove Route - Remove an external route configuration from the local network data.
- otBorder
Router ⚠SetNet Data Full Callback - Sets the callback to indicate when Network Data gets full.
- otBorder
Routing ⚠Clear Route Info Option Preference - Clears a previously set preference value for advertised Route Info Options.
- otBorder
Routing ⚠Clear Route Preference - Clears a previously set preference value for published routes in Network Data.
- otBorder
Routing ⚠Count Peer Brs - Returns the number of peer BRs found in the Network Data.
- otBorder
Routing ⚠Dhcp6 PdGet State - Gets the current state of DHCPv6 Prefix Delegation.
- otBorder
Routing ⚠Dhcp6 PdSet Enabled - Enables / Disables DHCPv6 Prefix Delegation.
- otBorder
Routing ⚠Dhcp6 PdSet Request Callback - Sets the callback whenever the DHCPv6 PD state changes on the Thread interface.
- otBorder
Routing ⚠GetFavored Nat64 Prefix - Gets the currently favored NAT64 prefix.
- otBorder
Routing ⚠GetFavored OmrPrefix - Gets the currently favored Off-Mesh-Routable (OMR) Prefix.
- otBorder
Routing ⚠GetFavored OnLink Prefix - Gets the currently favored On-Link Prefix.
- otBorder
Routing ⚠GetNat64 Prefix - Gets the local NAT64 Prefix of the Border Router.
- otBorder
Routing ⚠GetNext Peer BrEntry - Iterates over the peer BRs found in the Network Data.
- otBorder
Routing ⚠GetNext Prefix Table Entry - Iterates over the entries in the Border Router’s discovered prefix table.
- otBorder
Routing ⚠GetNext Router Entry - Iterates over the discovered router entries on the infrastructure link.
- otBorder
Routing ⚠GetOmr Prefix - Gets the local Off-Mesh-Routable (OMR) Prefix, for example
fdfc:1ff5:1512:5622::/64
. - otBorder
Routing ⚠GetOn Link Prefix - Gets the local On-Link Prefix for the adjacent infrastructure link.
- otBorder
Routing ⚠GetPd OmrPrefix - Gets the DHCPv6 Prefix Delegation (PD) provided off-mesh-routable (OMR) prefix.
- otBorder
Routing ⚠GetPd Processed RaInfo - Gets the data of platform generated RA message processed..
- otBorder
Routing ⚠GetRoute Info Option Preference - Gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
- otBorder
Routing ⚠GetRoute Preference - Gets the current preference used for published routes in Network Data.
- otBorder
Routing ⚠GetState - Gets the current state of Border Routing Manager.
- otBorder
Routing ⚠Init - Initializes the Border Routing Manager on given infrastructure interface.
- otBorder
Routing ⚠Prefix Table Init Iterator - Initializes an
otBorderRoutingPrefixTableIterator
. - otBorder
Routing ⚠SetEnabled - Enables or disables the Border Routing Manager.
- otBorder
Routing ⚠SetExtra Router Advert Options - Sets additional options to append at the end of emitted Router Advertisement (RA) messages.
- otBorder
Routing ⚠SetOn Link Prefix - Sets the local on-link prefix.
- otBorder
Routing ⚠SetRoute Info Option Preference - Explicitly sets the preference to use when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
- otBorder
Routing ⚠SetRoute Preference - Explicitly sets the preference of published routes in Network Data.
- otChannel
Manager ⚠GetAuto Channel Selection Enabled - Indicates whether the auto-channel-selection functionality for a network channel is enabled or not.
- otChannel
Manager ⚠GetAuto Channel Selection Interval - Gets the period interval (in seconds) used by auto-channel-selection functionality.
- otChannel
Manager ⚠GetAuto CslChannel Selection Enabled - Indicates whether the auto-csl-channel-selection functionality is enabled or not.
- otChannel
Manager ⚠GetCca Failure Rate Threshold - Gets the CCA failure rate threshold.
- otChannel
Manager ⚠GetDelay - Gets the delay (in seconds) used by Channel Manager for a network channel change.
- otChannel
Manager ⚠GetFavored Channels - Gets the favored channel mask.
- otChannel
Manager ⚠GetRequested Channel - Gets the channel from the last successful call to
otChannelManagerRequestChannelChange()
- otChannel
Manager ⚠GetSupported Channels - Gets the supported channel mask.
- otChannel
Manager ⚠Request Channel Change - Requests a Thread network channel change.
- otChannel
Manager ⚠Request Channel Select - Requests that
ChannelManager
checks and selects a new channel and starts a channel change. - otChannel
Manager ⚠Request CslChannel Select - Requests that
ChannelManager
checks and selects a new CSL channel and starts a CSL channel change. - otChannel
Manager ⚠SetAuto Channel Selection Enabled - Enables or disables the auto-channel-selection functionality for network channel.
- otChannel
Manager ⚠SetAuto Channel Selection Interval - Sets the period interval (in seconds) used by auto-channel-selection functionality.
- otChannel
Manager ⚠SetAuto CslChannel Selection Enabled - Enables or disables the auto-channel-selection functionality for a CSL channel.
- otChannel
Manager ⚠SetCca Failure Rate Threshold - Sets the CCA failure rate threshold.
- otChannel
Manager ⚠SetDelay - Sets the delay (in seconds) used for a network channel change.
- otChannel
Manager ⚠SetFavored Channels - Sets the favored channel mask.
- otChannel
Manager ⚠SetSupported Channels - Sets the supported channel mask.
- otChannel
Monitor ⚠GetChannel Occupancy - Gets the current channel occupancy for a given channel.
- otChannel
Monitor ⚠GetRssi Threshold - Get channel monitoring RSSI threshold in dBm.
- otChannel
Monitor ⚠GetSample Count - Get channel monitoring total number of RSSI samples (per channel).
- otChannel
Monitor ⚠GetSample Interval - Get channel monitoring sample interval in milliseconds.
- otChannel
Monitor ⚠GetSample Window - Get channel monitoring averaging sample window length (number of samples).
- otChannel
Monitor ⚠IsEnabled - Indicates whether the Channel Monitoring operation is enabled and running.
- otChannel
Monitor ⚠SetEnabled - Enables or disables the Channel Monitoring operation.
- otChild
Supervision ⚠GetCheck Failure Counter - Get the value of supervision check timeout failure counter.
- otChild
Supervision ⚠GetCheck Timeout - Gets the supervision check timeout interval (in seconds) on the child.
- otChild
Supervision ⚠GetInterval - Gets the Child Supervision interval (in seconds) on a child.
- otChild
Supervision ⚠Reset Check Failure Counter - Reset the supervision check timeout failure counter to zero.
- otChild
Supervision ⚠SetCheck Timeout - Sets the supervision check timeout interval (in seconds) on the child.
- otChild
Supervision ⚠SetInterval - Sets the child supervision interval (in seconds) on the child.
- otCli
Append ⚠Result - Write error code to the CLI console
- otCli
Init ⚠ - Initialize the CLI module.
- otCli
Input ⚠Line - Is called to feed in a console input line.
- otCli
Output ⚠Bytes - Write a number of bytes to the CLI console as a hex string.
- otCli
Output ⚠Format - Write formatted string to the CLI console
- otCli
Plat ⚠Logv - Callback to write the OpenThread Log to the CLI console
- otCli
SetUser ⚠Commands - Set a user command table.
- otCli
Vendor ⚠SetUser Commands - Callback to allow vendor specific commands to be added to the user command table.
- otCoap
AddBlock ⚠Wise Resource - Adds a block-wise resource to the CoAP server.
- otCoap
AddResource ⚠ - Adds a resource to the CoAP server.
- otCoap
Block ⚠Size From Exponent - Converts a CoAP Block option SZX field to the actual block size
- otCoap
Message ⚠Append Block1 Option - Appends a Block1 option
- otCoap
Message ⚠Append Block2 Option - Appends a Block2 option
- otCoap
Message ⚠Append Content Format Option - 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.
- otCoap
Message ⚠Append MaxAge Option - Appends a Max-Age option.
- otCoap
Message ⚠Append Observe Option - Appends an Observe option.
- otCoap
Message ⚠Append Option - Appends a CoAP option in a header.
- otCoap
Message ⚠Append Proxy UriOption - Appends a Proxy-Uri option.
- otCoap
Message ⚠Append Uint Option - Appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2
- otCoap
Message ⚠Append UriPath Options - Appends a Uri-Path option.
- otCoap
Message ⚠Append UriQuery Option - Appends a single Uri-Query option.
- otCoap
Message ⚠Append UriQuery Options - Appends a Uri-Query option.
- otCoap
Message ⚠Code ToString - Returns the CoAP Code as human readable string.
- otCoap
Message ⚠Generate Token - Sets the Token length and randomizes its value.
- otCoap
Message ⚠GetCode - Returns the Code value.
- otCoap
Message ⚠GetMessage Id - Returns the Message ID value.
- otCoap
Message ⚠GetToken - Returns a pointer to the Token value.
- otCoap
Message ⚠GetToken Length - Returns the Token length.
- otCoap
Message ⚠GetType - Returns the Type value.
- otCoap
Message ⚠Init - Initializes the CoAP header.
- otCoap
Message ⚠Init Response - Initializes a response message.
- otCoap
Message ⚠SetCode - Sets the Code value.
- otCoap
Message ⚠SetPayload Marker - Adds Payload Marker indicating beginning of the payload to the CoAP header.
- otCoap
Message ⚠SetToken - Sets the Token value and length in a header.
- otCoap
NewMessage ⚠ - Creates a new CoAP message.
- otCoap
Option ⚠Iterator GetFirst Option - Returns a pointer to the first option.
- otCoap
Option ⚠Iterator GetFirst Option Matching - Returns a pointer to the first option matching the specified option number.
- otCoap
Option ⚠Iterator GetNext Option - Returns a pointer to the next option.
- otCoap
Option ⚠Iterator GetNext Option Matching - Returns a pointer to the next option matching the specified option number.
- otCoap
Option ⚠Iterator GetOption Uint Value - 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
- otCoap
Option ⚠Iterator GetOption Value - Fills current option value into @p aValue.
- otCoap
Option ⚠Iterator Init - Initialises an iterator for the options in the given message.
- otCoap
Remove ⚠Block Wise Resource - Removes a block-wise resource from the CoAP server.
- otCoap
Remove ⚠Resource - Removes a resource from the CoAP server.
- otCoap
Secure ⚠AddBlock Wise Resource - Adds a block-wise resource to the CoAP Secure server.
- otCoap
Secure ⚠AddResource - Adds a resource to the CoAP Secure server.
- otCoap
Secure ⚠Connect - Initializes DTLS session with a peer.
- otCoap
Secure ⚠Disconnect - Stops the DTLS connection.
- otCoap
Secure ⚠GetPeer Certificate Base64 - Returns the peer x509 certificate base64 encoded.
- otCoap
Secure ⚠IsClosed - Indicates whether or not the DTLS session is closed.
- otCoap
Secure ⚠IsConnected - Indicates whether or not the DTLS session is connected.
- otCoap
Secure ⚠IsConnection Active - Indicates whether or not the DTLS session is active.
- otCoap
Secure ⚠Remove Block Wise Resource - Removes a block-wise resource from the CoAP Secure server.
- otCoap
Secure ⚠Remove Resource - Removes a resource from the CoAP Secure server.
- otCoap
Secure ⚠Send Request - Sends a CoAP request over secure DTLS connection.
- otCoap
Secure ⚠Send Request Block Wise - Sends a CoAP request block-wise over secure DTLS connection.
- otCoap
Secure ⚠Send Response - Sends a CoAP response from the CoAP Secure server.
- otCoap
Secure ⚠Send Response Block Wise - Sends a CoAP response block-wise from the CoAP Secure server.
- otCoap
Secure ⚠SetCa Certificate Chain - Sets the trusted top level CAs. It is needed for validating the certificate of the peer.
- otCoap
Secure ⚠SetCertificate - Sets the local device’s X509 certificate with corresponding private key for DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
- otCoap
Secure ⚠SetClient Connect Event Callback - Sets the connect event callback to indicate when a Client connection to the CoAP Secure server has changed.
- otCoap
Secure ⚠SetDefault Handler - Sets the default handler for unhandled CoAP Secure requests.
- otCoap
Secure ⚠SetPsk - Sets the Pre-Shared Key (PSK) and cipher suite DTLS_PSK_WITH_AES_128_CCM_8.
- otCoap
Secure ⚠SetSsl Auth Mode - Sets the authentication mode for the coap secure connection.
- otCoap
Secure ⚠Start - Starts the CoAP Secure service.
- otCoap
Secure ⚠Start With MaxConn Attempts - Starts the CoAP secure service and sets the maximum number of allowed connection attempts before stopping the agent automatically.
- otCoap
Secure ⚠Stop - Stops the CoAP Secure server.
- otCoap
Send ⚠Request Block Wise With Parameters - Sends a CoAP request block-wise with custom transmission parameters.
- otCoap
Send ⚠Request With Parameters - Sends a CoAP request with custom transmission parameters.
- otCoap
Send ⚠Response Block Wise With Parameters - Sends a CoAP response block-wise from the server with custom transmission parameters.
- otCoap
Send ⚠Response With Parameters - Sends a CoAP response from the server with custom transmission parameters.
- otCoap
SetDefault ⚠Handler - Sets the default handler for unhandled CoAP requests.
- otCoap
Start ⚠ - Starts the CoAP server.
- otCoap
Stop ⚠ - Stops the CoAP server.
- otCommissioner
AddJoiner ⚠ - Adds a Joiner entry.
- otCommissioner
AddJoiner ⚠With Discerner - Adds a Joiner entry with a given Joiner Discerner value.
- otCommissioner
Announce ⚠Begin - Sends an Announce Begin message.
- otCommissioner
Energy ⚠Scan - Sends an Energy Scan Query message.
- otCommissioner
GetId ⚠ - Returns the Commissioner Id.
- otCommissioner
GetNext ⚠Joiner Info - Get joiner info at aIterator position.
- otCommissioner
GetProvisioning ⚠Url - Gets the Provisioning URL.
- otCommissioner
GetSession ⚠Id - Returns the Commissioner Session ID.
- otCommissioner
GetState ⚠ - Returns the Commissioner State.
- otCommissioner
PanId ⚠Query - Sends a PAN ID Query message.
- otCommissioner
Remove ⚠Joiner - Removes a Joiner entry.
- otCommissioner
Remove ⚠Joiner With Discerner - Removes a Joiner entry.
- otCommissioner
Send ⚠Mgmt Get - Sends MGMT_COMMISSIONER_GET.
- otCommissioner
Send ⚠Mgmt Set - Sends MGMT_COMMISSIONER_SET.
- otCommissioner
SetId ⚠ - Sets the Commissioner Id.
- otCommissioner
SetProvisioning ⚠Url - Sets the Provisioning URL.
- otCommissioner
Start ⚠ - Enables the Thread Commissioner role.
- otCommissioner
Stop ⚠ - Disables the Thread Commissioner role.
- otConvert
Duration ⚠InSeconds ToString - Converts an
uint32_t
duration (in seconds) to a human-readable string. - otDataset
Convert ⚠ToTlvs - Converts a given Operational Dataset to
otOperationalDatasetTlvs
. - otDataset
Create ⚠NewNetwork - For FTD only, creates a new Operational Dataset to use when forming a new network.
- otDataset
Generate ⚠Pskc - Generates PSKc from a given pass-phrase, network name, and extended PAN ID.
- otDataset
GetActive ⚠ - Gets the Active Operational Dataset.
- otDataset
GetActive ⚠Tlvs - Gets the Active Operational Dataset.
- otDataset
GetDelay ⚠Timer Minimal - For FTD only, gets a minimal delay timer.
- otDataset
GetPending ⚠ - Gets the Pending Operational Dataset.
- otDataset
GetPending ⚠Tlvs - Gets the Pending Operational Dataset.
- otDataset
IsCommissioned ⚠ - Indicates whether a valid network is present in the Active Operational Dataset or not.
- otDataset
Parse ⚠Tlvs - Parses an Operational Dataset from a given
otOperationalDatasetTlvs
. - otDataset
Send ⚠Mgmt Active Get - Sends MGMT_ACTIVE_GET.
- otDataset
Send ⚠Mgmt Active Set - Sends MGMT_ACTIVE_SET.
- otDataset
Send ⚠Mgmt Pending Get - Sends MGMT_PENDING_GET.
- otDataset
Send ⚠Mgmt Pending Set - Sends MGMT_PENDING_SET.
- otDataset
SetActive ⚠ - Sets the Active Operational Dataset.
- otDataset
SetActive ⚠Tlvs - Sets the Active Operational Dataset.
- otDataset
SetDelay ⚠Timer Minimal - For FTD only, sets a minimal delay timer.
- otDataset
SetPending ⚠ - Sets the Pending Operational Dataset.
- otDataset
SetPending ⚠Tlvs - Sets the Pending Operational Dataset.
- otDataset
Update ⚠Tlvs - Updates a given Operational Dataset.
- otDataset
Updater ⚠Cancel Update - Cancels an ongoing (if any) Operational Dataset update request.
- otDataset
Updater ⚠IsUpdate Ongoing - Indicates whether there is an ongoing Operation Dataset update request.
- otDataset
Updater ⚠Request Update - Requests an update to Operational Dataset.
- otDiag
IsEnabled ⚠ - Indicates whether or not the factory diagnostics mode is enabled.
- otDiag
Process ⚠Cmd - Processes a factory diagnostics command line.
- otDiag
Process ⚠CmdLine - Processes a factory diagnostics command line.
- otDiag
SetOutput ⚠Callback - Sets the diag output callback.
- otDns
Address ⚠Response GetAddress - Gets an IPv6 address associated with an address resolution DNS response.
- otDns
Address ⚠Response GetHost Name - Gets the full host name associated with an address resolution DNS response.
- otDns
Browse ⚠Response GetHost Address - Gets the host IPv6 address from a DNS browse (service instance enumeration) response.
- otDns
Browse ⚠Response GetService Info - Gets info for a service instance from a DNS browse (service instance enumeration) response.
- otDns
Browse ⚠Response GetService Instance - Gets a service instance associated with a DNS browse (service instance enumeration) response.
- otDns
Browse ⚠Response GetService Name - Gets the service name associated with a DNS browse (service instance enumeration) response.
- otDns
Client ⚠Browse - Sends a DNS browse (service instance enumeration) query for a given service name.
- otDns
Client ⚠GetDefault Config - Gets the current default query config used by DNS client.
- otDns
Client ⚠Resolve Address - Sends an address resolution DNS query for AAAA (IPv6) record(s) for a given host name.
- otDns
Client ⚠Resolve Ip4Address - Sends an address resolution DNS query for A (IPv4) record(s) for a given host name.
- otDns
Client ⚠Resolve Service - Starts a DNS service instance resolution for a given service instance.
- otDns
Client ⚠Resolve Service AndHost Address - 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.
- otDns
Client ⚠SetDefault Config - Sets the default query config on DNS client.
- otDns
Encode ⚠TxtData - Encodes a given list of TXT record entries (key/value pairs) into TXT data (following format specified by RFC 6763).
- otDns
GetNext ⚠TxtEntry - Parses the TXT data from an iterator and gets the next TXT record entry (key/value pair).
- otDns
Init ⚠TxtEntry Iterator - Initializes a TXT record iterator.
- otDns
IsName ⚠Compression Enabled - Indicates whether the “DNS name compression” mode is enabled or not.
- otDns
Service ⚠Response GetHost Address - Gets the host IPv6 address from a DNS service instance resolution response.
- otDns
Service ⚠Response GetService Info - Gets info for a service instance from a DNS service instance resolution response.
- otDns
Service ⚠Response GetService Name - Gets the service instance name associated with a DNS service instance resolution response.
- otDns
SetName ⚠Compression Enabled - Enables/disables the “DNS name compression” mode.
- otDnssd
GetCounters ⚠ - Returns the counters of the DNS-SD server.
- otDnssd
GetNext ⚠Query - Acquires the next query in the DNS-SD server.
- otDnssd
GetQuery ⚠Type AndName - Acquires the DNS-SD query type and name for a specific query.
- otDnssd
Query ⚠Handle Discovered Host - Notifies a discovered host.
- otDnssd
Query ⚠Handle Discovered Service Instance - Notifies a discovered service instance.
- otDnssd
Query ⚠SetCallbacks - Sets DNS-SD server query callbacks.
- otDnssd
Upstream ⚠Query IsEnabled - Returns whether the DNSSD server will forward DNS queries to the platform DNS upstream API.
- otDnssd
Upstream ⚠Query SetEnabled - Enable or disable forwarding DNS queries to platform DNS upstream API.
- otDump
Crit ⚠Plat - Generates a memory dump at critical log level.
- otDump
Debg ⚠Plat - Generates a memory dump at debug log level.
- otDump
Info ⚠Plat - Generates a memory dump at info log level.
- otDump
Note ⚠Plat - Generates a memory dump at note log level.
- otDump
Warn ⚠Plat - Generates a memory dump at warning log level.
- otGet
Radio ⚠Version String - Gets the OpenThread radio version string.
- otGet
Version ⚠String - Gets the OpenThread version string.
- otHeapC
Alloc ⚠ - @note This API is deprecated and use of it is discouraged.
- otHeap
Free ⚠ - @note This API is deprecated and use of it is discouraged.
- otIcmp6
GetEcho ⚠Mode - Indicates whether or not ICMPv6 Echo processing is enabled.
- otIcmp6
Register ⚠Handler - Registers a handler to provide received ICMPv6 messages.
- otIcmp6
Send ⚠Echo Request - Sends an ICMPv6 Echo Request via the Thread interface.
- otIcmp6
SetEcho ⚠Mode - Sets whether or not ICMPv6 Echo processing is enabled.
- otInstance
Erase ⚠Persistent Info - 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. - otInstance
Factory ⚠Reset - Deletes all the settings stored on non-volatile memory, and then triggers a platform reset.
- otInstance
Finalize ⚠ - Disables the OpenThread library.
- otInstance
GetId ⚠ - Gets the instance identifier.
- otInstance
GetUptime ⚠ - Returns the current instance uptime (in msec).
- otInstance
GetUptime ⚠AsString - Returns the current instance uptime as a human-readable string.
- otInstance
Init ⚠ - Initializes the OpenThread library.
- otInstance
Init ⚠Multiple - Initializes the OpenThread instance.
- otInstance
Init ⚠Single - Initializes the static single instance of the OpenThread library.
- otInstance
IsInitialized ⚠ - Indicates whether or not the instance is valid/initialized.
- otInstance
Reset ⚠ - Triggers a platform reset.
- otInstance
Reset ⚠Radio Stack - Resets the internal states of the OpenThread radio stack.
- otInstance
Reset ⚠ToBootloader - Triggers a platform reset to bootloader mode, if supported.
- otIp4
Address ⚠From String - Converts a human-readable IPv4 address string into a binary representation.
- otIp4
Address ⚠ToString - Converts the address to a string.
- otIp4
Cidr ⚠From String - Converts a human-readable IPv4 CIDR string into a binary representation.
- otIp4
Cidr ⚠ToString - Converts the IPv4 CIDR to a string.
- otIp4
Extract ⚠From Ip6Address - Set @p aIp4Address by performing NAT64 address translation from @p aIp6Address as specified in RFC 6052.
- otIp4
From ⚠Ip4Mapped Ip6Address - Extracts the IPv4 address from a given IPv4-mapped IPv6 address.
- otIp4
IsAddress ⚠Equal - Test if two IPv4 addresses are the same.
- otIp4
NewMessage ⚠ - Allocate a new message buffer for sending an IPv4 message to the NAT64 translator.
- otIp4
ToIp4 ⚠Mapped Ip6Address - Converts a given IP4 address to an IPv6 address following the IPv4-mapped IPv6 address format.
- otIp6
AddUnicast ⚠Address - Adds a Network Interface Address to the Thread interface.
- otIp6
AddUnsecure ⚠Port - Adds a port to the allowed unsecured port list.
- otIp6
Address ⚠From String - Converts a human-readable IPv6 address string into a binary representation.
- otIp6
Address ⚠ToString - Converts a given IPv6 address to a human-readable string.
- otIp6
ArePrefixes ⚠Equal - Test if two IPv6 prefixes are the same.
- otIp6
GetBorder ⚠Routing Counters - Gets the Border Routing counters.
- otIp6
GetMulticast ⚠Addresses - Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
- otIp6
GetPrefix ⚠ - Gets a prefix with @p aLength from @p aAddress.
- otIp6
GetUnicast ⚠Addresses - Gets the list of IPv6 addresses assigned to the Thread interface.
- otIp6
GetUnsecure ⚠Ports - Returns a pointer to the unsecure port list.
- otIp6
HasUnicast ⚠Address - Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
- otIp6
IsAddress ⚠Equal - Test if two IPv6 addresses are the same.
- otIp6
IsAddress ⚠Unspecified - Indicates whether or not a given IPv6 address is the Unspecified Address.
- otIp6
IsEnabled ⚠ - Indicates whether or not the IPv6 interface is up.
- otIp6
IsReceive ⚠Filter Enabled - Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
- otIp6
IsSlaac ⚠Enabled - Indicates whether the SLAAC module is enabled or not.
- otIp6
NewMessage ⚠ - Allocate a new message buffer for sending an IPv6 message.
- otIp6
NewMessage ⚠From Buffer - Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message.
- otIp6
Prefix ⚠From String - Converts a human-readable IPv6 prefix string into a binary representation.
- otIp6
Prefix ⚠Match - Returns the prefix match length (bits) for two IPv6 addresses.
- otIp6
Prefix ⚠ToString - Converts a given IPv6 prefix to a human-readable string.
- otIp6
Proto ⚠ToString - Converts a given IP protocol number to a human-readable string.
- otIp6
Register ⚠Multicast Listeners - Registers Multicast Listeners to Primary Backbone Router.
- otIp6
Remove ⚠AllUnsecure Ports - Removes all ports from the allowed unsecure port list.
- otIp6
Remove ⚠Unicast Address - Removes a Network Interface Address from the Thread interface.
- otIp6
Remove ⚠Unsecure Port - Removes a port from the allowed unsecure port list.
- otIp6
Reset ⚠Border Routing Counters - Resets the Border Routing counters.
- otIp6
Select ⚠Source Address - Perform OpenThread source address selection.
- otIp6
Send ⚠ - Sends an IPv6 datagram via the Thread interface.
- otIp6
SetAddress ⚠Callback - Registers a callback to notify internal IPv6 address changes.
- otIp6
SetEnabled ⚠ - Brings the IPv6 interface up or down.
- otIp6
SetMesh ⚠Local Iid - Sets the Mesh Local IID (for test purpose).
- otIp6
SetReceive ⚠Callback - Registers a callback to provide received IPv6 datagrams.
- otIp6
SetReceive ⚠Filter Enabled - Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
- otIp6
SetSlaac ⚠Enabled - Enables/disables the SLAAC module.
- otIp6
SetSlaac ⚠Prefix Filter - Sets the SLAAC module filter handler.
- otIp6
Sock ⚠Addr ToString - Converts a given IPv6 socket address to a human-readable string.
- otIp6
Subscribe ⚠Multicast Address - Subscribes the Thread interface to a Network Interface Multicast Address.
- otIp6
Unsubscribe ⚠Multicast Address - Unsubscribes the Thread interface to a Network Interface Multicast Address.
- otJam
Detection ⚠GetBusy Period - Get the Jam Detection Busy Period (in seconds)
- otJam
Detection ⚠GetHistory Bitmap - Get the current history bitmap.
- otJam
Detection ⚠GetRssi Threshold - Get the Jam Detection RSSI Threshold (in dBm).
- otJam
Detection ⚠GetState - Get the Jam Detection State
- otJam
Detection ⚠GetWindow - Get the Jam Detection Detection Window (in seconds).
- otJam
Detection ⚠IsEnabled - Get the Jam Detection Status (enabled/disabled)
- otJam
Detection ⚠SetBusy Period - Set the Jam Detection Busy Period (in seconds).
- otJam
Detection ⚠SetRssi Threshold - Set the Jam Detection RSSI Threshold (in dBm).
- otJam
Detection ⚠SetWindow - Set the Jam Detection Detection Window (in seconds).
- otJam
Detection ⚠Start - Start the jamming detection.
- otJam
Detection ⚠Stop - Stop the jamming detection.
- otJoiner
GetDiscerner ⚠ - Gets the Joiner Discerner. For more information, refer to #otJoinerSetDiscerner.
- otJoiner
GetId ⚠ - Gets the Joiner ID.
- otJoiner
GetState ⚠ - Gets the Joiner State.
- otJoiner
SetDiscerner ⚠ - Sets the Joiner Discerner.
- otJoiner
Start ⚠ - Enables the Thread Joiner role.
- otJoiner
State ⚠ToString - Converts a given joiner state enumeration value to a human-readable string.
- otJoiner
Stop ⚠ - Disables the Thread Joiner role.
- otLink
Active ⚠Scan - Starts an IEEE 802.15.4 Active Scan
- otLink
Convert ⚠Link Quality ToRss - Converts link quality to typical received signal strength.
- otLink
Convert ⚠RssTo Link Quality - Converts received signal strength to link quality.
- otLink
Energy ⚠Scan - Starts an IEEE 802.15.4 Energy Scan
- otLink
Filter ⚠AddAddress - Adds an Extended Address to MAC filter.
- otLink
Filter ⚠AddRss In - Adds the specified Extended Address to the
RssIn
list (or modifies an existing address in theRssIn
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 theaddress allowlist/denylist
filter to set therss
. @note TheRssIn
list contains Extended Addresses whoserss
or link quality indicator (lqi
) values have been set to be different from the defaults. - otLink
Filter ⚠Clear Addresses - Clears all the Extended Addresses from MAC filter.
- otLink
Filter ⚠Clear AllRss In - Clears all the received signal strength (
rss
) and link quality indicator (lqi
) entries (including defaults) from theRssIn
list. Performing this action means that all Extended Addresses will use the on-air signal. - otLink
Filter ⚠Clear Default RssIn - Clears any previously set default received signal strength (in dBm) on MAC Filter.
- otLink
Filter ⚠GetAddress Mode - Gets the address mode of MAC filter.
- otLink
Filter ⚠GetNext Address - Gets an in-use address filter entry.
- otLink
Filter ⚠GetNext RssIn - Gets an in-use RssIn filter entry.
- otLink
Filter ⚠Remove Address - Removes an Extended Address from MAC filter.
- otLink
Filter ⚠Remove RssIn - Removes the specified Extended Address from the
RssIn
list. Once removed from theRssIn
list, this MAC address will instead use the defaultrss
andlqi
settings, assuming defaults have been set. (If no defaults have been set, the over-air signal is used.) - otLink
Filter ⚠SetAddress Mode - Sets the address mode of MAC filter.
- otLink
Filter ⚠SetDefault RssIn - Sets the default received signal strength (in dBm) on MAC Filter.
- otLink
GetAlternate ⚠Short Address - Get the IEEE 802.15.4 alternate short address.
- otLink
GetCca ⚠Failure Rate - Returns the current CCA (Clear Channel Assessment) failure rate.
- otLink
GetChannel ⚠ - Get the IEEE 802.15.4 channel.
- otLink
GetCounters ⚠ - Get the MAC layer counters.
- otLink
GetCsl ⚠Channel - Gets the CSL channel.
- otLink
GetCsl ⚠Period - Gets the CSL period in microseconds
- otLink
GetCsl ⚠Timeout - Gets the CSL timeout.
- otLink
GetExtended ⚠Address - Gets the IEEE 802.15.4 Extended Address.
- otLink
GetFactory ⚠Assigned Ieee Eui64 - Get the factory-assigned IEEE EUI-64.
- otLink
GetFrame ⚠Counter - Gets the current MAC frame counter value.
- otLink
GetMax ⚠Frame Retries Direct - Returns the maximum number of frame retries during direct transmission.
- otLink
GetMax ⚠Frame Retries Indirect - Returns the maximum number of frame retries during indirect transmission.
- otLink
GetPan ⚠Id - Get the IEEE 802.15.4 PAN ID.
- otLink
GetPoll ⚠Period - Get the data poll period of sleepy end device.
- otLink
GetRegion ⚠ - Get the region code.
- otLink
GetShort ⚠Address - Get the IEEE 802.15.4 Short Address.
- otLink
GetSupported ⚠Channel Mask - Get the supported channel mask of MAC layer.
- otLink
GetTx ⚠Direct Retry Success Histogram - Gets histogram of retries for a single direct packet until success.
- otLink
GetTx ⚠Indirect Retry Success Histogram - Gets histogram of retries for a single indirect packet until success.
- otLink
GetWakeup ⚠Channel - Gets the Wake-up channel.
- otLink
GetWakeup ⚠Listen Parameters - Get the wake-up listen parameters.
- otLink
IsActive ⚠Scan InProgress - Indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
- otLink
IsCsl ⚠Enabled - Indicates whether or not CSL is enabled.
- otLink
IsCsl ⚠Supported - Indicates whether the device is connected to a parent which supports CSL.
- otLink
IsEnabled ⚠ - Indicates whether or not the link layer is enabled.
- otLink
IsEnergy ⚠Scan InProgress - Indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
- otLink
IsIn ⚠Transmit State - Indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
- otLink
IsPromiscuous ⚠ - Indicates whether or not promiscuous mode is enabled at the link layer.
- otLink
IsRadio ⚠Filter Enabled - Indicates whether the IEEE 802.15.4 radio filter is enabled or not.
- otLink
IsWakeup ⚠Listen Enabled - Returns whether listening for wake-up frames is enabled.
- otLink
Metrics ⚠Config EnhAck Probing - Sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing. This functionality requires OT_LINK_METRICS_INITIATOR feature enabled.
- otLink
Metrics ⚠Config Forward Tracking Series - Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.
- otLink
Metrics ⚠Manager GetMetrics Value ByExt Addr - Get Link Metrics data of a neighbor by its extended address.
- otLink
Metrics ⚠Manager IsEnabled - If Link Metrics Manager is enabled.
- otLink
Metrics ⚠Manager SetEnabled - Enable or disable Link Metrics Manager.
- otLink
Metrics ⚠Query - Sends an MLE Data Request to query Link Metrics.
- otLink
Metrics ⚠Send Link Probe - Sends an MLE Link Probe message.
- otLink
RawEnergy ⚠Scan - Begins the energy scan sequence on the radio.
- otLink
RawGet ⚠Caps - Get the radio capabilities.
- otLink
RawGet ⚠Promiscuous - Gets the status of promiscuous mode.
- otLink
RawGet ⚠Radio Time - Get current platform time (64bits width) of the radio chip.
- otLink
RawGet ⚠Rssi - Get the most recent RSSI measurement.
- otLink
RawGet ⚠Transmit Buffer - The radio transitions from Transmit to Receive. Returns a pointer to the transmit buffer.
- otLink
RawIs ⚠Enabled - Indicates whether or not the raw link-layer is enabled.
- otLink
RawReceive ⚠ - Transitioning the radio from Sleep to Receive. Turn on the radio.
- otLink
RawSet ⚠Alternate Short Address - Set the alternate short address.
- otLink
RawSet ⚠MacFrame Counter - Sets the current MAC frame counter value.
- otLink
RawSet ⚠MacFrame Counter IfLarger - Sets the current MAC frame counter value only if the new value is larger than the current one.
- otLink
RawSet ⚠MacKey - Update MAC keys and key index.
- otLink
RawSet ⚠Promiscuous - Enables or disables promiscuous mode.
- otLink
RawSet ⚠Receive Done - Enables/disables the raw link-layer.
- otLink
RawSet ⚠Short Address - Set the Short Address for address filtering.
- otLink
RawSleep ⚠ - Transition the radio from Receive to Sleep. Turn off the radio.
- otLink
RawSrc ⚠Match AddExt Entry - Adding extended address to the source match table.
- otLink
RawSrc ⚠Match AddShort Entry - Adding short address to the source match table.
- otLink
RawSrc ⚠Match Clear ExtEntries - Removing all the extended addresses from the source match table.
- otLink
RawSrc ⚠Match Clear ExtEntry - Removing extended address to the source match table of the radio.
- otLink
RawSrc ⚠Match Clear Short Entries - Removing all the short addresses from the source match table.
- otLink
RawSrc ⚠Match Clear Short Entry - Removing short address to the source match table.
- otLink
RawSrc ⚠Match Enable - Enable/Disable source match for frame pending.
- otLink
RawTransmit ⚠ - Begins the transmit sequence on the radio.
- otLink
Reset ⚠Counters - Resets the MAC layer counters.
- otLink
Reset ⚠TxRetry Success Histogram - Clears histogram statistics for direct and indirect transmissions.
- otLink
Send ⚠Data Request - Enqueues an IEEE 802.15.4 Data Request message for transmission.
- otLink
Send ⚠Empty Data - Instructs the device to send an empty IEEE 802.15.4 data frame.
- otLink
SetChannel ⚠ - Set the IEEE 802.15.4 channel
- otLink
SetCsl ⚠Channel - Sets the CSL channel.
- otLink
SetCsl ⚠Period - Sets the CSL period in microseconds. Disable CSL by setting this parameter to
0
. - otLink
SetCsl ⚠Timeout - Sets the CSL timeout in seconds.
- otLink
SetEnabled ⚠ - Enables or disables the link layer.
- otLink
SetExtended ⚠Address - Sets the IEEE 802.15.4 Extended Address.
- otLink
SetMax ⚠Frame Retries Direct - Sets the maximum number of frame retries during direct transmission.
- otLink
SetMax ⚠Frame Retries Indirect - Sets the maximum number of frame retries during indirect transmission.
- otLink
SetPan ⚠Id - Set the IEEE 802.15.4 PAN ID.
- otLink
SetPcap ⚠Callback - Registers a callback to provide received raw IEEE 802.15.4 frames.
- otLink
SetPoll ⚠Period - Set/clear user-specified/external data poll period for sleepy end device.
- otLink
SetPromiscuous ⚠ - Enables or disables the link layer promiscuous mode.
- otLink
SetRadio ⚠Filter Enabled - Enables/disables IEEE 802.15.4 radio filter mode.
- otLink
SetRegion ⚠ - Sets the region code.
- otLink
SetRx ⚠OnWhen Idle - Sets the rx-on-when-idle state.
- otLink
SetSupported ⚠Channel Mask - Set the supported channel mask of MAC layer.
- otLink
SetWake ⚠UpListen Enabled - Enables or disables listening for wake-up frames.
- otLink
SetWakeup ⚠Channel - Sets the Wake-up channel.
- otLink
SetWakeup ⚠Listen Parameters - Set the wake-up listen parameters.
- otLog
Cli ⚠ - Emits a log message at a given log level.
- otLog
Crit ⚠Plat - Emits a log message at critical log level.
- otLog
Debg ⚠Plat - Emits a log message at debug log level.
- otLog
Generate ⚠Next HexDump Line - Generates the next hex dump line.
- otLog
Info ⚠Plat - Emits a log message at info log level.
- otLog
Note ⚠Plat - Emits a log message at note log level.
- otLog
Plat ⚠ - Emits a log message at given log level using a platform module name.
- otLog
Plat ⚠Args - Emits a log message at given log level using a platform module name.
- otLog
Warn ⚠Plat - Emits a log message at warning log level.
- otLogging
GetLevel ⚠ - Returns the current log level.
- otLogging
SetLevel ⚠ - Sets the log level.
- otMessage
Append ⚠ - Append bytes to a message.
- otMessage
Free ⚠ - Free an allocated message buffer.
- otMessage
GetBuffer ⚠Info - Get the Message Buffer information.
- otMessage
GetLength ⚠ - Get the message length in bytes.
- otMessage
GetOffset ⚠ - Get the message offset in bytes.
- otMessage
GetOrigin ⚠ - Gets the message origin.
- otMessage
GetRss ⚠ - Returns the average RSS (received signal strength) associated with the message.
- otMessage
GetThread ⚠Link Info - Retrieves the link-specific information for a message received over Thread radio.
- otMessage
IsLink ⚠Security Enabled - Indicates whether or not link security is enabled for the message.
- otMessage
IsLoopback ⚠ToHost Allowed - Indicates whether or not the message is allowed to be looped back to host.
- otMessage
IsMulticast ⚠Loop Enabled - Indicates whether the given message may be looped back in a case of a multicast destination address.
- otMessage
Queue ⚠Dequeue - Removes a message from the given message queue.
- otMessage
Queue ⚠Enqueue - Adds a message to the end of the given message queue.
- otMessage
Queue ⚠Enqueue AtHead - Adds a message at the head/front of the given message queue.
- otMessage
Queue ⚠GetHead - Returns a pointer to the message at the head of the queue.
- otMessage
Queue ⚠GetNext - Returns a pointer to the next message in the queue by iterating forward (from head to tail).
- otMessage
Queue ⚠Init - Initialize the message queue.
- otMessage
Read ⚠ - Read bytes from a message.
- otMessage
Reset ⚠Buffer Info - Reset the Message Buffer information counter tracking the maximum number buffers in use at the same time.
- otMessage
SetDirect ⚠Transmission - Sets/forces the message to be forwarded using direct transmission.
Default setting for a new message is
false
. - otMessage
SetLength ⚠ - Set the message length in bytes.
- otMessage
SetLoopback ⚠ToHost Allowed - Sets whether or not the message is allowed to be looped back to host.
- otMessage
SetMulticast ⚠Loop Enabled - Controls whether the given message may be looped back in a case of a multicast destination address.
- otMessage
SetOffset ⚠ - Set the message offset in bytes.
- otMessage
SetOrigin ⚠ - Sets the message origin.
- otMessage
Write ⚠ - Write bytes to a message.
- otMulti
Radio ⚠GetNeighbor Info - Gets the multi radio link information associated with a neighbor with a given Extended Address.
- otNat64
Clear ⚠Ip4Cidr - Clears the CIDR used when setting the source address of the outgoing translated IPv4 packets.
- otNat64
GetCidr ⚠ - Gets the IPv4 CIDR configured in the NAT64 translator.
- otNat64
GetCounters ⚠ - Gets NAT64 translator counters.
- otNat64
GetError ⚠Counters - Gets the NAT64 translator error counters.
- otNat64
GetNext ⚠Address Mapping - Gets the next AddressMapping info (using an iterator).
- otNat64
GetPrefix ⚠Manager State - Gets the state of NAT64 prefix manager.
- otNat64
GetTranslator ⚠State - Gets the state of NAT64 translator.
- otNat64
Init ⚠Address Mapping Iterator - Initializes an
otNat64AddressMappingIterator
. - otNat64
Send ⚠ - Translates an IPv4 datagram to an IPv6 datagram and sends via the Thread interface.
- otNat64
SetEnabled ⚠ - Enable or disable NAT64 functions.
- otNat64
SetIp4 ⚠Cidr - Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.
- otNat64
SetReceive ⚠Ip4Callback - Registers a callback to provide received IPv4 datagrams.
- otNat64
Synthesize ⚠Ip6Address - Sets the IPv6 address by performing NAT64 address translation from the preferred NAT64 prefix and the given IPv4 address as specified in RFC 6052.
- otNcp
Hdlc ⚠Init - Initialize the NCP based on HDLC framing.
- otNcp
Hdlc ⚠Init Multi - Initialize the NCP based on HDLC framing.
- otNcp
Hdlc ⚠Receive - Is called after HDLC encoded NCP data received.
- otNcp
Hdlc ⚠Send Done - Is called after NCP send finished.
- otNcp
Plat ⚠Logv - Writes OpenThread Log using
otNcpStreamWrite
. - otNcp
Register ⚠Peek Poke Delegates - Registers peek/poke delegate functions with NCP module.
- otNcp
SpiInit ⚠ - Initialize the NCP based on SPI framing.
- otNcp
Stream ⚠Write - @brief Send data to the host via a specific stream.
- otNet
Data ⚠Contains OmrPrefix - Check whether a given Prefix can act as a valid OMR prefix and also the Leader’s Network Data contains this prefix.
- otNet
Data ⚠Get - Provide full or stable copy of the Partition’s Thread Network Data.
- otNet
Data ⚠GetCommissioning Dataset - Gets the Commissioning Dataset from the partition’s Network Data.
- otNet
Data ⚠GetLength - Get the current length (number of bytes) of Partition’s Thread Network Data.
- otNet
Data ⚠GetMax Length - Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to
otNetDataResetMaxLength()
. - otNet
Data ⚠GetNext Lowpan Context Info - Get the next 6LoWPAN Context ID info in the partition’s Network Data.
- otNet
Data ⚠GetNext OnMesh Prefix - Get the next On Mesh Prefix in the partition’s Network Data.
- otNet
Data ⚠GetNext Route - Get the next external route in the partition’s Network Data.
- otNet
Data ⚠GetNext Service - Get the next service in the partition’s Network Data.
- otNet
Data ⚠GetStable Version - Get the Stable Network Data Version.
- otNet
Data ⚠GetVersion - Get the Network Data Version.
- otNet
Data ⚠Reset MaxLength - Reset the tracked maximum length of the Thread Network Data.
- otNet
Data ⚠Steering Data Check Joiner - Check if the steering data includes a Joiner.
- otNet
Data ⚠Steering Data Check Joiner With Discerner - Check if the steering data includes a Joiner with a given discerner value.
- otNetwork
Name ⚠From String - Sets an
otNetworkName
instance from a given null terminated C string. - otNetwork
Time ⚠Get - Get the Thread network time.
- otNetwork
Time ⚠GetSync Period - Get the time synchronization period.
- otNetwork
Time ⚠GetXtal Threshold - Get the time synchronization XTAL accuracy threshold for Router.
- otNetwork
Time ⚠SetSync Period - Set the time synchronization period.
- otNetwork
Time ⚠SetXtal Threshold - Set the time synchronization XTAL accuracy threshold for Router-Capable device.
- otNetwork
Time ⚠Sync SetCallback - Set a callback to be called when a network time sync or status change occurs
- otPing
Sender ⚠Ping - Starts a ping.
- otPing
Sender ⚠Stop - Stops an ongoing ping.
- otPlat
Alarm ⚠Micro Fired - Signal that the alarm has fired.
- otPlat
Alarm ⚠Micro GetNow - Get the current time.
- otPlat
Alarm ⚠Micro Start At - Set the alarm to fire at @p aDt microseconds after @p aT0.
- otPlat
Alarm ⚠Micro Stop - Stop the alarm.
- otPlat
Alarm ⚠Milli Fired - Signal that the alarm has fired.
- otPlat
Alarm ⚠Milli GetNow - Get the current time.
- otPlat
Alarm ⚠Milli Start At - Set the alarm to fire at @p aDt milliseconds after @p aT0.
- otPlat
Alarm ⚠Milli Stop - Stop the alarm.
- otPlat
Assert ⚠Fail - Provides a platform specific implementation for assert.
- otPlat
Border ⚠Routing Process Dhcp6 PdPrefix - 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.
- otPlat
Border ⚠Routing Process Icmp6 Ra - Handles ICMP6 RA messages received on the Thread interface on the platform.
- otPlatC
Alloc ⚠ - 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:
- otPlat
Crypto ⚠AesEncrypt - Encrypt the given data.
- otPlat
Crypto ⚠AesFree - Free the AES context.
- otPlat
Crypto ⚠AesInit - Initialise the AES operation.
- otPlat
Crypto ⚠AesSet Key - Set the key for AES operation.
- otPlat
Crypto ⚠Destroy Key - Destroy a key stored in PSA ITS.
- otPlat
Crypto ⚠Ecdsa Export Public Key - Get the associated public key from the key reference passed.
- otPlat
Crypto ⚠Ecdsa Generate AndImport Key - Generate and import a new ECDSA key-pair at reference passed.
- otPlat
Crypto ⚠Ecdsa Generate Key - Generate and populate the output buffer with a new ECDSA key-pair.
- otPlat
Crypto ⚠Ecdsa GetPublic Key - Get the associated public key from the input context.
- otPlat
Crypto ⚠Ecdsa Sign - Calculate the ECDSA signature for a hashed message using the private key from the input context.
- otPlat
Crypto ⚠Ecdsa Sign Using KeyRef - Calculate the ECDSA signature for a hashed message using the Key reference passed.
- otPlat
Crypto ⚠Ecdsa Verify - Use the key from the input context to verify the ECDSA signature of a hashed message.
- otPlat
Crypto ⚠Ecdsa Verify Using KeyRef - Use the keyref to verify the ECDSA signature of a hashed message.
- otPlat
Crypto ⚠Export Key - Export a key stored in PSA ITS.
- otPlat
Crypto ⚠HasKey - Check if the key ref passed has an associated key in PSA ITS.
- otPlat
Crypto ⚠Hkdf Deinit - Uninitialize the HKDF context.
- otPlat
Crypto ⚠Hkdf Expand - Perform HKDF Expand step.
- otPlat
Crypto ⚠Hkdf Extract - Perform HKDF Extract step.
- otPlat
Crypto ⚠Hkdf Init - Initialise the HKDF context.
- otPlat
Crypto ⚠Hmac Sha256 Deinit - Uninitialize the HMAC operation.
- otPlat
Crypto ⚠Hmac Sha256 Finish - Complete the HMAC operation.
- otPlat
Crypto ⚠Hmac Sha256 Init - Initialize the HMAC operation.
- otPlat
Crypto ⚠Hmac Sha256 Start - Start HMAC operation.
- otPlat
Crypto ⚠Hmac Sha256 Update - Update the HMAC operation with new input.
- otPlat
Crypto ⚠Import Key - Import a key into PSA ITS.
- otPlat
Crypto ⚠Init - Initialize the Crypto module.
- otPlat
Crypto ⚠Pbkdf2 Generate Key - Perform PKCS#5 PBKDF2 using CMAC (AES-CMAC-PRF-128).
- otPlat
Crypto ⚠Random Deinit - Deinitialize cryptographically-secure pseudorandom number generator (CSPRNG).
- otPlat
Crypto ⚠Random Get - Fills a given buffer with cryptographically secure random bytes.
- otPlat
Crypto ⚠Random Init - Initialize cryptographically-secure pseudorandom number generator (CSPRNG).
- otPlat
Crypto ⚠Sha256 Deinit - Uninitialize the SHA-256 operation.
- otPlat
Crypto ⚠Sha256 Finish - Finish SHA-256 operation.
- otPlat
Crypto ⚠Sha256 Init - Initialise the SHA-256 operation.
- otPlat
Crypto ⚠Sha256 Start - Start SHA-256 operation.
- otPlat
Crypto ⚠Sha256 Update - Update SHA-256 operation with new input.
- otPlat
Debug ⚠Uart_ getc - Poll/Read a byte from the debug uart
- otPlat
Debug ⚠Uart_ kbhit - Poll/test debug uart if a key has been pressed. It would be common to a stub function that returns 0.
- otPlat
Debug ⚠Uart_ logfile - Some platforms (simulation) can log to a file.
- otPlat
Debug ⚠Uart_ printf - Standard printf() to the debug uart with no log decoration.
- otPlat
Debug ⚠Uart_ putchar - Write byte to the uart, expand cr/lf as need.
- otPlat
Debug ⚠Uart_ putchar_ raw - Platform specific write single byte to Debug Uart This should not perform CR/LF mapping.
- otPlat
Debug ⚠Uart_ puts - identical to “man 3 puts” - terminates with lf Which is then mapped to cr/lf as required
- otPlat
Debug ⚠Uart_ puts_ no_ nl - puts() without a terminal newline. see: “man 3 puts”, without a adding a terminal lf
- otPlat
Debug ⚠Uart_ vprintf - Standard vprintf() to the debug uart, with no log decoration.
- otPlat
Debug ⚠Uart_ write_ bytes - Write N bytes to the UART, mapping cr/lf
- otPlat
Diag ⚠Alarm Callback - Processes the alarm event.
- otPlat
Diag ⚠Alarm Fired - Signal diagnostics module that the alarm has fired.
- otPlat
Diag ⚠Channel Set - Sets the channel to use for factory diagnostics.
- otPlat
Diag ⚠Gpio Get - Gets the gpio value.
- otPlat
Diag ⚠Gpio GetMode - Gets the gpio mode.
- otPlat
Diag ⚠Gpio Set - Sets the gpio value.
- otPlat
Diag ⚠Gpio SetMode - Sets the gpio mode.
- otPlat
Diag ⚠Mode Get - Indicates whether or not factory diagnostics mode is enabled.
- otPlat
Diag ⚠Mode Set - Enables/disables the factory diagnostics mode.
- otPlat
Diag ⚠Process - Processes a factory diagnostics command line.
- otPlat
Diag ⚠Radio GetPower Settings - Get the power settings for the given channel.
- otPlat
Diag ⚠Radio GetRaw Power Setting - Get the radio raw power setting for diagnostics module.
- otPlat
Diag ⚠Radio RawPower Setting Enable - Enable/disable the platform layer to use the raw power setting set by
otPlatDiagRadioSetRawPowerSetting()
. - otPlat
Diag ⚠Radio Receive Done - The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
- otPlat
Diag ⚠Radio Received - Processes the received radio frame.
- otPlat
Diag ⚠Radio SetRaw Power Setting - Set the radio raw power setting for diagnostics module.
- otPlat
Diag ⚠Radio Transmit Carrier - Start/stop the platform layer to transmit continuous carrier wave.
- otPlat
Diag ⚠Radio Transmit Done - The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.
- otPlat
Diag ⚠Radio Transmit Stream - Start/stop the platform layer to transmit stream of characters.
- otPlat
Diag ⚠SetOutput Callback - Sets the platform diag output callback.
- otPlat
Diag ⚠TxPower Set - Sets the transmit power to use for factory diagnostics.
- otPlat
DnsCancel ⚠Upstream Query - Cancels a transaction of upstream query.
- otPlat
DnsStart ⚠Upstream Query - Starts an upstream query transaction.
- otPlat
DnsUpstream ⚠Query Done - The platform calls this function to finish DNS query.
- otPlat
Entropy ⚠Get - Fill buffer with entropy.
- otPlat
Flash ⚠Erase - Erases the swap space indicated by @p aSwapIndex.
- otPlat
Flash ⚠GetSwap Size - Gets the size of the swap space.
- otPlat
Flash ⚠Init - Initializes the flash driver.
- otPlat
Flash ⚠Read - Reads @p aSize bytes into @p aData.
- otPlat
Flash ⚠Write - Writes @p aSize bytes from @p aData.
- otPlat
Free ⚠ - Frees memory that was dynamically allocated.
- otPlat
GetInfra ⚠IfLink Layer Address - Get the link-layer address of the infrastructure interface.
- otPlat
GetMcu ⚠Power State - Gets the current desired MCU power state.
- otPlat
GetReset ⚠Reason - Returns the reason for the last platform reset.
- otPlat
Infra ⚠IfDiscover Nat64 Prefix - Send a request to discover the NAT64 prefix on the infrastructure interface with @p aInfraIfIndex.
- otPlat
Infra ⚠IfDiscover Nat64 Prefix Done - The infra interface driver calls this method to notify OpenThread that the discovery of NAT64 prefix is done.
- otPlat
Infra ⚠IfHas Address - Tells whether an infra interface has the given IPv6 address assigned.
- otPlat
Infra ⚠IfRecv Icmp6 Nd - The infra interface driver calls this method to notify OpenThread that an ICMPv6 Neighbor Discovery message is received.
- otPlat
Infra ⚠IfSend Icmp6 Nd - Sends an ICMPv6 Neighbor Discovery message on given infrastructure interface.
- otPlat
Infra ⚠IfState Changed - The infra interface driver calls this method to notify OpenThread of the interface state changes.
- otPlat
Log ⚠ - Outputs logs.
- otPlat
LogCrash ⚠Dump - Logs a crash dump using OpenThread logging APIs
- otPlat
LogHandle ⚠Level Changed - This function handles OpenThread log level changes.
- otPlat
Message ⚠Pool Free - Is used to free a buffer back to the platform managed buffer pool.
- otPlat
Message ⚠Pool Init - Initialize the platform implemented message pool.
- otPlat
Message ⚠Pool New - Allocate a buffer from the platform managed buffer pool.
- otPlat
Message ⚠Pool NumFree Buffers - Get the number of free buffers.
- otPlat
Otns ⚠Status - Exports status information to OTNS.
- otPlat
Radio ⚠AddCalibrated Power - Add a calibrated power of the specified channel to the power calibration table.
- otPlat
Radio ⚠AddSrc Match ExtEntry - Add an extended address to the source address match table.
- otPlat
Radio ⚠AddSrc Match Short Entry - Add a short address to the source address match table.
- otPlat
Radio ⚠BusLatency Changed - The radio driver calls this method to notify OpenThread that the spinel bus latency has been changed.
- otPlat
Radio ⚠Clear Calibrated Powers - Clear all calibrated powers from the power calibration table.
- otPlat
Radio ⚠Clear SrcMatch ExtEntries - Clear all the extended/long addresses from source address match table.
- otPlat
Radio ⚠Clear SrcMatch ExtEntry - Remove an extended address from the source address match table.
- otPlat
Radio ⚠Clear SrcMatch Short Entries - Clear all short addresses from the source address match table.
- otPlat
Radio ⚠Clear SrcMatch Short Entry - Remove a short address from the source address match table.
- otPlat
Radio ⚠Configure EnhAck Probing - Enable/disable or update Enhanced-ACK Based Probing in radio for a specific Initiator.
- otPlat
Radio ⚠Disable - Disable the radio.
- otPlat
Radio ⚠Enable - Enable the radio.
- otPlat
Radio ⚠Enable Csl - Enable or disable CSL receiver.
- otPlat
Radio ⚠Enable SrcMatch - Enable/Disable source address match feature.
- otPlat
Radio ⚠Energy Scan - Begin the energy scan sequence on the radio.
- otPlat
Radio ⚠Energy Scan Done - The radio driver calls this method to notify OpenThread that the energy scan is complete.
- otPlat
Radio ⚠GetBus Latency - Get the bus latency in microseconds between the host and the radio chip.
- otPlat
Radio ⚠GetBus Speed - Get the bus speed in bits/second between the host and the radio chip.
- otPlat
Radio ⚠GetCaps - Get the radio capabilities.
- otPlat
Radio ⚠GetCca Energy Detect Threshold - Get the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
- otPlat
Radio ⚠GetCoex Metrics - Get the radio coexistence metrics.
- otPlat
Radio ⚠GetCsl Accuracy - 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.
- otPlat
Radio ⚠GetCsl Uncertainty - The fixed uncertainty (i.e. random jitter) of the arrival time of CSL transmissions received by this device in units of 10 microseconds.
- otPlat
Radio ⚠GetFem LnaGain - Gets the external FEM’s Rx LNA gain in dBm.
- otPlat
Radio ⚠GetIeee Eui64 - Gets the factory-assigned IEEE EUI-64 for this interface.
- otPlat
Radio ⚠GetNow - Get the current time in microseconds referenced to a continuous monotonic local radio clock (64 bits width).
- otPlat
Radio ⚠GetPreferred Channel Mask - Gets the radio preferred channel mask that the device prefers to form on.
- otPlat
Radio ⚠GetPromiscuous - Get the status of promiscuous mode.
- otPlat
Radio ⚠GetRaw Power Setting - Get the raw power setting for the given channel.
- otPlat
Radio ⚠GetReceive Sensitivity - Get the radio receive sensitivity value.
- otPlat
Radio ⚠GetRegion - Get the region code.
- otPlat
Radio ⚠GetRssi - Get the most recent RSSI measurement.
- otPlat
Radio ⚠GetState - Get current state of the radio.
- otPlat
Radio ⚠GetSupported Channel Mask - Get the radio supported channel mask that the device is allowed to be on.
- otPlat
Radio ⚠GetTransmit Buffer - Get the radio transmit frame buffer.
- otPlat
Radio ⚠GetTransmit Power - Get the radio’s transmit power in dBm.
- otPlat
Radio ⚠GetVersion String - Get the radio version string.
- otPlat
Radio ⚠IsCoex Enabled - Check whether radio coex is enabled or not.
- otPlat
Radio ⚠IsEnabled - Check whether radio is enabled or not.
- otPlat
Radio ⚠Receive - Transition the radio from Sleep to Receive (turn on the radio).
- otPlat
Radio ⚠Receive At - Schedule a radio reception window at a specific time and duration.
- otPlat
Radio ⚠Receive Done - The radio driver calls this method to notify OpenThread of a received frame.
- otPlat
Radio ⚠Reset Csl - Reset CSL receiver in the platform.
- otPlat
Radio ⚠SetAlternate Short Address - Set the alternate short address.
- otPlat
Radio ⚠SetCca Energy Detect Threshold - Set the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
- otPlat
Radio ⚠SetChannel MaxTransmit Power - Set the max transmit power for a specific channel.
- otPlat
Radio ⚠SetChannel Target Power - Set the target power for the given channel.
- otPlat
Radio ⚠SetCoex Enabled - Enable the radio coex.
- otPlat
Radio ⚠SetExtended Address - Set the Extended Address for address filtering.
- otPlat
Radio ⚠SetFem LnaGain - Sets the external FEM’s Rx LNA gain in dBm.
- otPlat
Radio ⚠SetMac Frame Counter - Sets the current MAC frame counter value.
- otPlat
Radio ⚠SetMac Frame Counter IfLarger - Sets the current MAC frame counter value only if the new given value is larger than the current value.
- otPlat
Radio ⚠SetMac Key - Update MAC keys and key index
- otPlat
Radio ⚠SetPan Id - Set the PAN ID for address filtering.
- otPlat
Radio ⚠SetPromiscuous - Enable or disable promiscuous mode.
- otPlat
Radio ⚠SetRegion - Set the region code.
- otPlat
Radio ⚠SetRx OnWhen Idle - Sets the rx-on-when-idle state to the radio platform.
- otPlat
Radio ⚠SetShort Address - Set the Short Address for address filtering.
- otPlat
Radio ⚠SetTransmit Power - Set the radio’s transmit power in dBm for all channels.
- otPlat
Radio ⚠Sleep - Transition the radio from Receive to Sleep (turn off the radio).
- otPlat
Radio ⚠Transmit - Begin the transmit sequence on the radio.
- otPlat
Radio ⚠TxDone - 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.
- otPlat
Radio ⚠TxStarted - The radio driver calls this method to notify OpenThread that the transmission has started.
- otPlat
Radio ⚠Update CslSample Time - Update CSL sample time in radio driver.
- otPlat
Reset ⚠ - Performs a software reset on the platform, if supported.
- otPlat
Reset ⚠ToBootloader - Performs a hardware reset on the platform to launch bootloader mode, if supported.
- otPlat
SetMcu ⚠Power State - Sets the desired MCU power state.
- otPlat
Settings ⚠Add - Adds a value to a setting.
- otPlat
Settings ⚠Deinit - Performs any de-initialization for the settings subsystem, if necessary.
- otPlat
Settings ⚠Delete - Removes a setting from the setting store.
- otPlat
Settings ⚠Get - Fetches the value of a setting.
- otPlat
Settings ⚠Init - Performs any initialization for the settings subsystem, if necessary.
- otPlat
Settings ⚠Set - Sets or replaces the value of a setting.
- otPlat
Settings ⚠Wipe - Removes all settings from the setting store.
- otPlat
SpiSlave ⚠Disable - Shutdown and disable the SPI slave interface.
- otPlat
SpiSlave ⚠Enable - Initialize the SPI slave interface.
- otPlat
SpiSlave ⚠Prepare Transaction - 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()
. - otPlat
Time ⚠Get - Get the current platform time in microseconds referenced to a continuous monotonic local clock (64 bits width).
- otPlat
Time ⚠GetXtal Accuracy - Get the current estimated worst case accuracy (maximum ± deviation from the nominal frequency) of the local platform clock in units of PPM.
- otPlat
Trel ⚠Disable - Disables TREL platform layer.
- otPlat
Trel ⚠Enable - Initializes and enables TREL platform layer.
- otPlat
Trel ⚠GetCounters - Gets the pointer to the TREL counters in the platform layer.
- otPlat
Trel ⚠Handle Discovered Peer Info - This is a callback function from platform layer to report a discovered TREL peer info.
- otPlat
Trel ⚠Handle Received - Is a callback from platform to notify of a received TREL UDP packet.
- otPlat
Trel ⚠Notify Peer Socket Address Difference - Notifies platform that a TREL packet is received from a peer using a different socket address than the one reported
earlier from
otPlatTrelHandleDiscoveredPeerInfo()
. - otPlat
Trel ⚠Register Service - Registers a new service to be advertised using DNS-SD [RFC6763].
- otPlat
Trel ⚠Reset Counters - Resets the TREL counters in the platform layer.
- otPlat
Trel ⚠Send - Requests a TREL UDP packet to be sent to a given destination.
- otPlat
UdpBind ⚠ - Binds the UDP socket by platform.
- otPlat
UdpBind ⚠ToNetif - Binds the UDP socket to a platform network interface.
- otPlat
UdpClose ⚠ - Closes the UDP socket by platform.
- otPlat
UdpConnect ⚠ - Connects UDP socket by platform.
- otPlat
UdpJoin ⚠Multicast Group - Configures the UDP socket to join a UDP multicast group.
- otPlat
UdpLeave ⚠Multicast Group - Configures the UDP socket to leave a UDP multicast group.
- otPlat
UdpSend ⚠ - Sends UDP payload by platform.
- otPlat
UdpSocket ⚠ - Initializes the UDP socket by platform.
- otPlat
Wake ⚠Host - Performs a platform specific operation to wake the host MCU. This is used only for NCP configurations.
- otRandom
NonCrypto ⚠AddJitter - Adds a random jitter within a given range to a given value.
- otRandom
NonCrypto ⚠Fill Buffer - Fills a given buffer with random bytes.
- otRandom
NonCrypto ⚠GetUint8 - Generates and returns a random byte.
- otRandom
NonCrypto ⚠GetUint8 InRange - Generates and returns a random
uint8_t
value within a given range[aMin, aMax)
. - otRandom
NonCrypto ⚠GetUint16 - Generates and returns a random
uint16_t
value. - otRandom
NonCrypto ⚠GetUint32 - Generates and returns a random
uint32_t
value. - otRandom
NonCrypto ⚠GetUint16 InRange - Generates and returns a random
uint16_t
value within a given range[aMin, aMax)
. - otRandom
NonCrypto ⚠GetUint32 InRange - Generates and returns a random
uint32_t
value within a given range[aMin, aMax)
. - otRemove
State ⚠Change Callback - Removes a callback to indicate when certain configuration or state changes within OpenThread.
- otServer
AddService ⚠ - Add a service configuration to the local network data.
- otServer
GetNet ⚠Data Local - Provides a full or stable copy of the local Thread Network Data.
- otServer
GetNext ⚠Service - Gets the next service in the local Network Data.
- otServer
Register ⚠ - Immediately register the local network data with the Leader.
- otServer
Remove ⚠Service - Remove a service configuration from the local network data.
- otSet
State ⚠Changed Callback - Registers a callback to indicate when certain configuration or state changes within OpenThread.
- otSntp
Client ⚠Query - Sends a SNTP query.
- otSntp
Client ⚠SetUnix Era - Sets the unix era number.
- otSrp
Client ⚠AddService - Adds a service to be registered with server.
- otSrp
Client ⚠Buffers Allocate Service - Allocates a new service entry from the pool.
- otSrp
Client ⚠Buffers Free AllServices - Frees all previously allocated service entries.
- otSrp
Client ⚠Buffers Free Service - Frees a previously allocated service entry.
- otSrp
Client ⚠Buffers GetHost Addresses Array - Gets the array of IPv6 address entries to use as SRP client host address list.
- otSrp
Client ⚠Buffers GetHost Name String - Gets the string buffer to use for SRP client host name.
- otSrp
Client ⚠Buffers GetService Entry Instance Name String - Gets the string buffer for service instance name from a service entry.
- otSrp
Client ⚠Buffers GetService Entry Service Name String - Gets the string buffer for service name from a service entry.
- otSrp
Client ⚠Buffers GetService Entry TxtBuffer - Gets the buffer for TXT record from a service entry.
- otSrp
Client ⚠Buffers GetSub Type Labels Array - Gets the array for service subtype labels from the service entry.
- otSrp
Client ⚠Clear Host AndServices - Clears all host info and all the services.
- otSrp
Client ⚠Clear Service - Clears a service, immediately removing it from the client service list.
- otSrp
Client ⚠Disable Auto Start Mode - Disables the auto-start mode.
- otSrp
Client ⚠Enable Auto Host Address - Enables auto host address mode.
- otSrp
Client ⚠Enable Auto Start Mode - Enables the auto-start mode.
- otSrp
Client ⚠GetDomain Name - Gets the domain name being used by SRP client.
- otSrp
Client ⚠GetHost Info - Gets the host info.
- otSrp
Client ⚠GetKey Lease Interval - Gets the default key lease interval used in SRP update requests.
- otSrp
Client ⚠GetLease Interval - Gets the default lease interval used in SRP update requests.
- otSrp
Client ⚠GetServer Address - Gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP client.
- otSrp
Client ⚠GetServices - Gets the list of services being managed by client.
- otSrp
Client ⚠GetTtl - Gets the TTL value in every record included in SRP update requests.
- otSrp
Client ⚠IsAuto Start Mode Enabled - Indicates the current state of auto-start mode (enabled or disabled).
- otSrp
Client ⚠IsRunning - Indicates whether the SRP client is running or not.
- otSrp
Client ⚠IsService KeyRecord Enabled - Indicates whether the “service key record inclusion” mode is enabled or disabled.
- otSrp
Client ⚠Item State ToString - Converts a
otSrpClientItemState
to a string. - otSrp
Client ⚠Remove Host AndServices - Starts the remove process of the host info and all services.
- otSrp
Client ⚠Remove Service - Requests a service to be unregistered with server.
- otSrp
Client ⚠SetCallback - Sets the callback to notify caller of events/changes from SRP client.
- otSrp
Client ⚠SetDomain Name - Sets the domain name to be used by SRP client.
- otSrp
Client ⚠SetHost Addresses - Sets/updates the list of host IPv6 address.
- otSrp
Client ⚠SetHost Name - Sets the host name label.
- otSrp
Client ⚠SetKey Lease Interval - Sets the default key lease interval used in SRP update requests.
- otSrp
Client ⚠SetLease Interval - Sets the default lease interval used in SRP update requests.
- otSrp
Client ⚠SetService KeyRecord Enabled - Enables/disables “service key record inclusion” mode.
- otSrp
Client ⚠SetTtl - Sets the TTL value in every record included in SRP update requests.
- otSrp
Client ⚠Start - Starts the SRP client operation.
- otSrp
Client ⚠Stop - Stops the SRP client operation.
- otSrp
Server ⚠GetAddress Mode - Returns the address mode being used by the SRP server.
- otSrp
Server ⚠GetAnycast Mode Sequence Number - Returns the sequence number used with anycast address mode.
- otSrp
Server ⚠GetDomain - Returns the domain authorized to the SRP server.
- otSrp
Server ⚠GetLease Config - Returns SRP server LEASE and KEY-LEASE configurations.
- otSrp
Server ⚠GetNext Host - Returns the next registered host on the SRP server.
- otSrp
Server ⚠GetPort - Returns the port the SRP server is listening to.
- otSrp
Server ⚠GetResponse Counters - Returns the response counters of the SRP server.
- otSrp
Server ⚠GetState - Returns the state of the SRP server.
- otSrp
Server ⚠GetTtl Config - Returns SRP server TTL configuration.
- otSrp
Server ⚠Handle Service Update Result - Reports the result of processing a SRP update to the SRP server.
- otSrp
Server ⚠Host GetAddresses - Returns the addresses of given host.
- otSrp
Server ⚠Host GetFull Name - Returns the full name of the host.
- otSrp
Server ⚠Host GetLease Info - Returns the LEASE and KEY-LEASE information of a given host.
- otSrp
Server ⚠Host GetNext Service - Returns the next service of given host.
- otSrp
Server ⚠Host IsDeleted - Tells if the SRP service host has been deleted.
- otSrp
Server ⚠Host Matches Full Name - Indicates whether the host matches a given host name.
- otSrp
Server ⚠IsAuto Enable Mode - Indicates whether the auto-enable mode is enabled or disabled.
- otSrp
Server ⚠Parse SubType Service Name - Parses a sub-type service name (full name) and extracts the sub-type label.
- otSrp
Server ⚠Service GetHost - Returns the host which the service instance reside on.
- otSrp
Server ⚠Service GetInstance Label - Returns the service instance label (first label in instance name) of the service.
- otSrp
Server ⚠Service GetInstance Name - Returns the full service instance name of the service.
- otSrp
Server ⚠Service GetLease Info - Returns the LEASE and KEY-LEASE information of a given service.
- otSrp
Server ⚠Service GetNumber OfSub Types - Gets the number of sub-types of the service.
- otSrp
Server ⚠Service GetPort - Returns the port of the service instance.
- otSrp
Server ⚠Service GetPriority - Returns the priority of the service instance.
- otSrp
Server ⚠Service GetService Name - Returns the full service name of the service.
- otSrp
Server ⚠Service GetSub Type Service Name At - Gets the sub-type service name (full name) of the service at a given index
- otSrp
Server ⚠Service GetTtl - Returns the TTL of the service instance.
- otSrp
Server ⚠Service GetTxt Data - Returns the TXT record data of the service instance.
- otSrp
Server ⚠Service GetWeight - Returns the weight of the service instance.
- otSrp
Server ⚠Service HasSub Type Service Name - Indicates whether or not the service has a given sub-type.
- otSrp
Server ⚠Service IsDeleted - Indicates whether or not the SRP service has been deleted.
- otSrp
Server ⚠Service Matches Instance Name - Indicates whether this service matches a given service instance name.
- otSrp
Server ⚠Service Matches Service Name - Indicates whether this service matches a given service name.
- otSrp
Server ⚠SetAddress Mode - Sets the address mode to be used by the SRP server.
- otSrp
Server ⚠SetAnycast Mode Sequence Number - Sets the sequence number used with anycast address mode.
- otSrp
Server ⚠SetAuto Enable Mode - Enables/disables the auto-enable mode on SRP server.
- otSrp
Server ⚠SetDomain - Sets the domain on the SRP server.
- otSrp
Server ⚠SetEnabled - Enables/disables the SRP server.
- otSrp
Server ⚠SetLease Config - Sets SRP server LEASE and KEY-LEASE configurations.
- otSrp
Server ⚠SetService Update Handler - Sets the SRP service updates handler on SRP server.
- otSrp
Server ⚠SetTtl Config - Sets SRP server TTL configuration.
- otTasklets
ArePending ⚠ - Indicates whether or not OpenThread has tasklets pending.
- otTasklets
Process ⚠ - Run all queued OpenThread tasklets at the time this is called.
- otTasklets
Signal ⚠Pending - OpenThread calls this function when the tasklet queue transitions from empty to non-empty.
- otTcp
Abort ⚠ - Forcibly ends the TCP connection associated with this TCP endpoint.
- otTcp
Bind ⚠ - Binds the TCP endpoint to an IP address and port.
- otTcp
Commit ⚠Receive - 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.
- otTcp
Connect ⚠ - Records the remote host and port for this connection.
- otTcp
Endpoint ⚠Deinitialize - Deinitializes this TCP endpoint.
- otTcp
Endpoint ⚠GetContext - Obtains the context pointer that was associated with @p aEndpoint upon initialization.
- otTcp
Endpoint ⚠GetInstance - Obtains the otInstance that was associated with @p aEndpoint upon initialization.
- otTcp
Endpoint ⚠Initialize - Initializes a TCP endpoint.
- otTcp
GetLocal ⚠Address - Obtains a pointer to a TCP endpoint’s local host and port.
- otTcp
GetPeer ⚠Address - Obtains a pointer to a TCP endpoint’s peer’s host and port.
- otTcp
Listen ⚠ - Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener’s callbacks.
- otTcp
Listener ⚠Deinitialize - Deinitializes this TCP listener.
- otTcp
Listener ⚠GetContext - Obtains the context pointer that was associated with @p aListener upon initialization.
- otTcp
Listener ⚠GetInstance - Obtains the otInstance that was associated with @p aListener upon initialization.
- otTcp
Listener ⚠Initialize - Initializes a TCP listener.
- otTcp
Receive ⚠ByReference - Provides the application with a linked buffer chain referencing data currently in the TCP receive buffer.
- otTcp
Receive ⚠Contiguify - Reorganizes the receive buffer to be entirely contiguous in memory.
- otTcp
Send ⚠ByExtension - Adds data to the send buffer by extending the length of the final otLinkedBuffer in the send buffer by the specified amount.
- otTcp
Send ⚠ByReference - Adds data referenced by the linked buffer pointed to by @p aBuffer to the send buffer.
- otTcp
Send ⚠EndOf Stream - Informs the connection peer that this TCP endpoint will not send more data.
- otTcp
Stop ⚠Listening - Causes this TCP listener to stop listening for incoming connections.
- otThread
Become ⚠Child - Attempt to reattach as a child.
- otThread
Become ⚠Detached - Detach from the Thread network.
- otThread
Become ⚠Leader - Become a leader and start a new partition.
- otThread
Become ⚠Router - Attempt to become a router.
- otThread
Detach ⚠Gracefully - Notifies other nodes in the network (if any) and then stops Thread protocol operation.
- otThread
Device ⚠Role ToString - Convert the device role to human-readable string.
- otThread
Discover ⚠ - Starts a Thread Discovery scan.
- otThread
Error ⚠ToString - Converts an otError enum into a string.
- otThread
GetAdvertisement ⚠Trickle Interval Max - Gets the current Interval Max value used by Advertisement trickle timer.
- otThread
GetChild ⚠Info ById - Gets diagnostic information for an attached Child by its Child ID or RLOC16.
- otThread
GetChild ⚠Info ByIndex - The function retains diagnostic information for an attached Child by the internal table index.
- otThread
GetChild ⚠Next Ip6Address - Gets the next IPv6 address (using an iterator) for a given child.
- otThread
GetChild ⚠Router Links - Get the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
- otThread
GetChild ⚠Timeout - Gets the Thread Child Timeout (in seconds) used when operating in the Child role.
- otThread
GetContext ⚠IdReuse Delay - Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
- otThread
GetCurrent ⚠Attach Duration - Gets the current attach duration (number of seconds since the device last attached).
- otThread
GetDevice ⚠Properties - Get the current device properties.
- otThread
GetDevice ⚠Role - Get the device role.
- otThread
GetDomain ⚠Name - Gets the Thread Domain Name.
- otThread
GetExtended ⚠PanId - Gets the IEEE 802.15.4 Extended PAN ID.
- otThread
GetFixed ⚠DuaInterface Identifier - Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.
- otThread
GetIp6 ⚠Counters - Gets the IPv6 counters.
- otThread
GetJoiner ⚠UdpPort - Gets the Joiner UDP Port.
- otThread
GetKey ⚠Sequence Counter - Gets the thrKeySequenceCounter.
- otThread
GetKey ⚠Switch Guard Time - Gets the thrKeySwitchGuardTime (in hours).
- otThread
GetLeader ⚠Data - Get the Thread Leader Data.
- otThread
GetLeader ⚠Rloc - Returns a pointer to the Leader’s RLOC.
- otThread
GetLeader ⚠Router Id - Get the Leader’s Router ID.
- otThread
GetLeader ⚠Weight - Get the Leader’s Weight.
- otThread
GetLink ⚠Local AllThread Nodes Multicast Address - Gets the Thread Link-Local All Thread Nodes multicast address.
- otThread
GetLink ⚠Local Ip6Address - Gets the Thread link-local IPv6 address.
- otThread
GetLink ⚠Mode - Get the MLE Link Mode configuration.
- otThread
GetLocal ⚠Leader Weight - Gets the Thread Leader Weight used when operating in the Leader role.
- otThread
GetMax ⚠Allowed Children - Gets the maximum number of children currently allowed.
- otThread
GetMax ⚠Child IpAddresses - Gets the maximum number of IP addresses that each MTD child may register with this device as parent.
- otThread
GetMax ⚠Router Id - The function returns the maximum allowed router ID
- otThread
GetMax ⚠Time InQueue - Gets the maximum time-in-queue for messages in the TX queue.
- otThread
GetMesh ⚠Local Eid - Gets the Mesh Local EID address.
- otThread
GetMesh ⚠Local Prefix - Returns a pointer to the Mesh Local Prefix.
- otThread
GetMle ⚠Counters - Gets the Thread MLE counters.
- otThread
GetNetwork ⚠IdTimeout - Get the
NETWORK_ID_TIMEOUT
parameter. - otThread
GetNetwork ⚠Key - Get the Thread Network Key.
- otThread
GetNetwork ⚠KeyRef - Get the
otNetworkKeyRef
for Thread Network Key. - otThread
GetNetwork ⚠Name - Get the Thread Network Name.
- otThread
GetNext ⚠Cache Entry - Gets the next EID cache entry (using an iterator).
- otThread
GetNext ⚠Diagnostic Tlv - Gets the next Network Diagnostic TLV in the message.
- otThread
GetNext ⚠HopAnd Path Cost - Gets the next hop and path cost towards a given RLOC16 destination.
- otThread
GetNext ⚠Neighbor Info - Gets the next neighbor information. It is used to go through the entries of the neighbor table.
- otThread
GetParent ⚠Average Rssi - The function retrieves the average RSSI for the Thread Parent.
- otThread
GetParent ⚠Info - The function retrieves diagnostic information for a Thread Router as parent.
- otThread
GetParent ⚠Last Rssi - The function retrieves the RSSI of the last packet from the Thread Parent.
- otThread
GetParent ⚠Priority - Get the assigned parent priority.
- otThread
GetPartition ⚠Id - Get the Partition ID.
- otThread
GetPreferred ⚠Leader Partition Id - Get the preferred Thread Leader Partition Id used when operating in the Leader role.
- otThread
GetPskc ⚠ - Get the Thread PSKc
- otThread
GetPskc ⚠Ref - Get Key Reference to Thread PSKc stored
- otThread
GetRealm ⚠Local AllThread Nodes Multicast Address - Gets the Thread Realm-Local All Thread Nodes multicast address.
- otThread
GetRloc ⚠ - Gets the Thread Routing Locator (RLOC) address.
- otThread
GetRloc16 ⚠ - Get the RLOC16.
- otThread
GetRouter ⚠Downgrade Threshold - Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.
- otThread
GetRouter ⚠IdRange - Gets the range of router IDs that are allowed to assign to nodes within the thread network.
- otThread
GetRouter ⚠IdSequence - Get the current Router ID Sequence.
- otThread
GetRouter ⚠Info - The function retains diagnostic information for a given Thread Router.
- otThread
GetRouter ⚠Selection Jitter - Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
- otThread
GetRouter ⚠Upgrade Threshold - Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.
- otThread
GetService ⚠Aloc - Retrieves the Service ALOC for given Service ID.
- otThread
GetStore ⚠Frame Counter Ahead - Gets the store frame counter ahead.
- otThread
GetTime ⚠InQueue Histogram - Gets the time-in-queue histogram for messages in the TX queue.
- otThread
GetVendor ⚠AppUrl - Get the vendor app URL string.
- otThread
GetVendor ⚠Model - Get the vendor model string.
- otThread
GetVendor ⚠Name - Get the vendor name string.
- otThread
GetVendor ⚠SwVersion - Get the vendor software version string.
- otThread
GetVersion ⚠ - Gets the Thread protocol version.
- otThread
IsAnycast ⚠Locate InProgress - Indicates whether an anycast locate request is currently in progress.
- otThread
IsDiscover ⚠InProgress - Determines if an MLE Thread Discovery is currently in progress.
- otThread
IsRouter ⚠Eligible - Indicates whether or not the device is router-eligible.
- otThread
IsRouter ⚠IdAllocated - Indicates whether or not a Router ID is currently allocated.
- otThread
IsSingleton ⚠ - Indicates whether a node is the only router on the network.
- otThread
IsTmf ⚠Origin Filter Enabled - Indicates whether the filter that drops TMF UDP messages from untrusted origin is enabled or not.
- otThread
Locate ⚠Anycast Destination - Requests the closest destination of a given anycast address to be located.
- otThread
Register ⚠Neighbor Table Callback - Registers a neighbor table callback function.
- otThread
Register ⚠Parent Response Callback - Registers a callback to receive MLE Parent Response data.
- otThread
Release ⚠Router Id - Release a Router ID that has been allocated by the device in the Leader role.
- otThread
Reset ⚠Ip6Counters - Resets the IPv6 counters.
- otThread
Reset ⚠MleCounters - Resets the Thread MLE counters.
- otThread
Reset ⚠Time InQueue Stat - Resets the TX queue time-in-queue statistics.
- otThread
Search ⚠ForBetter Parent - Starts the process for child to search for a better parent while staying attached to its current parent.
- otThread
Send ⚠Address Notification - Sends a Proactive Address Notification (ADDR_NTF.ntf) message.
- otThread
Send ⚠Diagnostic Get - Send a Network Diagnostic Get request.
- otThread
Send ⚠Diagnostic Reset - Send a Network Diagnostic Reset request.
- otThread
Send ⚠Proactive Backbone Notification - Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
- otThread
SetCcm ⚠Enabled - Sets whether the device was commissioned using CCM.
- otThread
SetChild ⚠Router Links - Set the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
- otThread
SetChild ⚠Timeout - Sets the Thread Child Timeout (in seconds) used when operating in the Child role.
- otThread
SetContext ⚠IdReuse Delay - Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
- otThread
SetDevice ⚠Properties - Set the device properties which are then used to determine and set the Leader Weight.
- otThread
SetDiscovery ⚠Request Callback - Sets a callback to receive MLE Discovery Request data.
- otThread
SetDomain ⚠Name - Sets the Thread Domain Name. Only succeeds when Thread protocols are disabled.
- otThread
SetEnabled ⚠ - Starts Thread protocol operation.
- otThread
SetExtended ⚠PanId - Sets the IEEE 802.15.4 Extended PAN ID.
- otThread
SetFixed ⚠DuaInterface Identifier - Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.
- otThread
SetJoiner ⚠Advertisement - Sets the Thread Joiner Advertisement when discovering Thread network.
- otThread
SetJoiner ⚠UdpPort - Sets the Joiner UDP Port.
- otThread
SetKey ⚠Sequence Counter - Sets the thrKeySequenceCounter.
- otThread
SetKey ⚠Switch Guard Time - Sets the thrKeySwitchGuardTime (in hours).
- otThread
SetLink ⚠Mode - Set the MLE Link Mode configuration.
- otThread
SetLocal ⚠Leader Weight - Sets the Thread Leader Weight used when operating in the Leader role.
- otThread
SetMax ⚠Allowed Children - Sets the maximum number of children currently allowed.
- otThread
SetMax ⚠Child IpAddresses - Sets or restores the maximum number of IP addresses that each MTD child may register with this device as parent.
- otThread
SetMesh ⚠Local Prefix - Sets the Mesh Local Prefix.
- otThread
SetNetwork ⚠IdTimeout - Set the
NETWORK_ID_TIMEOUT
parameter. - otThread
SetNetwork ⚠Key - Set the Thread Network Key.
- otThread
SetNetwork ⚠KeyRef - Set the Thread Network Key as a
otNetworkKeyRef
. - otThread
SetNetwork ⚠Name - Set the Thread Network Name.
- otThread
SetParent ⚠Priority - Set the parent priority.
- otThread
SetPreferred ⚠Leader Partition Id - Set the preferred Thread Leader Partition Id used when operating in the Leader role.
- otThread
SetPreferred ⚠Router Id - Set the preferred Router Id.
- otThread
SetPskc ⚠ - Set the Thread PSKc
- otThread
SetPskc ⚠Ref - Set the Key Reference to the Thread PSKc
- otThread
SetRouter ⚠Downgrade Threshold - Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.
- otThread
SetRouter ⚠Eligible - Sets whether or not the device is router-eligible.
- otThread
SetRouter ⚠IdRange - Sets the range of router IDs that are allowed to assign to nodes within the thread network.
- otThread
SetRouter ⚠Selection Jitter - Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
- otThread
SetRouter ⚠Upgrade Threshold - Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.
- otThread
SetSteering ⚠Data - Set Steering data out of band.
- otThread
SetStore ⚠Frame Counter Ahead - Sets the store frame counter ahead.
- otThread
SetThread ⚠Version Check Enabled - Sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.
- otThread
SetTmf ⚠Origin Filter Enabled - Enables or disables the filter to drop TMF UDP messages from untrusted origin.
- otThread
SetVendor ⚠AppUrl - Set the vendor app URL string.
- otThread
SetVendor ⚠Model - Set the vendor model string.
- otThread
SetVendor ⚠Name - Set the vendor name string.
- otThread
SetVendor ⚠SwVersion - Set the vendor software version string.
- otThread
Wakeup ⚠ - Attempts to wake a Wake-up End Device.
- otTrel
GetCounters ⚠ - Gets the TREL counters.
- otTrel
GetNext ⚠Peer - Iterates over the peer table entries and get the next entry from the table
- otTrel
GetNumber ⚠OfPeers - Returns the number of TREL peers.
- otTrel
GetUdp ⚠Port - Gets the UDP port of the TREL interface.
- otTrel
Init ⚠Peer Iterator - Initializes a peer table iterator.
- otTrel
IsEnabled ⚠ - Indicates whether the TREL operation is enabled.
- otTrel
IsFilter ⚠Enabled - Indicates whether or not the filter mode is enabled.
- otTrel
Reset ⚠Counters - Resets the TREL counters.
- otTrel
SetEnabled ⚠ - Enables or disables TREL operation.
- otTrel
SetFilter ⚠Enabled - Sets the filter mode (enables/disables filtering).
- otUdp
AddReceiver ⚠ - Adds a UDP receiver.
- otUdp
Bind ⚠ - Bind a UDP/IPv6 socket.
- otUdp
Close ⚠ - Close a UDP/IPv6 socket.
- otUdp
Connect ⚠ - Connect a UDP/IPv6 socket.
- otUdp
Forward ⚠Receive - Handle a UDP packet received from host.
- otUdp
Forward ⚠SetForwarder - Set UDP forward callback to deliver UDP packets to host.
- otUdp
GetSockets ⚠ - Gets the head of linked list of UDP Sockets.
- otUdp
IsOpen ⚠ - Check if a UDP socket is open.
- otUdp
IsPort ⚠InUse - Determines if the given UDP port is exclusively opened by OpenThread API.
- otUdp
NewMessage ⚠ - Allocate a new message buffer for sending a UDP message.
- otUdp
Open ⚠ - Open a UDP/IPv6 socket.
- otUdp
Remove ⚠Receiver - Removes a UDP receiver.
- otUdp
Send ⚠ - Send a UDP/IPv6 message.
- otUdp
Send ⚠Datagram - 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.
- otBackbone
Router Domain Prefix Callback - Pointer is called whenever the Domain Prefix changed.
- otBackbone
Router Domain Prefix Event - Represents the Domain Prefix events.
- otBackbone
Router Multicast Listener Callback - Pointer is called whenever the Multicast Listeners change.
- otBackbone
Router Multicast Listener Event - Represents the Multicast Listener events.
- otBackbone
Router Multicast Listener Iterator - otBackbone
Router NdProxy Callback - Pointer is called whenever the Nd Proxy changed.
- otBackbone
Router NdProxy Event - Represents the ND Proxy events.
- otBackbone
Router State - Represents the Backbone Router Status.
- otBorder
Agent Ephemeral KeyCallback - Callback function pointer to signal state changes to the Border Agent’s Ephemeral Key Manager.
- otBorder
Agent Ephemeral KeyState - Represents Border Agent’s Ephemeral Key Manager state.
- otBorder
Agent Mesh CoPService Changed Callback - This callback informs the application of the changes in the state of the MeshCoP service.
- otBorder
Router NetData Full Callback - Function pointer callback which is invoked when Network Data (local or leader) gets full.
- otBorder
Routing Dhcp6 PdState - This enumeration represents the state of DHCPv6 Prefix Delegation State.
- otBorder
Routing Request Dhcp6 PdCallback - 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.
- otBorder
Routing State - Represents the state of Border Routing Manager.
- otCache
Entry State - Defines the EID cache entry state.
- otChanged
Flags - Represents a bit-field indicating specific state/configuration that has changed. See
OT_CHANGED_*
definitions. - otChannel
Mask - Represents Channel Mask.
- otChild
Ip6Address Iterator - otCli
Output Callback - Pointer is called to notify about Console output.
- otCoap
Block Szx - CoAP Block Size Exponents
- otCoap
Blockwise Receive Hook - Pointer is called when a CoAP message with a block-wise transfer option is received.
- otCoap
Blockwise Transmit Hook - Pointer is called before the next block in a block-wise transfer is sent.
- otCoap
Code - CoAP Code values.
- otCoap
Option Content Format - CoAP Content Format codes. The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats
- otCoap
Option Type - CoAP Option Numbers
- otCoap
Request Handler - Pointer is called when a CoAP request with a given Uri-Path is received.
- otCoap
Response Handler - Pointer is called when a CoAP response is received or on the request timeout.
- otCoap
Secure Auto Stop Callback - Callback function pointer to notify when the CoAP secure agent is automatically stopped due to reaching the maximum number of connection attempts.
- otCoap
Secure Connect Event - CoAP secure connection event types.
- otCoap
Type - CoAP Type values (2 bit unsigned integer).
- otCommissioner
Energy Report Callback - Pointer is called when the Commissioner receives an Energy Report.
- otCommissioner
Joiner Callback - Pointer is called whenever the joiner state changes.
- otCommissioner
Joiner Event - Defines a Joiner Event on the Commissioner.
- otCommissioner
PanId Conflict Callback - Pointer is called when the Commissioner receives a PAN ID Conflict message.
- otCommissioner
State - Defines the Commissioner State.
- otCommissioner
State Callback - Pointer is called whenever the commissioner state changes.
- otCrypto
KeyAlgorithm - Defines the key algorithms.
- otCrypto
KeyRef - This datatype represents the key reference.
- otCrypto
KeyStorage - Defines the key storage types.
- otCrypto
KeyType - Defines the key types.
- otDataset
Mgmt SetCallback - Pointer is called when a response to a MGMT_SET request is received or times out.
- otDataset
Updater Callback - This callback function pointer is called when a Dataset update request finishes, reporting success or failure status of the Dataset update request.
- otDetach
Gracefully Callback - This callback informs the application that the detaching process has finished.
- otDevice
Role - Represents a Thread device role.
- otDiag
Output Callback - @addtogroup api-factory-diagnostics
- otDns
Address Callback - Pointer is called when a DNS response is received for an address resolution query.
- otDns
Browse Callback - Pointer is called when a DNS response is received for a browse (service instance enumeration) query.
- otDns
Nat64 Mode - Type represents the NAT64 mode in an
otDnsQueryConfig
. - otDns
Recursion Flag - Type represents the “Recursion Desired” (RD) flag in an
otDnsQueryConfig
. - otDns
Service Callback - Pointer is called when a DNS response is received for a service instance resolution query.
- otDns
Service Mode - Type represents the service resolution mode in an
otDnsQueryConfig
. - otDns
Transport Proto - Type represents the DNS transport protocol in an
otDnsQueryConfig
. - otDnssd
Query - This opaque type represents a DNS-SD query.
- otDnssd
Query Subscribe Callback - Is called when a DNS-SD query subscribes one of: 1. a service name. 2. a service instance name. 3. a host name.
- otDnssd
Query Type - Specifies a DNS-SD query type.
- otDnssd
Query Unsubscribe Callback - 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.
- otGpio
Mode - Defines the gpio modes.
- otHandle
Active Scan Result - Pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes.
- otHandle
Coap Secure Client Connect - Pointer is called when the DTLS connection state changes.
- otHandle
Energy Scan Result - Pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes.
- otIcmp6
Code - ICMPv6 Message Codes
- otIcmp6
Echo Mode - ICMPv6 Echo Reply Modes
- otIcmp6
Receive Callback - This callback allows OpenThread to inform the application of a received ICMPv6 message.
- otIcmp6
Type - ICMPv6 Message Types
- otIp6
Address Callback - Pointer is called when an internal IPv6 address is added or removed.
- otIp6
Receive Callback - Pointer is called when an IPv6 datagram is received.
- otIp6
Register Multicast Listeners Callback - Pointer is called with results of
otIp6RegisterMulticastListeners
. - otIp6
Slaac Prefix Filter - Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
- otJam
Detection Callback - Pointer is called if signal jam detection is enabled and a jam is detected.
- otJoiner
Callback - Pointer is called to notify the completion of a join operation.
- otJoiner
Info Type - Defines a Joiner Info Type.
- otJoiner
State - Defines the Joiner State.
- otLink
Metrics EnhAck Flags - Enhanced-ACK Flags.
- otLink
Metrics EnhAck Probing IeReport Callback - Pointer is called when Enh-ACK Probing IE is received.
- otLink
Metrics Mgmt Response Callback - Pointer is called when a Link Metrics Management Response is received.
- otLink
Metrics Report Callback - Pointer is called when a Link Metrics report is received.
- otLink
Metrics Status - Link Metrics Status values.
- otLink
Pcap Callback - Pointer is called when an IEEE 802.15.4 frame is received.
- otLink
RawEnergy Scan Done - Pointer on receipt of a IEEE 802.15.4 frame.
- otLink
RawReceive Done - Pointer on receipt of a IEEE 802.15.4 frame.
- otLink
RawTransmit Done - Pointer on receipt of a IEEE 802.15.4 frame.
- otLog
Level - Represents the log level.
- otLog
Region - Represents log regions.
- otMac
Filter Address Mode - Defines address mode of the mac filter.
- otMac
Filter Iterator - otMac
KeyRef - Represents a MAC Key Ref used by PSA.
- otMesh
Local Prefix - Represents a Mesh Local Prefix.
- otMeshcop
TlvType - Represents meshcop TLV types.
- otMessage
Origin - Defines the OpenThread message origins.
- otMessage
Priority - Defines the OpenThread message priority levels.
- otNat64
Drop Reason - Packet drop reasons.
- otNat64
Receive Ip4Callback - Pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.
- otNat64
State - States of NAT64.
- otNcp
Delegate Allow Peek Poke - Defines delegate (function pointer) type to control behavior of peek/poke operation.
- otNcp
Hdlc Send Callback - Pointer is called to send HDLC encoded NCP data.
- otNeighbor
Info Iterator - otNeighbor
Table Callback - Pointer is called to notify that there is a change in the neighbor table.
- otNeighbor
Table Event - Defines the constants used in
otNeighborTableCallback
to indicate changes in neighbor table. - otNetif
Identifier - Defines the OpenThread network interface identifiers.
- otNetwork
Data Iterator - otNetwork
Diag Iterator - otNetwork
KeyRef - This datatype represents KeyRef to NetworkKey.
- otNetwork
Time Status - Represents OpenThread time synchronization status.
- otNetwork
Time Sync Callback Fn - Pointer is called when a network time sync or status change occurs.
- otPanId
- Represents the IEEE 802.15.4 PAN ID.
- otPing
Sender Reply Callback - Pointer type specifies the callback to notify receipt of a ping reply.
- otPing
Sender Statistics Callback - Pointer type specifies the callback to report the ping statistics.
- otPlat
Diag Output Callback - Pointer to callback to output platform diag messages.
- otPlat
McuPower State - Enumeration of micro-controller’s power states.
- otPlat
Reset Reason - Enumeration of possible reset reason codes.
- otPlat
SpiSlave Transaction Complete Callback - 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 tootPlatSpiSlavePrepareTransaction()
. - otPlat
SpiSlave Transaction Process Callback - Invoked after a transaction complete callback is called and returns
TRUE
to do any further processing required. UnlikeotPlatSpiSlaveTransactionCompleteCallback
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. - otPower
Supply - Represents the power supply property on a device.
- otPskc
Ref - This datatype represents KeyRef to PSKc.
- otRadio
Caps - Represents radio capabilities.
- otRadio
KeyType - Defines constants about key types.
- otRadio
State - Represents the state of a radio. Initially, a radio is in the Disabled state.
- otReceive
Diagnostic GetCallback - Pointer is called when Network Diagnostic Get response is received.
- otRoute
Preference - Defines valid values for
mPreference
inotExternalRouteConfig
andotBorderRouterConfig
. - otShort
Address - Represents the IEEE 802.15.4 Short Address.
- otSntp
Response Handler - Pointer is called when a SNTP response is received.
- otSrp
Client Auto Start Callback - Pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
- otSrp
Client Callback - Pointer type defines the callback used by SRP client to notify user of changes/events/errors.
- otSrp
Client Item State - Specifies an SRP client item (service or host info) state.
- otSrp
Server Address Mode - Represents the address mode used by the SRP server.
- otSrp
Server Service Update Handler - Handles SRP service updates.
- otSrp
Server Service Update Id - The ID of a SRP service update transaction on the SRP Server.
- otSrp
Server State - Represents the state of the SRP server.
- otState
Changed Callback - Pointer is called to notify certain configuration or state changes within OpenThread.
- otTcp
Accept Done - This callback indicates that the TCP connection is now ready for two-way communication.
- otTcp
Accept Ready - This callback indicates that an incoming connection that matches this TCP listener has arrived.
- otTcp
Disconnected - This callback indicates that the connection was broken and should no longer be used, or that a connection has entered the TIME-WAIT state.
- otTcp
Disconnected Reason - otTcp
Established - This callback informs the application that the TCP 3-way handshake is complete and that the connection is now established.
- otTcp
Forward Progress - 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.
- otTcp
Incoming Connection Action - Defines incoming connection actions.
- otTcp
Receive Available - This callback indicates the number of bytes available for consumption from the receive buffer.
- otTcp
Send Done - 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.
- otThread
Anycast Locator Callback - Pointer type defines the callback to notify the outcome of a
otThreadLocateAnycastDestination()
request. - otThread
Discovery Request Callback - Pointer is called every time an MLE Discovery Request message is received.
- otThread
Parent Response Callback - Pointer is called every time an MLE Parent Response message is received.
- otTrel
Counters - Represents a group of TREL related counters.
- otTrel
Peer Iterator - Represents an iterator for iterating over TREL peer table entries.
- otUdp
Forwarder - Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
- otUdp
Handler - This callback allows OpenThread to provide specific handlers for certain UDP messages.
- otUdp
Receive - This callback allows OpenThread to inform the application of a received UDP message.
- otWakeup
Callback - Informs the application about the result of waking a Wake-up End Device.
- va_list
Unions§
- otIcmp6
Header__ bindgen_ ty_ 1 - otIp4
Address__ bindgen_ ty_ 1 - otIp6
Address__ bindgen_ ty_ 1 - otIp6
Interface Identifier__ bindgen_ ty_ 1 - otJoiner
Info__ bindgen_ ty_ 1 - otMac
KeyMaterial__ bindgen_ ty_ 1 - otNeighbor
Table Entry Info__ bindgen_ ty_ 1 - otNetwork
Diag Tlv__ bindgen_ ty_ 1 - otRadio
Frame__ bindgen_ ty_ 1 - The union of transmit and receive information for a radio frame.
- otTcp
Endpoint__ bindgen_ ty_ 1 - otTcp
Listener__ bindgen_ ty_ 1