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§
- Represents a received IEEE 802.15.4 Beacon.
- Represents Backbone Router configuration.
- Represents a Backbone Router Multicast Listener info.
- Represents the Backbone Router ND Proxy info.
- @struct otBorderAgentId
- Represents a Border Router configuration.
- Represents the counters of packets forwarded via Border Routing.
- Represents an entry from the discovered prefix table.
- Represents an iterator to iterate through the Border Router’s discovered prefix table.
- Represents a discovered router on the infrastructure link.
- Represents the message buffer information for different queues used by OpenThread stack.
- Represents an EID cache entry.
- Represents an iterator used for iterating through the EID cache table entries.
- Holds diagnostic information for a Thread Child
- Represents a CLI command.
- Represents a CoAP resource with block-wise transfer.
- Represents a CoAP option.
- Acts as an iterator for CoAP options
- Represents a CoAP resource.
- Represents the CoAP transmission parameters.
- Represents a Commissioning Dataset.
- @struct otCryptoContext
- @struct otCryptoKey
- Represents the device properties which are used for calculating the local leader weight on a device.
- Represents a DNS query configuration.
- Provides info for a DNS service instance.
- Represents a TXT record entry representing a key/value pair (RFC 6763 - section 6.3).
- Represents an iterator for TXT record entries (key/value pairs).
- Contains the counters of DNS-SD server.
- Represents information of a discovered host for a DNS-SD query.
- Represents information of a discovered service instance for a DNS-SD query.
- Represents an energy scan result.
- @struct otExtAddress
- Represents an Extended PAN ID.
- Represents an External Route configuration.
- Implements ICMPv6 message handler.
- @struct otIcmp6Header
- @struct otIp4Address
- @struct otIp4Cidr
- @struct otIp6Address
- @struct otIp6AddressComponents
- Represents IPv6 address information.
- @struct otIp6InterfaceIdentifier
- @struct otIp6NetworkPrefix
- @struct otIp6Prefix
- Represents the IP level counters.
- Represents a Joiner Discerner.
- Represents a Joiner Info.
- Represents a Joiner PSKd.
- Represents the Thread Leader Data.
- Represents what metrics are specified to query.
- Represents which frames are accounted in a Forward Tracking Series.
- Represents the result (value) for a Link Metrics query.
- Represents an MLE Link Mode configuration.
- A linked buffer structure for use with TCP.
- Represents information used for generating hex dump output.
- Represents 6LoWPAN Context ID information associated with a prefix in Network Data.
- Represents the MAC layer counters.
- Represents a Mac Filter entry.
- @struct otMacKey
- @struct otMacKeyMaterial
- Represents an OpenThread message buffer.
- Represents the local and peer IPv6 socket addresses.
- Represents an OpenThread message queue.
- Represents information about a message queue.
- Represents a message settings.
- Represents the Thread MLE counters.
- Represents multi radio link information associated with a neighbor.
- Represents an address mapping record for NAT64.
- Used to iterate through NAT64 address mappings.
- Represents the counters for NAT64.
- Represents the counters of dropped packets due to errors when handling NAT64 packets.
- Represents the counters for the protocols supported by NAT64.
- Holds diagnostic information for a neighboring Thread node
- Represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table callback
otNeighborTableCallback
. - Represents an IPv6 network interface unicast address.
- Represents an IPv6 network interface multicast address.
- Represents a Network Diagnostic Child Table Entry.
- Represents a Network Diagnostic Connectivity value.
- Represents a Network Diagnostic Mac Counters value.
- Represents a Network Diagnostics MLE Counters value.
- Represents a Network Diagnostic Route64 TLV value.
- Represents a Network Diagnostic Route data.
- Represents a Network Diagnostic TLV.
- @struct otNetworkKey
- Represents a Network Name.
- Represents an Active or Pending Operational Dataset.
- Represents presence of different components in Active or Pending Operational Dataset.
- Represents an Active or Pending Operational Dataset.
- Represents the counters for packets and bytes.
- Represents a group of data of platform-generated RA messages processed.
- Represents a ping request configuration.
- Represents a ping reply.
- Represents statistics of a ping request.
- @struct otPlatCryptoEcdsaKeyPair
- @struct otPlatCryptoEcdsaPublicKey
- @struct otPlatCryptoEcdsaSignature
- @struct otPlatCryptoSha256Hash
- Represents a group of TREL related counters in the platform layer.
- Represents a TREL peer info discovered using DNS-SD browse on the service name “_trel._udp”.
- Represents PSKc.
- Represents radio coexistence metrics.
- Represents an IEEE 802.15.4 radio frame.
- Structure representing radio frame transmit information.
- Structure representing radio frame receive information.
- Represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame.
- Represents information associated with a radio link.
- Holds diagnostic information for a Thread Router
- Represent Security Policy.
- Represents a Server configuration.
- Represents a Service configuration.
- Implements SNTP Query parameters.
- Represents an IPv6 socket address.
- Represents a SRP client service pool entry.
- Represents an SRP client host info.
- Represents an SRP client service.
- Includes SRP server LEASE and KEY-LEASE configurations.
- Includes SRP server lease information of a host/service.
- Includes the statistics of SRP server responses.
- Includes SRP server TTL configurations.
- Represents the steering data.
- Represents a TCP endpoint.
- Contains arguments to the otTcpEndpointInitialize() function.
- Represents a TCP listener.
- Contains arguments to the otTcpListenerInitialize() function.
- Represents the Thread Discovery Request data.
- Represents link-specific information for messages received from the Thread radio.
- Represents the MLE Parent Response data.
- Represents a Thread Dataset timestamp component.
- Represents a TREL peer.
- Represents a UDP receiver.
- Represents a UDP socket.
- Represents the count of queries, responses, failures handled by upstream DNS server.
Constants§
- < Max length for header IE in ACK.
- < DHCPv6 assigned address
- < Manually assigned address
- < SLAAC assigned address
- < Thread assigned address (ALOC, RLOC, MLEID, etc)
- < Domain Prefix was added.
- < Domain Prefix was changed.
- < Domain Prefix was removed.
- < Multicast Listener was added.
- < Multicast Listener was removed or expired.
- < ND Proxy was added.
- < All ND Proxies were cleared.
- < ND Proxy was removed.
- < ND Proxy was renewed.
- < Backbone function is disabled.
- < The Primary Backbone Router.
- < Secondary Backbone Router.
- < Border agent is connected with external commissioner.
- < Border agent is started.
- < Border agent role is disabled.
- < DHCPv6 PD is disabled on the border router.
- < DHCPv6 PD is enabled and will try to request and publish a prefix.
- < DHCPv6 PD in enabled but won’t try to request and publish a prefix.
- < Routing Manager is initialized but disabled.
- < Routing Manager is initialized, enabled, and running.
- < Routing Manager in initialized and enabled but currently stopped.
- < Routing Manager is uninitialized.
- < Bad Gateway
- < Bad Option
- < Bad Request
- < Changed
- < Content
- < RFC7959 Continue
- < Created
- < Delete
- < Deleted
- < Empty message code
- < Forbidden
- < Gateway Timeout
- < Get
- < Internal Server Error
- < Method Not Allowed
- < Not Acceptable
- < Not Found
- < Not Implemented
- < Post
- < Precondition Failed
- < Proxying Not Supported
- < Put
- < RFC7959 Request Entity Incomplete
- < Request Entity Too Large
- < 2.00
- < Service Unavailable
- < Unauthorized
- < Unsupported Content-Format
- < Valid
- < Accept
- < Block1 (RFC7959)
- < Block2 (RFC7959)
- < Content-Format
- application/cbor: [RFC7049]
- application/coap-group+json: [RFC7390]
- application/cose; cose-type=“cose-encrypt”: [RFC8152]
- application/cose; cose-type=“cose-encrypt0”: [RFC8152]
- application/cose-key: [RFC8152]
- application/cose-key-set: [RFC8152]
- application/cose; cose-type=“cose-mac”: [RFC8152]
- application/cose; cose-type=“cose-mac0”: [RFC8152]
- application/cose; cose-type=“cose-sign”: [RFC8152]
- application/cose; cose-type=“cose-sign1”: [RFC8152]
- application/cwt: [RFC8392]
- application/exi: [“Efficient XML Interchange (EXI) Format 1.0 (Second Edition)”, February 2014]
- application/json: [RFC7159]
- application/json-patch+json: [RFC6902]
- application/link-format: [RFC6690]
- application/merge-patch+json: [RFC7396]
- application/octet-stream: [RFC2045][RFC2046]
- application/senml+cbor: [RFC8428]
- application/senml-exi: [RFC8428]
- application/senml+json: [RFC8428]
- application/senml+xml: [RFC8428]
- application/sensml+cbor: [RFC8428]
- application/sensml-exi: [RFC8428]
- application/sensml+json: [RFC8428]
- application/sensml+xml: [RFC8428]
- text/plain; charset=utf-8: [RFC2046][RFC3676][RFC5147]
- application/xml: [RFC3023]
- < ETag
- < If-Match
- < If-None-Match
- < Location-Path
- < Location-Query
- < Max-Age
- < Observe [RFC7641]
- < Proxy-Scheme
- < Proxy-Uri
- < Size1
- < Size2 (RFC7959)
- < Uri-Host
- < Uri-Path
- < Uri-Port
- < Uri-Query
- < Acknowledgment
- < Confirmable
- < Non-confirmable
- < Reset
- < Commissioner role is active.
- < Commissioner role is disabled.
- < Currently petitioning to become a Commissioner.
- < Key Algorithm: AES ECB.
- < Key Algorithm: ECDSA.
- < Key Algorithm: HMAC SHA-256.
- < Key Algorithm: Vendor Defined.
- < Key Persistence: Key is persistent.
- < Key Persistence: Key is volatile.
- < Key Type: AES.
- < Key Type: ECDSA.
- < Key Type: HMAC.
- < Key Type: Raw Data.
- < Key Usage: AES ECB.
- < Key Usage: Encryption (vendor defined).
- < Key Usage: Key can be exported.
- < Key Usage: Key Usage is empty.
- < Key Usage: Sign Hash.
- < Key Usage: Verify Hash.
- < Size of CSL IE content in bytes.
- < The Thread Child role.
- < Not currently participating in a Thread network/partition.
- < The Thread stack is disabled.
- < The Thread Leader role.
- < The Thread Router role.
- < Service type browse service.
- < Service type unspecified.
- < Service type resolve service instance.
- < Service type resolve hostname.
- < Indicates DNS name server can not resolve the query recursively.
- < Indicates DNS name server can resolve the query recursively.
- < Indicates the flag is not specified.
- < Allow NAT64 address translation during DNS client address resolution.
- < Do not allow NAT64 address translation during DNS client address resolution.
- < NAT64 mode is not specified. Use default NAT64 mode.
- < Query for SRV record only.
- < Query for both SRV and TXT records in same message.
- < Query for TXT/SRV together first, if fails then query separately.
- < Query in parallel for SRV and TXT using separate messages.
- < Query for TXT record only.
- < Mode is not specified. Use default service mode.
- DNS query should be sent via UDP.
- DNS transport is unspecified.
- < ECT(0)
- < ECT(1)
- < Congestion encountered (CE)
- < Non-ECT
- < Max length of Link Metrics data in Vendor-Specific IE.
- Operation was aborted.
- Received a frame filtered by the address filter (allowlisted or denylisted).
- Address resolution requires an address query operation.
- The operation is already in progress.
- Service is busy and could not service the operation.
- 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).
- Received a frame filtered by the destination address check.
- Not currently attached to a Thread Partition.
- Message was dropped.
- Received a duplicated frame.
- Operational failed.
- FCS check failure while receiving.
- Generic error (should not use).
- Input arguments are invalid.
- Input (CLI) command is invalid.
- Received a frame from an invalid source address.
- Cannot complete due to invalid state.
- The creation of IPv6 address failed.
- The link margin was too low.
- No error.
- Operation prevented by mode flags
- The requested item could not be found.
- Function or method is not implemented.
- Received a non-lowpan data frame.
- Message is not a TMF Message.
- No acknowledgment was received after macMaxFrameRetries (IEEE 802.15.4-2006).
- Address is not in the source match table.
- Insufficient buffers.
- No frame received.
- No route available.
- Failed to parse message.
- Special error code used to indicate success/error status is pending and not yet known.
- Message is being dropped from reassembly list due to timeout.
- Request rejected.
- Coap response or acknowledgment or DNS, SNTP response not received.
- Security checks failed.
- Received a frame from an unknown neighbor.
- < Input mode without pull resistor.
- < Output mode.
- < Destination Unreachable No Route
- < Fragment Reassembly Time Exceeded
- < ICMPv6 Echo processing enabled for unicast and multicast requests
- < ICMPv6 Echo processing disabled
- < ICMPv6 Echo processing enabled only for multicast requests only
- < ICMPv6 Echo processing enabled for RLOC/ALOC destinations only
- < ICMPv6 Echo processing enabled only for unicast requests only
- < Destination Unreachable
- < Echo Reply
- < Echo Request
- < Neighbor Advertisement
- < Neighbor Solicitation
- < Packet To Big
- < Parameter Problem
- < Router Advertisement
- < Router Solicitation
- < Time Exceeded
- < Size of IE header in bytes.
- < Destination Options for IPv6
- < Fragment Header for IPv6
- < IPv6 Hop-by-Hop Option
- < ICMP for IPv6
- < IPv6 encapsulation
- < No Next Header for IPv6
- < Routing Header for IPv6
- < Transmission Control Protocol
- < User Datagram
- < Accept any Joiner (no EUI64 or Discerner is specified).
- < Joiner Discerner is specified (
mSharedId.mDiscerner
inotJoinerInfo
). - < Joiner EUI-64 is specified (
mSharedId.mEui64
inotJoinerInfo
). - < Use Reference to Key.
- < Use Literal Keys.
- < Clear.
- < Register.
- < OpenThread API
- < EID-to-RLOC mapping.
- < Backbone Router (available since Thread 1.2)
- < Border Router
- < CLI
- < CoAP
- < OpenThread Core
- < DNS
- < Domain Unicast Address (available since Thread 1.2)
- < ICMPv6
- < IPv6
- < IEEE 802.15.4 MAC
- < Memory
- < Mesh Commissioning Protocol
- < MLE
- < Multicast Listener Registration (available since Thread 1.2)
- < NCP
- < Network Data
- < Network Diagnostic
- < Platform
- < Service Registration Protocol (SRP)
- < TCP
- < Utility module
- < Allowlist address filter mode is enabled.
- < Denylist address filter mode is enabled.
- < Address filter is disabled.
- < meshcop Active Timestamp TLV
- < meshcop Border Agent Locator TLV
- < meshcop Channel TLV
- < meshcop Channel Mask TLV
- < meshcop Commissioner ID TLV
- < meshcop Commissioner UDP Port TLV
- < meshcop Commissioner Session ID TLV
- < meshcop Count TLV
- < meshcop Delay Timer TLV
- < meshcop Discovery Request TLV
- < meshcop Discovery Response TLV
- < meshcop Energy List TLV
- < meshcop Extended Pan Id TLV
- < meshcop Get TLV
- < meshcop IPv6 address TLV
- < meshcop Joiner Advertisement TLV
- < meshcop Joiner DTLS Encapsulation TLV
- < meshcop Joiner IID TLV
- < meshcop Joiner Router Locator TLV
- < meshcop Joiner Router KEK TLV
- < meshcop Joiner UDP Port TLV
- < meshcop Mesh Local Prefix TLV
- < meshcop Network Key TLV
- < meshcop Network Name TLV
- < meshcop Network Key Sequence TLV
- < meshcop Pan Id TLV
- < meshcop Pending Timestamp TLV
- < meshcop Period TLV
- < meshcop Provisioning URL TLV
- < meshcop PSKc TLV
- < meshcop Scan Duration TLV
- < meshcop Security Policy TLV
- < meshcop State TLV
- < meshcop Steering Data TLV
- < meshcop UDP encapsulation TLV
- < meshcop Vendor Data TLV
- < meshcop Vendor Model TLV
- < meshcop Vendor Name TLV
- < meshcop Vendor Stack Version TLV
- < meshcop Vendor SW Version TLV
- < Message from a trusted source on host.
- < Message from an untrusted source on host.
- < Message from Thread Netif.
- < High priority level.
- < Low priority level.
- < Normal priority level.
- < Packet drop due to failed to parse the datagram.
- < Packet drop due to no mappings found or mapping pool exhausted.
- < Packet drop for unknown reasons.
- < Packet drop due to unsupported IP protocol.
- < The BR is publishing a NAT64 prefix and/or translating packets.
- < NAT64 is disabled.
- < NAT64 is enabled, but this BR is not an active NAT64 BR.
- < NAT64 is enabled, but one or more dependencies of NAT64 are not running.
- < A child is being added.
- < An existing child’s mode is changed.
- < A child is being removed.
- < A router is being added.
- < A router is being removed.
- < The Backbone interface.
- < The Thread interface.
- < Unspecified network interface.
- < The device hasn’t received time sync for more than two periods time.
- < The device network time is synchronized.
- < The device hasn’t attached to a network.
- The number of defined errors.
- NCP’s MCU can enter low-power (energy-saving) state.
- NCP is fully off.
- NCP’s MCU stays on and active all the time.
- < Battery powered.
- < Externally powered (mains-powered).
- < Stable external power with a battery backup or UPS.
- < Potentially unstable ext power (e.g. light bulb powered via a switch).
- < 2.4 GHz IEEE 802.15.4-2006
- < 2.4 GHz IEEE 802.15.4-2006
- < 2.4 GHz IEEE 802.15.4-2006
- < 915 MHz IEEE 802.15.4-2006
- < 915 MHz IEEE 802.15.4-2006
- < 915 MHz IEEE 802.15.4-2006
- < Number of bits per octet
- < 2.4 GHz IEEE 802.15.4 (bits per second)
- < Radio supports AckTime event.
- < Radio supports CSMA backoff for frame transmission (but no retry).
- < Radio supports Energy Scans.
- < Radio supports no capability.
- < Radio supports rx at specific time.
- < Radio supports RxOnWhenIdle handling.
- < Radio supports direct transition from sleep to TX with CSMA.
- < Radio supports tx retry logic with collision avoidance (CSMA).
- < Radio supports tx security.
- < Radio supports tx at specific time.
- < 2.4 GHz IEEE 802.15.4-2006
- < 2.4 GHz IEEE 802.15.4-2006
- < 915 MHz IEEE 802.15.4-2006
- < 915 MHz IEEE 802.15.4-2006
- < aMaxPHYPacketSize (IEEE 802.15.4-2006)
- < Minimal size of frame FCS + CONTROL
- < LQI measurement not supported
- < Invalid or unknown power value
- < Invalid or unknown RSSI value
- < 2.4 GHz IEEE 802.15.4-2006
- < The O-QPSK PHY symbol rate when operating in the 780MHz, 915MHz, 2380MHz, 2450MHz
- < Symbol duration time in unit of microseconds
- < Time for 10 symbols in unit of microseconds
- < High route preference.
- < Low route preference.
- < Medium route preference.
- < Active Operational Dataset.
- < Unique Border Agent/Router ID.
- < BR local on-link prefixes.
- < BR ULA prefix.
- < Child information.
- < Duplicate Address Detection (DAD) information.
- < Thread network information.
- < Parent information.
- < Pending Operational Dataset.
- < SLAAC key to generate semantically opaque IID.
- < The SRP client info (selected SRP server address).
- < SRP client ECDSA public/private key pair.
- < The SRP server info (UDP port).
- < Item is being added/registered.
- < Item is being refreshed.
- < Item is registered with server.
- < Item is removed.
- < Item is being removed.
- < Item to be added/registered.
- < Item to be refreshed (re-register to renew lease).
- < Item to be removed.
- < Anycast address mode.
- < Unicast address mode.
- < The SRP server is disabled.
- < The SRP server is enabled and running.
- < The SRP server is enabled but stopped.
- < Accept the incoming connection.
- < Defer (silently ignore) the incoming connection.
- < Refuse the incoming connection.
Functions§
- Configures response status for next DUA registration.
- Configures the response status for the next Multicast Listener Registration.
- Gets the local Backbone Router configuration.
- Gets the local Domain Prefix configuration.
- Gets the Backbone Router ND Proxy info.
- Gets the Primary Backbone Router information in the Thread Network.
- Returns the Backbone Router registration jitter value.
- Gets the Backbone Router #otBackboneRouterState.
- Adds a Multicast Listener with a timeout value, in seconds.
- Clears the Multicast Listeners.
- Gets the next Multicast Listener info (using an iterator).
- Explicitly registers local Backbone Router configuration.
- Sets the local Backbone Router configuration #otBackboneRouterConfig.
- Sets the Backbone Router Domain Prefix callback.
- Enables or disables Backbone functionality.
- Sets the Backbone Router Multicast Listener callback.
- Sets the Backbone Router ND Proxy callback.
- Sets the Backbone Router registration jitter value.
- Cancels the ephemeral key that is in use.
- Gets the randomly generated Border Agent ID.
- Gets the #otBorderAgentState of the Thread Border Agent role.
- Gets the UDP port of the Thread Border Agent service.
- Indicates whether or not an ephemeral key is currently active.
- Sets the ephemeral key for a given timeout duration.
- Sets the callback function used by the Border Agent to notify any changes related to use of ephemeral key.
- Sets the Border Agent ID.
- Add a border router configuration to the local network data.
- Add an external route configuration to the local network data.
- Provides a full or stable copy of the local Thread Network Data.
- Gets the next On Mesh Prefix in the local Network Data.
- Gets the next external route in the local Network Data.
- Immediately register the local network data with the Leader.
- Remove a border router configuration from the local network data.
- Remove an external route configuration from the local network data.
- Sets the callback to indicate when Network Data gets full.
- Clears a previously set preference value for advertised Route Info Options.
- Clears a previously set preference value for published routes in Network Data.
- Gets the current state of DHCPv6 Prefix Delegation.
- Enables / Disables DHCPv6 Prefix Delegation.
- Sets the callback whenever the DHCPv6 PD state changes on the Thread interface.
- Gets the currently favored NAT64 prefix.
- Gets the currently favored Off-Mesh-Routable (OMR) Prefix.
- Gets the currently favored On-Link Prefix.
- Gets the local NAT64 Prefix of the Border Router.
- Iterates over the entries in the Border Router’s discovered prefix table.
- Iterates over the discovered router entries on the infrastructure link.
- Gets the local Off-Mesh-Routable (OMR) Prefix, for example
fdfc:1ff5:1512:5622::/64
. - Gets the local On-Link Prefix for the adjacent infrastructure link.
- Gets the DHCPv6 Prefix Delegation (PD) provided off-mesh-routable (OMR) prefix.
- Gets the data of platform generated RA message processed..
- Gets the current preference used when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
- Gets the current preference used for published routes in Network Data.
- Gets the current state of Border Routing Manager.
- Initializes the Border Routing Manager on given infrastructure interface.
- Initializes an
otBorderRoutingPrefixTableIterator
. - Enables or disables the Border Routing Manager.
- Sets additional options to append at the end of emitted Router Advertisement (RA) messages.
- Explicitly sets the preference to use when advertising Route Info Options (RIO) in Router Advertisement messages sent over the infrastructure link.
- Explicitly sets the preference of published routes in Network Data.
- Indicates whether the auto-channel-selection functionality for a network channel is enabled or not.
- Gets the period interval (in seconds) used by auto-channel-selection functionality.
- Indicates whether the auto-csl-channel-selection functionality is enabled or not.
- Gets the CCA failure rate threshold.
- Gets the delay (in seconds) used by Channel Manager for a network channel change.
- Gets the favored channel mask.
- Gets the channel from the last successful call to
otChannelManagerRequestChannelChange()
- Gets the supported channel mask.
- Requests a Thread network channel change.
- Requests that
ChannelManager
checks and selects a new channel and starts a channel change. - Requests that
ChannelManager
checks and selects a new CSL channel and starts a CSL channel change. - Enables or disables the auto-channel-selection functionality for network channel.
- Sets the period interval (in seconds) used by auto-channel-selection functionality.
- Enables or disables the auto-channel-selection functionality for a CSL channel.
- Sets the CCA failure rate threshold.
- Sets the delay (in seconds) used for a network channel change.
- Sets the favored channel mask.
- Sets the supported channel mask.
- Gets the current channel occupancy for a given channel.
- Get channel monitoring RSSI threshold in dBm.
- Get channel monitoring total number of RSSI samples (per channel).
- Get channel monitoring sample interval in milliseconds.
- Get channel monitoring averaging sample window length (number of samples).
- Indicates whether the Channel Monitoring operation is enabled and running.
- Enables or disables the Channel Monitoring operation.
- Get the value of supervision check timeout failure counter.
- Gets the supervision check timeout interval (in seconds) on the child.
- Gets the Child Supervision interval (in seconds) on a child.
- Reset the supervision check timeout failure counter to zero.
- Sets the supervision check timeout interval (in seconds) on the child.
- Sets the child supervision interval (in seconds) on the child.
- Write error code to the CLI console
- Initialize the CLI module.
- Is called to feed in a console input line.
- Write a number of bytes to the CLI console as a hex string.
- Write formatted string to the CLI console
- Callback to write the OpenThread Log to the CLI console
- Set a user command table.
- Callback to allow vendor specific commands to be added to the user command table.
- Adds a block-wise resource to the CoAP server.
- Adds a resource to the CoAP server.
- Converts a CoAP Block option SZX field to the actual block size
- Appends a Block1 option
- Appends a Block2 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.
- Appends a Max-Age option.
- Appends an Observe option.
- Appends a CoAP option in a header.
- Appends a Proxy-Uri option.
- Appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2
- Appends a Uri-Path option.
- Appends a single Uri-Query option.
- Returns the CoAP Code as human readable string.
- Sets the Token length and randomizes its value.
- Returns the Code value.
- Returns the Message ID value.
- Returns a pointer to the Token value.
- Returns the Token length.
- Returns the Type value.
- Initializes the CoAP header.
- Initializes a response message.
- Sets the Code value.
- Adds Payload Marker indicating beginning of the payload to the CoAP header.
- Sets the Token value and length in a header.
- Creates a new CoAP message.
- Returns a pointer to the first option.
- Returns a pointer to the first option matching the specified option number.
- Returns a pointer to the next option.
- Returns a pointer to the next option matching the specified option number.
- 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
- Fills current option value into @p aValue.
- Initialises an iterator for the options in the given message.
- Removes a block-wise resource from the CoAP server.
- Removes a resource from the CoAP server.
- Adds a block-wise resource to the CoAP Secure server.
- Adds a resource to the CoAP Secure server.
- Initializes DTLS session with a peer.
- Stops the DTLS connection.
- Returns the peer x509 certificate base64 encoded.
- Indicates whether or not the DTLS session is closed.
- Indicates whether or not the DTLS session is connected.
- Indicates whether or not the DTLS session is active.
- Removes a block-wise resource from the CoAP Secure server.
- Removes a resource from the CoAP Secure server.
- Sends a CoAP request over secure DTLS connection.
- Sends a CoAP request block-wise over secure DTLS connection.
- Sends a CoAP response from the CoAP Secure server.
- Sends a CoAP response block-wise from the CoAP Secure server.
- Sets the trusted top level CAs. It is needed for validating the certificate of the peer.
- Sets the local device’s X509 certificate with corresponding private key for DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8.
- Sets the connected callback to indicate, when a Client connect to the CoAP Secure server.
- Sets the default handler for unhandled CoAP Secure requests.
- Sets the Pre-Shared Key (PSK) and cipher suite DTLS_PSK_WITH_AES_128_CCM_8.
- Sets the authentication mode for the coap secure connection.
- Starts the CoAP Secure service.
- Starts the CoAP secure service and sets the maximum number of allowed connection attempts before stopping the agent automatically.
- Stops the CoAP Secure server.
- Sends a CoAP request block-wise with custom transmission parameters.
- Sends a CoAP request with custom transmission parameters.
- Sends a CoAP response block-wise from the server with custom transmission parameters.
- Sends a CoAP response from the server with custom transmission parameters.
- Sets the default handler for unhandled CoAP requests.
- Starts the CoAP server.
- Stops the CoAP server.
- Adds a Joiner entry.
- Adds a Joiner entry with a given Joiner Discerner value.
- Sends an Announce Begin message.
- Sends an Energy Scan Query message.
- Returns the Commissioner Id.
- Get joiner info at aIterator position.
- Gets the Provisioning URL.
- Returns the Commissioner Session ID.
- Returns the Commissioner State.
- Sends a PAN ID Query message.
- Removes a Joiner entry.
- Removes a Joiner entry.
- Sends MGMT_COMMISSIONER_GET.
- Sends MGMT_COMMISSIONER_SET.
- Sets the Commissioner Id.
- Sets the Provisioning URL.
- Enables the Thread Commissioner role.
- Disables the Thread Commissioner role.
- Converts an
uint32_t
duration (in seconds) to a human-readable string. - Converts a given Operational Dataset to
otOperationalDatasetTlvs
. - For FTD only, creates a new Operational Dataset to use when forming a new network.
- Generates PSKc from a given pass-phrase, network name, and extended PAN ID.
- Gets the Active Operational Dataset.
- Gets the Active Operational Dataset.
- For FTD only, gets a minimal delay timer.
- Gets the Pending Operational Dataset.
- Gets the Pending Operational Dataset.
- Indicates whether a valid network is present in the Active Operational Dataset or not.
- Parses an Operational Dataset from a given
otOperationalDatasetTlvs
. - Sends MGMT_ACTIVE_GET.
- Sends MGMT_ACTIVE_SET.
- Sends MGMT_PENDING_GET.
- Sends MGMT_PENDING_SET.
- Sets the Active Operational Dataset.
- Sets the Active Operational Dataset.
- For FTD only, sets a minimal delay timer.
- Sets the Pending Operational Dataset.
- Sets the Pending Operational Dataset.
- Updates a given Operational Dataset.
- Cancels an ongoing (if any) Operational Dataset update request.
- Indicates whether there is an ongoing Operation Dataset update request.
- Requests an update to Operational Dataset.
- Indicates whether or not the factory diagnostics mode is enabled.
- Processes a factory diagnostics command line.
- Processes a factory diagnostics command line.
- Gets an IPv6 address associated with an address resolution DNS response.
- Gets the full host name associated with an address resolution DNS response.
- Gets the host IPv6 address from a DNS browse (service instance enumeration) response.
- Gets info for a service instance from a DNS browse (service instance enumeration) response.
- Gets a service instance associated with a DNS browse (service instance enumeration) response.
- Gets the service name associated with a DNS browse (service instance enumeration) response.
- Sends a DNS browse (service instance enumeration) query for a given service name.
- Gets the current default query config used by DNS client.
- Sends an address resolution DNS query for AAAA (IPv6) record(s) for a given host name.
- Sends an address resolution DNS query for A (IPv4) record(s) for a given host name.
- Starts a DNS service instance resolution for a given service instance.
- 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.
- Sets the default query config on DNS client.
- Encodes a given list of TXT record entries (key/value pairs) into TXT data (following format specified by RFC 6763).
- Parses the TXT data from an iterator and gets the next TXT record entry (key/value pair).
- Initializes a TXT record iterator.
- Indicates whether the “DNS name compression” mode is enabled or not.
- Gets the host IPv6 address from a DNS service instance resolution response.
- Gets info for a service instance from a DNS service instance resolution response.
- Gets the service instance name associated with a DNS service instance resolution response.
- Enables/disables the “DNS name compression” mode.
- Returns the counters of the DNS-SD server.
- Acquires the next query in the DNS-SD server.
- Acquires the DNS-SD query type and name for a specific query.
- Notifies a discovered host.
- Notifies a discovered service instance.
- Sets DNS-SD server query callbacks.
- Returns whether the DNSSD server will forward DNS queries to the platform DNS upstream API.
- Enable or disable forwarding DNS queries to platform DNS upstream API.
- Generates a memory dump at critical log level.
- Generates a memory dump at debug log level.
- Generates a memory dump at info log level.
- Generates a memory dump at note log level.
- Generates a memory dump at warning log level.
- Gets the OpenThread radio version string.
- Gets the OpenThread version string.
- @note This API is deprecated and use of it is discouraged.
- @note This API is deprecated and use of it is discouraged.
- Indicates whether or not ICMPv6 Echo processing is enabled.
- Registers a handler to provide received ICMPv6 messages.
- Sends an ICMPv6 Echo Request via the Thread interface.
- Sets whether or not ICMPv6 Echo processing is enabled.
- 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. - Deletes all the settings stored on non-volatile memory, and then triggers a platform reset.
- Disables the OpenThread library.
- Gets the instance identifier.
- Returns the current instance uptime (in msec).
- Returns the current instance uptime as a human-readable string.
- Initializes the OpenThread library.
- Initializes the OpenThread instance.
- Initializes the static single instance of the OpenThread library.
- Indicates whether or not the instance is valid/initialized.
- Triggers a platform reset.
- Resets the internal states of the OpenThread radio stack.
- Triggers a platform reset to bootloader mode, if supported.
- Converts a human-readable IPv4 address string into a binary representation.
- Converts the address to a string.
- Converts a human-readable IPv4 CIDR string into a binary representation.
- Converts the IPv4 CIDR to a string.
- Set @p aIp4Address by performing NAT64 address translation from @p aIp6Address as specified in RFC 6052.
- Extracts the IPv4 address from a given IPv4-mapped IPv6 address.
- Test if two IPv4 addresses are the same.
- Allocate a new message buffer for sending an IPv4 message to the NAT64 translator.
- Converts a given IP4 address to an IPv6 address following the IPv4-mapped IPv6 address format.
- Adds a Network Interface Address to the Thread interface.
- Adds a port to the allowed unsecured port list.
- Converts a human-readable IPv6 address string into a binary representation.
- Converts a given IPv6 address to a human-readable string.
- Test if two IPv6 prefixes are the same.
- Gets the Border Routing counters.
- Gets the list of IPv6 multicast addresses subscribed to the Thread interface.
- Gets a prefix with @p aLength from @p aAddress.
- Gets the list of IPv6 addresses assigned to the Thread interface.
- Returns a pointer to the unsecure port list.
- Indicates whether or not a unicast IPv6 address is assigned to the Thread interface.
- Test if two IPv6 addresses are the same.
- Indicates whether or not a given IPv6 address is the Unspecified Address.
- Indicates whether or not the IPv6 interface is up.
- Checks if multicast promiscuous mode is enabled on the Thread interface.
- Indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
- Indicates whether the SLAAC module is enabled or not.
- Allocate a new message buffer for sending an IPv6 message.
- Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message.
- Converts a human-readable IPv6 prefix string into a binary representation.
- Returns the prefix match length (bits) for two IPv6 addresses.
- Converts a given IPv6 prefix to a human-readable string.
- Converts a given IP protocol number to a human-readable string.
- Registers Multicast Listeners to Primary Backbone Router.
- Removes all ports from the allowed unsecure port list.
- Removes a Network Interface Address from the Thread interface.
- Removes a port from the allowed unsecure port list.
- Resets the Border Routing counters.
- Perform OpenThread source address selection.
- Sends an IPv6 datagram via the Thread interface.
- Registers a callback to notify internal IPv6 address changes.
- Brings the IPv6 interface up or down.
- Sets the Mesh Local IID (for test purpose).
- Enables or disables multicast promiscuous mode on the Thread interface.
- Registers a callback to provide received IPv6 datagrams.
- Sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback().
- Enables/disables the SLAAC module.
- Sets the SLAAC module filter handler.
- Converts a given IPv6 socket address to a human-readable string.
- Subscribes the Thread interface to a Network Interface Multicast Address.
- Unsubscribes the Thread interface to a Network Interface Multicast Address.
- Get the Jam Detection Busy Period (in seconds)
- Get the current history bitmap.
- Get the Jam Detection RSSI Threshold (in dBm).
- Get the Jam Detection State
- Get the Jam Detection Detection Window (in seconds).
- Get the Jam Detection Status (enabled/disabled)
- Set the Jam Detection Busy Period (in seconds).
- Set the Jam Detection RSSI Threshold (in dBm).
- Set the Jam Detection Detection Window (in seconds).
- Start the jamming detection.
- Stop the jamming detection.
- Gets the Joiner Discerner. For more information, refer to #otJoinerSetDiscerner.
- Gets the Joiner ID.
- Gets the Joiner State.
- Sets the Joiner Discerner.
- Enables the Thread Joiner role.
- Converts a given joiner state enumeration value to a human-readable string.
- Disables the Thread Joiner role.
- Starts an IEEE 802.15.4 Active Scan
- Converts link quality to typical received signal strength.
- Converts received signal strength to link quality.
- Starts an IEEE 802.15.4 Energy Scan
- Adds an Extended Address to MAC filter.
- 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. - Clears all the Extended Addresses from MAC filter.
- 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. - Clears any previously set default received signal strength (in dBm) on MAC Filter.
- Gets the address mode of MAC filter.
- Gets an in-use address filter entry.
- Gets an in-use RssIn filter entry.
- Removes an Extended Address from MAC filter.
- 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.) - Sets the address mode of MAC filter.
- Sets the default received signal strength (in dBm) on MAC Filter.
- Returns the current CCA (Clear Channel Assessment) failure rate.
- Get the IEEE 802.15.4 channel.
- Get the MAC layer counters.
- Gets the CSL channel.
- Gets the CSL period in microseconds
- Gets the CSL timeout.
- Gets the IEEE 802.15.4 Extended Address.
- Get the factory-assigned IEEE EUI-64.
- Returns the maximum number of frame retries during direct transmission.
- Returns the maximum number of frame retries during indirect transmission.
- Get the IEEE 802.15.4 PAN ID.
- Get the data poll period of sleepy end device.
- Get the region code.
- Get the IEEE 802.15.4 Short Address.
- Get the supported channel mask of MAC layer.
- Gets histogram of retries for a single direct packet until success.
- Gets histogram of retries for a single indirect packet until success.
- Indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress.
- Indicates whether or not CSL is enabled.
- Indicates whether the device is connected to a parent which supports CSL.
- Indicates whether or not the link layer is enabled.
- Indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress.
- Indicates whether or not an IEEE 802.15.4 MAC is in the transmit state.
- Indicates whether or not promiscuous mode is enabled at the link layer.
- Indicates whether the IEEE 802.15.4 radio filter is enabled or not.
- Sends an MLE Link Metrics Management Request to configure/clear an Enhanced-ACK Based Probing. This functionality requires OT_LINK_METRICS_INITIATOR feature enabled.
- Sends an MLE Link Metrics Management Request to configure or clear a Forward Tracking Series.
- Get Link Metrics data of a neighbor by its extended address.
- If Link Metrics Manager is enabled.
- Enable or disable Link Metrics Manager.
- Sends an MLE Data Request to query Link Metrics.
- Sends an MLE Link Probe message.
- Begins the energy scan sequence on the radio.
- Get the radio capabilities.
- Gets the status of promiscuous mode.
- Get current platform time (64bits width) of the radio chip.
- Get the most recent RSSI measurement.
- The radio transitions from Transmit to Receive. Returns a pointer to the transmit buffer.
- Indicates whether or not the raw link-layer is enabled.
- Transitioning the radio from Sleep to Receive. Turn on the radio.
- Sets the current MAC frame counter value.
- Sets the current MAC frame counter value only if the new value is larger than the current one.
- Update MAC keys and key index.
- Enables or disables promiscuous mode.
- Enables/disables the raw link-layer.
- Set the Short Address for address filtering.
- Transition the radio from Receive to Sleep. Turn off the radio.
- Adding extended address to the source match table.
- Adding short address to the source match table.
- Removing all the extended addresses from the source match table.
- Removing extended address to the source match table of the radio.
- Removing all the short addresses from the source match table.
- Removing short address to the source match table.
- Enable/Disable source match for frame pending.
- Begins the transmit sequence on the radio.
- Resets the MAC layer counters.
- Clears histogram statistics for direct and indirect transmissions.
- Enqueues an IEEE 802.15.4 Data Request message for transmission.
- Instructs the device to send an empty IEEE 802.15.4 data frame.
- Set the IEEE 802.15.4 channel
- Sets the CSL channel.
- Sets the CSL period in microseconds. Disable CSL by setting this parameter to
0
. - Sets the CSL timeout in seconds.
- Enables or disables the link layer.
- Sets the IEEE 802.15.4 Extended Address.
- Sets the maximum number of frame retries during direct transmission.
- Sets the maximum number of frame retries during indirect transmission.
- Set the IEEE 802.15.4 PAN ID.
- Registers a callback to provide received raw IEEE 802.15.4 frames.
- Set/clear user-specified/external data poll period for sleepy end device.
- Enables or disables the link layer promiscuous mode.
- Enables/disables IEEE 802.15.4 radio filter mode.
- Sets the region code.
- Set the supported channel mask of MAC layer.
- Emits a log message at a given log level.
- Emits a log message at critical log level.
- Emits a log message at debug log level.
- Generates the next hex dump line.
- Emits a log message at info log level.
- Emits a log message at note log level.
- Emits a log message at given log level using a platform module name.
- Emits a log message at given log level using a platform module name.
- Emits a log message at warning log level.
- Returns the current log level.
- Sets the log level.
- Append bytes to a message.
- Free an allocated message buffer.
- Get the Message Buffer information.
- Get the message length in bytes.
- Get the message offset in bytes.
- Gets the message origin.
- Returns the average RSS (received signal strength) associated with the message.
- Retrieves the link-specific information for a message received over Thread radio.
- Indicates whether or not link security is enabled for the message.
- Indicates whether or not the message is allowed to be looped back to host.
- Indicates whether the given message may be looped back in a case of a multicast destination address.
- Removes a message from the given message queue.
- Adds a message to the end of the given message queue.
- Adds a message at the head/front of the given message queue.
- Returns a pointer to the message at the head of the queue.
- Returns a pointer to the next message in the queue by iterating forward (from head to tail).
- Initialize the message queue.
- Read bytes from a message.
- Reset the Message Buffer information counter tracking the maximum number buffers in use at the same time.
- Sets/forces the message to be forwarded using direct transmission. Default setting for a new message is
false
. - Set the message length in bytes.
- Sets whether or not the message is allowed to be looped back to host.
- Controls whether the given message may be looped back in a case of a multicast destination address.
- Set the message offset in bytes.
- Sets the message origin.
- Write bytes to a message.
- Gets the multi radio link information associated with a neighbor with a given Extended Address.
- Gets the IPv4 CIDR configured in the NAT64 translator.
- Gets NAT64 translator counters.
- Gets the NAT64 translator error counters.
- Gets the next AddressMapping info (using an iterator).
- Gets the state of NAT64 prefix manager.
- Gets the state of NAT64 translator.
- Initializes an
otNat64AddressMappingIterator
. - Translates an IPv4 datagram to an IPv6 datagram and sends via the Thread interface.
- Enable or disable NAT64 functions.
- Sets the CIDR used when setting the source address of the outgoing translated IPv4 packets.
- Registers a callback to provide received IPv4 datagrams.
- Sets the IPv6 address by performing NAT64 address translation from the preferred NAT64 prefix and the given IPv4 address as specified in RFC 6052.
- Initialize the NCP based on HDLC framing.
- Initialize the NCP based on HDLC framing.
- Is called after HDLC encoded NCP data received.
- Is called after NCP send finished.
- Writes OpenThread Log using
otNcpStreamWrite
. - Registers peek/poke delegate functions with NCP module.
- Initialize the NCP based on SPI framing.
- @brief Send data to the host via a specific stream.
- Check whether a given Prefix can act as a valid OMR prefix and also the Leader’s Network Data contains this prefix.
- Provide full or stable copy of the Partition’s Thread Network Data.
- Gets the Commissioning Dataset from the partition’s Network Data.
- Get the current length (number of bytes) of Partition’s Thread Network Data.
- Get the maximum observed length of the Thread Network Data since OT stack initialization or since the last call to
otNetDataResetMaxLength()
. - Get the next 6LoWPAN Context ID info in the partition’s Network Data.
- Get the next On Mesh Prefix in the partition’s Network Data.
- Get the next external route in the partition’s Network Data.
- Get the next service in the partition’s Network Data.
- Get the Stable Network Data Version.
- Get the Network Data Version.
- Reset the tracked maximum length of the Thread Network Data.
- Check if the steering data includes a Joiner.
- Check if the steering data includes a Joiner with a given discerner value.
- Sets an
otNetworkName
instance from a given null terminated C string. - Get the Thread network time.
- Get the time synchronization period.
- Get the time synchronization XTAL accuracy threshold for Router.
- Set the time synchronization period.
- Set the time synchronization XTAL accuracy threshold for Router-Capable device.
- Set a callback to be called when a network time sync or status change occurs
- Starts a ping.
- Stops an ongoing ping.
- Signal that the alarm has fired.
- Get the current time.
- Set the alarm to fire at @p aDt microseconds after @p aT0.
- Stop the alarm.
- Signal that the alarm has fired.
- Get the current time.
- Set the alarm to fire at @p aDt milliseconds after @p aT0.
- Stop the alarm.
- Provides a platform specific implementation for assert.
- 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.
- Handles ICMP6 RA messages received on the Thread interface on the platform.
- 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:
- Encrypt the given data.
- Free the AES context.
- Initialise the AES operation.
- Set the key for AES operation.
- Destroy a key stored in PSA ITS.
- Get the associated public key from the key reference passed.
- Generate and import a new ECDSA key-pair at reference passed.
- Generate and populate the output buffer with a new ECDSA key-pair.
- Get the associated public key from the input context.
- Calculate the ECDSA signature for a hashed message using the private key from the input context.
- Calculate the ECDSA signature for a hashed message using the Key reference passed.
- Use the key from the input context to verify the ECDSA signature of a hashed message.
- Use the keyref to verify the ECDSA signature of a hashed message.
- Export a key stored in PSA ITS.
- Check if the key ref passed has an associated key in PSA ITS.
- Uninitialize the HKDF context.
- Perform HKDF Expand step.
- Perform HKDF Extract step.
- Initialise the HKDF context.
- Uninitialize the HMAC operation.
- Complete the HMAC operation.
- Initialize the HMAC operation.
- Start HMAC operation.
- Update the HMAC operation with new input.
- Import a key into PSA ITS.
- Initialize the Crypto module.
- Perform PKCS#5 PBKDF2 using CMAC (AES-CMAC-PRF-128).
- Deinitialize cryptographically-secure pseudorandom number generator (CSPRNG).
- Fills a given buffer with cryptographically secure random bytes.
- Initialize cryptographically-secure pseudorandom number generator (CSPRNG).
- Uninitialize the SHA-256 operation.
- Finish SHA-256 operation.
- Initialise the SHA-256 operation.
- Start SHA-256 operation.
- Update SHA-256 operation with new input.
- Poll/Read a byte from the debug uart
- Poll/test debug uart if a key has been pressed. It would be common to a stub function that returns 0.
- Some platforms (simulation) can log to a file.
- Standard printf() to the debug uart with no log decoration.
- Write byte to the uart, expand cr/lf as need.
- Platform specific write single byte to Debug Uart This should not perform CR/LF mapping.
- identical to “man 3 puts” - terminates with lf Which is then mapped to cr/lf as required
- puts() without a terminal newline. see: “man 3 puts”, without a adding a terminal lf
- Standard vprintf() to the debug uart, with no log decoration.
- Write N bytes to the UART, mapping cr/lf
- Processes the alarm event.
- Signal diagnostics module that the alarm has fired.
- Sets the channel to use for factory diagnostics.
- Gets the gpio value.
- Gets the gpio mode.
- Sets the gpio value.
- Sets the gpio mode.
- Indicates whether or not factory diagnostics mode is enabled.
- Enables/disables the factory diagnostics mode.
- Processes a factory diagnostics command line.
- Get the power settings for the given channel.
- Get the radio raw power setting for diagnostics module.
- Enable/disable the platform layer to use the raw power setting set by
otPlatDiagRadioSetRawPowerSetting()
. - The radio driver calls this method to notify OpenThread diagnostics module of a received frame.
- Processes the received radio frame.
- Set the radio raw power setting for diagnostics module.
- Start/stop the platform layer to transmit continuous carrier wave.
- The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed.
- Start/stop the platform layer to transmit stream of characters.
- Sets the transmit power to use for factory diagnostics.
- Cancels a transaction of upstream query.
- Starts an upstream query transaction.
- The platform calls this function to finish DNS query.
- Fill buffer with entropy.
- Erases the swap space indicated by @p aSwapIndex.
- Gets the size of the swap space.
- Initializes the flash driver.
- Reads @p aSize bytes into @p aData.
- Writes @p aSize bytes from @p aData.
- Frees memory that was dynamically allocated.
- Gets the current desired MCU power state.
- Returns the reason for the last platform reset.
- Send a request to discover the NAT64 prefix on the infrastructure interface with @p aInfraIfIndex.
- The infra interface driver calls this method to notify OpenThread that the discovery of NAT64 prefix is done.
- Tells whether an infra interface has the given IPv6 address assigned.
- The infra interface driver calls this method to notify OpenThread that an ICMPv6 Neighbor Discovery message is received.
- Sends an ICMPv6 Neighbor Discovery message on given infrastructure interface.
- The infra interface driver calls this method to notify OpenThread of the interface state changes.
- Outputs logs.
- This function handles OpenThread log level changes.
- Is used to free a buffer back to the platform managed buffer pool.
- Initialize the platform implemented message pool.
- Allocate a buffer from the platform managed buffer pool.
- Get the number of free buffers.
- Exports status information to OTNS.
- Add a calibrated power of the specified channel to the power calibration table.
- Add an extended address to the source address match table.
- Add a short address to the source address match table.
- Clear all calibrated powers from the power calibration table.
- Clear all the extended/long addresses from source address match table.
- Remove an extended address from the source address match table.
- Clear all short addresses from the source address match table.
- Remove a short address from the source address match table.
- Enable/disable or update Enhanced-ACK Based Probing in radio for a specific Initiator.
- Disable the radio.
- Enable the radio.
- Enable or disable CSL receiver.
- Enable/Disable source address match feature.
- Begin the energy scan sequence on the radio.
- The radio driver calls this method to notify OpenThread that the energy scan is complete.
- Get the bus speed in bits/second between the host and the radio chip.
- Get the radio capabilities.
- Get the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
- Get the radio coexistence metrics.
- 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.
- The fixed uncertainty (i.e. random jitter) of the arrival time of CSL transmissions received by this device in units of 10 microseconds.
- Gets the external FEM’s Rx LNA gain in dBm.
- Gets the factory-assigned IEEE EUI-64 for this interface.
- Get the current time in microseconds referenced to a continuous monotonic local radio clock (64 bits width).
- Gets the radio preferred channel mask that the device prefers to form on.
- Get the status of promiscuous mode.
- Get the raw power setting for the given channel.
- Get the radio receive sensitivity value.
- Get the region code.
- Get the most recent RSSI measurement.
- Get current state of the radio.
- Get the radio supported channel mask that the device is allowed to be on.
- Get the radio transmit frame buffer.
- Get the radio’s transmit power in dBm.
- Get the radio version string.
- Check whether radio coex is enabled or not.
- Check whether radio is enabled or not.
- Transition the radio from Sleep to Receive (turn on the radio).
- Schedule a radio reception window at a specific time and duration.
- The radio driver calls this method to notify OpenThread of a received frame.
- Reset CSL receiver in the platform.
- Set the radio’s CCA ED threshold in dBm measured at antenna connector per IEEE 802.15.4 - 2015 section 10.1.4.
- Set the max transmit power for a specific channel.
- Set the target power for the given channel.
- Enable the radio coex.
- Set the Extended Address for address filtering.
- Sets the external FEM’s Rx LNA gain in dBm.
- Sets the current MAC frame counter value.
- Sets the current MAC frame counter value only if the new given value is larger than the current value.
- Update MAC keys and key index
- Set the PAN ID for address filtering.
- Enable or disable promiscuous mode.
- Set the region code.
- Sets the rx-on-when-idle state to the radio platform.
- Set the Short Address for address filtering.
- Set the radio’s transmit power in dBm.
- Transition the radio from Receive to Sleep (turn off the radio).
- Begin the transmit sequence on the radio.
- 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.
- The radio driver calls this method to notify OpenThread that the transmission has started.
- Update CSL sample time in radio driver.
- Performs a software reset on the platform, if supported.
- Performs a hardware reset on the platform to launch bootloader mode, if supported.
- Sets the desired MCU power state.
- Adds a value to a setting.
- Performs any de-initialization for the settings subsystem, if necessary.
- Removes a setting from the setting store.
- Fetches the value of a setting.
- Performs any initialization for the settings subsystem, if necessary.
- Sets or replaces the value of a setting.
- Removes all settings from the setting store.
- Shutdown and disable the SPI slave interface.
- Initialize the SPI slave interface.
- 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()
. - Get the current platform time in microseconds referenced to a continuous monotonic local clock (64 bits width).
- Get the current estimated worst case accuracy (maximum ± deviation from the nominal frequency) of the local platform clock in units of PPM.
- Disables TREL platform layer.
- Initializes and enables TREL platform layer.
- Gets the pointer to the TREL counters in the platform layer.
- This is a callback function from platform layer to report a discovered TREL peer info.
- Is a callback from platform to notify of a received TREL UDP packet.
- Registers a new service to be advertised using DNS-SD [RFC6763].
- Resets the TREL counters in the platform layer.
- Requests a TREL UDP packet to be sent to a given destination.
- Binds the UDP socket by platform.
- Binds the UDP socket to a platform network interface.
- Closes the UDP socket by platform.
- Connects UDP socket by platform.
- Configures the UDP socket to join a UDP multicast group.
- Configures the UDP socket to leave a UDP multicast group.
- Sends UDP payload by platform.
- Initializes the UDP socket by platform.
- Performs a platform specific operation to wake the host MCU. This is used only for NCP configurations.
- Adds a random jitter within a given range to a given value.
- Fills a given buffer with random bytes.
- Generates and returns a random byte.
- Generates and returns a random
uint8_t
value within a given range[aMin, aMax)
. - Generates and returns a random
uint16_t
value. - Generates and returns a random
uint32_t
value. - Generates and returns a random
uint16_t
value within a given range[aMin, aMax)
. - Generates and returns a random
uint32_t
value within a given range[aMin, aMax)
. - Removes a callback to indicate when certain configuration or state changes within OpenThread.
- Add a service configuration to the local network data.
- Provides a full or stable copy of the local Thread Network Data.
- Gets the next service in the local Network Data.
- Immediately register the local network data with the Leader.
- Remove a service configuration from the local network data.
- Registers a callback to indicate when certain configuration or state changes within OpenThread.
- Sends a SNTP query.
- Sets the unix era number.
- Adds a service to be registered with server.
- Allocates a new service entry from the pool.
- Frees all previously allocated service entries.
- Frees a previously allocated service entry.
- Gets the array of IPv6 address entries to use as SRP client host address list.
- Gets the string buffer to use for SRP client host name.
- Gets the string buffer for service instance name from a service entry.
- Gets the string buffer for service name from a service entry.
- Gets the buffer for TXT record from a service entry.
- Gets the array for service subtype labels from the service entry.
- Clears all host info and all the services.
- Clears a service, immediately removing it from the client service list.
- Disables the auto-start mode.
- Enables auto host address mode.
- Enables the auto-start mode.
- Gets the domain name being used by SRP client.
- Gets the host info.
- Gets the default key lease interval used in SRP update requests.
- Gets the default lease interval used in SRP update requests.
- Gets the socket address (IPv6 address and port number) of the SRP server which is being used by SRP client.
- Gets the list of services being managed by client.
- Gets the TTL value in every record included in SRP update requests.
- Indicates the current state of auto-start mode (enabled or disabled).
- Indicates whether the SRP client is running or not.
- Indicates whether the “service key record inclusion” mode is enabled or disabled.
- Converts a
otSrpClientItemState
to a string. - Starts the remove process of the host info and all services.
- Requests a service to be unregistered with server.
- Sets the callback to notify caller of events/changes from SRP client.
- Sets the domain name to be used by SRP client.
- Sets/updates the list of host IPv6 address.
- Sets the host name label.
- Sets the default key lease interval used in SRP update requests.
- Sets the default lease interval used in SRP update requests.
- Enables/disables “service key record inclusion” mode.
- Sets the TTL value in every record included in SRP update requests.
- Starts the SRP client operation.
- Stops the SRP client operation.
- Returns the address mode being used by the SRP server.
- Returns the sequence number used with anycast address mode.
- Returns the domain authorized to the SRP server.
- Returns SRP server LEASE and KEY-LEASE configurations.
- Returns the next registered host on the SRP server.
- Returns the port the SRP server is listening to.
- Returns the response counters of the SRP server.
- Returns the state of the SRP server.
- Returns SRP server TTL configuration.
- Reports the result of processing a SRP update to the SRP server.
- Returns the addresses of given host.
- Returns the full name of the host.
- Returns the LEASE and KEY-LEASE information of a given host.
- Returns the next service of given host.
- Tells if the SRP service host has been deleted.
- Indicates whether the host matches a given host name.
- Indicates whether the auto-enable mode is enabled or disabled.
- Parses a sub-type service name (full name) and extracts the sub-type label.
- Returns the host which the service instance reside on.
- Returns the service instance label (first label in instance name) of the service.
- Returns the full service instance name of the service.
- Returns the LEASE and KEY-LEASE information of a given service.
- Gets the number of sub-types of the service.
- Returns the port of the service instance.
- Returns the priority of the service instance.
- Returns the full service name of the service.
- Gets the sub-type service name (full name) of the service at a given index
- Returns the TTL of the service instance.
- Returns the TXT record data of the service instance.
- Returns the weight of the service instance.
- Indicates whether or not the service has a given sub-type.
- Indicates whether or not the SRP service has been deleted.
- Indicates whether this service matches a given service instance name.
- Indicates whether this service matches a given service name.
- Sets the address mode to be used by the SRP server.
- Sets the sequence number used with anycast address mode.
- Enables/disables the auto-enable mode on SRP server.
- Sets the domain on the SRP server.
- Enables/disables the SRP server.
- Sets SRP server LEASE and KEY-LEASE configurations.
- Sets the SRP service updates handler on SRP server.
- Sets SRP server TTL configuration.
- Indicates whether or not OpenThread has tasklets pending.
- Run all queued OpenThread tasklets at the time this is called.
- OpenThread calls this function when the tasklet queue transitions from empty to non-empty.
- Forcibly ends the TCP connection associated with this TCP endpoint.
- Binds the TCP endpoint to an IP address and port.
- 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.
- Records the remote host and port for this connection.
- Deinitializes this TCP endpoint.
- Obtains the context pointer that was associated with @p aEndpoint upon initialization.
- Obtains the otInstance that was associated with @p aEndpoint upon initialization.
- Initializes a TCP endpoint.
- Obtains a pointer to a TCP endpoint’s local host and port.
- Obtains a pointer to a TCP endpoint’s peer’s host and port.
- Causes incoming TCP connections that match the specified IP address and port to trigger this TCP listener’s callbacks.
- Deinitializes this TCP listener.
- Obtains the context pointer that was associated with @p aListener upon initialization.
- Obtains the otInstance that was associated with @p aListener upon initialization.
- Initializes a TCP listener.
- Provides the application with a linked buffer chain referencing data currently in the TCP receive buffer.
- Reorganizes the receive buffer to be entirely contiguous in memory.
- Adds data to the send buffer by extending the length of the final otLinkedBuffer in the send buffer by the specified amount.
- Adds data referenced by the linked buffer pointed to by @p aBuffer to the send buffer.
- Informs the connection peer that this TCP endpoint will not send more data.
- Causes this TCP listener to stop listening for incoming connections.
- Attempt to reattach as a child.
- Detach from the Thread network.
- Become a leader and start a new partition.
- Attempt to become a router.
- Notifies other nodes in the network (if any) and then stops Thread protocol operation.
- Convert the device role to human-readable string.
- Starts a Thread Discovery scan.
- Converts an otError enum into a string.
- Gets the current Interval Max value used by Advertisement trickle timer.
- Gets diagnostic information for an attached Child by its Child ID or RLOC16.
- The function retains diagnostic information for an attached Child by the internal table index.
- Gets the next IPv6 address (using an iterator) for a given child.
- Get the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
- Gets the Thread Child Timeout (in seconds) used when operating in the Child role.
- Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
- Get the current device properties.
- Get the device role.
- Gets the Thread Domain Name.
- Gets the IEEE 802.15.4 Extended PAN ID.
- Gets the Interface Identifier manually specified for the Thread Domain Unicast Address.
- Gets the IPv6 counters.
- Gets the Joiner UDP Port.
- Gets the thrKeySequenceCounter.
- Gets the thrKeySwitchGuardTime (in hours).
- Get the Thread Leader Data.
- Returns a pointer to the Leader’s RLOC.
- Get the Leader’s Router ID.
- Get the Leader’s Weight.
- Gets the Thread Link-Local All Thread Nodes multicast address.
- Gets the Thread link-local IPv6 address.
- Get the MLE Link Mode configuration.
- Gets the Thread Leader Weight used when operating in the Leader role.
- Gets the maximum number of children currently allowed.
- Gets the maximum number of IP addresses that each MTD child may register with this device as parent.
- The function returns the maximum allowed router ID
- Gets the maximum time-in-queue for messages in the TX queue.
- Gets the Mesh Local EID address.
- Returns a pointer to the Mesh Local Prefix.
- Gets the Thread MLE counters.
- Get the
NETWORK_ID_TIMEOUT
parameter. - Get the Thread Network Key.
- Get the
otNetworkKeyRef
for Thread Network Key. - Get the Thread Network Name.
- Gets the next EID cache entry (using an iterator).
- Gets the next Network Diagnostic TLV in the message.
- Gets the next hop and path cost towards a given RLOC16 destination.
- Gets the next neighbor information. It is used to go through the entries of the neighbor table.
- The function retrieves the average RSSI for the Thread Parent.
- The function retrieves diagnostic information for a Thread Router as parent.
- The function retrieves the RSSI of the last packet from the Thread Parent.
- Get the assigned parent priority.
- Get the Partition ID.
- Get the preferred Thread Leader Partition Id used when operating in the Leader role.
- Get the Thread PSKc
- Get Key Reference to Thread PSKc stored
- Gets the Thread Realm-Local All Thread Nodes multicast address.
- Gets the Thread Routing Locator (RLOC) address.
- Get the RLOC16.
- Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role.
- Gets the range of router IDs that are allowed to assign to nodes within the thread network.
- Get the current Router ID Sequence.
- The function retains diagnostic information for a given Thread Router.
- Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
- Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role.
- Retrieves the Service ALOC for given Service ID.
- Gets the time-in-queue histogram for messages in the TX queue.
- Get the vendor app URL string.
- Get the vendor model string.
- Get the vendor name string.
- Get the vendor software version string.
- Gets the Thread protocol version.
- Indicates whether an anycast locate request is currently in progress.
- Determines if an MLE Thread Discovery is currently in progress.
- Indicates whether or not the device is router-eligible.
- Indicates whether or not a Router ID is currently allocated.
- Indicates whether a node is the only router on the network.
- Requests the closest destination of a given anycast address to be located.
- Registers a neighbor table callback function.
- Registers a callback to receive MLE Parent Response data.
- Release a Router ID that has been allocated by the device in the Leader role.
- Resets the IPv6 counters.
- Resets the Thread MLE counters.
- Resets the TX queue time-in-queue statistics.
- Starts the process for child to search for a better parent while staying attached to its current parent.
- Sends a Proactive Address Notification (ADDR_NTF.ntf) message.
- Send a Network Diagnostic Get request.
- Send a Network Diagnostic Reset request.
- Sends a Proactive Backbone Notification (PRO_BB.ntf) message on the Backbone link.
- Sets whether the device was commissioned using CCM.
- Set the MLE_CHILD_ROUTER_LINKS parameter used in the REED role.
- Sets the Thread Child Timeout (in seconds) used when operating in the Child role.
- Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role.
- Set the device properties which are then used to determine and set the Leader Weight.
- Sets a callback to receive MLE Discovery Request data.
- Sets the Thread Domain Name. Only succeeds when Thread protocols are disabled.
- Starts Thread protocol operation.
- Sets the IEEE 802.15.4 Extended PAN ID.
- Sets or clears the Interface Identifier manually specified for the Thread Domain Unicast Address.
- Sets the Thread Joiner Advertisement when discovering Thread network.
- Sets the Joiner UDP Port.
- Sets the thrKeySequenceCounter.
- Sets the thrKeySwitchGuardTime (in hours).
- Set the MLE Link Mode configuration.
- Sets the Thread Leader Weight used when operating in the Leader role.
- Sets the maximum number of children currently allowed.
- Sets or restores the maximum number of IP addresses that each MTD child may register with this device as parent.
- Sets the Mesh Local Prefix.
- Set the
NETWORK_ID_TIMEOUT
parameter. - Set the Thread Network Key.
- Set the Thread Network Key as a
otNetworkKeyRef
. - Set the Thread Network Name.
- Set the parent priority.
- Set the preferred Thread Leader Partition Id used when operating in the Leader role.
- Set the preferred Router Id.
- Set the Thread PSKc
- Set the Key Reference to the Thread PSKc
- Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role.
- Sets whether or not the device is router-eligible.
- Sets the range of router IDs that are allowed to assign to nodes within the thread network.
- Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role.
- Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role.
- Set Steering data out of band.
- Sets whether the Security Policy TLV version-threshold for routing (VR field) is enabled.
- Set the vendor app URL string.
- Set the vendor model string.
- Set the vendor name string.
- Set the vendor software version string.
- Gets the TREL counters.
- Iterates over the peer table entries and get the next entry from the table
- Returns the number of TREL peers.
- Initializes a peer table iterator.
- Indicates whether the TREL operation is enabled.
- Indicates whether or not the filter mode is enabled.
- Resets the TREL counters.
- Enables or disables TREL operation.
- Sets the filter mode (enables/disables filtering).
- Adds a UDP receiver.
- Bind a UDP/IPv6 socket.
- Close a UDP/IPv6 socket.
- Connect a UDP/IPv6 socket.
- Handle a UDP packet received from host.
- Set UDP forward callback to deliver UDP packets to host.
- Gets the head of linked list of UDP Sockets.
- Check if a UDP socket is open.
- Determines if the given UDP port is exclusively opened by OpenThread API.
- Allocate a new message buffer for sending a UDP message.
- Open a UDP/IPv6 socket.
- Removes a UDP receiver.
- Send a UDP/IPv6 message.
- Sends a UDP message without socket.
Type Aliases§
- Defines the key usage flags.
- @defgroup radio-types Radio Types
- Defines the channel page.
- Defines the frequency band channel range.
- Defines constants that are used to indicate different radio capabilities. See
otRadioCaps
. - Defines constants about size of header IE in ACK.
- IPv6 Address origins
- ECN statuses, represented as in the IP header.
- Internet Protocol Numbers.
- Defines the keys of settings.
- Defines flags passed to otTcpConnect().
- Defines flags passed to @p otTcpSendByReference.
- Pointer is called whenever the Domain Prefix changed.
- Represents the Domain Prefix events.
- Pointer is called whenever the Multicast Listeners change.
- Represents the Multicast Listener events.
- Pointer is called whenever the Nd Proxy changed.
- Represents the ND Proxy events.
- Represents the Backbone Router Status.
- Callback function pointer to signal changes related to the Border Agent’s ephemeral key.
- Defines the Border Agent state.
- Function pointer callback which is invoked when Network Data (local or leader) gets full.
- This enumeration represents the state of DHCPv6 Prefix Delegation State.
- 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.
- Represents the state of Border Routing Manager.
- Defines the EID cache entry state.
- Represents a bit-field indicating specific state/configuration that has changed. See
OT_CHANGED_*
definitions. - Represents Channel Mask.
- Pointer is called to notify about Console output.
- CoAP Block Size Exponents
- Pointer is called when a CoAP message with a block-wise transfer option is received.
- Pointer is called before the next block in a block-wise transfer is sent.
- CoAP Code values.
- CoAP Content Format codes. The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats
- CoAP Option Numbers
- Pointer is called when a CoAP request with a given Uri-Path is received.
- Pointer is called when a CoAP response is received or on the request timeout.
- Callback function pointer to notify when the CoAP secure agent is automatically stopped due to reaching the maximum number of connection attempts.
- CoAP Type values (2 bit unsigned integer).
- Pointer is called when the Commissioner receives an Energy Report.
- Pointer is called whenever the joiner state changes.
- Defines a Joiner Event on the Commissioner.
- Pointer is called when the Commissioner receives a PAN ID Conflict message.
- Defines the Commissioner State.
- Pointer is called whenever the commissioner state changes.
- Defines the key algorithms.
- This datatype represents the key reference.
- Defines the key storage types.
- Defines the key types.
- Pointer is called when a response to a MGMT_SET request is received or times out.
- This callback function pointer is called when a Dataset update request finishes, reporting success or failure status of the Dataset update request.
- This callback informs the application that the detaching process has finished.
- Represents a Thread device role.
- Pointer is called when a DNS response is received for an address resolution query.
- Pointer is called when a DNS response is received for a browse (service instance enumeration) query.
- Type represents the NAT64 mode in an
otDnsQueryConfig
. - Type represents the “Recursion Desired” (RD) flag in an
otDnsQueryConfig
. - Pointer is called when a DNS response is received for a service instance resolution query.
- Type represents the service resolution mode in an
otDnsQueryConfig
. - Type represents the DNS transport protocol in an
otDnsQueryConfig
. - This opaque type represents a DNS-SD query.
- Is called when a DNS-SD query subscribes one of: 1. a service name. 2. a service instance name. 3. a host name.
- Specifies a DNS-SD query type.
- Is called when a DNS-SD query unsubscribes one of: 1. a service name. 2. a service instance name. 3. a host name.
- Represents error codes used throughout OpenThread.
- Defines the gpio modes.
- Pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes.
- Pointer is called when the DTLS connection state changes.
- Pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes.
- ICMPv6 Message Codes
- ICMPv6 Echo Reply Modes
- This callback allows OpenThread to inform the application of a received ICMPv6 message.
- ICMPv6 Message Types
- Pointer is called when an internal IPv6 address is added or removed.
- Pointer is called when an IPv6 datagram is received.
- Pointer is called with results of
otIp6RegisterMulticastListeners
. - Pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added.
- Pointer is called if signal jam detection is enabled and a jam is detected.
- Pointer is called to notify the completion of a join operation.
- Defines a Joiner Info Type.
- Defines the Joiner State.
- Enhanced-ACK Flags.
- Pointer is called when Enh-ACK Probing IE is received.
- Pointer is called when a Link Metrics Management Response is received.
- Pointer is called when a Link Metrics report is received.
- Link Metrics Status values.
- Pointer is called when an IEEE 802.15.4 frame is received.
- Pointer on receipt of a IEEE 802.15.4 frame.
- Pointer on receipt of a IEEE 802.15.4 frame.
- Pointer on receipt of a IEEE 802.15.4 frame.
- Represents the log level.
- Represents log regions.
- Defines address mode of the mac filter.
- Represents a MAC Key Ref used by PSA.
- Represents a Mesh Local Prefix.
- Represents meshcop TLV types.
- Defines the OpenThread message origins.
- Defines the OpenThread message priority levels.
- Packet drop reasons.
- Pointer is called when an IPv4 datagram (translated by NAT64 translator) is received.
- States of NAT64.
- Defines delegate (function pointer) type to control behavior of peek/poke operation.
- Pointer is called to send HDLC encoded NCP data.
- Pointer is called to notify that there is a change in the neighbor table.
- Defines the constants used in
otNeighborTableCallback
to indicate changes in neighbor table. - Defines the OpenThread network interface identifiers.
- This datatype represents KeyRef to NetworkKey.
- Represents OpenThread time synchronization status.
- Pointer is called when a network time sync or status change occurs.
- Represents the IEEE 802.15.4 PAN ID.
- Pointer type specifies the callback to notify receipt of a ping reply.
- Pointer type specifies the callback to report the ping statistics.
- Enumeration of micro-controller’s power states.
- Enumeration of possible reset reason codes.
- 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()
. - 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. - Represents the power supply property on a device.
- This datatype represents KeyRef to PSKc.
- Represents radio capabilities.
- Defines constants about key types.
- Represents the state of a radio. Initially, a radio is in the Disabled state.
- Pointer is called when Network Diagnostic Get response is received.
- Defines valid values for
mPreference
inotExternalRouteConfig
andotBorderRouterConfig
. - Represents the IEEE 802.15.4 Short Address.
- Pointer is called when a SNTP response is received.
- Pointer type defines the callback used by SRP client to notify user when it is auto-started or stopped.
- Pointer type defines the callback used by SRP client to notify user of changes/events/errors.
- Specifies an SRP client item (service or host info) state.
- Represents the address mode used by the SRP server.
- Handles SRP service updates.
- The ID of a SRP service update transaction on the SRP Server.
- Represents the state of the SRP server.
- Pointer is called to notify certain configuration or state changes within OpenThread.
- This callback indicates that the TCP connection is now ready for two-way communication.
- This callback indicates that an incoming connection that matches this TCP listener has arrived.
- This callback indicates that the connection was broken and should no longer be used, or that a connection has entered the TIME-WAIT state.
- This callback informs the application that the TCP 3-way handshake is complete and that the connection is now established.
- 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.
- Defines incoming connection actions.
- This callback indicates the number of bytes available for consumption from the receive buffer.
- 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.
- Pointer type defines the callback to notify the outcome of a
otThreadLocateAnycastDestination()
request. - Pointer is called every time an MLE Discovery Request message is received.
- Pointer is called every time an MLE Parent Response message is received.
- Represents a group of TREL related counters.
- Represents an iterator for iterating over TREL peer table entries.
- Pointer delivers the UDP packet to host and host should send the packet through its own network stack.
- This callback allows OpenThread to provide specific handlers for certain UDP messages.
- This callback allows OpenThread to inform the application of a received UDP message.
Unions§
- The union of transmit and receive information for a radio frame.