Kernel
Getting Started
About FreeRTOS Kernel
Developer Docs
Secondary Docs
Supported Devices
API Reference
Licensing
Emulation/Simulation
Windows Simulator
Posix/Linux Simulator
Libraries
new
LTS Libraries
Libraries Categories
FreeRTOS Plus
Overview
FreeRTOS+TCP
FreeRTOS+CLI
FreeRTOS+IO
FreeRTOS Core
Overview
coreMQTT
coreMQTT Agent
coreHTTP
coreSNTP
Transport Interface
coreJSON
corePKCS11
Cellular Interface
FreeRTOS for AWS
Overview
Reference Integrations
AWS IoT OTA
AWS IoT Device Shadow
AWS IoT Jobs
AWS IoT Device Defender
FreeRTOS Labs
Overview
LoRaWAN
FreeRTOS+POSIX
FreeRTOS+FAT
FreeRTOS+TCP IPv6
FreeRTOS+TCP Multiple Interfaces
Licensing
Support
Contact
Support Options
Mailing List
Licensing
FAQ
Books and Manuals
Partners
Overview
Semiconductor
Productivity Tools
Training and Consulting
Software
Community
Overview
Forums
Blog
Media
FreeRTOS on Twitter
Download FreeRTOS
Quality RTOS & Embedded Software
Download FreeRTOS
Menu
Kernel
Getting Started
About FreeRTOS Kernel
Developer Docs
Secondary Docs
Supported Devices
API Reference
Licensing
Emulation/Simulation
Windows Simulator
Posix/Linux Simulator
Libraries
new
LTS Libraries
Libraries Categories
FreeRTOS Plus
Overview
FreeRTOS+TCP
FreeRTOS+CLI
FreeRTOS+IO
FreeRTOS Core
Overview
coreMQTT
coreMQTT Agent
coreHTTP
coreSNTP
Transport Interface
coreJSON
corePKCS11
Cellular Interface
FreeRTOS for AWS
Overview
Reference Integrations
AWS IoT OTA
AWS IoT Device Shadow
AWS IoT Jobs
AWS IoT Device Defender
FreeRTOS Labs
Overview
LoRaWAN
FreeRTOS+POSIX
FreeRTOS+FAT
FreeRTOS+TCP IPv6
FreeRTOS+TCP Multiple Interfaces
Licensing
Support
Contact
Support Options
Mailing List
Licensing
FAQ
Books and Manuals
Partners
Overview
Semiconductor
Productivity Tools
Training and Consulting
Software
Community
Overview
Forums
Blog
Media
FreeRTOS on Twitter
LIBRARIES
Home
LTS Libraries
Library Categories
FreeRTOS Plus
Overview
FreeRTOS+TCP
Introduction
Networking Basics/Glossary
Introduction
Ethernet Addressing
MTU
Internet Protocol (IP)
IP Address
ARP
Subnet / Netmask
Router and Gateway
UDP
TCP
MSS
Port Number
Sockets
Binding
Clients and Servers
Static IP Address
DHCP
Name Resolution
DNS
LLMNR
NBNS (NetBIOS)
Endian
FreeRTOS+TCP Tutorial
Introduction
Source Code Organisation
Including in a Project
Initialisation and Startup
Creating TCP Sockets
Sending TCP Data
Receiving TCP Data
Closing a TCP Socket
Creating UDP Sockets
Sending UDP Data (standard)
Sending UDP Data (zero copy)
Receiving UDP Data (standard)
Receiving UDP Data (zero copy)
Buffer Mgmt. & Performance
Configuration File
Configuration Examples
Trace Macros
API Reference
Primary Socket API
FreeRTOS_socket
FreeRTOS_bind
FreeRTOS_connect
FreeRTOS_listen
FreeRTOS_accept
FreeRTOS_send
FreeRTOS_sendto
FreeRTOS_recv
FreeRTOS_recvfrom
FreeRTOS_setsockopt
FreeRTOS_shutdown
FreeRTOS_closesocket
FreeRTOS_select
Misc Socket API
FreeRTOS_CreateSocketSet
FreeRTOS_FD_SET
FreeRTOS_FD_CLR
FreeRTOS_FD_ISSET
FreeRTOS_gethostbyname
FreeRTOS_inet_ntoa
FreeRTOS_inet_addr_quick
FreeRTOS_inet_addr
FreeRTOS_htons
FreeRTOS_htonl
FreeRTOS_ntohs
FreeRTOS_ntohl
FreeRTOS_outstanding
FreeRTOS_recvcount
FreeRTOS_issocketconnected
FreeRTOS_getremoteaddress
FreeRTOS_maywrite
FreeRTOS+TCP API
FreeRTOS_IpInit
FreeRTOS_GetAddressConfiguration
FreeRTOS_GetUDPPayloadBuffer
FreeRTOS_ReleaseUDPPayloadBuffer
FreeRTOS_SendPingRequest
FreeRTOS_GetMACAddress
FreeRTOS_GetIPAddress
FreeRTOS_GetGatewayAddress
FreeRTOS_GetDNSServerAddress
FreeRTOS_GetNetmask
FreeRTOS_OutputARPRequest
FreeRTOS_IsNetworkUp
FreeRTOS_SignalSocket
Hook/Callback API
eApplicationProcessCustomFrameHook
pcApplicationHostnameHook
vApplicationIPNetworkEventHook
vApplicationPingReplyHook
xApplicationDHCPHook
xApplicationDNSQueryHook
Application provided functions
ulApplicationGetNextSequenceNumber
xApplicationGetRandomNumber
Porting
Changing Compiler
Changing Hardware
Porting API
pxGetNetworkBufferWithDescriptor
vReleaseNetworkBufferAndDescriptor
pucGetNetworkBuffer
vReleaseNetworkBuffer
eConsiderFrameForProcessing
xSendEventStructToIPTask
Pre-configured Examples
Build Instructions
TCP Examples
TCP Basic (Windows)
TCP Basic (Posix/Linux)
UDP IO for CLI
TCP IO for CLI
Network logging via UDP
UDP Client and Server
Using FreeRTOS_select()
UDP Echo Clients
TCP Echo Clients
TCP Echo Clients (split)
TCP Echo Server
TCP and FAT Examples
FTP Server
HTTP Web Server
MIT Licensing
FreeRTOS+IO
Introduction
Quick Examples
Demos
API Reference
FreeRTOS_open
FreeRTOS_read
FreeRTOS_write
FreeRTOS_ioctl
Transfer Modes
Polled Rx and Tx
Zero Copy Tx
Circular buffer Rx
FreeRTOS+CLI
Introduction
Demos
Configuration and Use
Implementing a Command
Command Parameters
Registering a Command
Calling the Interpreter
A FreeRTOS+CLI Task
Buffer Management
Logging
Backoff Algorithm
Introduction
API Reference
MIT Licensing
FreeRTOS Core
Overview
coreMQTT
Introduction
Terminology
Demo (Plaintext)
Demo (With TLS)
Demo (Mutual Auth)
Demo (Keep-Alive)
Demo (Agent Multithreading)
Logging
API Reference
coreMQTT Agent
Introduction
Demo
API Reference
coreHTTP
Introduction
Terminology
Demo (Plaintext)
Demo (Mutual Authentication)
Demo (Basic S3 Upload)
Demo (Basic S3 Download)
Demo (Multithreaded)
Logging
API Reference
coreSNTP
Introduction
Terminology
Demo
Setting up an NTP server
API Reference
Transport Interface
Introduction
TLS Introduction
TLS Terminology
X.509 Certificates
coreJSON
Introduction
Terminology
API Reference
corePKCS11
Introduction
Functions
Demo (MQTT)
Demo (Management and RNG)
Demo (Mechanisms and Digests)
Demo (Objects)
Demo (Sign and Verify)
Logging
API Reference
Cellular Interface
Introduction
Demo
Porting Guide
API Reference
FreeRTOS for AWS
Overview
Reference Integrations
AWS IoT OTA
Introduction
Terminology
Demo (MQTT)
Demo (HTTP)
Porting
API Reference
AWS IoT Device Shadow
Introduction
Design for Named Shadow Support
Terminology
Demo
API Reference
Logging
AWS IoT Jobs
Introduction
Terminology
Demo
API Reference
AWS IoT Device Defender
Introduction
Demo
Demo (MQTT Agent)
Logging
API Reference
MIT Licensing
FreeRTOS Labs
Overview
FreeRTOS LoRaWAN
Introduction
Demo
API Reference
FreeRTOS+POSIX
Introduction
API Reference
Demos
FreeRTOS+FAT
Introduction
Source Code Organization
Configuration File
API Reference
Standard Function
Standard API errno Values
Directory/Folder Functions
ff_mkdir
ff_chdir
ff_rmdir
ff_getcwd
Read & Write Functions
ff_fopen
ff_fclose
ff_fwrite
ff_fread
ff_fputc
ff_fgetc
ff_fgets
ff_fprintf
ff_fseek
ff_ftell
ff_seteof
ff_truncate
ff_rewind
Utility Functions
ff_errno
ff_feof
ff_rename
ff_remove
ff_stat
ff_filelength
ff_findfirst
ff_findnext
Disk Management Functions
FF_Partition
FF_Format
FF_Mount
FF_FS_Add
Porting
Creating a Media Driver
Step 1: Read Functions
Step 2: Write Function
Step 3: Init Function
Driver API and Structures
FF_CreateIOManager
FF_Disk_t
Demos
Build Instructions
FAT Examples
Basic File Use
stdio API tests
Creating a Disk
File System CLI
TCP and FAT Examples
FTP Server
HTTP Web Server
FreeRTOS+TCP IPv6
IPv6 Demo
IPv6 Functions
FreeRTOS+TCP Multiple Interfaces
MIT Licensing
WHAT'S NEW
FreeRTOS:
The latest release now includes the SNTP library, see
blog post
.
AWS Reference Integrations:
See our latest 202107.00 release's
blog post
.
FreeRTOS SMP:
See our
blog post
on the latest development.
Embedded World track keynote:
Watch
Richard Barry's 2021 talk on future proofing MCU devices.
This site requires JavaScript
to be enabled.
Click here
to
view a static menu.
Libraries
>
FreeRTOS Plus
>
FreeRTOS+IO
>
API Reference
FreeRTOS+IO API functions
FreeRTOS_open()
FreeRTOS_read()
FreeRTOS_write()
FreeRTOS_ioctl()
Copyright (C) Amazon Web Services, Inc. or its affiliates. All rights reserved.
