OpenThread Modules#

Modules

Alarm

This module includes the platform abstraction for the alarm service.

Backbone Router

This module includes functions for the OpenThread Backbone Router Service.

Border Agent

This module includes functions for the Thread Border Agent role.

Border Router

This module includes functions to manage local network data with the OpenThread Border Router.

Border Routing Manager

This module includes definitions related to Border Routing Manager.

Channel Manager

This module includes functions for Channel Manager.

Channel Monitoring

This module includes functions for channel monitoring feature.

Child Supervision

This module includes functions for child supervision feature.

CoAP

This module includes functions that control CoAP communication.

CoAP Secure

This module includes functions that control CoAP Secure (CoAP over DTLS) 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 - Platform

This module includes the platform abstraction for Crypto.

Crypto - Thread Stack

This module includes cryptographic functions.

DNS

This module includes functions that control DNS communication.

DNS - Platform

This module includes the platform abstraction for sending recursive DNS query to upstream DNS servers.

DNS-SD Server

This module includes APIs for DNS-SD server.

Entropy

This module includes the platform abstraction for entropy generation.

Error

This module includes error definitions used in OpenThread.

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.

Heap

This module includes functions that set the external OpenThread heap.

History Tracker

Records the history of different events, for example RX and TX messages or network info changes.

ICMPv6

This module includes functions that control ICMPv6 communication.

IPv6

This module includes functions that control IPv6 communication.

Infrastructure Interface

This module includes the platform abstraction for the adjacent infrastructure network interface.

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.

Link Metrics

This module includes functions that control the Link Metrics protocol.

Logging - Platform

This module includes the platform abstraction for the debug log service.

Logging - Thread Stack

This module includes OpenThread logging related definitions.

Memory

This module includes the platform abstraction for dynamic memory allocation.

Mesh Diagnostics

This module includes definitions and functions for Mesh Diagnostics.

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.

Multi Radio Link

This module includes definitions and functions for multi radio link.

NAT64

This module includes functions and structs for the NAT64 function on the border router.

Network Co-Processor

This module includes functions that control the Thread stack's execution.

Network Simulator

This module includes the platform abstraction for OTNS.

Network Time Synchronization

This module includes functions that control network time synchronization service.

Operational Dataset

Includes functions for the Operational Dataset API.

Ping Sender

This file includes the OpenThread API for the ping sender module.

RNG Cryptographic

This module includes functions that generates cryptographic random numbers.

RNG Non-cryptographic

This module includes functions that generates non cryptographic random numbers.

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.

Raw Link

This module includes functions that control the raw link-layer configuration.

Router/Leader

This module includes functions for Thread Routers and Leaders.

SNTP

This module includes functions that control SNTP communication.

SPI Slave

This module includes the platform abstraction for SPI slave communication.

SRP

This module includes functions that control SRP client behavior.

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.

TCP

This module includes functions that control TCP communication.

TCP Abstractions

This module includes easy-to-use abstractions on top of the base TCP API.

TREL - Platform

This module includes the platform abstraction for Thread Radio Encapsulation Link (TREL) using DNS-SD and UDP/IPv6.

TREL - Thread Stack

This module defines Thread Radio Encapsulation Link (TREL) APIs for Thread Over Infrastructure.

Tasklets

This module includes functions that control the Thread stack's execution.

Time Service

This module includes the platform abstraction for the time service.

Toolchain

This module defines a toolchain abstraction layer through macros.

UDP

This module includes functions that control UDP communication.

UDP Forward

This module includes functions for UDP forward feature.