Mistake on this page?
Report an issue in GitHub or email us

Full API list

Platform APIs

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

Wait RTC Shared pointer MPU management
Callback Debug Span ScopedRamExecutionLock
DeepSleepLock Memory tracing PlatformMutex ScopedRomWriteLock
Power management Error handling CircularBuffer
Idle loop Assert ATCmdParser
CriticalSectionLock NonCopyable Mbed statistics

Drivers APIs

Driver APIs include analog and digital inputs and outputs on development boards, as well as digital interfaces, which allow your board to interface with a computer or external devices.

AnalogIn PortIn LowPowerTicker QuadSPI (QSPI)
AnalogOut PortOut LowPowerTimeout I2C
DigitalIn PortInOut LowPowerTimer I2CSlave
DigitalOut PwmOut Flash IAP CAN
DigitalInOut InterruptIn RawSerial MbedCRC
BusIn Ticker Serial
BusOut Timeout SPI
BusInOut Timer SPISlave

RTOS APIs

The Mbed OS RTOS 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.

Thread Queue Mail Event
Mutex EventQueue RtosTimer ConditionVariable
Semaphore MemoryPool EventFlags Kernel interface functions

Network socket APIs

Network socket APIs include the application programming interface for IP networking. In Mbed OS, this API supports both TCP and UDP protocols.

Socket SocketAddress DTLSSocket
UDPSocket DNS Resolver SocketStats
TCPSocket TLS Socket

Network interfaces APIs

Network interfaces are the application level APIs where users choose the driver, connectivity method and IP stack. These include ethernet, Wi-Fi, cellular and mesh interfaces.

Ethernet 6LoWPAN Mesh
Wi-Fi Network status
Cellular

Bluetooth Low Energy (BLE) APIs

Bluetooth low energy (BLE) is a low power wireless technology standard for building personal area networks. Typical applications of BLE are health care, fitness trackers, beacons, smart home, security, entertainment, proximity sensors, industrial and automotive.

BLE GattServer HeartRateService
GAP SecurityManager iBeacon
GattClient BatteryService

LoRaWAN APIs

Arm Mbed OS provides a native network stack for LoRaWAN. LoRaWAN is a technology designed for low-power battery-powered devices. These devices operate in an unlicensed spectrum, creating high density wide-area networks.

LoRaWANInterface
LoRaRadio

NFC APIs

You can use Near-Field Communication (NFC), a short-range radio technology, to enable use cases such as contactless payments, access control and device pairing.

NFCController SimpleMessageParser
NFC EEPROM MessageBuilder
MessageParser

Security API

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

Mbed implementation of PSA DeviceKey
TLS PSA internal trusted storage

Storage APIs

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

KVStore LittleFileSystem ChainingBlockDevice DataFlashBlockDevice NVStore
Static Global API FATFileSystem SlicingBlockDevice FlashIAPBlockDevice
FileSystem BlockDevice ProfilingBlockDevice SDBlockDevice
Dir HeapBlockDevice BufferedBlockDevice SPIFlashBlockDevice
File MBRBlockDevice FlashSimBlockDevice QSPIFBlockDevice
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.