OpenThread C API Reference Updates

See "api: platform" and "api: user" labeled Pull Requests on GitHub for additional details on API Reference updates.

November 29, 2023

• Added new SRP server commands to the CLI Command Reference, beginning alphabetically with srp server (enable,disable).
• Added a new platform abstraction module for Multipan.
• Added new otNcpHdlcInitMulti function to the Network Co-Processor API.
• Added new otInstanceInitMultiple function to the Instance API.
• Added new otMessageIsMulticastLoopEnabled and otMessageSetMulticastLoopEnabled functions to the Message API.

November 21, 2023

• Added new SRP client commands to the CLI Command Reference, beginning alphabetically with srp client autostart (get).
• otBorderRoutingGetNextRouterEntry function added to Border Routing Manager API.
• otBorderRoutingRouterEntry struct added to Border Routing Manager.
• otPlatRadioSetRxOnWhenIdle function added to Radio Configuration.

November 7, 2023

• Added new TCP commands to the CLI Command Reference, beginning alphabetically with tcp abort.

November 2, 2023

• otLinkGetRegion and otLinkSetRegion functions added to the Link API.
• otThreadReleaseRouterId function added to the Router/Leader API.
• otNetDataGetCommissioningDataset function added to the Thread General API.
• otInstanceResetToBootloader function added to the Execution Instance API.
• Added new otLogHexDumpInfo structure.

October 13, 2023

• Added new commands to the CLI Command Reference:
  • Added udp bind, udp close, udp connect, udp linksecurity (enable,disable), udp linksecurity, udp open and udp send.
• otIp6HasUnicastAddress function added to the IPv6 API.
• otBorderAgentGetId function added to the Border Agent API.

October 5, 2023

• Added new commands to the CLI Command Reference:
  • Added neighbor linkquality, neighbor list and neighbor table.
  • Added netstat.
  • Added networkdiagnostic get, networkdiagnostic reset and networkidtimeout (get,set).
• otMessageGetOrigin, otMessageIsLoopbackToHostAllowed, otMessageSetLoopbackToHostAllowed and otMessageSetOrigin functions added to the Message API.

September 28, 2023

• Added new commands to the CLI Command Reference:
  • Added mac retries direct (get,set), mac retries indirect (get,set) and mac send.
  • Added macfilter rss add, macfilter rss add-lqi, macfilter rss clear, macfilter rss and macfilter rss remove.

September 22, 2023

• Added new commands to the CLI Command Reference:
  • Added macfilter addr add, macfilter addr allowlist, macfilter addr clear, macfilter addr denylist, macfilter addr disable, macfilter addr, macfilter addr remove and macfilter.

September 14, 2023

• Added new commands to the CLI Command Reference:
  • Added tvcheck (enable,disable).
  • Added txpower (get,set).
  • Added unsecure get.
  • Added unsecureport add and unsecureport remove.

September 8, 2023

• Added new commands to the CLI Command Reference:
  • Added linkmetricsmgr (enable,disable) and linkmetricsmgr show.
  • Added scan energy, scan.
  • Added service add and service remove.
  • Added singleton, sntp query and state.
  • Added thread start, thread stop and thread version.
  • Added trel (enable,disable), trel filter (enable,disable), trel filter, trel peers and trel.
• otLinkMetricsManagerGetMetricsValueByExtAddr and otLinkMetricsManagerSetEnabled functions added to the Link Metrics API.

August 29, 2023

• Added new commands to the CLI Command Reference:
  • Added locate (set) and locate.
  • Added log filename, log level (set) and log level
  • Added preferrouterid.
  • Added promiscuous (enable,disable) and promiscuous
  • Added pskc (set), pskc -p and pskc.
  • Added pskcref (set) and pskcref.

August 15, 2023

• Added new commands to the CLI Command Reference:
  • Added uptime ms.
  • Added uptime.
  • Added version api.
  • Added version.

July 31, 2023

• Added the new command mleadvimax to the CLI Command Reference.
• otThreadGetAdvertisementTrickleIntervalMax function added to the Router/Leader API.

July 26, 2023

• Added new commands to the CLI Command Reference:
  • Added ba id (get,set).
  • Added detach async.
  • Added detach.

July 19, 2023

• Added new APIs and related CLI commands to allow users to manually set the published route preference to the Border Routing Manager API.
• Updated the SRP API for better handling of service instance names.
• Added new structs, functions, and related CLI commands to the Mesh Diagnostics API to collect statistics on the time that messages spend in TX queue.

June 26, 2023

• Added Radio Statistics API, which includes new functions along with related CLI commands:
  • Added radio (enable,disable).
  • Added radio stats clear.
  • Added radio stats.

June 13, 2023

• Added new commands to the CLI Command Reference:
  • Added mliid.
  • Added mlr reg.
  • Added mode (get,set).
  • Added multiradio.
  • Added multiradio neighbor list.
  • Added multiradio neighbor.
• otBorderRoutingDhcp6PdSetEnabled and otBorderRoutingGetPdOmrPrefix functions added to the Border Routing Manager API.

June 1, 2023

• Added new commands to the CLI Command Reference:
  • Added dns servicehost.
  • Added instanceid.
• otBorderAgentId struct added to the Border Agent API.
• otBorderAgentSetId and otBorderAgentId functions added to the Border Agent API.
• otDnsClientResolveServiceAndHostAddress function added to the DNS API.
• otInstanceGetId function added to the Instance API.
• otCliVendorSetUserCommands function added to the CLI API.

May 17, 2023

• Added new commands to the CLI Command Reference:
  • Added meshdiag topology.
  • Added neighbor conntime.
  • Added neighbor conntime list.
  • Added netdata publish replace.
  • otConvertDurationInSecondsToString and otNetDataReplacePublishedExternalRoute functions added to the Thread - General API.

May 8, 2023

• Added new commands to the CLI Command Reference:
  • Added vendor model.
  • Added vendor name.
  • Added vendor swversion.
• otBorderAgentGetId function added to the Border Agent API.
• otIp6PrefixFromString function added to the IPv6 API.
• otThreadGetVendorModel, otThreadGetVendorName, otThreadGetVendorSwVersion, otThreadSetVendorModel, otThreadSetVendorName, and otThreadSetVendorSwVersion functions added to the Thread - General API.

May 1, 2023

• otPlatCryptoEcdsaGenerateAndImportKey, otPlatCryptoEcdsaExportPublicKey, otPlatCryptoEcdsaSignUsingKeyRef, and otPlatCryptoEcdsaVerifyUsingKeyRef functions added to the Crypto Platform API.
• otPlatDiagRadioTransmitStream function added to the Platform Factory Diagnostics API.

April 18, 2023

• otIp4CidrFromString function added to the NAT64 API.

March 28, 2023

• Added new commands to the CLI Command Reference:
  • Added partitionid commands.
  • Added platform.
  • Added pollperiod (get,set).

March 23, 2023

• New commands added to the CLI Command Reference.
• otDatasetUpdateTlvs function added to the Operational Dataset API.
• otDeviceProperties struct added to the Router/Leader API.
• otLowpanContextInfo struct added to the Thread - General API.

March 15, 2023

• Added new commands to the CLI Command Reference:
  • Added dataset set (active, pending).
  • Added dataset tlvs.
  • Added netdata length.
  • Added netdata maxlength.
• Updated dns commands in the CLI Command Reference, including config, browse, compression, resolve, and service commands.
• otMeshDiagRouterInfo struct added to the Mesh Diagnostics API.
• otNetworkDiagTlv struct added to the Thread - General API.
• otRadioFrame struct added to the Radio Types API.

March 02, 2023

• Added Mesh Diagnostics API.
• Added DNS - Platform API.
• Added childrouterlinks (get, set) to the CLI Command Reference.
• Added commands from rcp version to routerupgradethreshold (get, set).
• Counter functions added to the Child Supervision API, along with childrouterlinks (get, set).
• Added new APIs to the Border Routing Manager API, along with related CLI commands.
  • Added br state to the CLI Command Reference.
  • Updated br nat64prefix, br omrprefix, and br onlinkprefix to include favored and local prefixes.
  • Removed br (enable,disable) from the CLI Command Reference.
• otMessageResetBufferInfo function added to the Message API, along with bufferinfo reset.

February 20, 2023

• Removed otTrelDisable and otTrelEnable functions from the TREL - Thread Stack API.

February 14, 2023

• Added dns commands to the CLI Command Reference, including config, browse, compression, resolve, and service commands.
• Updated nexthop and added nexthop (get) to the CLI Command Reference.
• otNcpLegacyHandlers removed from the Network Co-Processor API.
• otHistoryTrackerRouterInfo struct added to History Tracker API.

January 31, 2023

• otTcpEndpointAndCircularSendBuffer function added to the TCP Abstractions API.
• Power calibration functions added to the Radio Operation API.
• TLS mode added to the TCP Abstractions API.

January 18, 2023

• Added discover reqcallback (enable,disable) to the CLI Command Reference.
• otThreadGetNextHopAndPathCost function added to the Router/Leader API.

January 3, 2023

• otBorderRoutingClearRouteInfoOptionPreference and otBorderRoutingClearRouteInfoOptionPreference functions added to the Border Routing Manager API.
• Power calibration functions added to the Radio Operation API.
• PSKc functions moved to the Crypto Platform API.
• Added br rioprf and br rioprf clear to the CLI Command Reference.

November 18, 2022

• Added new functioPlatform Factory Diagnostics APIns to the Platform Crypto API.
• Added the otGpioMode enum and new functions to the Platform Factory Diagnostics API.
• Added otBorderRoutingCounters and otPacketsAndBytes structs to the IPv6 API.

October 26, 2022

• New otIcmp6Type enums added to the ICMPv6 API.
• OT_TOOL_PRINTF_STYLE_FORMAT_ARG_CHECK macro added to the Toolchain API.
• New attributes added to the otMleCounters struct.

October 19, 2022

• otNat64State, otNat64GetPrefixManagerState, otNat64GetTranslatorState, and otNat64SetEnabled functions added to the NAT64 API.
• Added nat64 (enable,disable) and nat64 state to the CLI Command Reference.

October 13, 2022

• Added various commands to the CLI Command Reference, including ifconfig, ipaddr, and linkmetrics.

September 21, 2022

• otIp4AddressFromString and otNat64SynthesizeIp6Address functions added to the NAT64 API.
• otSrpServerIsAutoEnableMode and otSrpServerSetAutoEnableMode functions added to the SRP API.
• Enum updates to the TCP Abstractions API.

September 15, 2022

• Added new enums, typedefs, and functions to the NAT64 API to support new NAT64 CLI commands.
• Added NAT64 commands to the CLI Command Reference, including NAT64 CIDR, prefix, mapping, and counter commands.

August 25, 2022

• Added Operational Datasets to CLI Concepts.
• Added dataset commands to the CLI Command Reference.

August 24, 2022

• otNat64ReceiveIp4Callback, otIp4NewMessage, otNat64Send, otNat64SetIp4Cidr, and otNat64SetReceiveIp4Callback functions added to the NAT64 API.
• Added child commands to the CLI Command Reference.

August 16, 2022

• otBorderRoutingGetFavoredNat64Prefix function added to the Border Routing Manager API.
• otThreadSearchForBetterParent method added to the General API.
• otPlatInfraIfDiscoverNat64Prefix and otPlatInfraIfDiscoverNat64PrefixDone methods added to the Infrastructure Interface.
• otIp6GetPrefix method added to the IPv6 API.
• otIp4ExtractFromIp6Address and otIp4IsAddressEqual functions added to the NAT64 API.
• Updated otRouterInfo struct.
• Added bbr and other commands to the CLI Command Reference.

August 3, 2022

• Added channel commands to the CLI Command Reference.

July 27, 2022

• otBorderRoutingGetFavoredOmrPrefix function added to the Border Routing Manager API.
• br favoredomrprefix added to the CLI Command Reference.

July 20, 2022

• Added new CLI Command Reference.
• Added NAT64 API.

July 14, 2022

• Updates to Border Router API.
• Added Border Routing Manager API, which includes new typedefs and functions.
• Added Infrastructure Interface API.

July 7, 2022

• otBorderRoutingGetRouteInfoOptionPreference and otBorderRoutingSetRouteInfoOptionPreference functions added to the Border Router API.

June 28, 2022

• OT_IP6_MAX_MLR_ADDRESSES macro added to the IPv6 API.
• OT_ERROR_ALREADY removed from the otNetDataPublishExternalRoute and otNetDataPublishOnMeshPrefix functions in the Thread - General API.

June 14, 2022

• otTimestamp typedef added to the Operational Dataset API.
• OT_SETTINGS_KEY_LEGACY_NAT64_PREFIX, OT_SETTINGS_KEY_LEGACY_OMR_PREFIX OT_SETTINGS_KEY_ON_LINK_PREFIX, and OT_SETTINGS_KEY_RESERVED enums removed from the Platform - Settings API.
• otSrpServerTtlConfig typedef and otSrpClientEnableAutoHostAddress, otSrpServerGetTtlConfig, otSrpServerServiceGetTtl, and otSrpServerSetTtlConfig functions added to the SRP API.
• otDetachGracefullyCallback typedef and otThreadDetachGracefully function added to the Thread - General API.

May 31, 2022

• otDnssdCounters typedef and otDnssdGetCounters function added to the DNS-SD Server API.
• Removed otPlatRadioGetCslClockUncertainty function and added otPlatRadioGetCslUncertainty function to the Radio Operation API.
• otSrpServerLeaseInfo and otSrpServerResponseCounters typedefs, otSrpClientGetTtl, otSrpClientSetTtl, otSrpServerGetPort, otSrpServerGetResponseCounters, otSrpServerHostGetLeaseInfo, and otSrpServerServiceGetLeaseInfo functions added to the SRP API.

May 18, 2022

• otCommissionerGetId and otCommissionerSetId functions added to the Commissioner API.
• TCP Abstractions API added.
• otTcpForwardProgress typedef added, otTcpBytesAcked and otTcpSendReady typedefs removed from the TCP API.
• otNetDataContainsOmrPrefix function added to the Thread - General API.

April 20, 2022

• otMessageQueueInfo typedef added to the Message API.
• otBufferInfo struct updated in the Message API.

April 13, 2022

• otPlatLogHandleLevelChanged function added to the Logging - Platform API.
• otActiveScanResult struct updated in the Link API.
• otSecurityPolicy struct updated in the Operational Dataset API.

March 30, 2022

• otBackboneRouterConfigSkipSeqNumIncrease method removed from the Backbone Router API.
• otPlatSettingsSetCriticalKeys function removed and otPlatSettingsInit updated in the Platform Settings API.

March 15, 2022

• otDnsClientResolveIp4Address function added to the DNSv6 API.
• OT_SETTINGS_KEY_BR_ULA_PREFIX enum added along with other enum updates to the Platform Settings API.

February 23, 2022

• otCliPlatLogLine function removed from the Command Line Interface API.
• otPlatLogLine function removed from the Logging - Platform API.
• otDumpCritPlat, otDumpDebgPlat, otDumpInfoPlat, otDumpNotePlat, otDumpWarnPlat, otLogCli, otLogCritPlat, otLogDebgPlat, otLogInfoPlat, otLogNotePlat, otLogWarnPlat functions added to the Logging - Thread Stack API.

February 2, 2022

• otCoapMessageSetCode function added to the CoAP API.
• otPlatCryptoRandomDeinit, otPlatCryptoRandomGet, and otPlatCryptoRandomInit functions added to the Crypto - Platform API.
• otRandomCryptoMbedTlsContextGet removed from the RNG Cryptographic API.
• The Entropy Source API has been removed.
• otHistoryTrackerNetDataEvent enum, otHistoryTrackerExternalRouteInfo and otHistoryTrackerOnMeshPrefixInfo typedefs, otHistoryTrackerIterateExternalRouteHistory and otHistoryTrackerIterateOnMeshPrefixHistory functions added to the History Tracker API.
• Added new Transition Control Blocks (TCB) macros to the TCP API.
• Added Thread Radio Encapsulation Link (TREL) API for Thread Over Infrastructure.
• Function, typedef, and struct updates to the TREL - Platform API.

January 19, 2022

• otBackboneRouterNdProxyInfo typedef and otBackboneRouterConfigSkipSeqNumIncrease method added to the Backbone Router API.
• otBorderRoutingGetNat64Prefix function added to the Border Router API.
• Updated otIp6SubscribeMulticastAddress return values on the IPv6 API.
• otJoinerStateToString function added to the Joiner API.
• Updated the otPlatLogLine function on the Logging - Platform API.
• OT_SETTINGS_KEY_NAT64_PREFIX key added to the settings enum on the Settings API.

December 7, 2021

• otLinkIsRadioFilterEnabled and otLinkSetRadioFilterEnabled functions added to the Link API.
• otThreadSetThreadVersionCheckEnabled added to the Router/Leader API.

September 27, 2021

• otCryptoContext struct added to the Crypto API.

September 20, 2021

• otHistoryTrackerMulticastAddressInfo and otHistoryTrackerUnicastAddressInfo structs added to the History Tracker API.

September 13, 2021

• Crypto API added.
• otMacKeyMaterial struct added to the Radio API.

August 30, 2021

• otHistoryTrackerNeighborInfo struct added to the History Tracker API.

August 24, 2021

• History Tracker API added.

June 22, 2021

• TCP API added.
• otMasterKey struct renamed to otNetworkKey in the Operational Dataset API.

May 10, 2021

• otSrpServerLeaseConfig struct added to the SRP API.

April 12, 2021

• DNS-SD Server API added.

April 5, 2021

• otPingSenderStatistics struct added to the Ping Sender API.
• otSrpClientBuffersServiceEntry struct added to the SRP API.

March 25, 2021

• Ping Sender API added.
• The UART Platform API has been removed.

March 9, 2021

• otDnsTxtEntry and otDnsTxtEntryIterator structs added to the DNS API.
• otMessage struct removed from the Message API.
• otMessageBuffer struct added to the Message Pool API.

February 22, 2021

• otDnsQueryConfig struct added to the DNS API.

February 16, 2021

• otDnsQuery struct removed from and otDnsServiceInfo struct added to the DNS API.

February 9, 2021

• otSrpClientGetServerAddress, otSrpClientIsRunning, and otSrpClientSetCallback functions added to the SRP API.
• Heap API is deprecated.

February 2, 2021

• otCoapBlockwiseResource struct added to the CoAP API.
• otSrpTxtEntry struct removed from the SRP API.

January 26, 2021

• SRP API added.

January 20, 2021

• Dataset Updater API added to Operational Dataset.
• Multi Radio Link API added.
• Thread Radio Encapsulation Link (TREL) API added.
• otCryptoSha256Hash struct added to the Crypto API.

November 9, 2020

• otLinkMetricsSeriesFlags struct added to the Link Metrics API.
• otBackboneRouterNdProxyInfo struct added to the Backbone Router API.

October 20, 2020

• otIp6AddressInfo struct added to the IPv6 API.

October 2, 2020

• Link Metrics API added.

August 31, 2020

• Added APIs for Coordinated Sampled Listening (CSL) support in Thread 1.2.
• otBackboneRouterMulticastListenerInfo struct added to the Backbone Router API.

August 12, 2020

• otThreadDiscoveryRequestInfo struct added to the General API.

July 15, 2020

• otBackboneRouterConfig function added to the Backbone Router API.

• otCoapAddResource function removed from the CoAP API.

• otJoinerPskd, otJoinerInfoType, otCommissionerAddJoinerWithDiscerner, and otCommissionerRemoveJoinerWithDiscerner functions added to the Commissioner API.

• otJoinerGetDiscerner, otJoinerSetDiscerner, and otJoinerDiscerner functions added to the Joiner API.

• otLinkFilterClearDefaultRssIn, and otLinkFilterSetDefaultRssIn functions added to the Link API.

• otLinkRawGetRadioTime, otLinkRawSetMacFrameCounter, and otLinkRawSetMacKey functions added to the Raw Link API.

• otDatasetGetActiveTlvs, otDatasetGetPendingTlvs, otDatasetSetActiveTlvs, otDatasetSetPendingTlvs, otThreadGetFixedDuaInterfaceIdentifier, and otThreadSetFixedDuaInterfaceIdentifier functions added to the General API.

• otUdpGetSockets function removed from the UDP Forward API.

• otUdpGetSockets function added to the UDP API.

• otPlatRadioGetNow, otPlatRadioSetMacFrameCounter, and otPlatRadioSetMacKey, functions added to the Platform Radio Configuration API.

April 27, 2020

• Backbone Router API added.
• Network Simulator Platform API added.
• otNetworkDiag* structs added to the General API for improved Network Diagnostic usability.
• otThreadGetDomainName and otThreadSetDomainName functions added to the General API.
• otCommissionerGeneratePskc function removed from the Commissioner API. Use the otDatasetGeneratePskc function in the General API to generate a PSKc going forward.
• Router API updated for access to the address cache table.

March 24, 2020

• Added OT_COAP_MAX_RETRANSMIT and OT_COAP_MIN_ACK_TIMEOUT macros to the CoAP API.

March 2, 2020

• Updated the CoAP API:
  • otCoapOptionIterator and otCoapTxParameters structs added.
  • Added helper functions to encode CoAP block options.
  • Added functions to specify per-message transmission parameters for CoAP requests and responses.

January 9, 2020

• Histogram retry functions added to the Link API.

December 3, 2019

• Server and Service configuration functions and structs moved from the Server API to the General API to support service registration by Leaders.
• *RouterRoleEnabled functions renamed to *RouterEligible in the Router API to support REED enhancements.
• otPlatLogv function removed from the Logging Platform API.
• OT_TOOL_ALIGN macro removed from the Toolchain Platform API and from various struct definitions.

November 11, 2019

• otThreadResetIp6Counters function added to the General API.
• New functions for resetting counters and getting and setting maximum frame retries added to the Link API.

October 25, 2019

• otThreadGetVersion function added to the General API.
• otPlatRadioGetCcaEnergyDetectThreshold and otPlatRadioSetCcaEnergyDetectThreshold functions added to the Radio Configuration Platform API.

September 19, 2019

• Split the Random API page into Crypto and Non-Crypto to align with source code.
• otJoinerInfo struct and otCommissionerGetNextJoinerInfo function added to the Commissioner API.
• otRadioCoexMetrics struct and otPlatRadioIsCoexEnabled function added to the Radio Types API.
• Changed the return type of numerous APIs that always succeed from otError to void.

August 9, 2019

• otPlatSettingsDeinit function added to the Settings Platform API.
• otPlatUartFlush function added to the UART Platform API.
• mTimestamp moved from the otRadioIeInfo struct to the otRadioFrame struct.
• otNetifInterfaceId enumeration removed from the IPv6 API.

June 17, 2019

• Added callbacks for notifying of state changes and joiner activity to the Commissioner API.
• Compiler-specific function modifiers of OTAPI, OTCALL, OT_CALL, and OT_CDECL removed in conjunction with removal of Windows support.

May 28, 2019

• otNeighborTableEntryInfo struct added to the Router/Leader API.
• otDatasetCreateNewNetwork and otThreadGetRloc functions added to the General API.
• otUdpSendDatagram function added to the UDP API.
• Random API moved from a platform abstraction to a module, with improved cryptographic random number generation.
• Entropy and Entropy Platform APIs added.

May 14, 2019

• otPlatRadioGetPreferredChannelMask and otPlatRadioGetSupportedChannelMask functions added to the Radio Operation Platform API.
• Removed physical layer channel functions from the Link API.

March 14, 2019

• Added support for OQPSK modulation in the 915MHz band to the Radio Types Platform API and the Link API.
• Various CoAP Secure API refinements.
• New SLAAC module functions added to the IPv6 API.
• otSemanticallyOpaqueIidGeneratorData struct and related functions removed from the IPv6 API.

February 25, 2019

• otIp6SlaacIidCreate and otIp6SlaacUpdate functions removed from the IPv6 API.

January 30, 2019

• Various CLI API refinements.
• mDidTx removed from the otRadioFrame struct.

January 23, 2019

• UDP Receiver functions added to the UDP API.
• otCoapHeader struct removed from the CoAP API. CoAP header information has been refined into the CoAP message.
• The DHCPv6 Server API has been removed.

January 7, 2019

• otIp6NewMessageFromBuffer function added to the IPv6 API.
• otDhcpAddress struct removed from the DHCPv6 API.