基于esp32-pico-d4设计的迷你开发板.zip（皆可应用在毕设/课设/大作业/实训/竞赛/项目开发）

# SimpleCLI <p align="center"><img alt="SimpleCLI Logo" src="img/simplecli.gif" width="150"></p> <p align="center"> <b>A Command Line Interface Library for Arduino!</b><br> Add commands to your project without hassle.<br> <br> <a href="https://www.ardu-badge.com/SimpleCLI" target="_blank"><img alt="Ardu Badge for SimpleCLI Library" src="https://www.ardu-badge.com/badge/SimpleCLI.svg"></a><br> <br> 馃惁 <a href="https://twitter.com/spacehuhn">Twitter</a> | 馃摵 <a href="https://www.youtube.com/spacehuhn">YouTube</a> | 馃實 <a href="https://spacehuhn.io">spacehuhn.io</a><br> <br> Support this project and become a patron on <a href="https://patreon.com/spacehuhn">patreon.com/spacehuhn</a>.<br> Also available: <a href="https://www.tindie.com/products/Spacehuhn/spacehuhn-stickers/">Stickers</a></b>! </p>  ## Projects A list of projects that make use of this library: - [The Chicken Man Game](https://github.com/skickar/ChickenManGame) - [Control ESP32 with Command Line Interface Over the Internet](https://www.hackster.io/donowak/control-esp32-with-command-line-interface-over-the-internet-fa9634) - [WiFiDuck](https://github.com/spacehuhn/WiFiDuck) - [ESP8266 Deauther V3](https://github.com/SpacehuhnTech/esp8266_deauther/tree/v3) ## Overview - [About](#about) - [Supported Devices](#supported-devices) - [Installation](#installation) - [Usage](#usage) - [Examples](#examples) - [Include Library](#include-library) - [Create SimpleCLI instance](#create-simplecli-instance) - [Adding Commands](#adding-commands) - [Adding Commands with callback](#adding-commands-with-callback) - [Adding Arguments](#adding-arguments) - [Templates](#templates) - [Parsing Input](#parsing-input) - [Reacting on Commands](#reacting-on-commands) - [Reacting on Errors](#reacting-on-errors) - [Classes & Methods](#classes--methods) - [SimpleCLI](#simplecli) - [CommandType](#commandtype) - [Command](#command) - [CommandErrorType](#commanderrortype) - [CommandError](#commanderror) - [ArgumentType](#argumenttype) - [Argument](#argument) - [License](#license) ## About The goal of this library is to control your Arduino projects using commands similar to the Linux CLI. Because parsing and validating strings in C/C++ can be quite a pain, this library aims to simplify the process as much as possible. ## Supported Devices Strings take up a good amount of memory, so **it's strongly recommended to chose a development board with at least 32 KB RAM**. It doesn't make much sense to run this library on an Uno or Nano, because it will quickly take up a most of the resources. Here's a list of tested hardware (feel free to contribute by making a Pull-Request): | Chipset | Board(s) | Flash | RAM | Support | | ------- | -------- | ----- | --- | ------- | | ATtiny85 | Digispark | 8 KB | 512 Byte | No! (Does not compile C++11) | | ATmega328P | Arduino Nano, Arduino Uno | 32 KB | 2 KB | Works for small projects | | ATmega32u4 | Arduino Leonardo, Pro Micro | 32 KB | 2,560 Byte | Works for small projects | | ATSAMD21G18 | Arduino MKR WiFi 1010 | 256 KB | 32 KB | Yes! | | ATSAMD51G19 | Adafruit ItsyBitsy M4 Express | 512 KB | 192 KB | Yes! | | ESP8266 | NodeMCU, D1 Mini | 512 KB - 16 MB | 80 KB | Yes! | | ESP32 | DSTIKE D-duino-32 | 1 MB - 16 MB |520 KB | Yes! | *Some flash and RAM values depend on the development board or module being used.* ## Installation 1) Click [Download Zip](https://github.com/spacehuhn/SimpleCLI/archive/master.zip) to download the source code from GitHub. 2) Unzip and rename the Folder name to "SimpleCLI". 3) Paste it in your library folder (usually located somewhere at documents/Arduino/libraries). 4) Restart the Arduino IDE. ## Usage [](https://www.youtube.com/watch?v=UyW-wICdnKo) ### Examples Please check out the [example sketches](https://github.com/spacehuhn/SimpleCLI/tree/master/examples/), it's the quickest way to understand how this library works. The following sections are for reference.  ### Include Library ```c++ #include <SimpleCLI.h> ``` ### Create SimpleCLI instance ```c++ SimpleCLI cli; SimpleCLI cli(COMMAND_QUEUE_SIZE, ERROR_QUEUE_SIZE); ``` `COMMAND_QUEUE_SIZE` and `ERROR_QUEUE_SIZE` are `int`s set to 10 commands and 10 errors by default. The oldest command or error will be deleted automatically if the queue gets full. You can most likely ignore the queue sizes, as those are just a safety mechanism and won't be important for most use cases. ### Adding Commands Command names should only contain upper-, lowercase letters and numbers! Recommended are names with only lowercase letters and no numbers. ```c++ // Normal command with a defined number of arguments // For example: echo -str "Hello" -n 3 Command myCommand = cli.addCommand("myCommandName"); Command myCommand = cli.addCmd("myCmdName"); // Single-Argument-Command that saves everything after the command name in the first argument // For example: echo this will be a single string -even with hyphen and in "quotes" // => "this will be a single string -even with hyphen and in "quotes\"" will be the argument value Command mySingleArgumentCommand = cli.addSingleArgumentCommand("mySingleArgumentCommandName"); Command mySingleArgCmd = cli.addSingleArgCmd("mySingleArgCmdName"); // Boundless-Command that accepts any amount of arguments separated by spaces // For example: sum 1 2 3 // => "1", "2", "3" will the argument values Command myBoundlessCommand = cli.addBoundlessCommand("myBoundlessCommandName"); Command myBoundlessCmd = cli.addBoundlessCmd("myBoundlessCmdName"); ``` ### Adding Commands with callback Sometimes it's useful to give the command a callback function that will be executed automatically when the command was entered. You must define these callback functions as a global void function with a `cmd` pointer as shown here: ```c++ void myCallback(cmd* commandPointer) { Command cmd(commandPointer); // Create wrapper class instance for the pointer // .. } ``` Now you can create a command and pass it the function pointer: ```c++ Command myCommand = cli.addCommand("myCommandName", myCallback); Command myCommand = cli.addBoundlessCommand("myCommandName", myCallback); Command myCommand = cli.addSingleArgumentCommand("myCommandName", myCallback); Command myCommand = cli.addCmd("myCommandName", myCallback); Command myCommand = cli.addBoundlessCmd("myCommandName", myCallback); Command myCommand = cli.addSingleArgCmd("myCommandName", myCallback); ``` ### Adding Arguments Keep in mind that you can only add arguments to `Command`s and **not** to `SingleArgumentCommand`s and `BoundlessCommand`s. ```c++ // myCommandName -argumentName "argumentValue" Argument myArg = myCommand.addArgument("argumentName"); Argument myArg = myCommand.addArg("argumentName"); // Giving the argument a default value, means that the user does not have to specify the argument // myCommandName // myCommandName -argumentName "argumentValue" Argument myArg = myCommand.addArgument("argumentName", "DefaultValue"); Argument myArg = myCommand.addArg("argumentName", "DefaultValue"); // Positional arguments have a certain position and do not have to be named // myCommandName "argumentValue" // myCommandName -argumentName "argumentValue" Argument myArg = myCommand.addPositionalArgument("argumentName"); Argument myArg = myCommand.addPosArg("argumentName"); // Those can also have default values // myCommandName // myCommandName "argumentValue" // myCommandName -argumentName "argumentValue" Argument myArg = myCommand.addPositionalArgument("argumentName", "DefaultValue"); Argument myArg = myCommand.addPosArg("argumentName", "DefaultValue"); // Flag arguments can either be specified (set) or not, but they don't accept any value // myCommandName // myCommandName -argumentName Argument myAr