Added new examples: RGB Led and Ethernet Shield Example

geekfactory · geekfactory · commit 4f830e6d4a2f · 2015-02-08T22:07:34.000-06:00
diff --git a/examples/Shell_Basic/Shell_Basic.ino b/examples/Shell_Basic/Shell_Basic.ino
@@ -1,21 +1,15 @@
 /**
- * SIMPLE EXAMPLE OF COMMAND SHELL LIBRARY
- * 
- * This library implements a command line interface. The experience is similar to the windows
- * command prompt. This library can invoke functions when a specific string is received, in this
- * example we register 2 commands that can be executed by typing their names on the arduino serial
- * monitor (using the hardware UART).
- * 
- * The "shell" library is designed to be independent of the communication channel, this means
- * that it can be used with serial, softSerial and even TCP connections. For this reason the
- * shell library requires 2 pointers to functions to read and write characters to and from the
- * physical transmission media.
- * 
- * Arguments can be passed to the programs that are invoked by the command line and parsed by
- * standard string parsing functions, or you can write your own functions. The arguments
- * are passed as pointers to characters (null terminated strings) in a similar way that you
- * would receive them on any command line tool written in C. Each parameter is separated by
- * a "space" character after the command name.
+ * GeekFactory - "Construye tu propia tecnologia"
+ * Distribucion de materiales para el desarrollo e innovacion tecnologica
+ * www.geekfactory.mx
+ *
+ * Ejemplo de libreria Shell. Este ejemplo representa la configuracion minima
+ * requerida para implementar la funcionalidad de interfaz de comandos. En esta
+ * ocasion registramos 2 comandos y enviamos texto como respuesta a cada uno.
+ *
+ * Example for Shell library. This example shows the minimum setup needed to
+ * implement a command line interface. This time we register 2 commands and we
+ * send text as response for each command.
  */
 
 #include <Shell.h>
@@ -48,7 +42,7 @@ void loop()
  * They receive 2 parameters: The total count of arguments (argc) and a pointer 
  * to the begining of each one of the null-terminated argument strings.
  *
- + In this example we ignore the parameters passed to the functions
+ * In this example we ignore the parameters passed to the functions
  */
 int command_mycommand(int argc, char** argv)
 {
@@ -81,7 +75,7 @@ int shell_reader(char * data)
 
 /**
  * Function to write data to serial port
- * Functions to write to physical media should use this prototype
+ * Functions to write to physical media should use this prototype:
  * void my_writer_function(char data)
  */
 void shell_writer(char data)
diff --git a/examples/Shell_Command_Args/Shell_Command_Args.ino b/examples/Shell_Command_Args/Shell_Command_Args.ino
@@ -1,22 +1,15 @@
-
 /**
- * SIMPLE EXAMPLE OF COMMAND SHELL LIBRARY
- * 
- * This library implements a command line interface. The experience is similar to the windows
- * command prompt. This library can invoke functions when a specific string is received, in this
- * example we register 2 commands that can be executed by typing their names on the arduino serial
- * monitor (using the hardware UART).
- * 
- * The "shell" library is designed to be independent of the communication channel, this means
- * that it can be used with serial, softSerial and even TCP connections. For this reason the
- * shell library requires 2 pointers to functions to read and write characters to and from the
- * physical transmission media.
- * 
- * Arguments can be passed to the programs that are invoked by the command line and parsed by
- * standard string parsing functions, or you can write your own functions. The arguments
- * are passed as pointers to characters (null terminated strings) in a similar way that you
- * would receive them on any command line tool written in C. Each parameter is separated by
- * a "space" character after the command name.
+ * GeekFactory - "Construye tu propia tecnologia"
+ * Distribucion de materiales para el desarrollo e innovacion tecnologica
+ * www.geekfactory.mx
+ *
+ * Ejemplo de libreria Shell. En este ejemplo se ilustra la recepcion y manejo
+ * de los parametros recibidos por el comando. Se imprimen cada uno de los
+ * argumentos recibidos as� como la longitud de cada una de las cadenas.
+ *
+ * Example for Shell library. This example shows the reception and handling of
+ * arguments received by command programs. The arguments are printed along with
+ * the string lenghts.
  */
 
 #include <Shell.h>
@@ -80,7 +73,7 @@ int shell_reader(char * data)
 
 /**
  * Function to write data to serial port
- * Functions to write to physical media should use this prototype
+ * Functions to write to physical media should use this prototype:
  * void my_writer_function(char data)
  */
 void shell_writer(char data)
diff --git a/examples/Shell_IO_Control/Shell_IO_Control.ino b/examples/Shell_IO_Control/Shell_IO_Control.ino
@@ -1,23 +1,3 @@
-/**
- * SIMPLE EXAMPLE OF COMMAND SHELL LIBRARY
- * 
- * This library implements a command line interface. The experience is similar to the windows
- * command prompt. This library can invoke functions when a specific string is received, in this
- * example we register 2 commands that can be executed by typing their names on the arduino serial
- * monitor (using the hardware UART).
- * 
- * The "shell" library is designed to be independent of the communication channel, this means
- * that it can be used with serial, softSerial and even TCP connections. For this reason the
- * shell library requires 2 pointers to functions to read and write characters to and from the
- * physical transmission media.
- * 
- * Arguments can be passed to the programs that are invoked by the command line and parsed by
- * standard string parsing functions, or you can write your own functions. The arguments
- * are passed as pointers to characters (null terminated strings) in a similar way that you
- * would receive them on any command line tool written in C. Each parameter is separated by
- * a "space" character after the command name.
- */
-
 #include <Shell.h>
 
 void setup()
@@ -73,9 +53,9 @@ int command_ioctrl(int argc, char** argv)
       shell_println("Arguments in square brackets [ ] are mandatory; arguments in curly brackets { } are optional");
       shell_println("");
       shell_println("AVAILABLE SWITCHES:");
-      shell_println("  -p [PIN NUMBER]     -> \"Sets\" the pin to perform other operations on the pin");
-      shell_println("  -m [INPUT / OUTPUT] -> \"Configures\" PIN mode as input or output");
-      shell_println("  -w [LOW / HIGH]     -> \"Writes\" a digital output value: LOW or HIGH state");
+      shell_println("  -p [PIN_NUMBER]     -> \"Sets\" the pin (PIN_NUMBER) to perform other operations on the pin");
+      shell_println("  -m [INPUT|OUTPUT]   -> \"Configures\" PIN mode as INPUT or OUTPUT");
+      shell_println("  -w [LOW|HIGH]       -> \"Writes\" a digital output value LOW or HIGH");
       shell_println("  -r                  -> \"Reads\" the state of a digital input or output");
       shell_println("  -help               -> Shows this help message");
       shell_println("");
diff --git a/examples/Shell_Minimum/Shell_Minimum.ino b/examples/Shell_Minimum/Shell_Minimum.ino
@@ -1,7 +1,13 @@
 /**
- * SIMPLE EXAMPLE OF COMMAND SHELL LIBRARY
- * 
- * Minimal program to setup the library and read / write to serial port
+ * GeekFactory - "Construye tu propia tecnologia"
+ * Distribucion de materiales para el desarrollo e innovacion tecnologica
+ * www.geekfactory.mx
+ *
+ * Ejemplo de libreria Shell. Este ejemplo representa la configuracion minima
+ * requerida para implementar la funcionalidad de interfaz de comandos.
+ *
+ * Example for Shell library. This example shows the minimum setup needed to
+ * implement a command line interface.
  */
 
 #include <Shell.h>
@@ -53,12 +59,11 @@ int shell_reader(char * data)
 
 /**
  * Function to write data to serial port
- * Functions to write to physical media should use this prototype
+ * Functions to write to physical media should use this prototype:
  * void my_writer_function(char data)
  */
 void shell_writer(char data)
 {
   // Wrapper for Serial.write() method
   Serial.write(data);
 }
-
diff --git a/examples/Shell_RGB_Control/Shell_RGB_Control.ino b/examples/Shell_RGB_Control/Shell_RGB_Control.ino
@@ -0,0 +1,97 @@
+/**
+ * GeekFactory - "Construye tu propia tecnologia"
+ * Distribucion de materiales para el desarrollo e innovacion tecnologica
+ * www.geekfactory.mx
+ *
+ * Ejemplo de libreria Shell. Este ejemplo permite controlar el color mostrado
+ * en un led RGB conectado a los pines PWM mediante comandos de texto. El programa
+ * admite 3 parametros de 0 a 255 que representan la intensidad de cada led (RGB).
+ *
+ * Example for Shell library. This example controls the color displayed on the RGB
+ * led connected to PWM pins using text commands. The program accepts 3 parameters
+ * in a range from 0 to 255 that represent the intensity of each led.
+ */
+
+#include <Shell.h>
+
+void setup()
+{
+  // Prepare serial communication
+  Serial.begin(9600);
+  // Wait after reset or power on...
+  delay(1000);
+
+  // Pins to connect RGB led (PWM outputs)
+  pinMode(3,OUTPUT);
+  pinMode(5,OUTPUT);
+  pinMode(6,OUTPUT);
+
+  // Initialize command line interface (CLI)
+  // We pass the function pointers to the read and write functions that we implement below
+  // We can also pass a char pointer to display a custom start message
+  shell_init(shell_reader, shell_writer, 0);
+
+  // Add commands to the shell
+  shell_register(command_rgbled, "rgbled");
+}
+
+void loop()
+{
+  // This should always be called to process user input
+  shell_task();
+}
+
+/**
+ * This function implements the rgbled command and parses the required args
+ * Type: rgbled 255 255 255 to set led to maximum brigtness
+ * Type: rgbled 0 0 0 to set led to minimum brightess
+ */
+int command_rgbled(int argc, char** argv)
+{
+  // Variables that store parameter values
+  uint8_t val_R, val_G, val_B;
+
+  // Parse RGB values and write to PWM pins
+  val_R = strtol(argv[1],NULL,0);
+  analogWrite(3, val_R);
+
+  val_G = strtol(argv[2],NULL,0);
+  analogWrite(5, val_G);
+
+  val_B = strtol(argv[3],NULL,0);
+  analogWrite(6, val_B);
+
+  // Print the received falues to the terminal screen
+  shell_printf("#RGB-COMPONENTS:%d,%d,%d\r\n", val_R, val_G, val_B);
+
+  // Return success code
+  return SHELL_RET_SUCCESS;
+}
+
+/**
+ * Function to read data from serial port
+ * Functions to read from physical media should use this prototype:
+ * int my_reader_function(char * data)
+ */
+int shell_reader(char * data)
+{
+  // Wrapper for Serial.read() method
+  if (Serial.available()) {
+    *data = Serial.read();
+    return 1;
+  }
+  return 0;
+}
+
+/**
+ * Function to write data to serial port
+ * Functions to write to physical media should use this prototype:
+ * void my_writer_function(char data)
+ */
+void shell_writer(char data)
+{
+  // Wrapper for Serial.write() method
+  Serial.write(data);
+}
+
+
diff --git a/examples/Shell_Telnet/Shell_Telnet.ino b/examples/Shell_Telnet/Shell_Telnet.ino
