Keil Studio Cloud

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

Mbed OS 5

Quick start

APIs

Full API list

Platform

Wait

Avoiding OS delay Wait function reference Example Related content

Callback

Calling callbacks Callback class reference Serial passthrough example with callbacks Thread example with callbacks Sonar example

DeepSleepLock

DeepSleepLock class reference Example Related content

Power management (sleep)

Sleep System reset Function reference Example Related content

Idle loop

Function reference Example Related content

CriticalSectionLock

CriticalSectionLock class reference CriticalSectionLock example

Time

Time function reference Time example 2038

RTC

RTC function reference RTC Time example

Debug

Debug functions reference Debug example

Memory tracing

Memory tracing functions reference Memory tracing example Related content

Error handling

Error status usage Error status types Error code and error status ranges Posix error codes support Error context capture Error reporting Constructing error status values in your implementation Error history Extending error codes Error hook for applications Crash reporting and auto-reboot Error handling functions reference Error handling API examples Error handling example Crash reporting example List of Mbed OS defined error codes and descriptions Related content

Assert

Assert macros reference Assert example Related content

NonCopyable

NonCopyable class reference NonCopyable example Related content

Shared Pointer

SharedPtr class reference Shared pointer example

Span

Construction Operations Size encoding Span class reference Span example

FileHandle

FileHandle class reference FileHandle using C library example FileHandle sigio example Related content

Poll

Poll reference Poll example Related content

PlatformMutex

PlatformMutex class reference PlatformMutex example Related content

CircularBuffer

Memory considerations Declaration example CircularBuffer class reference CircularBuffer example

ATCmdParser

ATCmdParser class reference ATCmdParser examples

Mbed statistics

Memory statistics Thread statistics System information CPU statistics Mbed statistics function reference Memory statistics example Thread statistics example System information example CPU statistics example Related content

MPU management

Function reference Example Related content

ScopedRamExecutionLock

ScopedRamExecutionLock class reference Example Related content

ScopedRomWriteLock

ScopedRomWriteLock class reference Example Related content

Drivers

AnalogIn

AnalogIn class reference AnalogIn hello, world AnalogIn examples

AnalogOut

AnalogOut class reference AnalogOut hello, world AnalogOut example

DigitalIn

DigitalIn class reference DigitalIn hello, world DigitalIn example Related content

DigitalOut

DigitalOut class reference DigitalOut hello, world

DigitalInOut

DigitalInOut class reference DigitalInOut hello, world

BusIn

BusIn class reference BusIn hello, world

BusOut

BusOut class reference BusOut hello, world Related content

BusInOut

BusInOut class reference BusInOut hello, world Related content

PortIn

PortIn class reference PortIn hello, world Related content

PortOut

PortOut class reference PortOut hello, world Related content

PortInOut

PortInOut class reference PortInOut hello, world Related content

PwmOut

PwmOut class reference PwmOut hello, world PwmOut code examples

InterruptIn

InterruptIn class reference Related InterruptIn hello, world InterruptIn example Related content

Ticker

Warnings and notes Ticker class reference Ticker hello, world Ticker examples Related content

Timeout

Warnings and notes Timeout class reference Timeout hello, world Timeout example Related content

Timer

Warnings and notes Timer class reference Timer hello, world Related content

LowPowerTicker

Warnings and notes LowPowerTicker class reference LowPowerTicker example Related content

LowPowerTimeout

Notes LowPowerTimeout class reference LowPowerTimeout example Related content

LowPowerTimer

LowPowerTimer class reference LowPowerTimer example Related content

Watchdog ResetReason

ResetReason class reference ResetReason example

Flash IAP

Flash IAP class reference Flash IAP example

RawSerial

RawSerial class reference RawSerial hello, world RawSerial examples

Serial

Serial class reference Serial hello, world Serial examples Related content

SPI

Interface SPI class reference SPI hello, world

SPISlave

SPISlave class reference SPISlave example

QuadSPI (QSPI)

QSPI class hierarchy QuadSPI class reference QuadSPI example Related content

I2C

I2C class reference I2C hello, world

I2CSlave

I2CSlave class reference I2CSlave example

CAN

CAN class reference CAN hello, world

MbedCRC

MbedCRC class reference MbedCRC examples Related content

RTOS

Thread

Memory considerations Thread class reference Thread example Thread example with callbacks Debugging tips Related content

ThisThread

ThisThread class reference ThisThread example Related content

Mutex

Mutex class reference Mutex example Related content

Semaphore

Semaphore class reference Semaphore example

Queue

Queue class reference Queue example Queue and MemoryPool example Related content

EventQueue

Shared event queues EventQueue class reference Shared event queue reference EventQueue example: deferring from interrupt context Shared event example: deferring from interrupt context EventQueue example: posting events to the queue EventQueue example: chaining events from more than one queue Shared event example: running the shared queue from main Static EventQueue example: posting user allocated events to the static queue Related content

UserAllocatedEvent

UserAllocatedEvent class reference Static EventQueue example: posting user allocated events to the queue Related content

MemoryPool

MemoryPool class reference MemoryPool example Queue and MemoryPool example Related content

Mail

Mail class reference Mail example

EventFlags

EventFlags class reference EventFlags example

Event

Event class reference EventQueue example: posting events to the queue Related content

ConditionVariable

ConditionVariable class reference ConditionVariable example

Kernel interface functions

Kernel namespace reference get_ms_count() example Kernel hooks example

USB

USBSerial

USBSerial class reference USBSerial example Related content

USBAudio

USBAudio class reference USBAudio square wave example USBAudio loopback example USBAudio play sound data example

USBHID

USBHID class reference USBHID example Related content

USBCDC

USBCDC class reference USBCDC example Related content

USBCDC_ECM

USBCDC_ECM class reference USBCDC_ECM example

USBMSD

USBMSD class reference USBMSD example Related content

USBMIDI

USBMIDI class reference USBMIDI example Play "Take Me Out to the Ball Game" example

USBMouse

USBMouse class reference USBMouse example USBMouse Joystick example Related content

USBKeyboard

USBKeyboard class reference USBKeyboard example Related content

USBMouseKeyboard

USBMouseKeyboard class reference USBMouseKeyboard example Related content

Network Socket

Socket

Socket class reference Socket example Related content

UDPSocket

UDPSocket class reference UDPSocket example Related content

TCPSocket

Server socket TCPSocket class reference TCPSocket example Related content

SocketAddress

SocketAddress class reference SocketAddress example Related content

Non-IP cellular socket

CellularNonIPSocket class reference CellularNonIPSocket example

DNS Resolver

DNS resolver class reference DNS resolver example Troubleshooting information Related content

TLSSocket

TLSSocket class reference TLSSocket example Related content

DTLSSocket

DTLSSocket class reference DTLSSocket example Related content

SocketStats

SocketStats class reference SocketStats example Related content

Network interfaces

Ethernet

Usage Configuration Troubleshooting information EthInterface class reference EthInterface example Related content

Wi-Fi

Wi-Fi class reference Usage Troubleshooting information Security Wi-Fi example Related content

Cellular API

Getting started Basic working principles CellularInterface class reference Usage Cellular example: connection establishment Related content

Mesh

Mesh class reference Mesh example Related content

Network status

Usage Using multiple connection status callbacks Example Related content

Bluetooth

BLE

BLE_API, bridges and stacks Inside BLE_API The BLEDevice class and header Usage BLE class reference Example: BLE beacon Example: BLE heart rate monitor Related content

GAP

Advertising Scanning Extended and periodic advertising Privacy Modulation schemes Data length (over-the-air MTU) GAP class reference GAP example

GattClient

Discovery procedures Attribute manipulation Attribute Protocol Maximum Transmission Unit (ATT_MTU) Server initiated events GattClient class reference GattClient example

GattServer

Server layout Characteristic and attributes access Attribute Protocol Maximum Transmission Unit (ATT_MTU) Events GattServer class reference GattServer example

SecurityManager

Pairing Out of band (OOB) data used in pairing Signing Persistence of security information How to use SecurityManager class reference SecurityManager example

BatteryService

BatteryService class reference BatteryService example Related content

HeartRateService

HeartRateService class reference HeartRateService example Related content

iBeacon

iBeacon class reference iBeacon example

LoRaWAN

LoRaWAN network interface

LoRaWANInterface class reference LoRaWAN example Related content

LoRa radio driver

LoRaRadio class reference LoRaRadio example Related content

NFC

NFCController

NFCController class reference NFCController example

NFC EEPROM

NFCEEPROM class reference NFCEEPROM example

MessageParser

MessageParser class reference MessageParser example Related content

SimpleMessageParser

SimpleMessageParser class reference SimpleMessageParser example Related content

MessageBuilder

MessageBuilder class reference MessageBuilder example Related content

Security

PSA initial attestation

Specification Claims in the initial attestation token PSA initial attestation reference PSA initial attestation example Related content

Mbed Crypto

Configuring Mbed Crypto features Mbed Crypto examples Other resources

PSA lifecycle

PSA lifecycle reference Related content

TLS

Mbed TLS examples Configuring Mbed TLS features Mbed TLS platform context Other resources

DeviceKey

Root of Trust Key derivation API DeviceKey API class reference DeviceKey example

Storage

KVStore

KVStore class reference KVStore example Related content

Static Global API

Allocation of KVStore components Parameter details Static Global API class reference Static Global API example Related content

FileSystem

File system class reference File system example Sector requirements Related content

Dir

Dir class API File system example Related content

File

File class reference File system example Related content

LittleFileSystem

LittleFileSystem class reference LittleFileSystem example Related content

FATFileSystem

Use cases Usage FATFileSystem class reference FATFileSystem example Related content

BlockDevice

Block device operations Block device blocks Erased blocks BlockDevice get default instance BlockDevice class reference BlockDevice example Related content

HeapBlockDevice

HeapBlockDevice class reference HeapBlockDevice example Related content

MBRBlockDevice

MBRBlockDevice class reference MBRBlockDevice example Related content

ChainingBlockDevice

ChainingBlockDevice class reference ChainingBlockDevice example Related content

SlicingBlockDevice

SlicingBlockDevice class reference SlicingBlockDevice example Related content

ProfilingBlockDevice

ProfilingBlockDevice class reference ProfilingBlockDevice example Related content

BufferedBlockDevice

BufferedBlockDevice class reference BufferedBlockDevice example Related content

FlashSimBlockDevice

FlashSimBlockDevice class reference FlashSimBlockDevice example Related content

DataFlashBlockDevice

DataFlashBlockDevice class reference DataFlashBlockDevice example Related content

FlashIAPBlockDevice

FlashIAPBlockDevice class reference FlashIAPBlockDevice example Related content

SDBlockDevice

How to wire an external SD-card module to a developer board Mbed OS file system software component stack Mbed OS erase for SDBlockDevice SDBlockDevice class reference SDBlockDevice example application Related content

SPI Flash block device

SPIFBlockDevice class reference SPIFBlockDevice example Related content

QSPIFBlockDevice

QSPIFBlockDevice class reference QSPIFBlockDevice example

NVStore

Flash structure NVStore example Related content

PSA internal storage

PSA internal storage class reference Related content

PSA protected storage

PSA protected storage class reference Related content

Reference

Tools

Tutorials

Contributing

Porting

Mbed OS and the Pelion IoT Platform

Docs › APIs › NFC

NFC

Near-Field Communication (NFC) is a short-range radio technology. Mbed OS supports NFC card emulation through a controller or NFC EEPROM:

NFCController API reference.
NFCEEPROM API reference.

NDEF API

The common data format for an NFC message is an NDEF message. An NDEF message is a collection of separate NDEF records. Each of these records is defined by a type, such as URI, Mime and Text, that identifies a payload and what the record contains.

Mbed OS provides this API to construct and parse NDEF messages:

NFC

NDEF API

Related content

Important Information for this Arm website