summaryrefslogtreecommitdiffstats
path: root/index.html
diff options
context:
space:
mode:
authorjoeycastillo <joeycastillo@users.noreply.github.com>2022-01-27 15:47:25 +0000
committerjoeycastillo <joeycastillo@users.noreply.github.com>2022-01-27 15:47:25 +0000
commitc0090716995447bd59954c8a7e24cd5c20598f7a (patch)
treefd06dac4eb9e8c0d28e04f9e1393ec0c338212c4 /index.html
parentfabc6d28eaf6e0227c68673d3c564c31f4c01a17 (diff)
downloadSensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.tar.gz
Sensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.tar.bz2
Sensor-Watch-c0090716995447bd59954c8a7e24cd5c20598f7a.zip
deploy: 29fa6052831f8d26815405d4652b5799e3c74147
Diffstat (limited to 'index.html')
-rw-r--r--index.html20
1 files changed, 17 insertions, 3 deletions
diff --git a/index.html b/index.html
index 69142487..59644390 100644
--- a/index.html
+++ b/index.html
@@ -5,7 +5,7 @@
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>Sensor Watch: Main Page</title>
+<title>Sensor Watch: Sensor Watch Documentation</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
@@ -62,11 +62,25 @@ $(function() {
</iframe>
</div>
-<div class="header">
+<div class="PageDoc"><div class="header">
<div class="headertitle">
-<div class="title">Sensor Watch Documentation</div> </div>
+<div class="title">Sensor Watch Documentation </div> </div>
</div><!--header-->
<div class="contents">
+<div class="textblock"><p>This documentation covers most of the functions you will use to interact with the Sensor Watch hardware. It is divided into the following sections:</p><ul>
+<li><a class="el" href="group__app.html">Application Framework</a> - This section covers the functions that you will implement in your app.c file when designing a Sensor Watch app.</li>
+<li><a class="el" href="group__rtc.html">Real-Time Clock</a> - This section covers functions related to the SAM L22's real-time clock peripheral, including date, time and alarm functions.</li>
+<li><a class="el" href="group__slcd.html">Segment LCD Display</a> - This section covers functions related to the Segment LCD display driver, which is responsible for displaying strings of characters and indicators on the main watch display.</li>
+<li><a class="el" href="group__buttons.html">Buttons &amp; External Interrupts</a> - This section covers functions related to the three buttons: Light, Mode and Alarm.</li>
+<li><a class="el" href="group__led.html">LED Control</a> - This section covers functions related to the bi-color red/green LED mounted behind the LCD.</li>
+<li><a class="el" href="group__buzzer.html">Buzzer</a> - This section covers functions related to the piezo buzzer.</li>
+<li><a class="el" href="group__adc.html">Analog Input</a> - This section covers functions related to the SAM L22's analog-to-digital converter, as well as configuring and reading values from the five analog-capable pins on the 9-pin connector.</li>
+<li><a class="el" href="group__gpio.html">Digital Input and Output</a> - This section covers functions related to general-purpose input and output signals.</li>
+<li><a class="el" href="group__i2c.html">I2C Controller Driver</a> - This section covers functions related to the SAM L22's built-I2C driver, including configuring the I2C bus, putting values directly on the bus and reading data from registers on I2C devices.</li>
+<li><a class="el" href="group__debug.html">UART</a> - This section covers functions related to the debug UART, available on pin D1 of the 9-pin connector.</li>
+<li><a class="el" href="group__deepsleep.html">Sleep Control</a> - This section covers functions related to preparing for and entering BACKUP mode, the deepest sleep mode available on the SAM L22. </li>
+</ul>
+</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>