Full API list

This is the full list of APIs Mbed OS offers application writers (it does not include the internal APIs, which are not intended for use by application code). The list indicates which of the APIs the bare metal profile supports, and which of those are manually enabled (as opposed to enabled by default). For consistency, we also show the full profile's API support, although that is - and is expected to remain - all APIs.

For a list of APIs that were removed in Mbed OS 6, see the deprecated APIs list at the bottom of this page.

Scheduling

The Mbed OS scheduling capabilities include managing objects such as threads, synchronization objects and timers. It also provides interfaces for attaching an application-specific idle hook function, reads the OS tick count and implements functionality to report RTOS errors.

RTOS

Event handling

Drivers

Driver APIs include analog and digital inputs and outputs on development boards, as well as digital interfaces to a computer or external devices.

Serial (UART) drivers

SPI drivers

Input/Output drivers

USB drivers

Other drivers

Platform

Platform APIs provide general purpose MCU management infrastructure, common data structures and a consistent user experience on top of different standard libraries and toolchains.

Time

Power

Memory

Other Platform APIs

Data storage

The storage APIs include file system APIs, for file system operations, and block devices, which provide the raw storage for the file systems.

File system APIs

BlockDevice (block-based storage) APIs

PSA compliant

Connectivity

Connectivity APIs include:

• Network socket: The application programming interface for IP networking, supporting both TCP and UDP protocols.
• Network interface: The application level APIs where you choose the driver, connectivity method and IP stack. These include Ethernet, Wi-Fi, cellular and Mesh interfaces.
• Secure socket: DTLS and TLS streams over the existing Socket transport.
• DNS: Perform DNS host name resolutions to convert resource names to IP addresses.
• Bluetooth low energy (BLE): A low power wireless technology standard for building personal area networks.
• NFC: Near-Field Communication (NFC), a short-range radio technology for use cases such as contactless payments, access control and device pairing.
• LoRaWAN: A technology designed for low-power battery-powered devices that operate in an unlicensed spectrum, creating high density wide-area networks.

Network socket

Network interface

Secure socket

DNS

Bluetooth (BLE)

NFC

LoRaWAN

Security

With Arm Mbed TLS, a comprehensive SSL/TLS solution, you can include cryptographic and SSL/TLS capabilities in your code.

Deprecated APIs: moving from Mbed OS 5 to 6

If you're moving your program from Mbed OS 5 to 6, you will need to replace deprecated APIs. The table lists classes that have been completely removed. Functions and methods that have been removed from other classes are listed in each class's Doxgen, and summarised here.