OpenThread C++ API Reference

For help with the OpenThread Application API, see Resources.

Modules
Alarm This module includes the platform abstraction for the alarm service.
Border Router This module includes functions to manage local network data with the OpenThread Border Router.
Child Supervision This module includes functions for child supervision feature.
CoAP This module includes functions that control CoAP communication.
Command Line Interface This module includes functions that control the Thread stack's execution.
Commissioner This module includes functions for the Thread Commissioner role.
Crypto This module includes cryptographic functions.
DHCPv6 This module includes functions for DHCPv6 Client and Server.
DNSv6 This module includes functions that control DNS communication.
Factory Diagnostics - Platform This module includes the platform abstraction for diagnostics features.
Factory Diagnostics - Thread Stack This module includes functions that control the Thread stack's execution.
General This module includes functions for all Thread roles.
ICMPv6 This module includes functions that control ICMPv6 communication.
IPv6 This module includes functions that control IPv6 communication.
Instance This module includes functions that control the OpenThread Instance.
Jam Detection This module includes functions for signal jamming detection feature.
Joiner This module includes functions for the Thread Joiner role.
Link This module includes functions that control link-layer configuration.
Logging This module includes the platform abstraction for the debug log service.
Memory This module includes the platform abstraction for dynamic memory allocation.
Message This module includes functions that manipulate OpenThread message buffers.
Message Pool This module includes the platform abstraction for the message pool.
Miscellaneous This module includes platform abstractions for miscellaneous behaviors.
Network Co-Processor This module includes functions that control the Thread stack's execution.
Radio Configuration This module includes the platform abstraction for radio configuration.
Radio Operation This module includes the platform abstraction for radio operations.
Radio Types This module includes the platform abstraction for a radio frame.
Random This module includes the platform abstraction for random number generation.
Raw Link This module includes functions that control the raw link-layer configuration.
Router/Leader This module includes functions for Thread Routers and Leaders.
SPI Slave This module includes the platform abstraction for SPI slave communication.
Server This module includes functions to manage local network data with the OpenThread Server.
Settings This module includes the platform abstraction for non-volatile storage of settings.
TMF Proxy This module includes functions for TMF proxy feature.
Tasklets This module includes functions that control the Thread stack's execution.
Toolchain This module defines a toolchain abstraction layer through macros.
Types This module includes API types.
UART This module includes the platform abstraction for UART communication.
UDP This module includes functions that control UDP communication.

Send feedback about...

Need help? Visit our support page.