modules/woz_uwb/src/shell/aliro_shell.c
asxeem/openaliro
Module

aliro_shell.c

aliro UART shell command: colored console over the UWB engine.

modules/woz_uwb/src/shell/aliro_shell.c11 documented symbols

Overview

aliro UART shell command: colored console over the UWB engine.

depends on ccc_shim.h uwb_min.h uwb_rxdiag.h flight_recorder.h fira_session.h

API

Fstatic void hdr(const struct shell *sh, const char *title)

modules/woz_uwb/src/shell/aliro_shell.c:31

Section header: green "aliro · <title>" over a dim rule.

called by cmd_chip, cmd_range, cmd_rx, cmd_selftest, cmd_status, cmd_version

Fstatic int cmd_chip(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:49

Read and display the DW3110 DEV_ID register; verify chip identification.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success; nonzero SPI error code on read failure.
calls hdr

Fstatic int cmd_rx(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:75

Display RX/TX frame tally and error counters.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success.
calls hdr

Fstatic int cmd_range(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:99

Display the last valid DS-TWR distance measurement and metadata.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success.
calls hdr

Fstatic int cmd_selftest(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:134

Run radio TX/RX self-test and display results.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success; nonzero error code if self-test fails.
calls hdr

Fstatic int cmd_log(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:163

Enable, disable, or query the ranging heartbeat log output stream.

sh
Shell context.
argc
Argument count; if ≥2, argv[1] must be "on" or "off".
argv
Command arguments; argv[1] optionally specifies "on" or "off".
returns
0 on success; -EINVAL if argv[1] is neither "on" nor "off".

Fstatic int cmd_frames(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:187

Enable, disable, or query the per-block distance stream output.

sh
Shell context.
argc
Argument count; if ≥2, argv[1] must be "on" or "off".
argv
Command arguments; argv[1] optionally specifies "on" or "off".
returns
0 on success; -EINVAL if argv[1] is neither "on" nor "off".

Fstatic int cmd_frec(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:213

Arm/disarm the flight recorder, or dump/clear its RAM ring.

sh
Shell context.
argc
Argument count; if ≥2, argv[1] is on|off|dump|clear.
argv
Command arguments.
returns
0 on success; -EINVAL on an unrecognised sub-argument.

Fstatic int cmd_version(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:243

Display the build commit SHA.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success.
calls hdr

Fstatic int cmd_status(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:261

Display all system status: chip ID, CCC bind state, URSK provisioning, last range, RX tally, and stream state.

sh
Shell context.
argc
Argument count (unused).
argv
Argument vector (unused).
returns
0 on success.
calls hdr

Fstatic int cmd_aliro(const struct shell *sh, size_t argc, char **argv)

modules/woz_uwb/src/shell/aliro_shell.c:323

Print aliro shell command help and list all available subcommands.

sh
Shell context.
argc
Argument count; if >1, returns error for unknown subcommand.
argv
Argument vector; argv[1] if present must be empty or help request.
returns
0 on success; -EINVAL if argc >1.