Changed all clock_pos_ and pos_ function params to now be touch_pos_ …

…etc as it is a touch screen

Updated doxygen docs to reflect this change

Documentation/extra/overview.md

@@ -1,7 +1,8 @@
-# Overview
-Welcome to the documentation for the source code of the TinyWATCH S3 project. This guide provides insights into the intricacies of the firmware that powers the TinyWATCH S3, offering a deeper understanding of the functionalities and inner workings of the smartwatch.
+# Code Structure & Concepts
+The main areas of the code project are separated into folders to keep things grouped in a logical way.
+
+Everything you see displayed on the screen of the TinyWATCH happens inside a `FACE`. Faces inherit from the `tw_face` class, which manages the ability for faces to be swiped and navigated to. It also handles drawing of any controls or widgets assigned to a face.
 
-## Contents
 Class Documentation: Detailed breakdowns of the key classes within the firmware, including their members, methods, and purposes.
 
 The main entry point and runtime loop of the firmware lives in [tinywatch.cpp](@ref tinywatch.cpp). This is where the `Arduino setup() and loop()` functions live. 

Documentation/html/class_app_compass-members.html

@@ -104,11 +104,11 @@
   <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#aa8977866b6bc2829b4be921fdbf8d016">add</a>(String _name, uint _update_period)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#a3579e2c96a5534b151af35752ac09292">angle</a></td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"><span class="mlabel">private</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#a04c670bd2957f5fa24a97d6ae06f9831">canvasid</a></td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"><span class="mlabel">protected</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#aca45e38f1e7de29a360fb9e808b9eee5">click</a>(int16_t pos_x, int16_t pos_y)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#aff74b36c204aa2c2064478c3aaff7b85">tw_app::click</a>(uint16_t click_pos_x, uint16_t click_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#a2caecbd31379d637afd67fa94dc4ef08">click_double</a>(int16_t pos_x, int16_t pos_y)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#a0ab331b94d4ebfc9210030292e7d36ec">tw_app::click_double</a>(uint16_t click_pos_x, uint16_t click_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classtw__app.html#a49c377582445587b4127d6497bde2a3b">click_icon</a>(int16_t click_pos_x, int16_t click_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#a19d6f60164db24b408e10a6c7af8f99d">click</a>(int16_t touch_pos_x, int16_t touch_pos_y)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#ae5a5e5718113ee62cbaa36bfea0f9099">tw_app::click</a>(uint16_t touch_pos_x, uint16_t touch_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#a8a277ea37daf0798bcbe347c453d3e30">click_double</a>(int16_t touch_pos_x, int16_t touch_pos_y)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#ab9b6ac2cb42b944c79f0265277671619">tw_app::click_double</a>(uint16_t touch_pos_x, uint16_t touch_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"><span class="mlabel">inline</span><span class="mlabel">virtual</span></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classtw__app.html#a02678aa0754189f506cafeaa40f75f15">click_icon</a>(int16_t touch_pos_x, int16_t touch_pos_y)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classtw__app.html#ab1914aae31b736e21441c926a7045854">close</a>(bool save)</td><td class="entry"><a class="el" href="classtw__app.html">tw_app</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_app_compass.html#a94e74af29d8ebcc9d7de0879ed94e540">draw</a>(bool force)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="class_app_compass.html#ab6a82cec74937c780c78d978891de9da">draw_icon</a>(uint8_t canvasid, int16_t _pos_x, int16_t _pos_y, uint8_t style_hint)</td><td class="entry"><a class="el" href="class_app_compass.html">AppCompass</a></td><td class="entry"><span class="mlabel">virtual</span></td></tr>

Documentation/html/class_app_compass.html

@@ -123,10 +123,10 @@
 <tr class="memitem:ab6a82cec74937c780c78d978891de9da" id="r_ab6a82cec74937c780c78d978891de9da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab6a82cec74937c780c78d978891de9da">draw_icon</a> (uint8_t <a class="el" href="classtw__app.html#a04c670bd2957f5fa24a97d6ae06f9831">canvasid</a>, int16_t _pos_x, int16_t _pos_y, uint8_t style_hint)</td></tr>
 <tr class="memdesc:ab6a82cec74937c780c78d978891de9da"><td class="mdescLeft">&#160;</td><td class="mdescRight">Draw the icon that gets shown on the app menu face.  <br /></td></tr>
 <tr class="separator:ab6a82cec74937c780c78d978891de9da"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aca45e38f1e7de29a360fb9e808b9eee5" id="r_aca45e38f1e7de29a360fb9e808b9eee5"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aca45e38f1e7de29a360fb9e808b9eee5">click</a> (int16_t pos_x, int16_t pos_y)</td></tr>
-<tr class="separator:aca45e38f1e7de29a360fb9e808b9eee5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2caecbd31379d637afd67fa94dc4ef08" id="r_a2caecbd31379d637afd67fa94dc4ef08"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2caecbd31379d637afd67fa94dc4ef08">click_double</a> (int16_t pos_x, int16_t pos_y)</td></tr>
-<tr class="separator:a2caecbd31379d637afd67fa94dc4ef08"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a19d6f60164db24b408e10a6c7af8f99d" id="r_a19d6f60164db24b408e10a6c7af8f99d"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a19d6f60164db24b408e10a6c7af8f99d">click</a> (int16_t touch_pos_x, int16_t touch_pos_y)</td></tr>
+<tr class="separator:a19d6f60164db24b408e10a6c7af8f99d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a8a277ea37daf0798bcbe347c453d3e30" id="r_a8a277ea37daf0798bcbe347c453d3e30"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8a277ea37daf0798bcbe347c453d3e30">click_double</a> (int16_t touch_pos_x, int16_t touch_pos_y)</td></tr>
+<tr class="separator:a8a277ea37daf0798bcbe347c453d3e30"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a2e1ec53ba887b0340f2441318e2979cf" id="r_a2e1ec53ba887b0340f2441318e2979cf"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2e1ec53ba887b0340f2441318e2979cf">drawCompass</a> (int x, int y, int <a class="el" href="#a3579e2c96a5534b151af35752ac09292">angle</a>)</td></tr>
 <tr class="separator:a2e1ec53ba887b0340f2441318e2979cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ad22a2ab973d0fc837d085828f21d5018" id="r_ad22a2ab973d0fc837d085828f21d5018"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad22a2ab973d0fc837d085828f21d5018">getCoord</a> (int x, int y, int *xp, int *yp, int r, int a)</td></tr>
@@ -142,19 +142,19 @@
 <tr class="memitem:aa8977866b6bc2829b4be921fdbf8d016 inherit pub_methods_classtw__app" id="r_aa8977866b6bc2829b4be921fdbf8d016"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#aa8977866b6bc2829b4be921fdbf8d016">add</a> (String _name, uint _update_period)</td></tr>
 <tr class="memdesc:aa8977866b6bc2829b4be921fdbf8d016 inherit pub_methods_classtw__app"><td class="mdescLeft">&#160;</td><td class="mdescRight">Quick override for Add above.  <br /></td></tr>
 <tr class="separator:aa8977866b6bc2829b4be921fdbf8d016 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a49c377582445587b4127d6497bde2a3b inherit pub_methods_classtw__app" id="r_a49c377582445587b4127d6497bde2a3b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#a49c377582445587b4127d6497bde2a3b">click_icon</a> (int16_t click_pos_x, int16_t click_pos_y)</td></tr>
-<tr class="memdesc:a49c377582445587b4127d6497bde2a3b inherit pub_methods_classtw__app"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we have clicked on an app icon.  <br /></td></tr>
-<tr class="separator:a49c377582445587b4127d6497bde2a3b inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a02678aa0754189f506cafeaa40f75f15 inherit pub_methods_classtw__app" id="r_a02678aa0754189f506cafeaa40f75f15"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#a02678aa0754189f506cafeaa40f75f15">click_icon</a> (int16_t touch_pos_x, int16_t touch_pos_y)</td></tr>
+<tr class="memdesc:a02678aa0754189f506cafeaa40f75f15 inherit pub_methods_classtw__app"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if we have clicked on an app icon.  <br /></td></tr>
+<tr class="separator:a02678aa0754189f506cafeaa40f75f15 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5cf0211251f14dd57c0f575c4ac2ec04 inherit pub_methods_classtw__app" id="r_a5cf0211251f14dd57c0f575c4ac2ec04"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#a5cf0211251f14dd57c0f575c4ac2ec04">set_canvas</a> (uint _canvasid)</td></tr>
 <tr class="memdesc:a5cf0211251f14dd57c0f575c4ac2ec04 inherit pub_methods_classtw__app"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the canvas ID for the app to draw into.  <br /></td></tr>
 <tr class="separator:a5cf0211251f14dd57c0f575c4ac2ec04 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ab1914aae31b736e21441c926a7045854 inherit pub_methods_classtw__app" id="r_ab1914aae31b736e21441c926a7045854"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#ab1914aae31b736e21441c926a7045854">close</a> (bool save)</td></tr>
 <tr class="memdesc:ab1914aae31b736e21441c926a7045854 inherit pub_methods_classtw__app"><td class="mdescLeft">&#160;</td><td class="mdescRight">Close the app and go back to the app list.  <br /></td></tr>
 <tr class="separator:ab1914aae31b736e21441c926a7045854 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:aff74b36c204aa2c2064478c3aaff7b85 inherit pub_methods_classtw__app" id="r_aff74b36c204aa2c2064478c3aaff7b85"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#aff74b36c204aa2c2064478c3aaff7b85">click</a> (uint16_t click_pos_x, uint16_t click_pos_y)</td></tr>
-<tr class="separator:aff74b36c204aa2c2064478c3aaff7b85 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a0ab331b94d4ebfc9210030292e7d36ec inherit pub_methods_classtw__app" id="r_a0ab331b94d4ebfc9210030292e7d36ec"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#a0ab331b94d4ebfc9210030292e7d36ec">click_double</a> (uint16_t click_pos_x, uint16_t click_pos_y)</td></tr>
-<tr class="separator:a0ab331b94d4ebfc9210030292e7d36ec inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae5a5e5718113ee62cbaa36bfea0f9099 inherit pub_methods_classtw__app" id="r_ae5a5e5718113ee62cbaa36bfea0f9099"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#ae5a5e5718113ee62cbaa36bfea0f9099">click</a> (uint16_t touch_pos_x, uint16_t touch_pos_y)</td></tr>
+<tr class="separator:ae5a5e5718113ee62cbaa36bfea0f9099 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ab9b6ac2cb42b944c79f0265277671619 inherit pub_methods_classtw__app" id="r_ab9b6ac2cb42b944c79f0265277671619"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classtw__app.html#ab9b6ac2cb42b944c79f0265277671619">click_double</a> (uint16_t touch_pos_x, uint16_t touch_pos_y)</td></tr>
+<tr class="separator:ab9b6ac2cb42b944c79f0265277671619 inherit pub_methods_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
 Private Attributes</h2></td></tr>
@@ -223,42 +223,42 @@
 <tr class="separator:a610cfa88a6b424609aee2246bce71722 inherit pro_attribs_classtw__app"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <h2 class="groupheader">Member Function Documentation</h2>
-<a id="aca45e38f1e7de29a360fb9e808b9eee5" name="aca45e38f1e7de29a360fb9e808b9eee5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#aca45e38f1e7de29a360fb9e808b9eee5">&#9670;&#160;</a></span>click()</h2>
+<a id="a19d6f60164db24b408e10a6c7af8f99d" name="a19d6f60164db24b408e10a6c7af8f99d"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a19d6f60164db24b408e10a6c7af8f99d">&#9670;&#160;</a></span>click()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">bool AppCompass::click </td>
           <td>(</td>
-          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>pos_x</em>, </span></td>
+          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>touch_pos_x</em>, </span></td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>pos_y</em></span>&#160;)</td>
+          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>touch_pos_y</em></span>&#160;)</td>
         </tr>
       </table>
 </div><div class="memdoc">
 
 </div>
 </div>
-<a id="a2caecbd31379d637afd67fa94dc4ef08" name="a2caecbd31379d637afd67fa94dc4ef08"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a2caecbd31379d637afd67fa94dc4ef08">&#9670;&#160;</a></span>click_double()</h2>
+<a id="a8a277ea37daf0798bcbe347c453d3e30" name="a8a277ea37daf0798bcbe347c453d3e30"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a8a277ea37daf0798bcbe347c453d3e30">&#9670;&#160;</a></span>click_double()</h2>
 
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">bool AppCompass::click_double </td>
           <td>(</td>
-          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>pos_x</em>, </span></td>
+          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>touch_pos_x</em>, </span></td>
         </tr>
         <tr>
           <td class="paramkey"></td>
           <td></td>
-          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>pos_y</em></span>&#160;)</td>
+          <td class="paramtype">int16_t</td>          <td class="paramname"><span class="paramname"><em>touch_pos_y</em></span>&#160;)</td>
         </tr>
       </table>
 </div><div class="memdoc">

Documentation/html/class_app_compass.js

@@ -1,7 +1,7 @@
 var class_app_compass =
 [
-    [ "click", "class_app_compass.html#aca45e38f1e7de29a360fb9e808b9eee5", null ],
-    [ "click_double", "class_app_compass.html#a2caecbd31379d637afd67fa94dc4ef08", null ],
+    [ "click", "class_app_compass.html#a19d6f60164db24b408e10a6c7af8f99d", null ],
+    [ "click_double", "class_app_compass.html#a8a277ea37daf0798bcbe347c453d3e30", null ],
     [ "draw", "class_app_compass.html#a94e74af29d8ebcc9d7de0879ed94e540", null ],
     [ "draw_icon", "class_app_compass.html#ab6a82cec74937c780c78d978891de9da", null ],
     [ "drawCompass", "class_app_compass.html#a2e1ec53ba887b0340f2441318e2979cf", null ],