thinking through deep sleep stuff

2 files changed, 99 insertions, 36 deletions

diff --git a/Sensor Watch Starter Project/app.c b/Sensor Watch Starter Project/app.c
index eb862767..30c1b8ea 100644
--- a/Sensor Watch Starter Project/app.c
+++ b/Sensor Watch Starter Project/app.c
@@ -1,11 +1,11 @@
 #include <stdio.h>
 #include <string.h>
+#include "watch.h"
 #include "app.h"
 
-// these are implemented in main.c, just want to have access to them here.
-void uart_putc(char c);
-void uart_puts(char *s);
-
+//////////////////////////////////////////////////////////////////////////////////////////
+// This section sets up types and storage for our application state.
+// You can tear this out and replace it with whatever you want.
 typedef enum ApplicationMode {
     MODE_HELLO = 0,
     MODE_THERE
@@ -21,35 +21,64 @@ typedef enum LightColor {
 typedef struct ApplicationState {
     ApplicationMode mode;
     LightColor color;
+    uint8_t wake_count;
 } ApplicationState;
 
 ApplicationState applicationState;
 
-void cb_light_pressed() {
-    applicationState.color = (applicationState.color + 1) % 4;
+
+//////////////////////////////////////////////////////////////////////////////////////////
+// This section defines the callbacks for our button press events (implemented at bottom).
+// Add any other callbacks you may need either here or in another file.
+void cb_light_pressed();
+void cb_mode_pressed();
+void cb_alarm_pressed();
+
+
+//////////////////////////////////////////////////////////////////////////////////////////
+// This section contains the required functions for any watch app. You should tear out
+// all the code in these functions when writing your app, but you must implement all
+// of the functions, even if they are empty stubs. You can also replace the documentation
+// lines with documentation that describes what your functions do!
+
+/**
+ * @brief the app_init function is called before anything else. Use it to set up any
+ * internal data structures or application state required by your app.
+ */
+void app_init() {
+    memset(&applicationState, 0, sizeof(applicationState));
 }
 
-void cb_mode_pressed() {
-    applicationState.mode = (applicationState.mode + 1) % 2;
+/**
+ * @brief the app_wake_from_deep_sleep function is only called if your app is waking from
+ * the ultra-low power BACKUP sleep mode. You may have chosen to store some state in the
+ * RTC's backup registers prior to entering this mode. You may restore that state here.
+ *
+ * @see watch_enter_deep_sleep()
+ */
+void app_wake_from_deep_sleep() {
+    // TODO: deep sleep demo
 }
 
 /**
- * @brief the app_init function is like setup() in Arduino. It is called once when the
+ * @brief the app_setup function is like setup() in Arduino. It is called once when the
  * program begins. You should set pin modes and enable any peripherals you want to
- * set up (real-time clock, I2C, etc.)
- * 
- * @note If your app enters the ultra-low power BACKUP sleep mode, this function will 
+ * set up (real-time clock, I2C, etc.) Depending on your application, you may or may not
+ * want to configure sensors on your sensor board here. For example, a low-power
+ * accelerometer that will run at all times should be configured here, whereas you may
+ * want to enable a more power-hungry environmental sensor only when you need it.
+ *
+ * @note If your app enters the ultra-low power BACKUP sleep mode, this function will
  * be called again when it wakes from that deep sleep state. In this state, the RTC will
  * still be configured with the correct date and time.
  */
-void app_init() {
-    memset(&applicationState, 0, sizeof(applicationState));
-
-    watch_enable_led(false);
+void app_setup() {
+    watch_enable_led(false); // enable LED with plain digital IO, not PWM
 
     watch_enable_buttons();
     watch_register_button_callback(BTN_LIGHT, cb_light_pressed);
     watch_register_button_callback(BTN_MODE, cb_mode_pressed);
+    watch_register_button_callback(BTN_ALARM, cb_alarm_pressed);
 
     watch_enable_display();
 }
@@ -68,13 +97,15 @@ void app_prepare_for_sleep() {
  * STANDBY sleep mode.
  */
 void app_wake_from_sleep() {
+    applicationState.wake_count++;
 }
 
 /**
  * @brief the app_loop function is called once on app startup and then again each time
  * the watch STANDBY sleep mode.
  */
-void app_loop() {
+bool app_loop() {
+    // set the LED to a color
     switch (applicationState.color) {
         case COLOR_RED:
             watch_set_led_red();
@@ -89,6 +120,13 @@ void app_loop() {
             applicationState.color = COLOR_OFF;
             watch_set_led_off();
     }
+
+    // Display the number of times we've woken up (modulo 32 to fit in 2 digits at top right)
+    char buf[3] = {0};
+    sprintf(buf, "%2d", applicationState.wake_count % 32);
+    watch_display_string(buf, 2);
+
+    // display "Hello there" text
     switch (applicationState.mode) {
         case MODE_HELLO:
             watch_display_string("Hello", 5);
@@ -97,4 +135,25 @@ void app_loop() {
             watch_display_string("there", 5);
             break;
     }
+
+    // Wait a moment to debounce button input
+    delay_ms(250);
+
+    return true;
+}
+
+
+//////////////////////////////////////////////////////////////////////////////////////////
+// Implementations for our callback functions. Replace these with whatever functionality
+// your app requires.
+void cb_light_pressed() {
+    applicationState.color = (applicationState.color + 1) % 4;
+}
+
+void cb_mode_pressed() {
+    applicationState.mode = (applicationState.mode + 1) % 2;
 }
+
+void cb_alarm_pressed() {
+    // TODO: deep sleep demo
+}
\ No newline at end of file
diff --git a/Sensor Watch Starter Project/app.h b/Sensor Watch Starter Project/app.h
index b025725c..df40a30f 100644
--- a/Sensor Watch Starter Project/app.h
+++ b/Sensor Watch Starter Project/app.h
@@ -1,29 +1,33 @@
 /**
   * Header file for Sensor Watch application
-  * 
-  * Ideally you should implement your app entirely within these functions, as well as any
-  * interrupt callbacks you register with the watch API. The general flow is as follows:
-  * 
-  * 1. main.c configures the watch
-  * 2. main.c calls your app_init() function. 
+  *
+  * You should be able to write a watch app by simply implementing these functions
+  * and declaring callbacks for various GPIO and peripheral interrupts. The main.c
+  * file takes care of calling these functions for you. The general flow:
+  *
+  * 1. Your app_init() function is called.
+  *      - This method should only be used to set your initial application state.
+  * 2. If your app is waking from BACKUP, app_wake_from_deep_sleep()  is called.
+  *      - If you saved state in the RTC's backup registers, you can restore it here.
+  * 3. Your app_setup() method is called.
   *      - You may wish to enable some functionality and peripherals here.
-  *      - You should definitely set up some wake-up sources here.
-  * 3. main.c calls your app_loop() function. 
+  *      - You should definitely set up some interrupts here.
+  * 4. The main run loop begins: your app_loop() function is called.
   *      - Run code and update your UI here.
-  * 4. main.c calls your app_prepare_for_sleep() function.
-  *      - Consider resetting any state that was set in your wakeup callback here.
-  *      - You may also want to disable / depower external sensors or peripherals here.
-  * 5. main.c enters the STANDBY sleep mode.
+  *      - Return true if your app is prepared to enter STANDBY mode.
+  * 5. This step differs depending on the value returned by app_loop:
+  *      - If you returned false, execution resumes at (4).
+  *      - If you returned true, app_prepare_for_sleep() is called; execution moves on to (6).
+  * 6. The microcontroller enters the STANDBY sleep mode.
   *      - No user code will run, and the watch will enter a low power mode.
-  *      - The watch will remain in this state until something from (2) wakes it.
-  * 6. main.c calls your app_wake_from_sleep() function.
-  *      - You may wish to re-enable any peripherals you disabled.
-  *      - After this, execution resumes at step (3).
+  *      - The watch will remain in this state until an interrupt wakes it.
+  * 7. Once woken from STANDBY, your app_wake_from_sleep() function is called.
+  *      - After this, execution resumes at (4).
   */
 
-#include "watch.h"
-
 void app_init();
-void app_loop();
+void app_wake_from_deep_sleep();
+void app_setup();
+bool app_loop();
 void app_prepare_for_sleep();
 void app_wake_from_sleep();