edjubuh / libconsole

Port of LittleKernel's Console to PROS

libconsole

Easy to use console application for PROS projects

libconsole is a convenient console for PROS projects based off travisg's littkernel/lk console application.

Pull requests are welcome to add standard functionality to the console!

Installation

To be done, but:

prosv5 conduct apply libconsole

Note: An unreleased version of PROS kernel is required. Use a template from at least purduesigbots/pros@065b9d4 (this commit has been on develop branch)

Example

#include "main.h"
#include "console/command.h"

/**
 * This macro expands into a function prototype, e.g.
 * static int move_motor(int argc, const cmd_args *argv)
 */
static CONSOLE_COMMAND(move_motor)
{
  if (argc != 3) {
    printf("Invalid number of arguments: %d\n", argc);
    printf("move_motor 1 127");
  }

  /**
   * argv[0] is command name (move_motor)
   * argv[1] is first argument
   * argv[2] is second argument, and so on
   * First argument is motor port, second argument is desired speed
   * Note: if first or second arguments aren't integers, then "argv[x].i" is 0
   *       If you don't trust the user, then you'll need to do sscanf yourself
   *       to convert argv[x].str to whatever format
   */
  Motor(argv[1].i).move(argv[2].i);

  return 0;
}
/**
 * This macro registers the command with console
 * First parameter is function name
 * Second parameter is optional and is help text when running "help" command
 * Third parameter is optional and is command string to use. Function name is default if not provided
 */
STATIC_COMMAND_SINGLE(move_motor);

libconsole's Issues

Support reading/writing files from microSD card

Users could use this feature to write autonomous scripts fully within the libconsole world. The first necessary step would be to be able to read a script from the filesystem.