Merge branch 'master' of github.com:buxtronix/arduino

Author: buxtronix

libraries/Cli/cli.cpp renamed to libraries/Cli/Cli.cpp

@@ -1,7 +1,7 @@
 /* Cli library for Arduino */
 
 #include "Arduino.h"
-#include "cli.h"
+#include "Cli.h"
 #include <string.h>
 
 
@@ -25,7 +25,7 @@ void Cli::addChar(char c) {
     _parseAndRun();
     return;
   }
-  if (c == 0x8) {
+  if (c == 0x8 || c == 0x7F) {
     if (_cliBufferLength > 0) {
       _cliBuffer[--_cliBufferLength] = '\0';
       printfunc->print("\010 \010");
@@ -59,8 +59,8 @@ unsigned char len = 0;
   return len;
 }
 
-char Cli::atoi(char *s) {
-  char value = 0;
+int Cli::atoi(char *s) {
+  int value = 0;
   int mult = 1;  
   char *end = &s[_strlen(s)];
   while (end != s) {
@@ -105,7 +105,14 @@ char *ptr;
   return _argBuffer;
 }
 
-void Cli::_help() {
+// Returns the nth arg on the command line parsed as an int (0 is the command).
+int Cli::getArgi(char n) {
+  char *arg = getArg(n);
+  return atoi(arg);
+}
+
+// Displays help - all of the available commands.
+void Cli::help() {
     printfunc->println("Command help:");
     for (unsigned char i = 0 ; i < ncommands ; i++) {
       printfunc->write(' ');
@@ -126,7 +133,7 @@ unsigned char i;
     return;
   }
   if (_strlen(_cliBuffer) == 1 && _strncmp("?", _cliBuffer, 1)) {
-    _help();
+    help();
     return;
   }
 
@@ -139,7 +146,7 @@ unsigned char i;
     Command c = commands[i];
     if (_strlen(_commandBuffer) == _strlen(c.name) &&
         _strncmp(_commandBuffer, c.name, _strlen(c.name))) {
-      c.run();
+      runFunc(c);
       _clear();
       printfunc->print(prompt);
       return;
@@ -150,3 +157,16 @@ unsigned char i;
   printfunc->println("Unknown command. '?' for help.");
   printfunc->print(prompt);
 }
+
+// Runs the command, if the number of args matches.
+void Cli::runFunc(Command c) {
+  if (c.args > 0 && getArg(c.args)[0] == '\0') {
+    printfunc->print("Command '");
+    printfunc->print(c.name);
+    printfunc->print("' requires ");
+    printfunc->print((int)c.args);
+    printfunc->println(" arguments.");
+    return;
+  }
+  c.run();
+}

libraries/Cli/cli.h renamed to libraries/Cli/Cli.h

@@ -24,6 +24,8 @@ struct Command {
   const char *name;
   // Help text associated with the command.
   const char *help;
+  // Number of arguments required after the command.
+  const char args;
   // The function to run when the command is run.
   CommandProc run;
 };
@@ -40,10 +42,14 @@ class Cli
     void addChar(char c);
     /* Used by the command's function to get the command argument at position n */
     char *getArg(char n);
+    /* Similar to above, but parses the arg as an integer. */
+    int getArgi(char n);
     /* Fetch a pointer to the start of the command's arguments. */
     char *getArg();
-    /* Converts the given string to a signed char. */
-    char atoi(char *);
+    /* Converts the given string to a signed int. */
+    int atoi(char *);
+    // Display help.
+    void help(void);
     /* The printable function */
     Print *printfunc;
     /* The valid commands in this cli. */
@@ -70,8 +76,8 @@ class Cli
     char _strncmp(const char *, const char *, char);
     // When enter is pressed, run the command.
     void _parseAndRun();
-    // Display help.
-    void _help(void);
+    // Run the function that was found.
+    void runFunc(Command);
 };
 
 #endif

libraries/Cli/examples/arduino_cli/arduino_cli.ino

@@ -0,0 +1,113 @@
+/*
+ * Demonstrates use of the Cli library.
+ *
+ * The print function here is just the built in Serial module, so user i/o
+ * is via this.
+ */
+#include <Cli.h>
+#include <stdio.h>
+
+// Setup for being able to use "printf".
+static FILE uartout = {0};
+
+// Initialise the Cli with the given prompt.
+const char *prompt = "arduino> ";
+Cli *cli;
+
+/* This is where all of the commands are defined.
+ * Each entry contains four parameters:
+ * 1. The command that the user enters.
+ * 2. The help string displayed to the user.
+ * 3. Minimum number of arguments required.
+ * 4. A pointer to the function called when the command is entered.
+ */
+Command commands[7] = {
+  {"dl", "Sleep for given number of seconds", 1, &delay_func},
+  {"ms", "Show Arduino millis() value.", 0, &millis_func},
+  {"reset", "Reset the Arduino.", 0, &reset_func},
+  {"dw", "Write a value to a digital pin. [pin] [0|1]", 2, &write_func},
+  {"dr", "Read digital value from a pin.", 1, &read_func},
+  {"aw", "Write a value to an analog pin. [pin] [0-255]", 2, &awrite_func},
+  {"ar", "Read analogue value from a pin.", 1, &aread_func},
+};
+// Number of commands above.
+char ncommands = 7;
+
+// putchar method for "printf" (http://playground.arduino.cc/Main/Printf)
+static int uart_putchar(char c, FILE *stream) {
+  Serial.write(c);
+  return 0;
+}
+
+void setup() {
+  // Setup for printf to work.
+  fdev_setup_stream(&uartout, uart_putchar, NULL, _FDEV_SETUP_WRITE);
+  stdout = &uartout;
+  
+  // Initialise the serial port.
+  Serial.begin(57600);
+  // Initialise the Cli module with the commands defined above.
+  cli  = new Cli(prompt, &Serial);
+  cli->commands = commands;
+  cli->ncommands = ncommands;
+  // Show some initial help.
+  cli->help();
+}
+
+void loop() {
+  // Read characters from the serial port and pass them to the Cli module.
+  if (Serial.available()) {
+    cli->addChar(Serial.read());
+  }
+}
+
+// Handler for the "millis" command.
+void millis_func() {
+  printf("Millis: %ld\r\n", millis());
+}
+
+// Handler for the "reset" command.
+void(* resetFunc)(void) = 0;
+void reset_func() {
+  Serial.println("Resetting...");
+  Serial.flush();
+  resetFunc();
+}
+
+// Delay function.
+void delay_func() {
+  int value = cli->getArgi(1);
+  printf("Sleeping for %d millis...\r\n", value);
+  delay(value);
+}
+
+// Pin write function.
+void write_func() {
+  char pin = cli->getArgi(1);
+  char value = cli->getArgi(2);
+  pinMode(pin, OUTPUT);
+  digitalWrite(pin, value);
+  printf("Wrote %d to pin %d\r\n", value, pin);
+}
+
+// Pin read function.
+void read_func() {
+  char pin = cli->getArgi(1);
+  pinMode(pin, INPUT);
+  printf("Value on pin %d: %d\r\n", pin, digitalRead(pin));
+}
+
+// Analog write function.
+void awrite_func() {
+  char pin = cli->getArgi(1);
+  int value = cli->getArgi(2);
+  pinMode(pin, OUTPUT);
+  analogWrite(pin, value);
+  printf("Write PWM %d to pin %d\r\n", value, pin);
+}
+
+// Analog read function.
+void aread_func() {
+  char pin = cli->getArgi(1);
+  printf("Value on pin %d: %d\r\n", pin, analogRead(pin));
+}

libraries/Rotary/Rotary.cpp

@@ -61,7 +61,7 @@
  */
 
 #include "Arduino.h"
-#include "rotary.h"
+#include "Rotary.h"
 
 /*
  * The below state table has, for each state (row), the new state