From 595c3cb881c14a28d37a8a9a3e4aadc79285a673 Mon Sep 17 00:00:00 2001 From: joeycastillo Date: Sat, 5 Feb 2022 18:37:05 +0000 Subject: deploy: c74cacd34f68f2897fbd63e2ba90831f87cbad49 --- group__app.html | 51 +++++++++++++++++++++++++-------------------------- 1 file changed, 25 insertions(+), 26 deletions(-) (limited to 'group__app.html') diff --git a/group__app.html b/group__app.html index a2cea10c..9f34b744 100644 --- a/group__app.html +++ b/group__app.html @@ -2,8 +2,8 @@ - - + + Sensor Watch: Application Framework @@ -19,10 +19,9 @@
- - + @@ -31,21 +30,22 @@
-
Sensor Watch -  0.0.0 +
+
Sensor Watch 0.0.0
A board replacement for the classic Casio F-91W wristwatch, powered by a Microchip SAM L22 microcontroller.
- + +/* @license-end */ + @@ -65,22 +65,21 @@ $(function() {
Functions
-
-
Application Framework
+
Application Framework

This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app. More...

- - + - + @@ -92,14 +91,14 @@ void  - +

+

Functions

-void app_init (void)
+void app_init (void)
 A function you will implement to initialize your application state. 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, but don't configure any peripherals just yet.
 
-void app_wake_from_backup (void)
+void app_wake_from_backup (void)
 A function you will implement to wake from BACKUP mode, which wipes the system's RAM, and with it, your application's state. You may have chosen to store some important application state in the RTC's backup registers prior to entering this mode. You may restore that state here.
 
void app_setup (void)
void app_prepare_for_standby (void)
 A function you will implement to prepare to enter STANDBY mode. The app_prepare_for_standby function is called after your app_loop function returns true, and just before the watch enters STANDBY mode. In this mode most peripherals are shut down, and no code will run until the watch receives an interrupt (generally either the 1Hz tick or a press on one of the buttons). More...
 
-void app_wake_from_standby (void)
+void app_wake_from_standby (void)
 A method you will implement to configure the app after waking from STANDBY mode.
 

Detailed Description

-

This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app.

-

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:

+

This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app.

+

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.
      • @@ -135,7 +134,7 @@ void Function Documentation - +

      ◆ app_loop()

      @@ -157,7 +156,7 @@ void  +

      ◆ app_prepare_for_standby()

      @@ -178,7 +177,7 @@ void  +

      ◆ app_setup()

      @@ -202,7 +201,7 @@ void 
      -Generated by doxygen 1.9.1 +Generated by doxygen 1.9.3
      -- cgit v1.2.3