Skip to content

CLI

Jump to bottom
Just Call Me Koko edited this page Dec 23, 2022 · 9 revisions

Marauder Command Line Interface

This feature is actively being developed for firmware v0.9.6. The goal is to produce command line interface which can be used over hardware serial and/or bluetooth serial. In theory this will allow anyone with an ESP32 and a TX/RX or phone with bluetooth to make and use their own Marauder.

For full usage on how to establish a connection to the Marauder command line interface, see Access CLI below. If you would like to see examples of how these commands are used in a workflow, check out workflow examples.

Here are the currently supported commands:

Access CLI

The ESP32 Marauder firmware allows the user to interface with the device via its commandline interface over UART(TX, RX). If your device has a USB port, the physical connection is as simple as connecting the device to a PC or Android phone via USB cable. If your device does not have a USB port or your device is a Flipper Zero WiFi Dev Board, you will need to get a little more creative with how you interface with your device.

Note: To find out which serial port your device uses when plugged into your PC, use Device Manager

Standard USB

  1. Connect your Marauder device to a PC or Android phone
  2. Open your Serial terminal software
    • If you are using a PC, make sure you have Putty installed
    • If you are using an Android device, install a Serial terminal from the app store
  3. In your Serial terminal software, make sure the following is set
    • Baud: 115200
    • Port: Whatever serial port your device occupies when plugged in i.e. COMX
  4. Click whatever button starts the connection
    • Putty: Open
    • Android: Figure it out I guess
  5. Verify the connection was successful by typing help and hitting enter
    • You should see a list of available commands show up

Flipper Zero WiFi Dev Board

  1. Connect your Dev Board to the Flipper Zero
  2. Plug your flipper zero into your PC or Android phone
  3. On your flipper, start the USB/UART bridge app under GPIO
  4. Make sure the following settings are set
    • USB Channel: 0
    • Baudrate: 115200
  5. Open your Serial terminal software
    • If you are using a PC, make sure you have Putty installed
    • If you are using an Android device, install a Serial terminal from the app store
  6. In your Serial terminal software, make sure the following is set
    • Baud: 115200
    • Port: Whatever serial port your device occupies when plugged in i.e. COMX
  7. Click whatever button starts the connection
    • Putty: Open
    • Android: Figure it out I guess
  8. Verify the connection was successful by hitting the reset button on the dev board
    • You should see the Marauder title screen appear
Clone this wiki locally