You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by xi...@apache.org on 2023/10/23 11:53:04 UTC

[nuttx] 06/09: Documentation: list all supported libs tools and apps

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nuttx.git

commit e93eb76017980aece95eede485b2518adb5fcae1
Author: raiden00pl <ra...@railab.me>
AuthorDate: Mon Oct 23 10:52:26 2023 +0200

    Documentation: list all supported libs tools and apps
---
 Documentation/applications/audioutils/index.rst   |  4 ++
 Documentation/applications/benchmarks/index.rst   |  2 +
 Documentation/applications/canutils/index.rst     | 10 ++++
 Documentation/applications/crypto/index.rst       |  8 +++
 Documentation/applications/fsutils/index.rst      | 11 ++++
 Documentation/applications/games/index.rst        |  2 +
 Documentation/applications/graphics/index.rst     | 12 +++++
 Documentation/applications/industry/index.rst     |  5 ++
 Documentation/applications/inertial/index.rst     |  2 +
 Documentation/applications/interpreters/index.rst | 12 +++++
 Documentation/applications/lte/index.rst          |  3 ++
 Documentation/applications/math/index.rst         |  2 +
 Documentation/applications/mlearing/index.rst     |  4 ++
 Documentation/applications/netutils/index.rst     | 37 +++++++++++++
 Documentation/applications/sdr/index.rst          |  2 +
 Documentation/applications/system/index.rst       | 65 +++++++++++++++++++++++
 Documentation/applications/testing/index.rst      | 34 ++++++++++++
 Documentation/applications/wireless/index.rst     |  8 +++
 18 files changed, 223 insertions(+)

diff --git a/Documentation/applications/audioutils/index.rst b/Documentation/applications/audioutils/index.rst
index 4e86e6a7f0..f5252deed3 100644
--- a/Documentation/applications/audioutils/index.rst
+++ b/Documentation/applications/audioutils/index.rst
@@ -1,3 +1,7 @@
 =======================
 Audio Utility libraries
 =======================
+
+- fmsynth - FM Synthesizer Library
+- mml_parser - Music Macro Language(MML) Library 
+- nxaudio - NX Audio Library
diff --git a/Documentation/applications/benchmarks/index.rst b/Documentation/applications/benchmarks/index.rst
index f2dcd84bb1..3679931b24 100644
--- a/Documentation/applications/benchmarks/index.rst
+++ b/Documentation/applications/benchmarks/index.rst
@@ -1,3 +1,5 @@
 ======================
 Benchmark Applications
 ======================
+
+- coremark - CoreMark Benchmark
diff --git a/Documentation/applications/canutils/index.rst b/Documentation/applications/canutils/index.rst
index 7cd9121a93..ff6571ff72 100644
--- a/Documentation/applications/canutils/index.rst
+++ b/Documentation/applications/canutils/index.rst
@@ -1,3 +1,13 @@
 =============
 CAN Utilities
 =============
+
+- candump - SocketCAN candump tool
+- canlib - CAN utility library
+- cansend - SocketCAN cansend tool
+- lely-canopen - Lely CANopen support
+- libcanutils - CAN-utils support library
+- libdronecan - libcanard DroneCAN Library
+- libobd2 - OBD-II Library
+- libopencyphal - libcanard OpenCyphal Cyphal/CAN Library
+- slcan - SocketCAN slcan tool
diff --git a/Documentation/applications/crypto/index.rst b/Documentation/applications/crypto/index.rst
index dad33fc4f2..3cbbbbe466 100644
--- a/Documentation/applications/crypto/index.rst
+++ b/Documentation/applications/crypto/index.rst
@@ -1,3 +1,11 @@
 ============================
 Cryptography Library Support
 ============================
+
+- controlse - Control Secure Element device
+- libsodium - Libsodium Cryptography Library
+- libtomcrypt - LibTomCrypt CrypographyLibrary
+- mbedtls - Mbed TLS Cryptography Library
+- tinycrypt - TinyCrypt cryptography library
+- tinydtls - Eclipse Tinydtls
+- wolfssl - wolfSSL SSL/TLS Cryptography Library
diff --git a/Documentation/applications/fsutils/index.rst b/Documentation/applications/fsutils/index.rst
index 6f9cddd1c1..a24d54c3c8 100644
--- a/Documentation/applications/fsutils/index.rst
+++ b/Documentation/applications/fsutils/index.rst
@@ -1,3 +1,14 @@
 =====================
 File System Utilities
 =====================
+
+- flash_eraseall - flash_eraseall() function
+- inifile - INI File Parser
+- inih - inih ini file parser
+- ipcfg - IP Configuration File Support
+- libtinycbor - TinyCBOR Library (RFC 8949)
+- mkfatfs - mkfatfs utility
+- mkgpt - mkgpt utility
+- mkmbr - mkmbr utility
+- mksmartfs - mksmartfs utility
+- passwd - Password file support
diff --git a/Documentation/applications/games/index.rst b/Documentation/applications/games/index.rst
index f8ed87d060..2f7545354e 100644
--- a/Documentation/applications/games/index.rst
+++ b/Documentation/applications/games/index.rst
@@ -1,3 +1,5 @@
 =====
 Games
 =====
+
+- shift - Shift Game
diff --git a/Documentation/applications/graphics/index.rst b/Documentation/applications/graphics/index.rst
index e15b5022c5..af6ce64e76 100644
--- a/Documentation/applications/graphics/index.rst
+++ b/Documentation/applications/graphics/index.rst
@@ -1,3 +1,15 @@
 ================
 Graphics Support
 ================
+
+- ft80x - FTDI/BridgeTek FT80x library
+- libjpeg - libjpeg JPEG image encoding
+- libyuv - libyuv
+- lvgl - Light and Versatile Graphic Library (LVGL)
+- nxwidgets - NxWidgets
+- nxwm - NuttX Tiny Window Manager (NxWM)
+- pdcurs34 - pdcurses Text User Interface (TUI)
+- screenshot - TIFF screenshot utility
+- slcd - Segment LCD Emulaton
+- tiff - TIFF file generation library
+- twm4nx - Minimal Tom's Window Manager (TWM) for NuttX (Twm4Nx)
diff --git a/Documentation/applications/industry/index.rst b/Documentation/applications/industry/index.rst
index 0a0818e124..329b56360a 100644
--- a/Documentation/applications/industry/index.rst
+++ b/Documentation/applications/industry/index.rst
@@ -1,3 +1,8 @@
 =======================
 Industrial Applications
 =======================
+
+- abnt_codi
+- foc - Field Oriented Control user-space library
+- scpi - SCPI instrument side parser
+- modbus - Modbus support using FreeModbus
diff --git a/Documentation/applications/inertial/index.rst b/Documentation/applications/inertial/index.rst
index f1fa34a7ee..9c06bd5574 100644
--- a/Documentation/applications/inertial/index.rst
+++ b/Documentation/applications/inertial/index.rst
@@ -1,3 +1,5 @@
 ==========================
 Inertial Libraries Support
 ==========================
+
+- madgwick - Madgwick Fusion Algorithm
diff --git a/Documentation/applications/interpreters/index.rst b/Documentation/applications/interpreters/index.rst
index 6353d4b24d..c1debdfd64 100644
--- a/Documentation/applications/interpreters/index.rst
+++ b/Documentation/applications/interpreters/index.rst
@@ -1,3 +1,15 @@
 ============
 Interpreters
 ============
+
+- bas - Basic Interpreter 
+- duktape - Duktape JavaScript interpreter
+- ficl - Ficl Forth interpreter
+- lua - Lua interpreter 
+- luajit - LuaJIT interpreter
+- luamodules: cjson, lfs, luasyslog, luv
+- minibasic - Mini Basic Interpreter
+- quickjs - QuickJS JavaScript interpreter
+- toywasm - Toywasm Webassembly Runtime
+- wamr - Webassembly Micro Runtime
+- wasm3 - WASM3 Webassembly Runtime
diff --git a/Documentation/applications/lte/index.rst b/Documentation/applications/lte/index.rst
index a79b3927ea..a631851648 100644
--- a/Documentation/applications/lte/index.rst
+++ b/Documentation/applications/lte/index.rst
@@ -1,3 +1,6 @@
 =============================
 LTE Libraries and NSH Add-Ons
 =============================
+
+- alt1250 - ALT1250 usrsock daemon
+- lapi - LTE Configuration Library
diff --git a/Documentation/applications/math/index.rst b/Documentation/applications/math/index.rst
index 8e16193307..55e5bee67d 100644
--- a/Documentation/applications/math/index.rst
+++ b/Documentation/applications/math/index.rst
@@ -1,3 +1,5 @@
 ====================
 Math Library Support
 ====================
+
+- libtommath - LibTomMath MPI Math Library
diff --git a/Documentation/applications/mlearing/index.rst b/Documentation/applications/mlearing/index.rst
index 3f72ac5a6f..9a0022467d 100644
--- a/Documentation/applications/mlearing/index.rst
+++ b/Documentation/applications/mlearing/index.rst
@@ -1,3 +1,7 @@
 ========================
 Machine Learning Support
 ========================
+
+- cmsis - CMSIS Libraries
+- darknet - YOLO: Real-Time Object Detection
+- libnnablart - NNABLA Runtime Libraries
diff --git a/Documentation/applications/netutils/index.rst b/Documentation/applications/netutils/index.rst
index fb9f356c5a..a5e5674cf0 100644
--- a/Documentation/applications/netutils/index.rst
+++ b/Documentation/applications/netutils/index.rst
@@ -1,3 +1,40 @@
 =================
 Network Utilities
 =================
+
+- chat - Chat tool
+- cjson - cJSON library
+- codecs - CODEC Library: Base64 coding, URL coding, MD5
+- cwebsocket - WebSocket Client Library
+- dhcp6c - DHCPv6 client
+- dhcpc - DHCP client
+- dhcpd - DHCP server
+- discover - Network Discovery Utility
+- esp8266 - ESP8266
+- ftpc - FTP client
+- ftpd - FTP server
+- iperf - iperf example
+- iptables - iptables libary
+- libcurl4nx - cURL4nx HTTP client library
+- mqttc - MQTT-C library
+- netcat - NetCat tool
+- netinit - Network initialization
+- netlib - Network support library
+- nng - Nanomsg NG
+- ntpclient - NTP client
+- ping - ICMP ping support
+- pppd - PPP server
+- ptpd - PTPD client/server
+- rexec - Remote execution client
+- rexecd - Remote Execution Server
+- rtptools - RTP Tools
+- smtp - SMTP
+- telnetc - Telnet client library
+- telnetd - Telnet daemon
+- tftpc - TFTP client
+- thttpd - THTTPD webserver
+- wakaama - Eclipse Wakaama (formerly liblwm2m) - an implementation of LWM2M protocol.
+- wakeonlan - WakeOnLAN support
+- webclient - uIP web client
+- webserver - uIP web server
+- xmlrpc - XML RPC library
diff --git a/Documentation/applications/sdr/index.rst b/Documentation/applications/sdr/index.rst
index 3ce7a18cf6..e146c4f3c9 100644
--- a/Documentation/applications/sdr/index.rst
+++ b/Documentation/applications/sdr/index.rst
@@ -1,3 +1,5 @@
 ===============================
 Software Define Radio Libraries
 ===============================
+
+- liquid_dsp - Liquid DSP Library
diff --git a/Documentation/applications/system/index.rst b/Documentation/applications/system/index.rst
index e554a1c2e1..565b792e4d 100644
--- a/Documentation/applications/system/index.rst
+++ b/Documentation/applications/system/index.rst
@@ -8,3 +8,68 @@ System Libraries and NSH Add-Ons
    :titlesonly:
    
    nxdiag/index.rst
+
+- adb - ADB daemon application
+- argtable3 - ARGTABLE3 library
+- cachespeed - CACHE Speed Test
+- cdcacm - USB CDC/ACM Device Commands
+- cfgdata - Cfgdata Command
+- cle - EMACS-like Command Line Editor
+- composite - USB Composite Device Commands
+- coredump - Coredump tool capture system status
+- critmon - Critcal Section Monitor
+- cu - CU minimal serial terminal
+- dd - system 'dd' command
+- dhcp6c - DHCP IPv6 Address Renewal
+- dhcpc - DHCP Address Renewal
+- dumpstack - dumpstack tool for show the task backtrace
+- fastboot - fastbootd
+- fdt - fdt utility tools
+- flash_eraseall - FLASH Erase-all Command
+- gcov - gcov tool
+- gdbstub - GDBSTUB
+- hexed - Hex editor
+- hex2bin - Intel HEX to binary conversion
+- hostname - 'hostname' command
+- input - input tool
+- iptables - 'iptables' command
+- libuv - libuv asynchronous I/O Library
+- lm75 - LM75 Temperature
+- lzf - LZF compression tool
+- mdio - PHY MDIO tool
+- memstress - memory stress test
+- netdb - netdb interface
+- ntpc - NTP Daemon Commands
+- nxcamera - NxCamera video test application
+- nxlooper - NxLooper audio test application
+- nxplayer - NxPlayer Media Player
+- nxrecorder - NxRecorder pcm raw data Recorder
+- ping - ICMP 'ping' command
+- ping6 - ICMPv6 'ping6' command
+- popen - popen()/pclose() Functions
+- psmq - psmq
+- ptpd - PTP daemon commands
+- ramspeed - RAM Speed Test
+- ramtest - RAM Test
+- readline - readline() Support
+- sched_note - Scheduler monitor
+- setlogmask - 'setlogmask' command
+- spi - SPI tool
+- stackmonitor - Stack Monitor
+- system - System Command
+- taskset - Taskset Command
+- tcpdump - tcpdump command
+- tee - Tee Command
+- telnet - Telnet chat daemon
+- telnetd - Telnet daemon application
+- termcurses - Terminal Curses control support
+- trace - Trace command
+- ubloxmodem - u-blox modem configuration tool
+- uniqueid - 'uniqueid' command
+- uorb - uorb(micro object request broker)
+- usbmsc - USB Mass Storage Device Commands
+- vi - VI Work-Alike Text Editor
+- ymodem - YMODEM
+- ofloader - Open flash loader
+- zlib - zlib data compression library
+- zmodem - Zmodem Commands
diff --git a/Documentation/applications/testing/index.rst b/Documentation/applications/testing/index.rst
index 3fe0b96255..f792593f28 100644
--- a/Documentation/applications/testing/index.rst
+++ b/Documentation/applications/testing/index.rst
@@ -1,3 +1,37 @@
 =======
 Testing
 =======
+
+- arch_libc - arch-specific libc function test
+- atomic - "Test atomic" testing
+- batterydump - Battery dump for test
+- cmocka - libcmocka
+- cpuload - cpuload test
+- crypto - crypto test
+- cxxtest - C++ test program
+- drivertest - vela cmocka driver test
+- fatutf8 - FAT UTF8 test
+- fdsantest - vela cmocka fdsan test
+- fopencookie - Fopencookie test tool
+- fstest - Generic file system test
+- getprime - getprime example
+- iozone - IOzone, filesystem benchmark tool
+- irtest - IR driver test
+- ltp - Linux Test Project
+- memtester - utils_memtester
+- mm - Memory management test
+- monkey - Monkey test
+- mtd_config_fs - MTD Config fail-safe storage test
+- nist-sts - NIST Statistical Test Suite
+- nxffs - NXFFS file system example
+- osperf - System performance profiling
+- ostest - OS test example
+- scanftest - sscanf() test
+- sensortest - Sensor driver test
+- setest - Secure Element driver test
+- smart - SMART file system example
+- smart_test - SMART filesystem test tool
+- smp - SMP example
+- superpi - SuperPI test
+- uclibcxx_test - uclibcxx test
+- unity - Unity testing framework
diff --git a/Documentation/applications/wireless/index.rst b/Documentation/applications/wireless/index.rst
index 1158c8945c..d0299e5f82 100644
--- a/Documentation/applications/wireless/index.rst
+++ b/Documentation/applications/wireless/index.rst
@@ -8,3 +8,11 @@ Wireless Libraries and NSH Add-Ons
    :titlesonly:
    
    wapi/index.rst
+
+- btsak - Bluetooth Swiss Army Knife (NuttX BLE Host)
+- nimble
+- gs2200m - Telit GS2200M usrsock daemon
+- i8sak - IEEE 802.15.4 Swiss Army Knife
+- i8shark - IEEE 802.15.4 Wireshark adapter
+- libmac - IEEE 802.15.4 MAC library routines
+- ipwan - IEEE 802.15.4 Command Line Tool