Commit graph

83 commits

Author SHA1 Message Date
aviralgarg05
987f47d47d Documentation: Add NXStore hardware screenshot.
Add a real ESP32-S3 touchscreen photograph to the NXStore guide so the
companion documentation shows the package catalog on target hardware.

Assisted-by: OpenAI Codex:gpt-5.6-sol
Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
2026-08-24 09:53:50 +08:00
aviralgarg05
e15baa5650 Documentation: Update nxpkg and add nxstore guide.
Document nxpkg storage, repository metadata, lifecycle commands, recovery behavior, and transport trust limits.

Add the companion nxstore guide, including installed-manifest launch behavior and the shared framebuffer supervisor-strip contract.

Assisted-by: Claude:claude-sonnet-5
Assisted-by: OpenAI Codex:gpt-5.6-sol
Signed-off-by: aviralgarg05 <gargaviral99@gmail.com>
2026-08-24 09:53:50 +08:00
wangjianyu3
f40e948594 Documentation/nxinit: document property triggers and fix CONFIG names
Some checks are pending
Build Documentation / build-html (push) Waiting to run
MemBrowse Memory Report / changes-filter (push) Waiting to run
MemBrowse Memory Report / load-targets (push) Waiting to run
MemBrowse Memory Report / identical (push) Blocked by required conditions
MemBrowse Memory Report / analyze (push) Blocked by required conditions
The Triggers section previously stated that action (property) triggers
were not yet implemented; they are supported now, so describe the
fnmatch value matching and the edge-triggered semantics of on <event>.
The Examples section used the stale CONFIG_SYSTEM_INIT_* prefix and now
uses CONFIG_SYSTEM_NXINIT_* together with a property trigger example.

This documents the behavior added in
https://github.com/apache/nuttx-apps/pull/3726.

Assisted-by: GitHubCopilot:claude-opus-4.8
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-08-17 17:04:04 +08:00
fangpeina
fbfb1b95f7 Documentation/applications/system: Add stty command documentation
Add documentation for the stty terminal configuration utility,
describing usage, available settings, examples, and configuration
options.

Signed-off-by: fangpeina <fangpeina@xiaomi.com>
2026-08-14 13:47:04 +02:00
Alan Carvalho de Assis
fdcd0ec317 Documentation: add apps/system/toybox entry
Basic usage/configuration reference for the toybox application, plus
known limitations: ps lists no processes (it expects Linux's
/proc/<pid>/stat, which NuttX's procfs doesn't provide), and grep -r
is unreliable against procfs.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
Assisted-by: Claude Sonnet 5 <noreply@anthropic.com>
2026-08-14 10:20:52 +08:00
Alan Carvalho de Assis
2d0733cf41 doc/i2ctool: Add missing -z paramenter
As requested at https://github.com/apache/nuttx/pull/19712

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2026-08-06 09:28:08 -04:00
Jorge Guzman
a073c2f9c1 Documentation: follow the keyboard change in the application docs
The lvglterm page still told the reader to pick the input source that
matches the hardware, which was the whole thing being removed:  it has
one physical keyboard variant now, and reads whatever is registered.

The hidkbd page pointed at HIDKBD_ENCODED, which no longer exists.  What
produces that byte stream now is INPUT_KEYBOARD_BYTESTREAM.

system/kbd had no page at all.

Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
2026-08-02 18:37:12 +08:00
Marco Casaroli
1f3358e991 Documentation: Document the xipfs command, test suite and NXFLAT demo.
Pages for the three applications that come with xipfs: the command that
compacts a volume and prints its block map, the test suite and what each of
its sections covers, and the demo that downloads an NXFLAT module into a
volume and runs two instances of it in place.

Assisted-by: Claude Code:claude-opus-5
Signed-off-by: Marco Casaroli <marco.casaroli@gmail.com>
2026-07-29 07:49:03 -03:00
Jorge Guzman
13c6c7032e boards/linum-stm32h753bi: add curl config and document the curl command
Add a "curl" configuration for the linum-stm32h753bi board, based on the
netnsh configuration (ethernet + DHCP). It enables the system/curl HTTP
client command, SD card support (mounted manually, as in the sdcard
configuration) and a larger console line buffer (CONFIG_LINE_MAX=256) so
long URLs and JSON bodies are not truncated at the NSH prompt.

Also document the curl command: add a man page under
Documentation/applications/system/curl and a usage example (download,
POST JSON, multipart upload) to the board documentation.

Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
2026-07-21 14:36:23 +08:00
Jorge Guzman
05832a4e62 Documentation: system: cu: document the cu serial terminal
The cu application page was an empty stub. Document the command:
description, options, escape sequences, configuration dependencies
and limitations.

Also add an rs485 configuration to the linum-stm32h753bi board with
the two on-board RS-485 transceivers (UART4 and USART6) and the cu
terminal enabled, plus a board documentation section showing how to
bridge the console to one of the RS-485 buses with cu. The RS-485
DE pins are handled automatically by the serial driver.

Tested on hardware.

Signed-off-by: Jorge Guzman <jorge.gzm@gmail.com>
2026-07-13 09:35:18 -04:00
raiden00pl
07c4bf0048 !arch/stm32: move stm32l1 and finalize the directory split
Move the stm32l1 sources, headers and boards into arch/arm/src/stm32l1,
arch/arm/include/stm32l1 and boards/arm/stm32l1, then finalize the split:
source each split family directly in arch/arm/Kconfig and boards/Kconfig and
remove the now-empty combined arch/arm/src/stm32 and boards/arm/stm32 trees.

BREAKING CHANGE: The legacy STM32 architecture and board paths were split into
stm32f1, stm32l1, stm32f2, stm32f3, stm32f4, and stm32g4 directories.
Out-of-tree boards must move from stm32 to the matching split family.

Signed-off-by: raiden00pl <raiden00@railab.me>
2026-06-24 14:54:44 -03:00
hanzhijian
5e5137adee Documentation/applications/system/critmon: add critmon man page
Add documentation for the critmon command including:
- critmon (one-shot dump)
- critmon_start (start daemon)
- critmon_stop (stop daemon)
- Output format explanation
- Configuration options

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-06-16 17:07:18 +08:00
hanzhijian
d866153a25 Documentation/applications/system/conntrack: add conntrack man page
Add comprehensive documentation for the conntrack command including
dump and event monitoring options.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-06-11 22:52:33 -03:00
hanzhijian
f6bb93c379 Documentation/applications/system/conntrack: add conntrack man page
Add documentation for the conntrack command including usage, options,
output format, and examples for listing and monitoring connection
tracking entries.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-06-11 22:52:33 -03:00
hanzhijian
cdf500960f fix: remove cross-reference to ip6tables doc not yet in tree 2026-06-10 08:57:15 -03:00
hanzhijian
77060179dd fix: replace :kconfig:option: with plain backticks for Sphinx compatibility 2026-06-10 08:57:15 -03:00
hanzhijian
ffd09067e4 Documentation/applications/system/iptables: add iptables man page
Add comprehensive documentation for the iptables command including
all supported commands, options, and usage examples.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-06-10 08:57:15 -03:00
hanzhijian
21157586bc fix: remove extra backtick in See Also doc reference 2026-06-10 08:55:23 -03:00
hanzhijian
a0c9463f01 fix: replace :kconfig:option: with plain backticks for Sphinx compatibility 2026-06-10 08:55:23 -03:00
hanzhijian
d0665a8cff Documentation/applications/system/ip6tables: add ip6tables man page
Add comprehensive documentation for the ip6tables command including
all supported commands, options, and IPv6-specific usage examples.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-06-10 08:55:23 -03:00
hanzj
3c8621cb89 Documentation: document sensortest command
Add documentation for the sensortest system tool which reads data
from sensor drivers via the uORB topic interface.

Signed-off-by: hanzj <hanzj@xiaomi.com>
2026-06-08 10:04:48 +02:00
hanzj
7922011b72 Documentation: document tcpdump command.
Add documentation for the tcpdump system command, covering
command-line options (-i, -w, -s), Kconfig configuration,
usage examples, and notes on pcap output format compatibility.

Signed-off-by: hanzj <hanzjian@zepp.com>
2026-06-07 22:55:03 +08:00
hanzj
331caeb475 Documentation: document ping6 command.
Add documentation for the ping6 ICMPv6 ECHO request command.
The ping6 tool sends ICMPv6 ECHO_REQUEST packets to a remote
IPv6 host and reports round-trip times and packet loss statistics.

Refs #11081

Signed-off-by: hanzj <hanzjian@zepp.com>
2026-05-28 09:43:31 -03:00
hanzj
f031dc5604 Documentation: document lzf command.
Add documentation for the lzf compression/decompression command.
The lzf tool uses the liblzf library to compress and decompress
files using the lightweight LZF algorithm.

Refs #11081

Signed-off-by: hanzj <hanzjian@zepp.com>
2026-05-28 15:43:13 +08:00
Matteo Golin
8b0c54b59e docs/nxinit: Add link to Android init docs
Add the same link from the NXInit Kconfig help.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2026-05-28 09:38:17 +08:00
Matteo Golin
cee841c775 docs/nxinit: Document configurable file path
Document that the init.rc file path is now configurable.

Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
2026-05-28 09:38:17 +08:00
hanzhijian
2354c720d8 Documentation: document gprof command.
Add documentation for the gprof command, which controls NuttX
function-call profiling.  Covers the start, stop, dump, and help
subcommands, configuration dependencies on CONFIG_PROFILE and
CONFIG_SYSTEM_GPROF, and a worked example showing how to collect
and analyse a gmon.out file.

Refs #11081

Signed-off-by: hanzj <hanzhijian@zepp.com>
2026-05-28 02:20:42 +02:00
Alan Carvalho de Assis
4df7831d48 doc/nxinit: Rename Init to NXInit and fix review comments
Initially Xiang contributed NXInit as Init, but then the community
suggested to rename it to NXInit to avoid conflict with other init
systems.

Signed-off-by: Alan C. Assis <acassis@gmail.com>
2026-05-27 19:29:04 -04:00
wangjianyu3
a628ff656f Docs: Add documentation for Init
Add documentation for the Init component, including syntax explanations and
simple examples.

Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-05-27 19:29:04 -04:00
hanzhijian
304b8706cb Documentation: document hex2bin command.
Fill the blank hex2bin documentation page with an overview,
configuration options, usage synopsis, option descriptions,
examples, and notes.  All claims are sourced from the
hex2bin_main.c implementation and the Kconfig in
apps/system/hex2bin/.

Refs #11081

Signed-off-by: Zepp-Hanzj <han6569084@gmail.com>
2026-05-27 21:46:38 +08:00
hanzhijian
8bddb558cc Documentation: Document hostname command.
Add documentation for the hostname command, which displays or
sets the system hostname.

Refs #11081

Signed-off-by: hanzj <your-email@example.com>
2026-05-27 10:04:35 -03:00
hanzhijian
95b1f7dbf1 Documentation: document cle library.
Refs #11081

Signed-off-by: hanzj <hanzj@users.noreply.github.com>
Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-05-27 10:03:54 -03:00
hanzhijian
9fe1ce133f Documentation: document lm75 temperature command.
Fill the blank documentation page for the lm75 (LM75 Temperature)
system command. The command reads temperature data from an LM75
I2C sensor and supports sample count and unit configuration.

Refs #11081

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-05-27 10:03:04 -03:00
hanzhijian
4f512de7cb Documentation: Document dd command.
Add documentation for the dd command, which copies data from
an input file or device to an output file or device.

Refs #11081

Signed-off-by: hanzj <your-email@example.com>
2026-05-27 12:48:02 +02:00
hanzhijian
ab77fb3467 Documentation: Document stackmonitor command.
Add documentation for the stackmonitor command, which starts a
background daemon to monitor stack usage for all tasks and threads.

Refs #11081

Signed-off-by: hanzj <your-email@example.com>
2026-05-27 12:29:35 +08:00
hanzhijian
3f4251e257 Documentation: Document taskset command.
Fill the taskset application reference page with source-backed usage,
configuration, forms, examples, and notes.  The documented command forms and
mask constraints come from apps/system/taskset/taskset.c and the enabling
configuration comes from apps/system/taskset/Kconfig.

Signed-off-by: hanzj <han.zhijiang@zte.com.cn>
2026-05-26 23:15:36 +08:00
hanzhijian
84f8156605 Documentation: document uniqueid command.
Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-05-26 09:05:19 -04:00
hanzhijian
cea3a33ae7 Documentation: Document tee command.
Add the missing application reference for the tee system command.  The
page now documents the command purpose, build configuration, usage,
options, arguments, examples, and error behavior using the implementation
in apps/system/tee as source evidence.

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-05-26 09:04:57 -04:00
hanzhijian
0d792e6ffd Documentation: document setlogmask command 2026-05-25 10:30:16 -03:00
Arjav Patel
0eda74c478 doc/system: Add documentation for micro-ROS integration.
Add minimal documentation of micro-ROS integration to the system
applications category, covering the library skeleton structure and
Kconfig options. This document provides baseline context for the
foundational library layout in apps/system/microros/.
2026-05-24 09:10:01 +08:00
hanzhijian
41cd6eb16d Documentation/uorb: Fix command references in uORB docs.
Align the uORB application documentation with the actual command names, source layout, and configuration options in apps/system/uorb.

This updates the page to describe both uorb_listener and uorb_generator, uses the registered NSH command names in usage examples, and documents the listener and generator options to match the current implementation.

It also adds the relevant Kconfig enablement notes so the documented commands are easier to find and use.

Tested with:
- make html SPHINXOPTS="-W" -j

Signed-off-by: hanzhijian <hanzhijian@zepp.com>
2026-05-22 00:42:48 +08:00
bijunda
99d639b9fe Documentation: add nxcamera documentation
Document the nxcamera command usage, including device selection,
resolution, and pixel format options. Also mention recent support
for multi-instance camera mounting and the macOS AVFoundation
backend on the SIM platform.

Signed-off-by: Peter Bee <bijunda@bytedance.com>
2026-05-08 19:51:39 +08:00
wangjianyu3
f97b29c4c4 boards/lckfb-szpi-esp32s3: add vncviewer defconfig and documentation
Add vncviewer board configuration and documentation:
- boards: add lckfb-szpi-esp32s3:vncviewer defconfig
- Documentation: add system/vncviewer application doc with host
  VNC server setup examples (Xvfb, clip, scale modes) and images

Assisted-by: GitHubCopilot:claude-4.6-opus
Signed-off-by: wangjianyu3 <wangjianyu3@xiaomi.com>
2026-04-27 22:19:31 +02:00
Tomasz 'CeDeROM' CEDRO
3efaf80d3d boards/xtensa/esp32s3: New board WaveShare ESP32-S3-Touch-LCD-1.28 (WIP).
* Initial experimental / work in progress implementation.
* New board name is esp32s3-ws-lcd128.
* Supports Kconfig delectable w/wo touch variants (lcd gpios difference).
* IMU QMI8658 bringups is put into esp32s3/common/src to share with other
  boards. Pin defines are located at <board>include/board.h and referenced
  with `#include <arch/board/board.h>`.
* Supported configurations: nsh, ostest, coremark, touch-lvgl, notouch-lvgl,
  imu-qmi8658, watchdog.
* Does not have touch panel driver yet.
* Created board documentation. Added sphinx inline cross-references.
* TODO: Fix SPI GC9A01A LCD pixel format colors.
* TODO: Create I2C CST816S touch panel driver.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
2026-04-24 16:27:08 +08:00
raiden00pl
6f9d6f3d94 boards/nucleo-c071rb: add nxmodbus examples to jumbo
add nxmodbus client and server examples to jumbo

Signed-off-by: raiden00pl <raiden00@railab.me>
2026-04-21 09:39:04 +08:00
raiden00pl
d1c8c7e480 Documentation: add nxmodbus doc
add nxmodbus doc

Signed-off-by: raiden00pl <raiden00@railab.me>
2026-04-21 09:39:04 +08:00
shichunma
73be35c3a8 Documentation/ntpc: document DHCP NTP server support
Document that ntpc can use NTP servers learned from DHCP option 42 when DHCP client support is enabled.

Signed-off-by: Jerry Ma <shichunma@bestechnic.com>
2026-04-18 19:14:20 -03:00
raiden00pl
9424c3ac3b Documentation: update nxscope doc
update various nxscope doc

Signed-off-by: raiden00pl <raiden00@railab.me>
2026-03-24 09:39:42 +08:00
Huang Qi
e3eeaefd6d style: Fix "the the" typo across the codebase.
Fix 269 occurrences of duplicate "the" word typo found in 209 files
across source code, header files, and configuration.

Signed-off-by: Huang Qi <huangqi3@xiaomi.com>
2026-03-23 11:07:49 +01:00
yinshengkai
87b317f965 Documentation: Add gprof profiling tool documentation and support.
Verified on qemu-armv7a and mps2-an500 platforms with
CoreMark benchmark and system profiling examples

Signed-off-by: yinshengkai <yinshengkai@bytedance.com>
2026-02-04 03:03:45 +08:00