Skip to content

Nuttx Guide

Main Navigation

Website

Kernel Source

Nuttx-Apps Source

Support

English

English

Appearance

Sidebar Navigation

Introduction

applications

audioutils

fmsynt

mml_parser

nxaudio

benchmarks

cachespeed

coremark

coremark-pro

cyclictest

dhrystone

fio

iozone

mtd

osperf

ramspeed

superpi

boot

mcuboot

miniboot

nxboot

canutils

candump

canlib

cansend

lely-canopen

libcanutils

libdronecan

libobd2

libopecyphal

slcan

crypto

controlse

libsodium

libtomcrypt

mbedtls

tinycrypt

tinydtls

wolfssl

examples

abntcodi

adc

adjtime

adxl372_test

ajoystick

alarm

apa102

apds9960

audio_rttl

bastest

battery

bme680

bmi160

bmp180

bmp280

bridge

buttons

calib_udelay

camera

can

capture

cbortest

cctype

chat

chrono

configdata

cordic

cpuhog

cromfs

dac

dhcpd

discover

djoystick

dronecan

elf

embedlog

esp32_himem

etl

fb

fboverlay

flash_test

flowc

fmsynth

foc

ft80x

ftpc

ftpd

fxos8700cq_test

gpio

gps

hall

hdc1008_demo

hello

hello_nim

hello_wasm

helloxx

hello_zig

hidkbd

hts221_reader

i2cchar

i2sloop

igmp

ina219

ina226

ini_dumper

ipcfg

ipforward

json

keyboard

leds

leds_rust

leds_zig

libtest

lis3dsh_reader

lp503x

lsm303_reader

lsm6dsl_reader

ltr308

lua_module

lvgldemo

lvglterm

max31855

mcuboot

media

mld

mlx90614

mml_parser

modbus

modbusmaster

module

mount

mqttc

mtdpart

mtdrwb

netlink_route

netloop

netpkt

nettest

nimble

nng_test

noteprintf

nrf24l01_btle

nrf24l01_term

null

nunchuck

nx

nxdemo

nxflat

nxhello

nximage

nxlines

nxscope

nxterm

nxtext

obd2

oneshot

opencyphal

pca9635

pdcurses

pf_ieee802154

pipe

poll

popen

posix_spawn

powerled

powermonitor

pppd

pty_test

pwfb

pwlines

pwm

qencoder

random

relays

rfid_readuid

rgbled

romfs

rpmsgsocket

rust

baremetal

hello

slint

sendmail

serialblaster

serialrx

serloop

shm_test

sht3x

slcd

smps

sotest

spislv_test

stat

sx127x_demo

system

tcpblaster

tcpecho

tcp_ipc_client

tcp_ipc_server

telnetd

termios

thttpd

tiff

timer

timer_gpio

touchscreen

udgram

udp

udpblaster

uid

unionfs

usbserial

userfs

usrsocktest

ustream

veml6070

watchdog

watcher

webserver

wget

wgetjson

wiegand

ws2812

ws2812esp32rmt

xbc_test

xmlrpc

zerocross

fsutils

flash_eraseall

inifile

inih

ipcfg

libtinycbor

mkfatfs

mkgpt

mkmbr

mksmartfs

passwd

games

brickmatch

snake

graphics

ft80x

libjpeg

libyuv

lvgl

nxwidgets

nxwm

cnxconsole

pdcurs34

screenshot

slcd

tiff

twm4nx

industry

abnt_codi

foc

modbus

scpi

inertial

madgwick

interpreters

bas

duktape

ficl

lua

luajit

minibasic

python

quickjs

toywasm

wamr

wasm3

logging

embedlog

nxscope

lte

alt1250

lapi

math

libtommath

mlearing

cmsis

darknet

libnnablart

netutils

chat

cjson

codecs

cwebsocket

dhcp6c

dhcpc

dhcpd

discover

esp8266

ftpc

ftpd

iper

iptables

libcurl4nx

mqttc

netcat

netinit

netlib

nng

ntpclient

ping

pppd

ptpd

rexec

rexecd

rtptools

smtp

telnetc

telnetd

tftpc

thttpd

wakaama

wakeonlan

webclient

webserver

xmlrpc

nsh

builtin

commands

config

customizing

installation

login

nsh

running_apps

sdr

liquid_dsp

system

adb

argtable3

cdcacm

cfgdata

cle

composite

coredump

crimon

cu

dd

debugpoint

dhcp6c

dhcpc

dumpstack

fastboot

fdt

flash_eraseall

gcov

gdbstub

gprof

hex2bin

hexed

hostname

i2c

input

iptables

libuv

lm75

lzf

mdio

netdb

nsh

ntpc

nxcamera

nxcodec

nxdiag

config

nxlooper

nxplayer

nxrecorder

ofloader

ping

ping6

popen

psmq

ptpd

readline

sched_note

setlogmask

spi

stackmonitor

system

taskset

tcpdump

tee

telnet

telnetd

termcurses

trace

ubloxmodem

uniqueid

uorb

usbmsc

vi

ymodem

zlib

zmodem

testing

arch_libc

atomic

batterydump

cmocka

cpuload

crypto

cxxtest

drivertest

fatutf8

fdsantest

fmemopen

fopencookie

fstest

getprime

irtest

lpt

memstress

memtester

mm

monkey

mtd_config_fs

nand_sim

nist-sts

nxfss

open_memstream

ostest

ramtest

scanftest

sd_bench

sd_stress

sensortest

setest

smart

smart_test

smp

uclibcxx_test

unity

tools

wireless

btsak

gs2200m

i8sak

i8shark

ipwan

libmac

nimble

porting

wapi

commands

wireless

components

binfmt

boards

cmake

crypto

nxflat

openamp

paging

syscall

video

wireless

arch

audio

drivers

block

eeprom

ramdisk

character

1wire

bch

can

contactless

efuse

i2s

ipcc

loop

math

modem

note

nullzero

quadrature

rc

rf

serial

touchscreen

analog

adc

adc1242

ads1115

ads7828

hx711

ltc1867l

max1161x

mcp3008

pga11x

dac

dac7554

dac7571

mcp47x6

mcp48xx

crypto

se05x

input

keypad

leds

userled

ws2812

motor

foc

timers

pwm

rtc

timer

watchdog

wireless

lpwan

sx126x

special

audio

clk

devicetree

devmem

dma

framebuffer

i2c

i3c

ioexpander

lcd

mmcsd

mtd

pinctrl

pipes

regmap

reset

rptun

rwbuffer

sdio

segger

sensors

spi

syslog

usbdev

usbhost

usbmisc

usbmonitor

usrsock

video

virtio

wireless

net

ethernet

pci

power

pm

sensors

adt7320

adxl345

adxl362

adxl372

aht10

ak09912

lis2mdl

lsm330

lsm6dso32

mcp9600

mpl115a

nau7802

sensors_cluster

sensors_legacy

sensors_uorb

sht4x

wireless

rn2xx3

thermal

filesystem

aio

binfs

cromfs

fat

hostfs

how_nxffs_works

inotify

littlefs

mmap

mnemofs

nfs

nuttxfs

nxffs

nxflat

partition

procfs

pseudofs

romfs

rpmsgfs

shmfs

smartfs

special_files_dev_num

spiffs

tmpfs

unionfs

userfs

v9fs

zipfs

libs

libdsp

libm

libxx

libc

zoneinfo

libnx

nxfonts

mm

shm

net

delay_act_and_tcp_perf

ipfilter

nat

netdev

netdriver

netguardsize

netlink

pkt

sixlowpan

slip

socketcan

tcp_network_perf

wqueuedeadlocks

nxgraphics

appendix

framebuffer_char_driver

nxcursor

nxfonts

nxgl

nx

nxtk

nxwm_threading

sample

nxwm_threading_model

tools

contributing

coding_style

documentation

making-changes

releases

workflow

debugging

coredump

coresight

cortexmhardfaults

debugging_elf_loadable_modules

debuggingflash_nuttxonarm

disabling_stackdumpdebug

gdbserver

gdbwithpython

kasan

mte

qemugdb

stackcheck

stackrecord

tasktraceinternal

tasktrace

tasktraceuser

irqinfo

guides

armv7m_runtimestackcheck

automounter

building_nuttx_with_app_out_of_src_tree

building_uclibcpp

changing_systemclockconfig

citests

cpp_cmake

custom_app_directories

customapps

customboards

devicetree

drivers

etcromfs

fortify

fully_linked_elf

include_files_board_h

integrate_newlib

ipv6

kernel_threads_with_custom_stacks

logging_rambuffer

multiple_nsh_sessions

nestedinterrupts

nfs

nsh_network_link_management

ofloader

partially_linked_elf

platform_directories

port_bootsequence

port_drivers_to_stm32f7

port

port_relatedkernelconfigrations

protected_build

pysimcoder

ram_rom_disks

reading_can_msgs

remove_device_drivers_nsh

renode

rndis

rust

semihosting

signal_events_interrupt_handlers

signaling_sem_priority_inheritance

simulator

smaller_vector_tables

specialstuff_in_nuttxheaderfiles

stm32ccm

stm32nullpointer

testingtcpip

thread_local_storage

updating_release_system_elf

usbtrace

usingkernelthreads

versioning_and_task_names

zerolatencyinterrupts

porting-case-studies

bcm2711-rpi4b

port_arm_cm4

implementation

bottomhalf_interrupt

critical_sections

device_drivers

drivers_design

interrupt_controls

preemption_latency

processes_vs_tasks

simulation

introduction

about

development_environments

inviolables

licensing

resources

trademarks

platforms

arm

a1x

boards

pcduino-a10

README

am335x

boards

beaglebone-black

README

at32

boards

at32f437-mini

README

bcm2708

c5471

boards

c5471evm

README

cxd56xx

boards

spresense

README

dm320

boards

ntosd-dm320

README

efm32

boards

efm32-g8xx-stk

README

efm32gg-stk3700

README

olimex-efm32g880f128-stk

README

eoss3

boards

quickfeather

README

fvp-v8r-aarch32

boards

fvp-armv8r-aarch32

README

gd32f4

boards

gd32f450zk-aiotbox

gd32f450zk-eval

gd32f470ik-eval

gd32f470zk-aiotbox

gd32f470zk-eval

goldfish

goldfish_timer

imx1

imx6

boards

sabre-6quad

README

imx9

boards

imx95-evk

imxrt

boards

imxrt1020-evk

imxrt1050-evk

imxrt1060-evk

imxrt1064-evk

imxrt1170-evk

teensy-4.x

kinetis

boards

freedom-k28f

README

freedom-k64f

README

freedom-k66f

README

kwikstik-k40

README

teensy-3.x

README

twr-k60n512

README

twr-k64f120m

README

kl

boards

freedom-kl25z

README

freedom-kl26z

README

teensy-lc

README

lc823450

boards

lc823450-xgevk

README

lpc17xx

boards

lincoln60

README

lpcxpresso-lpc1768

README

mbed

README

mcb1700

README

olimex-lpc1766stk

README

open1788

README

pnev5180b

README

u-blox-c027

README

zkit-arm-1769

README

lpc214x

boards

mcu123-lpc214x

README

zp214xpa

README

lpc2378

boards

olimex-lpc2378

README

lpc31xx

boards

ea3131

README

ea3152

README

olimex-lpc-h3131

README

lpc40xx

boards

lpc4088-devkit

lpc4088-quickstart

lx_cpu

README

lpc43xx

boards

bambino-200e

lpc4330-xplorer

lpc4337-ws

lpc4357-evb

lpc4370-link2

README

lpc54xx

boards

lpcxpresso-lpc54628

README

max326xx

boards

max32660-evsys

README

moxart

boards

moxa

mps

boards

mps2-an500

mps2-an512

mps3-an547

mx8mp

boards

verdin-mx8mp

nrf52

ieee802154

boards

arduino-nano-33ble

arduino-nano-33ble-rev2

nrf52832-dk

nrf52832-mdk

nrf52832-sparkfun

nrf52840-dk

nrf52840-dongle

nrf52-feather

nrf9160-dk-nrf52

thingy52

thingy91-nrf52

xiao-nrf52840

nrf53

boards

nrf5340-audio-dk

nrf5340-dk

thingy53

nrf91

boards

nrf9160-dk

thingy91

nuc1xx

boards

nutiny-nuc120

README

phy62xx

boards

phy6222

qemu

boards

qemu-armv7a

ra4m1

boards

arduino-r4-minima

xiao-ra4m1

rp2040

boards

adafruit-feather-rp2040

adafruit-kb2040

adafruit-qt-py-rp2040

pimoroni-tiny2040

raspberrypi-pico

raspberrypi-pico-w

seeed-xiao-rp2040

w5500-evb-pico

waveshare-rp2040-lcd-1.28

waveshare-rp2040-zero

rp23xx

boards

raspberrypi-pico-2

README

xiao-rp2350

s32k1xx

boards

rddrone-bms772

s32k118evb

s32k144evb

s32k146evb

s32k148evb

ucans32k146

s32k3xx

boards

mr-canhubk3

s32k344evb

sam34

boards

arduino-due

flipnclick-sam3x

sam3u-ek

sam4cmp-db

sam4e-ek

sam4l-xplained

sam4s-xplained

sam4s-xplained-pro

sama5

boards

giant-board

jupiter-nano

sam5d3-xplained

sama5d2-xult

README

sama5d3x-ek

README

Using-NxPlayer

sama5d3-xplained

README

sama5d4-ek

README

RunningNxWM

samd2l2

boards

arduino-m0

circuit-express

samd20-xplained

samd21-xplained

saml21-xplained

xiao-seeeduino

samd5e5

boards

metro-m4

same54-xplained-pro

samv7

boards

same70-qmtech

same70-xplained

samv71-xult

stm32c0

boards

nucleo-c071rb

nucleo-c092rc

stm32f0

boards

nucleo-f072rb

nucleo-f091rc

stm32f051-discovery

stm32f072-discovery

stm32f1

boards

cloudctrl

et-stm32-stamp

fire-stm32v2

hymini-stm32

maple

nucleo-f103rb

olimexino-stm32

shenzhou

stm3210e-eval

stm32butterfly2

stm32f103-minimum

stm32_tiny

stm32vldiscovery

viewtool-stm32f107

stm32f2

boards

emw3162

nucleo-f207zg

olimex-stm32-p207

photon

stm3220g-eval

stm32f3

boards

nucleo-f302r8

nucleo-f303re

nucleo-f303ze

nucleo-f334r8

stm32f334-disco

stm32f3discovery

stm32f4

boards

axoloti

clicker2-stm32

mikroe-stm32f4

nucleo-f401re

nucleo-f410rb

nucleo-f411re

nucleo-f412zg

nucleo-f429zi

nucleo-f446re

odrive36

olimex-stm32-e407

olimex-stm32-h405

olimex-stm32-h407

olimex-stm32-p407

omnibusf4

stm3240g-eval

stm32f401rc-rs485

stm32f411e-disco

stm32f411-minimum

stm32f429i-disco

stm32f4discovery

stm32f7

boards

nucleo-f722ze

nucleo-f746zg

nucleo-f767zi

steval-eth001v1

stm32f746g-disco

stm32f746-ws

stm32f769i-disco

stm32f777zit6-meadow

stm32g0

boards

nucleo-g070rb

nucleo-g071rb

nucleo-g0b1re

stm32g071b-disco

stm32g4

boards

b-g431b-esc1

b-g474e-dpow1

nucleo-g431kb

nucleo-g431rb

nucleo-g474re

stm32h5

boards

nucleo-h563zi

stm32h7

boards

linum-stm32h753bi

nucleo-h743zi

nucleo-h743zi2

nucleo-h745zi

openh743i

stm32h745i-disco

stm32h747i-disco

weact-stm32h743

stm32l0

boards

b-l072z-lrwan1

nucleo-l073rz

stm32l0538-disco

stm32l1

boards

nucleo-l152re

stm32ldiscovery

stm32l4

boards

b-l475e-iot01a

nucleo-l432kc

nucleo-l452re

nucleo-l476rg

nucleo-l496zg

steval-stlcs01v1

stm32l476-mdk

stm32l476vg-disco

stm32l4r9ai-disco

stm32l5

boards

nucleo-l552ze

stm32l562e-dk

stm32u5

boards

b-u585i-iot02a

nucleo-u5a5zj-q

stm32wb

boards

flipperzero

nucleo-wb55rg

stm32wl5

boards

nucleo-wl55jc

str71x

boards

olimex-strp711

tiva

boards

dk-tm4c129x

eagle100

ekk-lm3s9b96

launchxl-cc1310

launchxl-cc1312r1

lm3s6432-s2e

lm3s6965-ek

lm3s8962-ek

lm4f120-launchpad

tm4c123g-launchpad

tm4c1294-launchpad

tm4c129e-launchpad

tms570

boards

launchxl-tms57004

tms570ls31x-usb-kit

xmc4

boards

xmc4500-relax

xmc4700-relax

arm64

a527

boards

avaota-a1

a64

boards

pinephone

bcm2711

boards

raspberrypi-4b

fvp-v8r

boards

fvp-armv8r

README

imx8

boards

imx8qm-mek

README

imx9

boards

imx93-evk

README

qemu

boards

qemu-armv8a

README

rk3399

boards

nanopi_m4

pinephonepro

zynq-mpsoc

boards

zcu111

avr

at32uc3

boards

avr32dev1

README

at90usb

boards

micropendous3

README

teensy-2.0

README

atmega

boards

amber

README

arduino-mega2560

mega1284p-xplained

moteino-mega

ceva

xc5

xm6

hc

m9s12

boards

demo9s12ne64

README

ne64badge

README

mips

pic32mx

boards

mirtoo

README

pic32mx7mmb

README

pic32mx-starterkit

README

sure-pic32mx

README

ubw32

README

pic32mz

boards

chipkit-wifire

README

flipnclick-pic32mz

README

pic32mz-starterkit

README

misco

lm32

boards

misoc

README

or1k

mor1kx

boards

or1k

README

renesas

m16c

boards

skp16c26

README

rx65n

boards

rx65n-grrose

README

ROMFS

rx65n-rsk2mb

README

ROMFS

sh1

boards

us7032evb1

README

risc-v

bl602

boards

bl602evb

bl808

boards

ox64

c906

boards

smartl-c906

README

README-qemu

eic7700x

boards

starpro64

esp32c3

boards

esp32c3-generic

esp32c3-xiao

esp32c3-legacy

boards

esp32c3-devkit

ROMFS

esp32c3-devkit-rust-1

README

esp32c6

boards

esp32c6-devkitc

esp32c6-devkitm

esp32h2

boards

esp32h2-devkit

fe310

boards

hifive1-revb

README

README-qemu

hpm6000

boards

hpm6360evk

hpm6750

boards

hpm6750evk2

README

jh7110

boards

star64

k210

boards

maix-bit

README

README-qemu

k230

boards

canmv230

litex

boards

arty_a7

README

vexriscv

vexriscv_smp

mpfs

boards

icicle

qemu-rv

boards

rv-virt

rv32m1

boards

rv32m1-vega

README

sg2000

boards

milkv_duos

sim

network_linux

network_vpnkit

sim

boards

sim

README

sparc

bm3803

boards

xx3803

bm3823

boards

xx3823

s698pm

boards

s698pm-dkit

tricore

tc397

boards

kit_a2g_tc397_tft

x86

qemu

boards

qemu-i486

README

x86_64

intel64

boards

qemu-intel64

xtensa

esp32

boards

esp32-2432S028

esp32-audio-kit

esp32-devkitc

esp32-ethernet-kit

README

esp32-lyrat

esp32-pico-kit

esp32-wrover-kit

esp32s2

boards

esp32s2-kaluga-1

esp32s2-saola-1

esp32s3

boards

esp32s3-devkit

esp32s3-eye

esp32s3-korvo-2

esp32s3-lcd-ev

esp32s3-lhcbit

esp32s3-xiao

lckfb-szpi-esp32s3

z16

z16f

boards

z16f2800100zcog

README

z80

ez80

boards

ez80f910200kitg

README

ez80f910200zco

README

makerlisp

README

z20x

README

z180

boards

p112

README

z8

boards

z8encore000zco

README

z8f64200100kit

README

z80

boards

z80sim

README

quickstart

compiling_cmake

compiling_make

configuring

debugging

install

organization

running

reference

os

addrenv

app_vs_os

arch

board

conventions

events

iob

led

mutex

newreno

notifier

nuttx

paging

shm

smp

time_clock

wqueue

user

01_task_control

02_task_scheduling

03_task_control

04_message_queue

05_counting_semaphore

06_clocks_timers

07_signals

08_pthread

09_env_vars

10_filesystem

11_network

12_shared_memory

13_boardctl

13_logging

structures

faq

On this page

`buttons` Read GPIO Buttons

Buttons driver example.

Edit on GitHub

Pager

Next pageIntroduction