shell module

Simple debug shell

No detailed description...

Example for airframe file

Add to your firmware section: This example contains all possible configuration options, not all of them are mandatory!

<module name="shell">
  b'<configure name="SHELL_PORT" value="uartX" />\n    '
  b'<configure name="SHELL_BAUD" value="B115200" />\n    '
  b'<configure name="SHELL_DYNAMIC_ENTRIES_NUMBER" value="5" />\n  '
</module>

Module configuration options

Configure Options

• name: SHELL_PORT value: uartX
  Description: serial link to use for the shell
• name: SHELL_BAUD value: B115200
  Description: baudrate for the shell
• name: SHELL_DYNAMIC_ENTRIES_NUMBER value: 5
  Description: maximum number of dynamic commands to register

Module functions

Init Functions

These initialization functions are called once on startup.

• shell_init()

Files

Header Files

The following headers are automatically included in modules.h

• shell.h

Source Files

• modules/core/shell.c
• modules/loggers/sdlog_chibios/printf.c
• arch dependent: modules/core/shell_arch.c
• arch dependent: modules/core/microrl/microrl.c
• arch dependent: modules/core/microrl/microrlShell.c

Raw shell.xml file:

<!DOCTYPE module SYSTEM "module.dtd">
<module name="shell" dir="core">
  <doc>
    <description>Simple debug shell</description>
    <configure name="SHELL_PORT" value="uartX" description="serial link to use for the shell"/>
    <configure name="SHELL_BAUD" value="B115200" description="baudrate for the shell"/>
    <configure name="SHELL_DYNAMIC_ENTRIES_NUMBER" value="5" description="maximum number of dynamic commands to register"/>
  </doc>
  <header>
    <file name="shell.h"/>
  </header>
  <init fun="shell_init()"/>
  <makefile target="ap">
    <configure name="SHELL_PORT" case="upper|lower"/>
    <configure name="SHELL_BAUD" default="B115200"/>
    <configure name="SHELL_DYNAMIC_ENTRIES_NUMBER" default="5"/>
    <file name="shell.c"/>
    <file_arch name="shell_arch.c"/>
    <file_arch name="microrl/microrl.c"/>
    <file_arch name="microrl/microrlShell.c"/>
    <include name="$(SRC_ARCH)/modules/core"/>
    <include name="modules/loggers/sdlog_chibios"/>
    <file name="printf.c" dir="modules/loggers/sdlog_chibios"/>
    <define name="USE_SHELL"/>
    <define name="USE_$(SHELL_PORT_UPPER)"/>
    <define name="USE_$(SHELL_PORT_UPPER)_TX" value="FALSE"/>
    <define name="USE_$(SHELL_PORT_UPPER)_RX" value="FALSE"/>
    <define name="$(SHELL_PORT_UPPER)_BAUD" value="$(SHELL_BAUD)"/>
    <define name="SHELL_DEV" value="$(SHELL_PORT_LOWER)"/>
    <define name="SHELL_DYNAMIC_ENTRIES_NUMBER" value="$(SHELL_DYNAMIC_ENTRIES_NUMBER)"/>
  </makefile>
</module>