Carvera SimpleShell

General Commands

• ls [-s] [-e] [folder]
  Lists the contents of a directory. The -s option adds file size and date information, while -e sends an EOT (End of Transmission) after listing files.

• cd folder
  Changes the current working directory to folder.

• pwd
  Prints the current working directory.

• cat file [limit] [-e] [-d 10]
  Displays the contents of a file.

  • limit: Limits the number of lines displayed.
  • -e: Ends the output with EOT.
  • -d: Delays the display for a number of seconds (useful before uploads).

• echo text
  Displays a line of text. Sends the text to all streams (for debugging/logging).

• rm file [-e]
  Deletes a file. If -e is provided, it sends an EOT when the file is successfully deleted.

• mv file newfile [-e]
  Renames or moves a file from file to newfile. The -e option sends an EOT upon success.

• mkdir directory [-e]
  Creates a new directory. The -e option sends an EOT upon success.

• reset
  Reboots the system.

• dfu
  Enters DFU (Device Firmware Update) bootloader mode for firmware flashing.

• break
  Enters MRI debug mode.

• help or ?
  Displays available commands and brief descriptions.

• version
  Displays the firmware version (in this case, 0.9.8).

• mem [-v]
  Displays memory usage statistics. With the -v option, it performs a detailed heap walk.

• task
  Displays task information, including state, priority, stack usage, and runtime stats (if FreeRTOS runtime stats are enabled).

• set_temp bed|hotend temp
  Sets the temperature for the bed or hotend to the specified value.

• switch name [value]
  Controls a switch by name. If no value is provided, it retrieves the current state of the switch. Value should be either on or off.

• md5sum file
  Computes and displays the MD5 checksum of a file.

• time [timestamp]
  Displays the current system time or sets a new system time if a UNIX timestamp is provided.

File Upload/Download Commands

• upload filename
  Saves incoming text to the specified file via the XModem protocol.

• download filename
  Downloads a file using the XModem protocol.

Configuration Commands

• config-get
  Retrieves a specific configuration setting.

• config-set
  Sets a specific configuration setting.

• config-load
  Loads the configuration from the storage.

• config-get-all [-e] [filename]
  Outputs all configuration settings. Can specify a filename (default /sd/config.txt), and -e will terminate with EOT.

• config-restore
  Restores the configuration to the default settings.

• config-default
  Saves the current configuration as the default.

Network & WLAN Commands

• net
  Displays the network status (currently commented out but would retrieve IP configuration).

• ap [channel|ssid|password|enable|disable]
  Configures an access point. Options:

  • channel: Sets the AP WiFi channel (1-14).
  • ssid: Sets the AP SSID (up to 27 characters).
  • password: Sets the AP password (min 8 characters).
  • enable or disable: Turns the AP on or off.

• wlan [ssid] [password] [-d] [-e]
  Configures a WLAN connection. If no SSID is provided, it scans for networks. The -d option disconnects from the WLAN, and -e sends an EOT after processing.

Power & Sleep Commands

• sleep
  Puts the system into sleep mode (turns off 12V/24V power).

• power on|off 12|24
  Controls the 12V or 24V power supply. Use power on 12 to turn on the 12V supply, and so on.

Specialized Commands

• ftype file
  Displays the supported file type for uploads (in this case, lz, compressed by quicklz).

• remount
  Remounts the filesystem.

• thermistors
  Lists predefined thermistors.

Jogging & Motion Control

• jog
  (Not yet implemented in the code) Would likely issue jogging commands for motion control, possibly through GRBL.