[−][src]Crate openthread_sys
Structs
| __BindgenBitfieldUnit | |
| __va_list_tag | |
| otActiveScanResult | This structure represents a received IEEE 802.15.4 Beacon. |
| otBackboneRouterConfig | This structure represents Backbone Router configuration. |
| otBleRadioPacket | This structure represents an BLE packet. |
| otBorderRouterConfig | This structure represents a Border Router configuration. |
| otBufferInfo | This structure represents the message buffer information. |
| otCacheEntryInfo | This structure represents an EID cache entry. |
| otCacheEntryIterator | This type represents an iterator used for iterating through the EID cache table entries. |
| otChildInfo | This structure holds diagnostic information for a Thread Child |
| otCliCommand | This structure represents a CLI command. |
| otCoapOption | This structure represents a CoAP option. |
| otCoapOptionIterator | This structure acts as an iterator for CoAP options |
| otCoapResource | This structure represents a CoAP resource. |
| otCoapTxParameters | This structure represents the CoAP transmission parameters. |
| otCommissioningDataset | This structure represents a Commissioning Dataset. |
| otDnsQuery | This structure implements DNS Query parameters. |
| otEnergyScanResult | This structure represents an energy scan result. |
| otExtAddress | @struct otExtAddress |
| otExtendedPanId | This structure represents an Extended PAN ID. |
| otExternalRouteConfig | This structure represents an External Route configuration. |
| otIcmp6Header | @struct otIcmp6Header |
| otIcmp6Handler | This structure implements ICMPv6 message handler. |
| otInstance | |
| otIp6Address | @struct otIp6Address |
| otIp6Prefix | This structure represents an IPv6 prefix. |
| otIpCounters | This structure represents the IP level counters. |
| otJoinerInfo | This structure represents a Joiner Info. |
| otLeaderData | This structure represents the Thread Leader Data. |
| otLinkModeConfig | This structure represents an MLE Link Mode configuration. |
| otMacCounters | This structure represents the MAC layer counters. |
| otMacFilterEntry | This structure represents a Mac Filter entry. |
| otMacKey | @struct otMacKey |
| otMasterKey | @struct otMasterKey |
| otMeshLocalPrefix | This structure represents a Mesh Local Prefix. |
| otMessage | This structure points to an OpenThread message buffer. |
| otMessageInfo | This structure represents the local and peer IPv6 socket addresses. |
| otMessageQueue | This structure represents an OpenThread message queue. |
| otMessageSettings | This structure represents a message settings. |
| otMleCounters | This structure represents the Thread MLE counters. |
| otNcpLegacyHandlers | Defines a struct containing all the legacy handlers (function pointers). |
| otNeighborInfo | This structure holds diagnostic information for a neighboring Thread node |
| otNeighborTableEntryInfo | This type represent a neighbor table entry info (child or router) and is used as a parameter in the neighbor table
callback |
| otNetifAddress | This structure represents an IPv6 network interface unicast address. |
| otNetifMulticastAddress | This structure represents an IPv6 network interface multicast address. |
| otNetworkDiagChildEntry | This structure represents a Network Diagnostic Child Table Entry. |
| otNetworkDiagConnectivity | This structure represents a Network Diagnostic Connectivity value. |
| otNetworkDiagMacCounters | This structure represents a Network Diagnostic Mac Counters value. |
| otNetworkDiagRoute | This structure represents a Network Diagnostic Route TLV value. |
| otNetworkDiagRouteData | This structure represents a Network Diagnostic Route data. |
| otNetworkDiagTlv | This structure represents a Network Diagnostic TLV. |
| otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_1 | |
| otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_2 | |
| otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_3 | |
| otNetworkDiagTlv__bindgen_ty_1__bindgen_ty_4 | |
| otNetworkName | This structure represents a Network Name. |
| otOperationalDataset | This structure represents an Active or Pending Operational Dataset. |
| otOperationalDatasetComponents | This structure represents presence of different components in Active or Pending Operational Dataset. |
| otPlatBleDeviceAddr | This structure represents BLE Device Address. |
| otPlatBleGapConnParams | This structure represents BLE connection parameters. |
| otPlatBleGattCharacteristic | This structure represents GATT Characteristic. |
| otPlatBleGattDescriptor | This structure represents GATT Descriptor. |
| otPlatBleGattService | Registration descriptor for a GATT service. |
| otPlatBleUuid | This structure represents BLE UUID. |
| otPskc | This structure represents PSKc. |
| otRadioCoexMetrics | This structure represents radio coexistence metrics. |
| otRadioFrame | This structure represents an IEEE 802.15.4 radio frame. |
| otRadioFrame__bindgen_ty_1__bindgen_ty_1 | Structure representing radio frame transmit information. |
| otRadioFrame__bindgen_ty_1__bindgen_ty_2 | Structure representing radio frame receive information. |
| otRadioIeInfo | This structure represents the IEEE 802.15.4 Header IE (Information Element) related information of a radio frame. |
| otRouterInfo | This structure holds diagnostic information for a Thread Router |
| otSecurityPolicy | This structure represent Security Policy. |
| otServerConfig | This structure represents a Server configuration. |
| otServiceConfig | This structure represents a Service configuration. |
| otSntpQuery | This structure implements SNTP Query parameters. |
| otSockAddr | This structure represents an IPv6 socket address. |
| otSteeringData | This structure represents the steering data. |
| otThreadParentResponseInfo | This structure represents the MLE Parent Response data. |
| otUdpReceiver | This structure represents a UDP receiver. |
| otUdpSocket | This structure represents a UDP socket. |
Constants
Functions
| otBackboneRouterGetConfig⚠ | This function gets the local Backbone Router configuration. |
| otBackboneRouterGetDomainPrefix⚠ | This method gets the local Domain Prefix configuration. |
| otBackboneRouterGetPrimary⚠ | This function gets the Primary Backbone Router information in the Thread Network. |
| otBackboneRouterGetRegistrationJitter⚠ | This method returns the Backbone Router registration jitter value. |
| otBackboneRouterGetState⚠ | This function gets the Backbone Router state. |
| otBackboneRouterRegister⚠ | This function explicitly registers local Backbone Router configuration. |
| otBackboneRouterSetConfig⚠ | This function sets the local Backbone Router configuration. |
| otBackboneRouterSetEnabled⚠ | This function enables or disables Backbone functionality. |
| otBackboneRouterSetRegistrationJitter⚠ | This method sets the Backbone Router registration jitter value. |
| otBorderAgentGetState⚠ | This function gets the state of Thread Border Agent role. |
| otBorderRouterAddOnMeshPrefix⚠ | Add a border router configuration to the local network data. |
| otBorderRouterAddRoute⚠ | Add an external route configuration to the local network data. |
| otBorderRouterGetNetData⚠ | This method provides a full or stable copy of the local Thread Network Data. |
| otBorderRouterGetNextOnMeshPrefix⚠ | This function gets the next On Mesh Prefix in the local Network Data. |
| otBorderRouterGetNextRoute⚠ | This function gets the next external route in the local Network Data. |
| otBorderRouterRegister⚠ | Immediately register the local network data with the Leader. |
| otBorderRouterRemoveOnMeshPrefix⚠ | Remove a border router configuration from the local network data. |
| otBorderRouterRemoveRoute⚠ | Remove an external route configuration from the local network data. |
| otChannelManagerGetAutoChannelSelectionEnabled⚠ | This function indicates whether the auto-channel-selection functionality is enabled or not. |
| otChannelManagerGetAutoChannelSelectionInterval⚠ | This function gets the period interval (in seconds) used by auto-channel-selection functionality. |
| otChannelManagerGetDelay⚠ | This function gets the delay (in seconds) used by Channel Manager for a channel change. |
| otChannelManagerGetFavoredChannels⚠ | This function gets the favored channel mask. |
| otChannelManagerGetRequestedChannel⚠ | This function gets the channel from the last successful call to |
| otChannelManagerGetSupportedChannels⚠ | This function gets the supported channel mask. |
| otChannelManagerRequestChannelChange⚠ | This function requests a Thread network channel change. |
| otChannelManagerRequestChannelSelect⚠ | This function requests that |
| otChannelManagerSetAutoChannelSelectionEnabled⚠ | This function enables/disables the auto-channel-selection functionality. |
| otChannelManagerSetAutoChannelSelectionInterval⚠ | This function sets the period interval (in seconds) used by auto-channel-selection functionality. |
| otChannelManagerSetDelay⚠ | This function sets the delay (in seconds) used for a channel change. |
| otChannelManagerSetFavoredChannels⚠ | This function sets the favored channel mask. |
| otChannelManagerSetSupportedChannels⚠ | This function sets the supported channel mask. |
| otChannelMonitorGetChannelOccupancy⚠ | Gets the current channel occupancy for a given channel. |
| otChannelMonitorGetRssiThreshold⚠ | Get channel monitoring RSSI threshold in dBm. |
| otChannelMonitorGetSampleCount⚠ | Get channel monitoring total number of RSSI samples (per channel). |
| otChannelMonitorGetSampleInterval⚠ | Get channel monitoring sample interval in milliseconds. |
| otChannelMonitorGetSampleWindow⚠ | Get channel monitoring averaging sample window length (number of samples). |
| otChannelMonitorIsEnabled⚠ | This function indicates whether the Channel Monitoring operation is enabled and running. |
| otChannelMonitorSetEnabled⚠ | This function enables/disables the Channel Monitoring operation. |
| otChildSupervisionGetCheckTimeout⚠ | Get the supervision check timeout interval (in seconds). |
| otChildSupervisionGetInterval⚠ | Get the child supervision interval (in seconds). |
| otChildSupervisionSetCheckTimeout⚠ | Set the supervision check timeout interval (in seconds). |
| otChildSupervisionSetInterval⚠ | Set the child supervision interval (in seconds). |
| otCliAppendResult⚠ | Write error code to the CLI console |
| otCliConsoleInit⚠ | Initialize the CLI CONSOLE module. |
| otCliConsoleInputLine⚠ | This method is called to feed in a console input line. |
| otCliOutput⚠ | Write string to the CLI console |
| otCliOutputBytes⚠ | Write a number of bytes to the CLI console as a hex string. |
| otCliOutputFormat⚠ | Write formatted string to the CLI console |
| otCliPlatLogv⚠ | Callback to write the OpenThread Log to the CLI console |
| otCliSetUserCommands⚠ | Set a user command table. |
| otCliUartInit⚠ | Initialize the CLI UART module. |
| otCoapAddResource⚠ | This function adds a resource to the CoAP server. |
| otCoapBlockSizeFromExponent⚠ | This function converts a CoAP Block option SZX field to the actual block size |
| otCoapMessageAppendBlock1Option⚠ | This function appends a Block1 option |
| otCoapMessageAppendBlock2Option⚠ | This function appends a Block2 option |
| otCoapMessageAppendContentFormatOption⚠ | This function appends the Content Format CoAP option as specified in https://tools.ietf.org/html/rfc7252#page-92. This must be called before setting otCoapMessageSetPayloadMarker if a payload is to be included in the message. |
| otCoapMessageAppendMaxAgeOption⚠ | This function appends a Max-Age option. |
| otCoapMessageAppendObserveOption⚠ | This function appends an Observe option. |
| otCoapMessageAppendOption⚠ | This function appends a CoAP option in a header. |
| otCoapMessageAppendProxyUriOption⚠ | This function appends a Proxy-Uri option. |
| otCoapMessageAppendUintOption⚠ | This function appends an unsigned integer CoAP option as specified in https://tools.ietf.org/html/rfc7252#section-3.2 |
| otCoapMessageAppendUriPathOptions⚠ | This function appends a Uri-Path option. |
| otCoapMessageAppendUriQueryOption⚠ | This function appends a single Uri-Query option. |
| otCoapMessageCodeToString⚠ | This method returns the CoAP Code as human readable string. |
| otCoapMessageGenerateToken⚠ | This function sets the Token length and randomizes its value. |
| otCoapMessageGetCode⚠ | This function returns the Code value. |
| otCoapMessageGetMessageId⚠ | This function returns the Message ID value. |
| otCoapMessageGetToken⚠ | This function returns a pointer to the Token value. |
| otCoapMessageGetTokenLength⚠ | This function returns the Token length. |
| otCoapMessageGetType⚠ | This function returns the Type value. |
| otCoapMessageInit⚠ | This function initializes the CoAP header. |
| otCoapMessageInitResponse⚠ | This function initializes a response message. |
| otCoapMessageSetPayloadMarker⚠ | This function adds Payload Marker indicating beginning of the payload to the CoAP header. |
| otCoapMessageSetToken⚠ | This function sets the Token value and length in a header. |
| otCoapNewMessage⚠ | This function creates a new CoAP message. |
| otCoapOptionIteratorGetFirstOption⚠ | This function returns a pointer to the first option. |
| otCoapOptionIteratorGetFirstOptionMatching⚠ | This function returns a pointer to the first option matching the specified option number. |
| otCoapOptionIteratorGetNextOption⚠ | This function returns a pointer to the next option. |
| otCoapOptionIteratorGetNextOptionMatching⚠ | This function returns a pointer to the next option matching the specified option number. |
| otCoapOptionIteratorGetOptionUintValue⚠ | This function fills current option value into @p aValue assuming the current value is an unsigned integer encoded according to https://tools.ietf.org/html/rfc7252#section-3.2 |
| otCoapOptionIteratorGetOptionValue⚠ | This function fills current option value into @p aValue. |
| otCoapOptionIteratorInit⚠ | This function initialises an iterator for the options in the given message. |
| otCoapRemoveResource⚠ | This function removes a resource from the CoAP server. |
| otCoapSecureAddResource⚠ | This function adds a resource to the CoAP Secure server. |
| otCoapSecureConnect⚠ | This method initializes DTLS session with a peer. |
| otCoapSecureDisconnect⚠ | This method stops the DTLS connection. |
| otCoapSecureGetPeerCertificateBase64⚠ | This method returns the peer x509 certificate base64 encoded. |
| otCoapSecureIsConnected⚠ | This method indicates whether or not the DTLS session is connected. |
| otCoapSecureIsConnectionActive⚠ | This method indicates whether or not the DTLS session is active. |
| otCoapSecureRemoveResource⚠ | This function removes a resource from the CoAP Secure server. |
| otCoapSecureSendRequest⚠ | This method sends a CoAP request over secure DTLS connection. |
| otCoapSecureSendResponse⚠ | This function sends a CoAP response from the CoAP Secure server. |
| otCoapSecureSetCaCertificateChain⚠ | This method sets the trusted top level CAs. It is needed for validating the certificate of the peer. |
| otCoapSecureSetCertificate⚠ | This method sets the local device's X509 certificate with corresponding private key for DTLS session with DTLS_ECDHE_ECDSA_WITH_AES_128_CCM_8. |
| otCoapSecureSetClientConnectedCallback⚠ | This method sets the connected callback to indicate, when a Client connect to the CoAP Secure server. |
| otCoapSecureSetDefaultHandler⚠ | This function sets the default handler for unhandled CoAP Secure requests. |
| otCoapSecureSetPsk⚠ | This method sets the Pre-Shared Key (PSK) and cipher suite DTLS_PSK_WITH_AES_128_CCM_8. |
| otCoapSecureSetSslAuthMode⚠ | This method sets the authentication mode for the coap secure connection. |
| otCoapSecureStart⚠ | This function starts the CoAP Secure service. |
| otCoapSecureStop⚠ | This function stops the CoAP Secure server. |
| otCoapSendRequestWithParameters⚠ | This function sends a CoAP request with custom transmission parameters. |
| otCoapSendResponseWithParameters⚠ | This function sends a CoAP response from the server with custom transmission parameters. |
| otCoapSetDefaultHandler⚠ | This function sets the default handler for unhandled CoAP requests. |
| otCoapStart⚠ | This function starts the CoAP server. |
| otCoapStop⚠ | This function stops the CoAP server. |
| otCommissionerAddJoiner⚠ | This function adds a Joiner entry. |
| otCommissionerAnnounceBegin⚠ | This function sends an Announce Begin message. |
| otCommissionerEnergyScan⚠ | This function sends an Energy Scan Query message. |
| otCommissionerGetNextJoinerInfo⚠ | This method get joiner info at aIterator position. |
| otCommissionerGetProvisioningUrl⚠ | This function gets the Provisioning URL. |
| otCommissionerGetSessionId⚠ | This function returns the Commissioner Session ID. |
| otCommissionerGetState⚠ | This function returns the Commissioner State. |
| otCommissionerPanIdQuery⚠ | This function sends a PAN ID Query message. |
| otCommissionerRemoveJoiner⚠ | This function removes a Joiner entry. |
| otCommissionerSendMgmtGet⚠ | This function sends MGMT_COMMISSIONER_GET. |
| otCommissionerSendMgmtSet⚠ | This function sends MGMT_COMMISSIONER_SET. |
| otCommissionerSetProvisioningUrl⚠ | This function sets the Provisioning URL. |
| otCommissionerStart⚠ | This function enables the Thread Commissioner role. |
| otCommissionerStop⚠ | This function disables the Thread Commissioner role. |
| otCryptoAesCcm⚠ | This method performs AES CCM computation. |
| otCryptoEcdsaSign⚠ | This method creates ECDSA sign. |
| otCryptoHmacSha256⚠ | This function performs HMAC computation. |
| otDatasetCreateNewNetwork⚠ | This method creates a new Operational Dataset to use when forming a new network. |
| otDatasetGeneratePskc⚠ | This function generates PSKc from a given pass-phrase, network name, and extended PAN ID. |
| otDatasetGetActive⚠ | This function gets the Active Operational Dataset. |
| otDatasetGetDelayTimerMinimal⚠ | Get minimal delay timer. |
| otDatasetGetPending⚠ | This function gets the Pending Operational Dataset. |
| otDatasetIsCommissioned⚠ | This function indicates whether a valid network is present in the Active Operational Dataset or not. |
| otDatasetSendMgmtActiveGet⚠ | This function sends MGMT_ACTIVE_GET. |
| otDatasetSendMgmtActiveSet⚠ | This function sends MGMT_ACTIVE_SET. |
| otDatasetSendMgmtPendingGet⚠ | This function sends MGMT_PENDING_GET. |
| otDatasetSendMgmtPendingSet⚠ | This function sends MGMT_PENDING_SET. |
| otDatasetSetActive⚠ | This function sets the Active Operational Dataset. |
| otDatasetSetDelayTimerMinimal⚠ | Set minimal delay timer. |
| otDatasetSetPending⚠ | This function sets the Pending Operational Dataset. |
| otDiagIsEnabled⚠ | This function indicates whether or not the factory diagnostics mode is enabled. |
| otDiagProcessCmd⚠ | This function processes a factory diagnostics command line. |
| otDiagProcessCmdLine⚠ | This function processes a factory diagnostics command line. |
| otDnsClientQuery⚠ | This function sends a DNS query for AAAA (IPv6) record. |
| otGetRadioVersionString⚠ | This function gets the OpenThread radio version string. |
| otGetVersionString⚠ | This function gets the OpenThread version string. |
| otHeapCAlloc⚠ | @note This API is deprecated and use of it is discouraged. |
| otHeapFree⚠ | @note This API is deprecated and use of it is discouraged. |
| otHeapSetCAllocFree⚠ | This function sets the external heap CAlloc and Free functions to be used by the OpenThread stack. |
| otIcmp6GetEchoMode⚠ | This function indicates whether or not ICMPv6 Echo processing is enabled. |
| otIcmp6SetEchoMode⚠ | This function sets whether or not ICMPv6 Echo processing is enabled. |
| otIcmp6RegisterHandler⚠ | This function registers a handler to provide received ICMPv6 messages. |
| otIcmp6SendEchoRequest⚠ | This function sends an ICMPv6 Echo Request via the Thread interface. |
| otInstanceErasePersistentInfo⚠ | This function erases all the OpenThread persistent info (network settings) stored on non-volatile memory.
Erase is successful only if the device is in |
| otInstanceFactoryReset⚠ | This method deletes all the settings stored on non-volatile memory, and then triggers platform reset. |
| otInstanceFinalize⚠ | This function disables the OpenThread library. |
| otInstanceInit⚠ | This function initializes the OpenThread library. |
| otInstanceInitSingle⚠ | This function initializes the static single instance of the OpenThread library. |
| otInstanceIsInitialized⚠ | This function indicates whether or not the instance is valid/initialized. |
| otInstanceReset⚠ | This method triggers a platform reset. |
| otIp6SetEnabled⚠ | This function brings up/down the IPv6 interface. |
| otIp6IsEnabled⚠ | This function indicates whether or not the IPv6 interface is up. |
| otIp6AddUnicastAddress⚠ | Add a Network Interface Address to the Thread interface. |
| otIp6RemoveUnicastAddress⚠ | Remove a Network Interface Address from the Thread interface. |
| otIp6GetUnicastAddresses⚠ | Get the list of IPv6 addresses assigned to the Thread interface. |
| otIp6SubscribeMulticastAddress⚠ | Subscribe the Thread interface to a Network Interface Multicast Address. |
| otIp6UnsubscribeMulticastAddress⚠ | Unsubscribe the Thread interface to a Network Interface Multicast Address. |
| otIp6GetMulticastAddresses⚠ | Get the list of IPv6 multicast addresses subscribed to the Thread interface. |
| otIp6IsMulticastPromiscuousEnabled⚠ | Check if multicast promiscuous mode is enabled on the Thread interface. |
| otIp6SetMulticastPromiscuousEnabled⚠ | Enable multicast promiscuous mode on the Thread interface. |
| otIp6NewMessage⚠ | Allocate a new message buffer for sending an IPv6 message. |
| otIp6NewMessageFromBuffer⚠ | Allocate a new message buffer and write the IPv6 datagram to the message buffer for sending an IPv6 message. |
| otIp6SetReceiveCallback⚠ | This function registers a callback to provide received IPv6 datagrams. |
| otIp6SetAddressCallback⚠ | This function registers a callback to notify internal IPv6 address changes. |
| otIp6IsReceiveFilterEnabled⚠ | This function indicates whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback(). |
| otIp6SetReceiveFilterEnabled⚠ | This function sets whether or not Thread control traffic is filtered out when delivering IPv6 datagrams via the callback specified in otIp6SetReceiveCallback(). |
| otIp6Send⚠ | This function sends an IPv6 datagram via the Thread interface. |
| otIp6AddUnsecurePort⚠ | This function adds a port to the allowed unsecured port list. |
| otIp6RemoveUnsecurePort⚠ | This function removes a port from the allowed unsecure port list. |
| otIp6RemoveAllUnsecurePorts⚠ | This function removes all ports from the allowed unsecure port list. |
| otIp6GetUnsecurePorts⚠ | This function returns a pointer to the unsecure port list. |
| otIp6IsAddressEqual⚠ | Test if two IPv6 addresses are the same. |
| otIp6AddressFromString⚠ | Convert a human-readable IPv6 address string into a binary representation. |
| otIp6PrefixMatch⚠ | This function returns the prefix match length (bits) for two IPv6 addresses. |
| otIp6IsAddressUnspecified⚠ | This function indicates whether or not a given IPv6 address is the Unspecified Address. |
| otIp6SelectSourceAddress⚠ | This function perform OpenThread source address selection. |
| otIp6IsSlaacEnabled⚠ | This function indicates whether the SLAAC module is enabled or not. |
| otIp6SetSlaacEnabled⚠ | This function enables/disables the SLAAC module. |
| otIp6SetSlaacPrefixFilter⚠ | This function sets the SLAAC module filter handler. |
| otJamDetectionGetBusyPeriod⚠ | Get the Jam Detection Busy Period (in seconds) |
| otJamDetectionGetHistoryBitmap⚠ | Get the current history bitmap. |
| otJamDetectionGetRssiThreshold⚠ | Get the Jam Detection RSSI Threshold (in dBm). |
| otJamDetectionGetState⚠ | Get the Jam Detection State |
| otJamDetectionGetWindow⚠ | Get the Jam Detection Detection Window (in seconds). |
| otJamDetectionIsEnabled⚠ | Get the Jam Detection Status (enabled/disabled) |
| otJamDetectionSetBusyPeriod⚠ | Set the Jam Detection Busy Period (in seconds). |
| otJamDetectionSetRssiThreshold⚠ | Set the Jam Detection RSSI Threshold (in dBm). |
| otJamDetectionSetWindow⚠ | Set the Jam Detection Detection Window (in seconds). |
| otJamDetectionStart⚠ | Start the jamming detection. |
| otJamDetectionStop⚠ | Stop the jamming detection. |
| otJoinerGetId⚠ | Get the Joiner ID. |
| otJoinerGetState⚠ | This function returns the Joiner State. |
| otJoinerStart⚠ | This function enables the Thread Joiner role. |
| otJoinerStop⚠ | This function disables the Thread Joiner role. |
| otLinkActiveScan⚠ | This function starts an IEEE 802.15.4 Active Scan |
| otLinkConvertLinkQualityToRss⚠ | This method converts link quality to typical received signal strength. |
| otLinkConvertRssToLinkQuality⚠ | This method converts received signal strength to link quality. |
| otLinkEnergyScan⚠ | This function starts an IEEE 802.15.4 Energy Scan |
| otLinkFilterAddAddress⚠ | This method adds an Extended Address to MAC filter. |
| otLinkFilterAddRssIn⚠ | This method sets the received signal strength (in dBm) for the messages from the Extended Address. The default received signal strength for all received messages would be set if no Extended Address is specified. |
| otLinkFilterClearAddresses⚠ | This method clears all the Extended Addresses from MAC filter. |
| otLinkFilterClearRssIn⚠ | This method clears all the received signal strength settings. |
| otLinkFilterGetAddressMode⚠ | This function gets the address mode of MAC filter. |
| otLinkFilterGetNextAddress⚠ | This method gets an in-use address filter entry. |
| otLinkFilterGetNextRssIn⚠ | This method gets an in-use RssIn filter entry. |
| otLinkFilterRemoveAddress⚠ | This method removes an Extended Address from MAC filter. |
| otLinkFilterRemoveRssIn⚠ | This method removes the received signal strength setting for the received messages from the Extended Address or removes the default received signal strength setting if no Extended Address is specified. |
| otLinkFilterSetAddressMode⚠ | This function sets the address mode of MAC filter. |
| otLinkGetCcaFailureRate⚠ | This function returns the current CCA (Clear Channel Assessment) failure rate. |
| otLinkGetChannel⚠ | Get the IEEE 802.15.4 channel. |
| otLinkGetCounters⚠ | Get the MAC layer counters. |
| otLinkGetExtendedAddress⚠ | Get the IEEE 802.15.4 Extended Address. |
| otLinkGetFactoryAssignedIeeeEui64⚠ | Get the factory-assigned IEEE EUI-64. |
| otLinkGetMaxFrameRetriesDirect⚠ | This method returns the maximum number of frame retries during direct transmission. |
| otLinkGetMaxFrameRetriesIndirect⚠ | This method returns the maximum number of frame retries during indirect transmission. |
| otLinkGetPanId⚠ | Get the IEEE 802.15.4 PAN ID. |
| otLinkGetPollPeriod⚠ | Get the data poll period of sleepy end device. |
| otLinkGetShortAddress⚠ | Get the IEEE 802.15.4 Short Address. |
| otLinkGetSupportedChannelMask⚠ | Get the supported channel mask of MAC layer. |
| otLinkGetTxDirectRetrySuccessHistogram⚠ | This method gets histogram of retries for a single direct packet until success. |
| otLinkGetTxIndirectRetrySuccessHistogram⚠ | This method gets histogram of retries for a single indirect packet until success. |
| otLinkIsActiveScanInProgress⚠ | This function indicates whether or not an IEEE 802.15.4 Active Scan is currently in progress. |
| otLinkIsEnabled⚠ | This function indicates whether or not the link layer is enabled. |
| otLinkIsEnergyScanInProgress⚠ | This function indicates whether or not an IEEE 802.15.4 Energy Scan is currently in progress. |
| otLinkIsInTransmitState⚠ | This function indicates whether or not an IEEE 802.15.4 MAC is in the transmit state. |
| otLinkIsPromiscuous⚠ | This function indicates whether or not promiscuous mode is enabled at the link layer. |
| otLinkOutOfBandTransmitRequest⚠ | This function enqueues an IEEE 802.15.4 out of band Frame for transmission. |
| otLinkRawEnergyScan⚠ | This method begins the energy scan sequence on the radio. |
| otLinkRawGetCaps⚠ | Get the radio capabilities. |
| otLinkRawGetPromiscuous⚠ | This function gets the status of promiscuous mode. |
| otLinkRawGetRssi⚠ | Get the most recent RSSI measurement. |
| otLinkRawGetTransmitBuffer⚠ | The radio transitions from Transmit to Receive. This method returns a pointer to the transmit buffer. |
| otLinkRawIsEnabled⚠ | This function indicates whether or not the raw link-layer is enabled. |
| otLinkRawReceive⚠ | Transitioning the radio from Sleep to Receive. Turn on the radio. |
| otLinkRawSetEnable⚠ | This function enables/disables the raw link-layer. |
| otLinkRawSetMacKey⚠ | Update MAC keys and key index. |
| otLinkRawSetPromiscuous⚠ | This function enables or disables promiscuous mode. |
| otLinkRawSetShortAddress⚠ | Set the Short Address for address filtering. |
| otLinkRawSleep⚠ | Transition the radio from Receive to Sleep. Turn off the radio. |
| otLinkRawSrcMatchAddExtEntry⚠ | Adding extended address to the source match table. |
| otLinkRawSrcMatchAddShortEntry⚠ | Adding short address to the source match table. |
| otLinkRawSrcMatchClearExtEntries⚠ | Removing all the extended addresses from the source match table. |
| otLinkRawSrcMatchClearExtEntry⚠ | Removing extended address to the source match table of the radio. |
| otLinkRawSrcMatchClearShortEntries⚠ | Removing all the short addresses from the source match table. |
| otLinkRawSrcMatchClearShortEntry⚠ | Removing short address to the source match table. |
| otLinkRawSrcMatchEnable⚠ | Enable/Disable source match for frame pending. |
| otLinkRawTransmit⚠ | This method begins the transmit sequence on the radio. |
| otLinkResetCounters⚠ | Reset the MAC layer counters. |
| otLinkResetTxRetrySuccessHistogram⚠ | This method clears histogram statistics for direct and indirect transmissions. |
| otLinkSendDataRequest⚠ | This function enqueues an IEEE 802.15.4 Data Request message for transmission. |
| otLinkSetChannel⚠ | Set the IEEE 802.15.4 channel |
| otLinkSetEnabled⚠ | This function enables or disables the link layer. |
| otLinkSetExtendedAddress⚠ | This function sets the IEEE 802.15.4 Extended Address. |
| otLinkSetMaxFrameRetriesDirect⚠ | This method sets the maximum number of frame retries during direct transmission. |
| otLinkSetMaxFrameRetriesIndirect⚠ | This method sets the maximum number of frame retries during indirect transmission. |
| otLinkSetPanId⚠ | Set the IEEE 802.15.4 PAN ID. |
| otLinkSetPcapCallback⚠ | This function registers a callback to provide received raw IEEE 802.15.4 frames. |
| otLinkSetPollPeriod⚠ | Set/clear user-specified/external data poll period for sleepy end device. |
| otLinkSetPromiscuous⚠ | This function enables or disables the link layer promiscuous mode. |
| otLinkSetSupportedChannelMask⚠ | Set the supported channel mask of MAC layer. |
| otLoggingGetLevel⚠ | This function returns the current log level. |
| otLoggingSetLevel⚠ | This function sets the log level. |
| otMessageAppend⚠ | Append bytes to a message. |
| otMessageFree⚠ | Free an allocated message buffer. |
| otMessageGetBufferInfo⚠ | Get the Message Buffer information. |
| otMessageGetLength⚠ | Get the message length in bytes. |
| otMessageGetOffset⚠ | Get the message offset in bytes. |
| otMessageGetRss⚠ | This function returns the average RSS (received signal strength) associated with the message. |
| otMessageIsLinkSecurityEnabled⚠ | This function indicates whether or not link security is enabled for the message. |
| otMessageQueueDequeue⚠ | This function removes a message from the given message queue. |
| otMessageQueueEnqueue⚠ | This function adds a message to the end of the given message queue. |
| otMessageQueueEnqueueAtHead⚠ | This function adds a message at the head/front of the given message queue. |
| otMessageQueueGetHead⚠ | This function returns a pointer to the message at the head of the queue. |
| otMessageQueueGetNext⚠ | This function returns a pointer to the next message in the queue by iterating forward (from head to tail). |
| otMessageQueueInit⚠ | Initialize the message queue. |
| otMessageRead⚠ | Read bytes from a message. |
| otMessageSetDirectTransmission⚠ | This function sets/forces the message to be forwarded using direct transmission.
Default setting for a new message is |
| otMessageSetLength⚠ | Set the message length in bytes. |
| otMessageSetOffset⚠ | Set the message offset in bytes. |
| otMessageWrite⚠ | Write bytes to a message. |
| otNcpHandleDidReceiveNewLegacyUlaPrefix⚠ | This callback is invoked by the legacy stack to notify that the legacy ULA prefix has changed. |
| otNcpHandleLegacyNodeDidJoin⚠ | This callback is invoked by the legacy stack to notify that a new legacy node did join the network. |
| otNcpInit⚠ | Initialize the NCP. |
| otNcpPlatLogv⚠ | Writes OpenThread Log using |
| otNcpRegisterLegacyHandlers⚠ | This method registers a set of legacy handlers with NCP. |
| otNcpRegisterPeekPokeDelagates⚠ | This method registers peek/poke delegate functions with NCP module. |
| otNcpStreamWrite⚠ | @brief Send data to the host via a specific stream. |
| otNetDataGet⚠ | This method provides a full or stable copy of the Partition's Thread Network Data. |
| otNetDataGetNextOnMeshPrefix⚠ | This function gets the next On Mesh Prefix in the partition's Network Data. |
| otNetDataGetNextRoute⚠ | This function gets the next external route in the partition's Network Data. |
| otNetDataGetNextService⚠ | This function gets the next service in the partition's Network Data. |
| otNetDataGetStableVersion⚠ | Get the Stable Network Data Version. |
| otNetDataGetVersion⚠ | Get the Network Data Version. |
| otNetworkTimeGet⚠ | Get the Thread network time. |
| otNetworkTimeGetSyncPeriod⚠ | Get the time synchronization period. |
| otNetworkTimeGetXtalThreshold⚠ | Get the time synchronization XTAL accuracy threshold for Router. |
| otNetworkTimeSetSyncPeriod⚠ | Set the time synchronization period. |
| otNetworkTimeSetXtalThreshold⚠ | Set the time synchronization XTAL accuracy threshold for Router-Capable device. |
| otNetworkTimeSyncSetCallback⚠ | Set a callback to be called when a network time sync or status change occurs |
| otPlatAlarmMicroFired⚠ | Signal that the alarm has fired. |
| otPlatAlarmMicroGetNow⚠ | Get the current time. |
| otPlatAlarmMicroStartAt⚠ | Set the alarm to fire at @p aDt microseconds after @p aT0. |
| otPlatAlarmMicroStop⚠ | Stop the alarm. |
| otPlatAlarmMilliFired⚠ | Signal that the alarm has fired. |
| otPlatAlarmMilliGetNow⚠ | Get the current time. |
| otPlatAlarmMilliStartAt⚠ | Set the alarm to fire at @p aDt milliseconds after @p aT0. |
| otPlatAlarmMilliStop⚠ | Stop the alarm. |
| otPlatAssertFail⚠ | This function provides a platform specific implementation for assert. |
| otPlatBleDisable⚠ | Disable the Bluetooth Low Energy radio. |
| otPlatBleEnable⚠ | Enable the Bluetooth Low Energy radio. |
| otPlatBleGapAddressGet⚠ | Gets Bluetooth Device Address. |
| otPlatBleGapAddressSet⚠ | Sets Bluetooth Device Address. |
| otPlatBleGapAdvDataSet⚠ | Sets BLE Advertising packet content. |
| otPlatBleGapAdvStart⚠ | Starts BLE Advertising procedure. |
| otPlatBleGapAdvStop⚠ | Stops BLE Advertising procedure. |
| otPlatBleGapConnParamsSet⚠ | Sets desired BLE Connection Parameters. |
| otPlatBleGapConnect⚠ | Starts BLE Connection procedure. |
| otPlatBleGapDisconnect⚠ | Disconnects BLE connection. |
| otPlatBleGapOnAdvReceived⚠ | The BLE driver calls this method to notify OpenThread that an advertisement packet has been received. |
| otPlatBleGapOnConnected⚠ | The BLE driver calls this method to notify OpenThread that BLE Device has been connected. |
| otPlatBleGapOnDisconnected⚠ | The BLE driver calls this method to notify OpenThread that the BLE Device has been disconnected. |
| otPlatBleGapOnScanRespReceived⚠ | The BLE driver calls this method to notify OpenThread that a scan response packet has been received. |
| otPlatBleGapScanResponseSet⚠ | Sets BLE Scan Response packet content. |
| otPlatBleGapScanStart⚠ | Starts BLE Scanning procedure. |
| otPlatBleGapScanStop⚠ | Stops BLE Scanning procedure. |
| otPlatBleGapServiceSet⚠ | Sets BLE device name and appearance that is visible as GATT Based service. |
| otPlatBleGattClientCharacteristicsDiscover⚠ | Performs GATT Characteristic Discovery of a service. |
| otPlatBleGattClientDescriptorsDiscover⚠ | Performs GATT Descriptor Discovery. |
| otPlatBleGattClientMtuExchangeRequest⚠ | Sends Exchange MTU Request. |
| otPlatBleGattClientOnCharacteristicsDiscoverDone⚠ | The BLE driver calls this method to notify OpenThread that GATT Characteristic Discovery of a service has been done. |
| otPlatBleGattClientOnDescriptorsDiscoverDone⚠ | The BLE driver calls this method to notify OpenThread that GATT Descriptor Discovery has been done. |
| otPlatBleGattClientOnIndication⚠ | The BLE driver calls this method to notify OpenThread that an ATT Handle Value Indication has been received. |
| otPlatBleGattClientOnMtuExchangeResponse⚠ | The BLE driver calls this method to notify OpenThread that Exchange MTU Response has been received. |
| otPlatBleGattClientOnReadResponse⚠ | The BLE driver calls this method to notify OpenThread that ATT Read Response packet has been received. |
| otPlatBleGattClientOnServiceDiscovered⚠ | The BLE driver calls this method to notify OpenThread that the next entry from GATT Primary Service Discovery has been found. |
| otPlatBleGattClientOnSubscribeResponse⚠ | The BLE driver calls this method to notify OpenThread that subscribe response has been received. |
| otPlatBleGattClientOnWriteResponse⚠ | The BLE driver calls this method to notify OpenThread that ATT Write Response packet has been received. |
| otPlatBleGattClientRead⚠ | Sends ATT Read Request. |
| otPlatBleGattClientServiceDiscover⚠ | Performs GATT Primary Service Discovery by UUID procedure of specific service. |
| otPlatBleGattClientServicesDiscover⚠ | Performs GATT Primary Service Discovery of all services available. |
| otPlatBleGattClientSubscribeRequest⚠ | Subscribes for characteristic indications. |
| otPlatBleGattClientWrite⚠ | Sends ATT Write Request. |
| otPlatBleGattMtuGet⚠ | Reads currently use value of ATT_MTU. |
| otPlatBleGattServerIndicate⚠ | Sends ATT Handle Value Indication. |
| otPlatBleGattServerOnIndicationConfirmation⚠ | The BLE driver calls this method to notify OpenThread that an ATT Handle Value Confirmation has been received. |
| otPlatBleGattServerOnReadRequest⚠ | The BLE driver calls this method to notify OpenThread that an ATT Read Request packet has been received. |
| otPlatBleGattServerOnSubscribeRequest⚠ | The BLE driver calls this method to notify OpenThread that an ATT Subscription Request packet has been received. |
| otPlatBleGattServerOnWriteRequest⚠ | The BLE driver calls this method to notify OpenThread that an ATT Write Request packet has been received. |
| otPlatBleGattServerServicesRegister⚠ | Registers a list of GATT Services and their enclosed Characteristics. The generated handles will be written back into this structure when the BLE stack is enabled. |
| otPlatBleGattVendorUuidRegister⚠ | Registers vendor specific UUID Base. |
| otPlatBleIsEnabled⚠ | Check whether Bluetooth Low Energy radio is enabled or not. |
| otPlatBleL2capConnectionRequest⚠ | Sends LE Credit Based Connection Request. |
| otPlatBleL2capOnConnectionRequest⚠ | The BLE driver calls this method to notify OpenThread that an LE Credit Based Connection Request packet has been received. |
| otPlatBleL2capConnectionResponse⚠ | Sends LE Credit Based Connection Response. |
| otPlatBleL2capOnConnectionResponse⚠ | The BLE driver calls this method to notify OpenThread that an LE Credit Based Connection Response packet has been received. |
| otPlatBleL2capSduSend⚠ | Sends an SDU on an L2CAP channel. |
| otPlatBleL2capOnSduReceived⚠ | The BLE driver calls this method to notify OpenThread that an L2CAP SDU has been received. |
| otPlatBleL2capOnSduSent⚠ | The BLE driver calls this method to notify OpenThread that an L2CAP SDU has been sent. |
| otPlatBleL2capDisconnect⚠ | Sends an L2CAP Disconnection Request. |
| otPlatBleL2capOnDisconnect⚠ | The BLE driver calls this method to notify OpenThread that an L2CAP Disconnection Request has been received. |
| otPlatBleOnEnabled⚠ | Callback sent when Bluetooth Low Energy is ready after being enabled. |
| otPlatBleReset⚠ | Reset the Bluetooth Low Energy subsystem. |
| otPlatCAlloc⚠ | Dynamically allocates new memory. On platforms that support it, should just redirect to calloc. For those that don't support calloc, should support the same functionality: |
| otPlatDebugUart_getc⚠ | Poll/Read a byte from the debug uart |
| otPlatDebugUart_kbhit⚠ | Poll/test debug uart if a key has been pressed. It would be common to a stub function that returns 0. |
| otPlatDebugUart_logfile⚠ | Some platforms (simulation) can log to a file. |
| otPlatDebugUart_printf⚠ | Standard printf() to the debug uart with no log decoration. |
| otPlatDebugUart_putchar⚠ | Write byte to the uart, expand cr/lf as need. |
| otPlatDebugUart_putchar_raw⚠ | Platform specific write single byte to Debug Uart This should not perform CR/LF mapping. |
| otPlatDebugUart_puts⚠ | identical to "man 3 puts" - terminates with lf Which is then mapped to cr/lf as required |
| otPlatDebugUart_puts_no_nl⚠ | puts() without a terminal newline. see: "man 3 puts", without a adding a terminal lf |
| otPlatDebugUart_vprintf⚠ | Standard vprintf() to the debug uart, with no log decoration. |
| otPlatDebugUart_write_bytes⚠ | Write N bytes to the UART, mapping cr/lf |
| otPlatDiagAlarmCallback⚠ | This function processes the alarm event. |
| otPlatDiagAlarmFired⚠ | Signal diagnostics module that the alarm has fired. |
| otPlatDiagChannelSet⚠ | This function sets the channel to use for factory diagnostics. |
| otPlatDiagModeGet⚠ | This function indicates whether or not factory diagnostics mode is enabled. |
| otPlatDiagModeSet⚠ | This function enables/disables the factory diagnostics mode. |
| otPlatDiagProcess⚠ | This function processes a factory diagnostics command line. |
| otPlatDiagRadioReceiveDone⚠ | The radio driver calls this method to notify OpenThread diagnostics module of a received frame. |
| otPlatDiagRadioReceived⚠ | This function processes the received radio frame. |
| otPlatDiagRadioTransmitDone⚠ | The radio driver calls this method to notify OpenThread diagnostics module that the transmission has completed. |
| otPlatDiagTxPowerSet⚠ | This function sets the transmit power to use for factory diagnostics. |
| otPlatEntropyGet⚠ | Fill buffer with entropy. |
| otPlatFlashErase⚠ | This function erases the swap space indicated by @p aSwapIndex. |
| otPlatFlashGetSwapSize⚠ | This function gets the size of the swap space. |
| otPlatFlashInit⚠ | This function initializes the flash driver. |
| otPlatFlashRead⚠ | This function reads @p aSize bytes into @p aData. |
| otPlatFlashWrite⚠ | This function writes @p aSize bytes from @p aData. |
| otPlatFree⚠ | Frees memory that was dynamically allocated. |
| otPlatGetMcuPowerState⚠ | This function gets the current desired MCU power state. |
| otPlatGetResetReason⚠ | This function returns the reason for the last platform reset. |
| otPlatLog⚠ | This function outputs logs. |
| otPlatMessagePoolFree⚠ | This function is used to free a Buffer back to the platform managed buffer pool. |
| otPlatMessagePoolInit⚠ | Initialize the platform implemented message pool. |
| otPlatMessagePoolNew⚠ | Allocate a buffer from the platform managed buffer pool. |
| otPlatMessagePoolNumFreeBuffers⚠ | Get the number of free buffers. |
| otPlatOtnsStatus⚠ | This function exports status information to OTNS. |
| otPlatRadioAddSrcMatchExtEntry⚠ | Add an extended address to the source address match table. |
| otPlatRadioAddSrcMatchShortEntry⚠ | Add a short address to the source address match table. |
| otPlatRadioClearSrcMatchExtEntries⚠ | Clear all the extended/long addresses from source address match table. |
| otPlatRadioClearSrcMatchExtEntry⚠ | Remove an extended address from the source address match table. |
| otPlatRadioClearSrcMatchShortEntries⚠ | Clear all short addresses from the source address match table. |
| otPlatRadioClearSrcMatchShortEntry⚠ | Remove a short address from the source address match table. |
| otPlatRadioDisable⚠ | Disable the radio. |
| otPlatRadioEnable⚠ | Enable the radio. |
| otPlatRadioEnableSrcMatch⚠ | Enable/Disable source address match feature. |
| otPlatRadioEnergyScan⚠ | Begin the energy scan sequence on the radio. |
| otPlatRadioEnergyScanDone⚠ | The radio driver calls this method to notify OpenThread that the energy scan is complete. |
| otPlatRadioGetCaps⚠ | Get the radio capabilities. |
| otPlatRadioGetCcaEnergyDetectThreshold⚠ | Get the radio's CCA ED threshold in dBm. |
| otPlatRadioGetCoexMetrics⚠ | Get the radio coexistence metrics. |
| otPlatRadioGetIeeeEui64⚠ | Get the factory-assigned IEEE EUI-64 for this interface. |
| otPlatRadioGetPreferredChannelMask⚠ | Get the radio preferred channel mask that the device prefers to form on. |
| otPlatRadioGetPromiscuous⚠ | Get the status of promiscuous mode. |
| otPlatRadioGetReceiveSensitivity⚠ | Get the radio receive sensitivity value. |
| otPlatRadioGetRssi⚠ | Get the most recent RSSI measurement. |
| otPlatRadioGetState⚠ | Get current state of the radio. |
| otPlatRadioGetSupportedChannelMask⚠ | Get the radio supported channel mask that the device is allowed to be on. |
| otPlatRadioGetTransmitBuffer⚠ | Get the radio transmit frame buffer. |
| otPlatRadioGetTransmitPower⚠ | Get the radio's transmit power in dBm. |
| otPlatRadioGetVersionString⚠ | Get the radio version string. |
| otPlatRadioIsCoexEnabled⚠ | Check whether radio coex is enabled or not. |
| otPlatRadioIsEnabled⚠ | Check whether radio is enabled or not. |
| otPlatRadioReceive⚠ | Transition the radio from Sleep to Receive (turn on the radio). |
| otPlatRadioReceiveDone⚠ | The radio driver calls this method to notify OpenThread of a received frame. |
| otPlatRadioSetCcaEnergyDetectThreshold⚠ | Set the radio's CCA ED threshold in dBm. |
| otPlatRadioSetCoexEnabled⚠ | Enable the radio coex. |
| otPlatRadioSetExtendedAddress⚠ | Set the Extended Address for address filtering. |
| otPlatRadioSetMacKey⚠ | Update MAC keys and key index |
| otPlatRadioSetPanId⚠ | Set the PAN ID for address filtering. |
| otPlatRadioSetPromiscuous⚠ | Enable or disable promiscuous mode. |
| otPlatRadioSetShortAddress⚠ | Set the Short Address for address filtering. |
| otPlatRadioSetTransmitPower⚠ | Set the radio's transmit power in dBm. |
| otPlatRadioSleep⚠ | Transition the radio from Receive to Sleep (turn off the radio). |
| otPlatRadioTransmit⚠ | Begin the transmit sequence on the radio. |
| otPlatRadioTxDone⚠ | The radio driver calls this function to notify OpenThread that the transmit operation has completed, providing both the transmitted frame and, if applicable, the received ack frame. |
| otPlatRadioTxStarted⚠ | The radio driver calls this method to notify OpenThread that the transmission has started. |
| otPlatReset⚠ | This function performs a software reset on the platform, if supported. |
| otPlatSetMcuPowerState⚠ | This function sets the desired MCU power state. |
| otPlatSettingsAdd⚠ | Adds a value to a setting ** This function adds the value to a setting |
| otPlatSettingsDeinit⚠ | Performs any de-initialization for the settings subsystem, if necessary. |
| otPlatSettingsDelete⚠ | Removes a setting from the setting store ** This function deletes a specific value from the |
| otPlatSettingsGet⚠ | Fetches the value of a setting ** This function fetches the value of the setting identified |
| otPlatSettingsInit⚠ | Performs any initialization for the settings subsystem, if necessary. |
| otPlatSettingsSet⚠ | Sets or replaces the value of a setting ** This function sets or replaces the value of a setting |
| otPlatSettingsWipe⚠ | Removes all settings from the setting store ** This function deletes all settings from the settings |
| otPlatSpiSlaveDisable⚠ | Shutdown and disable the SPI slave interface. |
| otPlatSpiSlaveEnable⚠ | Initialize the SPI slave interface. |
| otPlatSpiSlavePrepareTransaction⚠ | Prepare data for the next SPI transaction. Data pointers MUST remain valid until the transaction complete callback
is called by the SPI slave driver, or until after the next call to |
| otPlatTimeGet⚠ | Get the current time (64bits width). |
| otPlatTimeGetXtalAccuracy⚠ | Get the device's XTAL accuracy. |
| otPlatUartDisable⚠ | Disable the UART. |
| otPlatUartEnable⚠ | Enable the UART. |
| otPlatUartFlush⚠ | Flush the outgoing transmit buffer and wait for the data to be sent. This is called when the CLI UART interface has a full buffer but still wishes to send more data. |
| otPlatUartReceived⚠ | The UART driver calls this method to notify OpenThread that bytes have been received. |
| otPlatUartSend⚠ | Send bytes over the UART. |
| otPlatUartSendDone⚠ | The UART driver calls this method to notify OpenThread that the requested bytes have been sent. |
| otPlatUdpBind⚠ | This function binds the UDP socket by platform. |
| otPlatUdpClose⚠ | This function closes the UDP socket by platform. |
| otPlatUdpConnect⚠ | This function connects UDP socket by platform. |
| otPlatUdpSend⚠ | This function sends UDP payload by platform. |
| otPlatUdpSocket⚠ | This function initializes the UDP socket by platform. |
| otPlatWakeHost⚠ | This function performs a platform specific operation to wake the host MCU. This is used only for NCP configurations. |
| otRandomNonCryptoAddJitter⚠ | This function adds a random jitter within a given range to a given value. |
| otRandomNonCryptoFillBuffer⚠ | This function fills a given buffer with random bytes. |
| otRandomNonCryptoGetUint8⚠ | This function generates and returns a random byte. |
| otRandomNonCryptoGetUint8InRange⚠ | This function generates and returns a random |
| otRandomNonCryptoGetUint16⚠ | This function generates and returns a random |
| otRandomNonCryptoGetUint16InRange⚠ | This function generates and returns a random |
| otRandomNonCryptoGetUint32⚠ | This function generates and returns a random |
| otRandomNonCryptoGetUint32InRange⚠ | This function generates and returns a random |
| otRemoveStateChangeCallback⚠ | This function removes a callback to indicate when certain configuration or state changes within OpenThread. |
| otServerAddService⚠ | Add a service configuration to the local network data. |
| otServerGetNetDataLocal⚠ | This method provides a full or stable copy of the local Thread Network Data. |
| otServerGetNextService⚠ | This function gets the next service in the local Network Data. |
| otServerRegister⚠ | Immediately register the local network data with the Leader. |
| otServerRemoveService⚠ | Remove a service configuration from the local network data. |
| otSetStateChangedCallback⚠ | This function registers a callback to indicate when certain configuration or state changes within OpenThread. |
| otSntpClientQuery⚠ | This function sends a SNTP query. |
| otSntpClientSetUnixEra⚠ | This function sets the unix era number. |
| otTaskletsArePending⚠ | Indicates whether or not OpenThread has tasklets pending. |
| otTaskletsProcess⚠ | Run all queued OpenThread tasklets at the time this is called. |
| otTaskletsSignalPending⚠ | OpenThread calls this function when the tasklet queue transitions from empty to non-empty. |
| otThreadBecomeChild⚠ | Attempt to reattach as a child. |
| otThreadBecomeDetached⚠ | Detach from the Thread network. |
| otThreadBecomeLeader⚠ | Become a leader and start a new partition. |
| otThreadBecomeRouter⚠ | Attempt to become a router. |
| otThreadDiscover⚠ | This function starts a Thread Discovery scan. |
| otThreadErrorToString⚠ | This function converts an otError enum into a string. |
| otThreadGetChildInfoById⚠ | The function retains diagnostic information for an attached Child by its Child ID or RLOC16. |
| otThreadGetChildInfoByIndex⚠ | The function retains diagnostic information for an attached Child by the internal table index. |
| otThreadGetChildNextIp6Address⚠ | This function gets the next IPv6 address (using an iterator) for a given child. |
| otThreadGetChildTimeout⚠ | Get the Thread Child Timeout used when operating in the Child role. |
| otThreadGetContextIdReuseDelay⚠ | Get the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role. |
| otThreadGetDeviceRole⚠ | Get the device role. |
| otThreadGetDomainName⚠ | Get the Thread Domain Name. |
| otThreadGetExtendedPanId⚠ | Get the IEEE 802.15.4 Extended PAN ID. |
| otThreadGetIp6Counters⚠ | Get the IPv6 counters. |
| otThreadGetJoinerUdpPort⚠ | Get the Joiner UDP Port. |
| otThreadGetKeySequenceCounter⚠ | Get the thrKeySequenceCounter. |
| otThreadGetKeySwitchGuardTime⚠ | Get the thrKeySwitchGuardTime |
| otThreadGetLeaderData⚠ | This function get the Thread Leader Data. |
| otThreadGetLeaderRloc⚠ | This function returns a pointer to the Leader's RLOC. |
| otThreadGetLeaderRouterId⚠ | Get the Leader's Router ID. |
| otThreadGetLeaderWeight⚠ | Get the Leader's Weight. |
| otThreadGetLinkLocalIp6Address⚠ | This function returns the Thread link-local IPv6 address. |
| otThreadGetLinkMode⚠ | Get the MLE Link Mode configuration. |
| otThreadGetLocalLeaderPartitionId⚠ | Get the Thread Leader Partition Id used when operating in the Leader role. |
| otThreadGetLocalLeaderWeight⚠ | Get the Thread Leader Weight used when operating in the Leader role. |
| otThreadGetMasterKey⚠ | Get the thrMasterKey. |
| otThreadGetMaxAllowedChildren⚠ | Get the maximum number of children currently allowed. |
| otThreadGetMaxChildIpAddresses⚠ | This function gets the maximum number of IP addresses that each MTD child may register with this device as parent. |
| otThreadGetMaxRouterId⚠ | The function returns the maximum allowed router ID |
| otThreadGetMeshLocalEid⚠ | This function returns a pointer to the Mesh Local EID address. |
| otThreadGetMeshLocalPrefix⚠ | This function returns a pointer to the Mesh Local Prefix. |
| otThreadGetMleCounters⚠ | Get the Thread MLE counters. |
| otThreadGetNetworkIdTimeout⚠ | Get the NETWORK_ID_TIMEOUT parameter used in the Router role. |
| otThreadGetNetworkName⚠ | Get the Thread Network Name. |
| otThreadGetNextCacheEntry⚠ | This function gets the next EID cache entry (using an iterator). |
| otThreadGetNextDiagnosticTlv⚠ | This function gets the next Network Diagnostic TLV in the message. |
| otThreadGetNextNeighborInfo⚠ | This function gets the next neighbor information. It is used to go through the entries of the neighbor table. |
| otThreadGetParentAverageRssi⚠ | The function retrieves the average RSSI for the Thread Parent. |
| otThreadGetParentInfo⚠ | The function retrieves diagnostic information for a Thread Router as parent. |
| otThreadGetParentLastRssi⚠ | The function retrieves the RSSI of the last packet from the Thread Parent. |
| otThreadGetParentPriority⚠ | Get the assigned parent priority. |
| otThreadGetPartitionId⚠ | Get the Partition ID. |
| otThreadGetPskc⚠ | Get the Thread PSKc |
| otThreadGetRloc⚠ | This function returns a pointer to the Thread Routing Locator (RLOC) address. |
| otThreadGetRloc16⚠ | Get the RLOC16. |
| otThreadGetRouterDowngradeThreshold⚠ | Get the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Router role. |
| otThreadGetRouterIdSequence⚠ | Get the current Router ID Sequence. |
| otThreadGetRouterInfo⚠ | The function retains diagnostic information for a given Thread Router. |
| otThreadGetRouterSelectionJitter⚠ | Get the ROUTER_SELECTION_JITTER parameter used in the REED/Router role. |
| otThreadGetRouterUpgradeThreshold⚠ | Get the ROUTER_UPGRADE_THRESHOLD parameter used in the REED role. |
| otThreadGetVersion⚠ | This function gets the Thread protocol version. |
| otThreadIsDiscoverInProgress⚠ | This function determines if an MLE Thread Discovery is currently in progress. |
| otThreadIsRouterEligible⚠ | This method indicates whether or not the device is router-eligible. |
| otThreadIsSingleton⚠ | This function indicates whether a node is the only router on the network. |
| otThreadRegisterNeighborTableCallback⚠ | This function registers a neighbor table callback function. |
| otThreadRegisterParentResponseCallback⚠ | This function registers a callback to receive MLE Parent Response data. |
| otThreadReleaseRouterId⚠ | Release a Router ID that has been allocated by the device in the Leader role. |
| otThreadResetIp6Counters⚠ | Reset the IPv6 counters. |
| otThreadResetMleCounters⚠ | Reset the Thread MLE counters. |
| otThreadSendDiagnosticGet⚠ | Send a Network Diagnostic Get request. |
| otThreadSendDiagnosticReset⚠ | Send a Network Diagnostic Reset request. |
| otThreadSetChildTimeout⚠ | Set the Thread Child Timeout used when operating in the Child role. |
| otThreadSetContextIdReuseDelay⚠ | Set the CONTEXT_ID_REUSE_DELAY parameter used in the Leader role. |
| otThreadSetDomainName⚠ | Set the Thread Domain Name. |
| otThreadSetEnabled⚠ | This function starts Thread protocol operation. |
| otThreadSetExtendedPanId⚠ | Set the IEEE 802.15.4 Extended PAN ID. |
| otThreadSetJoinerUdpPort⚠ | Set the Joiner UDP Port. |
| otThreadSetKeySequenceCounter⚠ | Set the thrKeySequenceCounter. |
| otThreadSetKeySwitchGuardTime⚠ | Set the thrKeySwitchGuardTime |
| otThreadSetLinkMode⚠ | Set the MLE Link Mode configuration. |
| otThreadSetLocalLeaderPartitionId⚠ | Set the Thread Leader Partition Id used when operating in the Leader role. |
| otThreadSetLocalLeaderWeight⚠ | Set the Thread Leader Weight used when operating in the Leader role. |
| otThreadSetMasterKey⚠ | Set the thrMasterKey. |
| otThreadSetMaxAllowedChildren⚠ | Set the maximum number of children currently allowed. |
| otThreadSetMaxChildIpAddresses⚠ | This function sets/restores the maximum number of IP addresses that each MTD child may register with this device as parent. |
| otThreadSetMeshLocalPrefix⚠ | This function sets the Mesh Local Prefix. |
| otThreadSetNetworkIdTimeout⚠ | Set the NETWORK_ID_TIMEOUT parameter used in the Leader role. |
| otThreadSetNetworkName⚠ | Set the Thread Network Name. |
| otThreadSetParentPriority⚠ | Set the parent priority. |
| otThreadSetPreferredRouterId⚠ | Set the preferred Router Id. |
| otThreadSetPskc⚠ | Set the Thread PSKc |
| otThreadSetReceiveDiagnosticGetCallback⚠ | This function registers a callback to provide received raw Network Diagnostic Get response payload. |
| otThreadSetRouterDowngradeThreshold⚠ | Set the ROUTER_DOWNGRADE_THRESHOLD parameter used in the Leader role. |
| otThreadSetRouterEligible⚠ | This function sets whether or not the device is router-eligible. |
| otThreadSetRouterSelectionJitter⚠ | Set the ROUTER_SELECTION_JITTER parameter used in the REED/Router role. |
| otThreadSetRouterUpgradeThreshold⚠ | Set the ROUTER_UPGRADE_THRESHOLD parameter used in the Leader role. |
| otThreadSetSteeringData⚠ | Set Steering data out of band. |
| otUdpAddReceiver⚠ | This function adds a UDP receiver. |
| otUdpBind⚠ | Bind a UDP/IPv6 socket. |
| otUdpClose⚠ | Close a UDP/IPv6 socket. |
| otUdpConnect⚠ | Connect a UDP/IPv6 socket. |
| otUdpForwardReceive⚠ | Handle a UDP packet received from host. |
| otUdpForwardSetForwarder⚠ | Set UDP forward callback to deliver UDP packets to host. |
| otUdpGetSockets⚠ | This function gets the existing UDP Sockets. |
| otUdpNewMessage⚠ | Allocate a new message buffer for sending a UDP message. |
| otUdpOpen⚠ | Open a UDP/IPv6 socket. |
| otUdpRemoveReceiver⚠ | This function removes a UDP receiver. |
| otUdpSend⚠ | Send a UDP/IPv6 message. |
| otUdpSendDatagram⚠ | This function sends a UDP message without socket. |
Type Definitions
| __builtin_va_list | |
| __int8_t | |
| __int16_t | |
| __int64_t | |
| __uint8_t | |
| __uint16_t | |
| __uint32_t | |
| __uint64_t | |
| _bindgen_ty_1 | This enumeration defines flags that are passed as part of |
| _bindgen_ty_2 | @defgroup radio-types Types |
| _bindgen_ty_3 | This enumeration defines the channel page. |
| _bindgen_ty_4 | This enumeration defines the frequency band channel range. |
| _bindgen_ty_5 | This enumeration defines constants that are used to indicate different radio capabilities. See |
| _bindgen_ty_6 | This enumeration defines the Security Policy TLV flags. |
| _bindgen_ty_7 | |
| _bindgen_ty_8 | @addtogroup plat-ble |
| otBackboneRouterState | Represents the Backbone Router Status. |
| otBorderAgentState | This enumeration defines the Border Agent state. |
| otCacheEntryState | This enumeration defines the EID cache entry state. |
| otChangedFlags | This type represents a bit-field indicating specific state/configuration that has changed. See |
| otChannelMask | This type represents Channel Mask. |
| otChildIp6AddressIterator | |
| otCliConsoleOutputCallback | This function pointer is called to notify about Console output. |
| otCoapBlockSize | CoAP Block Size Exponents |
| otCoapCode | CoAP Code values. |
| otCoapOptionContentFormat | CoAP Content Format codes. The full list is documented at https://www.iana.org/assignments/core-parameters/core-parameters.xhtml#content-formats |
| otCoapRequestHandler | This function pointer is called when a CoAP request with a given Uri-Path is received. |
| otCoapResponseHandler | This function pointer is called when a CoAP response is received or on the request timeout. |
| otCoapType | CoAP Type values. |
| otCommissionerEnergyReportCallback | This function pointer is called when the Commissioner receives an Energy Report. |
| otCommissionerJoinerCallback | This function pointer is called whenever the joiner state changes. |
| otCommissionerJoinerEvent | This enumeration defines a Joiner Event on the Commissioner. |
| otCommissionerPanIdConflictCallback | This function pointer is called when the Commissioner receives a PAN ID Conflict message. |
| otCommissionerState | This enumeration defines the Commissioner State. |
| otCommissionerStateCallback | This function pointer is called whenever the commissioner state changes. |
| otDeviceRole | Represents a Thread device role. |
| otDnsResponseHandler | This function pointer is called when a DNS response is received. |
| otError | This enumeration represents error codes used throughout OpenThread. |
| otHandleActiveScanResult | This function pointer is called during an IEEE 802.15.4 Active Scan when an IEEE 802.15.4 Beacon is received or the scan completes. |
| otHandleCoapSecureClientConnect | This function pointer is called when the DTLS connection state changes. |
| otHandleEnergyScanResult | This function pointer is called during an IEEE 802.15.4 Energy Scan when the result for a channel is ready or the scan completes. |
| otHeapCAllocFn | Function pointer used to set external CAlloc function for OpenThread. |
| otHeapFreeFn | Function pointer used to set external Free function for OpenThread. |
| otIcmp6ReceiveCallback | This callback allows OpenThread to inform the application of a received ICMPv6 message. |
| otIcmp6EchoMode | ICMPv6 Echo Reply Modes |
| otIp6ReceiveCallback | This function pointer is called when an IPv6 datagram is received. |
| otIp6AddressCallback | This function pointer is called when an internal IPv6 address is added or removed. |
| otIp6SlaacPrefixFilter | This function pointer allows user to filter prefixes and not allow an SLAAC address based on a prefix to be added. |
| otJamDetectionCallback | This function pointer is called if signal jam detection is enabled and a jam is detected. |
| otJoinerCallback | This function pointer is called to notify the completion of a join operation. |
| otJoinerState | This enumeration defines the Joiner State. |
| otLinkPcapCallback | This function pointer is called when an IEEE 802.15.4 frame is received. |
| otLinkRawEnergyScanDone | This function pointer on receipt of a IEEE 802.15.4 frame. |
| otLinkRawReceiveDone | This function pointer on receipt of a IEEE 802.15.4 frame. |
| otLinkRawTransmitDone | This function pointer on receipt of a IEEE 802.15.4 frame. |
| otLogLevel | This type represents the log level. |
| otLogRegion | This enumeration represents log regions. |
| otMacFilterAddressMode | Defines address mode of the mac filter. |
| otMacFilterIterator | |
| otMessagePriority | This enumeration defines the OpenThread message priority levels. |
| otNcpDelegateAllowPeekPoke | Defines delegate (function pointer) type to control behavior of peek/poke operation. |
| otNcpHandlerJoinLegacyNode | Defines handler (function pointer) type for initiating joining process. |
| otNcpHandlerSetLegacyUlaPrefix | Defines handler (function pointer) type for setting the legacy ULA prefix. |
| otNcpHandlerStartLegacy | Defines handler (function pointer) type for starting legacy network |
| otNcpHandlerStopLegacy | Defines handler (function pointer) type for stopping legacy network |
| otNeighborInfoIterator | |
| otNeighborTableCallback | This function pointer is called to notify that a child or router neighbor is being added to or removed from neighbor table. |
| otNeighborTableEvent | This enumeration defines the constants used in |
| otNetworkDataIterator | |
| otNetworkDiagIterator | |
| otNetworkTimeStatus | This enumeration represents OpenThread time synchronization status. |
| otNetworkTimeSyncCallbackFn | This function pointer is called when a network time sync or status change occurs. |
| otPanId | This type represents the IEEE 802.15.4 PAN ID. |
| otPlatBleL2capError | The enum indicates the outcome of the L2CAP connection request procedure. See Bluetooth v5.0 | Vol 3, Part A, 4.23, Table 4.20. |
| otPlatBleUuidType | This enumeration represents BLE UUID value. |
| otPlatMcuPowerState | Enumeration of micro-controller's power states. |
| otPlatResetReason | Enumeration of possible reset reason codes. |
| otPlatSpiSlaveTransactionCompleteCallback | Indicates that a SPI transaction has completed with the given length. The data written to the slave has been written
to the pointer indicated by the |
| otPlatSpiSlaveTransactionProcessCallback | Invoked after a transaction complete callback is called and returns |
| otRadioCaps | This type represents radio capabilities. |
| otRadioState | This structure represents the state of a radio. Initially, a radio is in the Disabled state. |
| otReceiveDiagnosticGetCallback | This function pointer is called when Network Diagnostic Get response is received. |
| otShortAddress | This type represents the IEEE 802.15.4 Short Address. |
| otSntpResponseHandler | This function pointer is called when a SNTP response is received. |
| otStateChangedCallback | This function pointer is called to notify certain configuration or state changes within OpenThread. |
| otThreadParentResponseCallback | This function pointer is called every time an MLE Parent Response message is received. |
| otUdpForwarder | This function pointer delivers the UDP packet to host and host should send the packet through its own network stack. |
| otUdpHandler | This callback allows OpenThread to provide specific handlers for certain UDP messages. |
| otUdpReceive | This callback allows OpenThread to inform the application of a received UDP message. |
| size_t | |
| va_list |
Unions
| otIcmp6Header__bindgen_ty_1 | |
| otIp6Address__bindgen_ty_1 | |
| otNeighborTableEntryInfo__bindgen_ty_1 | |
| otNetworkDiagTlv__bindgen_ty_1 | |
| otPlatBleUuidValue | This structure represents BLE UUID value. |
| otRadioFrame__bindgen_ty_1 | The union of transmit and receive information for a radio frame. |