Clean up of examples

Author: nseidle

libraries/CoreTesting/examples/Advanced/ClassFunctions/ClassFunctions.ino

@@ -0,0 +1,47 @@
+/* Author: Owen Lyke
+  Created: May 2 2019
+  License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+  This example demonstrates how to use Arduino HardwareSerial class functions
+  Uart objects inherit from HardwareSerial. Declare a Uart object with the following parameters:
+  Uart myUart(instance, rx, tx, rts, cts)
+    instance: either 0 or 1, corresponding to uart0 or uart1 in the Apollo3
+    rx pin: (opt.) the *pin* number to use for rx. must map to a valid rx pad on the apollo3 for the uart instance
+    tx pin: (opt.) the *pin* number to use for tx. must map to a valid tx pad on the apollo3 for the uart instance
+    rts pin: (opt.) the *pin* number to use for rts. must map to a valid rts pad on the apollo3 for the uart instance
+    cts pin: (opt.) the *pin* number to use for cts. must map to a valid cts pad on the apollo3 for the uart instance
+  pin* means the variant's pin number, as opposed to the Apollo3 pad number. The provided number is mapped using the variant's pin map
+  Use AP3_UART_PIN_UNUSED if a particular function is unnecessary
+  Board-standard Uart objects can be declared in the variant configuration (variant.h and variant.cpp)
+
+  For example, this is the definition of Serial found in the SparkFun Edge variant
+  Uart Serial(0, 49, 48);
+*/
+
+#define SERIAL_PORT Serial
+
+void setup() {
+
+  SERIAL_PORT.begin(115200);
+
+  while (!SERIAL_PORT) {}; // todo: right now this falls straight through
+
+  SERIAL_PORT.println("SparkFun Arduino Apollo3 Serial Example");
+  SERIAL_PORT.printf("Compiled on %s, %s\n\n", __DATE__, __TIME__); // Look! You can use printf, if you so choose
+
+  SERIAL_PORT.print("Your Apollo3 variant has ");
+  SERIAL_PORT.print(AP3_VARIANT_NUM_PINS);
+  SERIAL_PORT.println(" pins.");
+  SERIAL_PORT.println();
+}
+
+void loop() {
+
+  if (SERIAL_PORT.available()) {
+    while (SERIAL_PORT.available()) {
+      char c = SERIAL_PORT.read();
+      SERIAL_PORT.write(c);
+    }
+  }
+
+}

libraries/CoreTesting/examples/example3_global_object_constructors/example3_global_object_constructors.ino renamed to libraries/CoreTesting/examples/Advanced/GlobalObjectConstructors/GlobalObjectConstructors.ino

@@ -8,6 +8,9 @@
 
   This example shows how to read an analog voltage from various ADC enabled pins.
 
+  Some boards have A0, A1, etc. Some boards have A23, A35, etc. Be sure to
+  select the correct board from the boards menu and modify the code to match those pins.
+
   Feel like supporting open source hardware?
   Buy a board from SparkFun!
   SparkFun Edge: https://www.sparkfun.com/products/15170
@@ -16,17 +19,15 @@
   Connect an Edge via programmer
   Upload code
   Use a trimpot or other device to send a 0 to 3V (no 5V!) signal to pin 'A16'
-  Max reading on ADC is 2V
+  ADC can resolve up to 2V but is 3.3V safe
 */
 
-#define LED 13 //Status LED
+#define LED 13 //Status LED on Artemis BlackBoard
 
 void setup() {
   Serial.begin(9600);
   Serial.println("SparkFun Arduino Apollo3 Analog Read example");
 
-  delay(100);
-
   pinMode(LED, OUTPUT);
 
   //analogReadResolution(14); //Set resolution to 14 bit
@@ -37,49 +38,29 @@ void loop() {
   digitalWrite(LED, LOW);
 
   int myValue1 = analogRead(A1); //Automatically sets pin to analog input
-  Serial.print(" left val: ");
+  Serial.print("A1: ");
   Serial.print(myValue1);
 
-  int myValue2 = analogRead(A3);
-  Serial.print(" right val: ");
-  Serial.print(myValue2);
-
-  int a5 = analogRead(A5);
-  Serial.print(" A5: ");
-  Serial.print(a5);
-
   int internalTemp = analogRead(ADC_TEMP); //Read internal temp sensor. 3.8mV/C, +/-3C
-  Serial.print(" internalTemp: ");
+  Serial.print("\tinternalTemp: ");
   Serial.print(internalTemp);
 
   int vss = analogRead(ADC_VSS); //Read internal VSS
-  Serial.print(" vss: ");
+  Serial.print("\tvss: ");
   Serial.print(vss);
 
   //TODO enable battload
   int div3 = analogRead(ADC_DIV3); //Read VCC across a 1/3 resistor divider
-  Serial.print(" VCC/3: ");
+  Serial.print("\tVCC/3: ");
   Serial.print(div3);
 
-  //  float vcc = (float)div3 * 6 / 1024.0; //Convert 1/3 VCC to VCC
-  //  Serial.print(" VCC: ");
-  //  Serial.print(vcc, 2);
-  //  Serial.print("V");
+  float vcc = (float)div3 * 6 / 1024.0; //Convert 1/3 VCC to VCC
+  Serial.print(" VCC: ");
+  Serial.print(vcc, 2);
+  Serial.print("V");
 
   //pinMode(A4, OUTPUT); //Reset analog function to false.
 
-  //Todo: test overall read time
-  /*long startTime = millis();
-    uint32_t total = 0;
-    for(int x = 0 ; x < 100 ; x++)
-    {
-    total += analogRead(16);
-    }
-    Serial.print(" total: ");
-    Serial.print(total);
-    Serial.print(" totalTime: ");
-    Serial.print( (millis() - startTime) / 100);*/
-
   Serial.println();
 
   digitalWrite(LED, HIGH);

libraries/CoreTesting/examples/Example7_analogRead/Example7_analogRead.ino

@@ -0,0 +1,22 @@
+/* Auzhor: Owen Lyke
+/ Created: May 13 2019
+ License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+ This example demonstrates how to use millis() and micros()
+*/
+
+void setup() {
+
+  Serial.begin(9600);
+
+  while(!Serial){}; //Wait for user to open terminal window
+
+  Serial.println("SparkFun Arduino Apollo3 STimer Example");
+  Serial.printf("Compiled on %s, %s\n\n", __DATE__, __TIME__);
+}
+
+void loop()
+{
+  Serial.printf("Sec: %d, millis: %d, micros: %d, systicks: 0x%08X, sysoverflows: 0x%08X\n", seconds(), millis(), micros(), systicks(), sysoverflows());
+  delay(1111); //Arbitrary delay
+}

libraries/CoreTesting/examples/Example8_millis/Example8_millis.ino

@@ -1,56 +1,16 @@
-// Author: Owen Lyke
-// Created: April 2 2019
-// License: MIT. See SparkFun Arduino Apollo3 Project for more information
+/* Author: Owen Lyke
+ Created: April 2 2019
+ License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
-// This example demonstrates that the IDE is able to compile the Ambiq Apollo3 HAL
-// Turn on verbose output and find the output path (i.e. ~/arduino_build_######/example0_compilation.ino.bin)
-// Use the Ambiq SDK + tools to upload the binary to your microcontroller
-
-static int boardSetup(void);
+ This example demonstrates that the IDE is able to compile the Ambiq Apollo3 HAL
+ Turn on verbose output and find the output path (i.e. ~/arduino_build_######/example0_compilation.ino.bin)
+ Use the Ambiq SDK + tools to upload the binary to your microcontroller
+*/
 
 void setup() {
   // put your setup code here, to run once:
-  boardSetup();
-
-  am_util_stdio_terminal_clear();
-
-  am_util_stdio_printf("SparkFun Arduino Apollo3 Compilation Test\n");
-  am_util_stdio_printf("Compiled on %s, %s\n\n", __DATE__, __TIME__);
-  am_bsp_uart_string_print("Hello, World!\r\n");  // Sting_print has less overhead than printf (and less risky behavior since no varargs)
 }
 
 void loop() {
   // put your main code here, to run repeatedly:
-
-}
-
-static int boardSetup(void)
-{
-    // Set the clock frequency.
-    am_hal_clkgen_control(AM_HAL_CLKGEN_CONTROL_SYSCLK_MAX, 0);
-
-    // Set the default cache configuration
-    am_hal_cachectrl_config(&am_hal_cachectrl_defaults);
-    am_hal_cachectrl_enable();
-
-    // Configure the board for low power operation.
-    am_bsp_low_power_init();
-
-    // Initialize the printf interface for ITM/SWO output.
-    am_bsp_uart_printf_enable(); // Enable UART - will set debug output to UART
-    //am_bsp_itm_printf_enable(); // Redirect debug output to SWO
-
-    // Setup LED's as outputs
-    am_hal_gpio_pinconfig(AM_BSP_GPIO_LED_RED, g_AM_HAL_GPIO_OUTPUT_12);
-    am_hal_gpio_pinconfig(AM_BSP_GPIO_LED_BLUE, g_AM_HAL_GPIO_OUTPUT_12);
-    am_hal_gpio_pinconfig(AM_BSP_GPIO_LED_GREEN, g_AM_HAL_GPIO_OUTPUT_12);
-    am_hal_gpio_pinconfig(AM_BSP_GPIO_LED_YELLOW, g_AM_HAL_GPIO_OUTPUT_12);
-
-    // Turn on the LEDs
-    am_hal_gpio_output_set(AM_BSP_GPIO_LED_RED);
-    am_hal_gpio_output_set(AM_BSP_GPIO_LED_BLUE);
-    am_hal_gpio_output_set(AM_BSP_GPIO_LED_GREEN);
-    am_hal_gpio_output_set(AM_BSP_GPIO_LED_YELLOW);
-
-    return 0;
 }

libraries/CoreTesting/examples/example0_compilation/example0_compilation.ino

@@ -1,26 +1,26 @@
-// Author: Owen Lyke
-// Created: April 9 2019
-// License: MIT. See SparkFun Arduino Apollo3 Project for more information
+/* Author: Owen Lyke
+ Created: April 9 2019
+ License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
-// This example demonstrates usage of:
-// pinMode
-// delay
+ This example demonstrates usage of:
+ pinMode
+ delay
+*/
 
-void setup() {
-  // put your setup code here, to run once:
-  am_util_stdio_terminal_clear();
+//Various boards have status LEDs on different pins
+//Most have LED_BUILTIN defined so just use that
+//But if you want, you can blink any pin
+
+//#define blinkPin 37
+#define blinkPin LED_BUILTIN
 
-  am_util_stdio_printf("SparkFun Arduino Apollo3 Blink Example\n");
-  am_util_stdio_printf("Compiled on %s, %s\n\n", __DATE__, __TIME__);
-  am_bsp_uart_string_print("Hello, World!\r\n");  // Sting_print has less overhead than printf (and less risky behavior since no varargs)
-  
-  pinMode(37, OUTPUT);
+void setup() {
+  pinMode(blinkPin, OUTPUT);
 }
 
 void loop() {
-  // put your main code here, to run repeatedly:
-  digitalWrite(37, LOW);
+  digitalWrite(blinkPin, LOW);
   delay(1000);
-  digitalWrite(37, HIGH);
+  digitalWrite(blinkPin, HIGH);
   delay(1000);
 }

libraries/CoreTesting/examples/example1_blink/example1_blink.ino

@@ -1,46 +1,58 @@
-// Author: Owen Lyke
-// Created: May 2 2019
-// License: MIT. See SparkFun Arduino Apollo3 Project for more information
-
-// This example demonstrates how to use Arduino HardwareSerial class functions
-// Uart objects inherit from HardwareSerial. Declare a Uart object with the following parameters:
-// Uart myUart(instance, rx, tx, rts, cts)
-//    instance: either 0 or 1, corresponding to uart0 or uart1 in the Apollo3
-//    rx pin: (opt.) the *pin* number to use for rx. must map to a valid rx pad on the apollo3 for the uart instance 
-//    tx pin: (opt.) the *pin* number to use for tx. must map to a valid tx pad on the apollo3 for the uart instance 
-//    rts pin: (opt.) the *pin* number to use for rts. must map to a valid rts pad on the apollo3 for the uart instance 
-//    cts pin: (opt.) the *pin* number to use for cts. must map to a valid cts pad on the apollo3 for the uart instance 
-// *pin* means the variant's pin number, as opposed to the Apollo3 pad number. The provided number is mapped using the variant's pin map
-// Use AP3_UART_PIN_UNUSED if a particular function is unnecessary
-// Board-standard Uart objects can be declared in the variant configuration (variant.h and variant.cpp)
-
-// For example, this is the definition of Serial found in the SparkFun Edge variant
-//Uart Serial(0, 49, 48);
-
-#define SERIAL_PORT Serial
+/* Author: Nathan Seidle
+  Created: June 12th, 2019
+  License: MIT. See SparkFun Arduino Apollo3 Project for more information
+
+  This example demonstrates usage of:
+  Serial
+  Serial1
+*/
 
 void setup() {
+  Serial.begin(9600);
+  Serial.println("Hello debug window!");
+
+  Serial1.begin(115200);
+  Serial1.println("This prints on TX1/RX1 pins");
+}
 
-  SERIAL_PORT.begin(115200);
+void loop() {
+  Serial.println("Time for a menu:");
+  Serial.println("a) Activate the cheese");
+  Serial.println("x) Exit");
+  Serial.println();
 
-    while(!SERIAL_PORT){}; // todo: right now this falls straight through
+  while (Serial.available() == true) Serial.read(); //Read any characters that may be sitting in the RX buffer before we wait for user input
 
-  SERIAL_PORT.println("SparkFun Arduino Apollo3 Serial Example");
-  SERIAL_PORT.printf("Compiled on %s, %s\n\n", __DATE__, __TIME__); // Look! You can use printf, if you so choose
+  while (Serial.available() == false) delay(1); //Wait for user input
 
-  SERIAL_PORT.print("Your Apollo3 variant has ");
-  SERIAL_PORT.print(AP3_VARIANT_NUM_PINS);
-  SERIAL_PORT.println(" pins.");
-  SERIAL_PORT.println();
-}
+  char incoming = Serial.read();
 
-void loop() {
+  if (incoming == 'a' || incoming == 'A')
+  {
+    Serial.println("How many cheeses to dispense?");
 
-  if(SERIAL_PORT.available()){
-    while(SERIAL_PORT.available()){
-      char c = SERIAL_PORT.read();
-      SERIAL_PORT.write(c);
+    while (Serial.available() == true) Serial.read(); //Read any characters that may be sitting in the RX buffer before we wait for user input
+
+    while (Serial.available() == false); //Wait for user to type a number
+    unsigned int cheeseCount = Serial.parseInt(); //That's a lot of potential cheese
+
+    //Print to second serial port
+    for (unsigned int x ; x < cheeseCount ; x++)
+    {
+      Serial1.println("Cheese!");
     }
-  }
 
+    Serial.printf("Thank you. %d cheeses dispensed.\n\r", cheeseCount); //Did you see that?! We used printf!
+  }
+  else if (incoming == 'x' || incoming == 'X')
+  {
+    Serial.println("Exiting... Have a nice day.");
+    while (1); //Freeze
+  }
+  else
+  {
+    Serial.print("Unknown choice: ");
+    Serial.write(incoming);
+    Serial.println();
+  }
 }