Updated documentation pages and version badge.

docs/classN2Coprocessor-members.html

@@ -106,8 +106,10 @@
   <tr class="even"><td class="entry"><a class="el" href="classN2Coprocessor.html#a73f47fc0606fbd11ac6e75f4d5ea36f6">getOutputWeights</a>(float *outputWeights)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classN2Coprocessor.html#aba048c1779d33419474d41fe85b1ea5f">handshake</a>()</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classN2Coprocessor.html#a0743692b6d1abe21198b3a1fd2704e55">infer</a>(float *input, float *output)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
-  <tr class="odd"><td class="entry"><a class="el" href="classN2Coprocessor.html#a3e40d2133253576034b5320e986ad2b5">N2Coprocessor</a>(uint8_t rx=N2CMU_RX_PIN, uint8_t tx=N2CMU_TX_PIN)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
-  <tr class="even"><td class="entry"><a class="el" href="classN2Coprocessor.html#ac0a0150730ec3242768fc016630410f7">resetNetwork</a>()</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="odd"><td class="entry"><b>loadFromFile</b>(const char *modelFilename) (defined in <a class="el" href="classN2Coprocessor.html">N2Coprocessor</a>)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="classN2Coprocessor.html#a3e40d2133253576034b5320e986ad2b5">N2Coprocessor</a>(uint8_t rx=N2CMU_RX_PIN, uint8_t tx=N2CMU_TX_PIN)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"><span class="mlabel">inline</span></td></tr>
+  <tr class="odd"><td class="entry"><a class="el" href="classN2Coprocessor.html#ac0a0150730ec3242768fc016630410f7">resetNetwork</a>()</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
+  <tr bgcolor="#f0f0f0" class="even"><td class="entry"><b>saveToFile</b>(const char *modelFilename) (defined in <a class="el" href="classN2Coprocessor.html">N2Coprocessor</a>)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classN2Coprocessor.html#aba32a8776fe3c18d6ce71e3de3131ece">setEpochCount</a>(uint16_t epoch)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="classN2Coprocessor.html#a3297260c684ee24ffcf11be57c214b43">setHiddenBias</a>(float *hiddenBias)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>
   <tr class="odd"><td class="entry"><a class="el" href="classN2Coprocessor.html#a05fe20c4b0203a506f2721f2507232b2">setHiddenCount</a>(uint8_t hiddenCount)</td><td class="entry"><a class="el" href="classN2Coprocessor.html">N2Coprocessor</a></td><td class="entry"></td></tr>

docs/classN2Coprocessor.html

@@ -193,6 +193,12 @@
 <tr class="memitem:ae5499645aab2d9305660fdd0762832cb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classN2Coprocessor.html#ae5499645aab2d9305660fdd0762832cb">getOutputGradient</a> (float *outputGrad)</td></tr>
 <tr class="memdesc:ae5499645aab2d9305660fdd0762832cb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get output neuron gradients.  <a href="classN2Coprocessor.html#ae5499645aab2d9305660fdd0762832cb">More...</a><br /></td></tr>
 <tr class="separator:ae5499645aab2d9305660fdd0762832cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a9eb3cb02fab71db8cbc1e204d0341db8"><td class="memItemLeft" align="right" valign="top"><a id="a9eb3cb02fab71db8cbc1e204d0341db8" name="a9eb3cb02fab71db8cbc1e204d0341db8"></a>
+void&#160;</td><td class="memItemRight" valign="bottom"><b>loadFromFile</b> (const char *modelFilename)</td></tr>
+<tr class="separator:a9eb3cb02fab71db8cbc1e204d0341db8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a6d7b44683a8b375c264feb632b0baa44"><td class="memItemLeft" align="right" valign="top"><a id="a6d7b44683a8b375c264feb632b0baa44" name="a6d7b44683a8b375c264feb632b0baa44"></a>
+void&#160;</td><td class="memItemRight" valign="bottom"><b>saveToFile</b> (const char *modelFilename)</td></tr>
+<tr class="separator:a6d7b44683a8b375c264feb632b0baa44"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p >Class representing the N2CMU device. </p>

docs/index.html

@@ -86,8 +86,10 @@
   <div class="headertitle"><div class="title">N2CMU Arduino Library </div></div>
 </div><!--header-->
 <div class="contents">
-<div class="textblock"><p ><a class="anchor" id="md_README"></a> <img src="https://github.com/nthnn/n2cmu-arduino/actions/workflows/ci_build.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/n2cmu-arduino/actions/workflows/ci_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-0.0.2-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/SIM900/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GNU%20GPL%20v3.0-yellow.svg" alt="License: GNU GPL v3.0" style="pointer-events: none;" class="inline"/></a></p>
+<div class="textblock"><p ><a class="anchor" id="md_README"></a> <img src="https://github.com/nthnn/n2cmu-arduino/actions/workflows/ci_build.yml/badge.svg" alt="Arduino CI" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/n2cmu-arduino/actions/workflows/ci_lint.yml/badge.svg" alt="Arduino Lint" style="pointer-events: none;" class="inline"/> <img src="https://github.com/nthnn/n2cmu-arduino/actions/workflows/ci_spellcheck.yml/badge.svg" alt="Spellcheck CI" style="pointer-events: none;" class="inline"/> <img src="https://img.shields.io/badge/Library%20Manager-0.0.3-red?logo=Arduino" alt="Arduino Release" class="inline"/> <a href="https://github.com/nthnn/SIM900/blob/main/LICENSE"><img src="https://img.shields.io/badge/License-GNU%20GPL%20v3.0-yellow.svg" alt="License: GNU GPL v3.0" style="pointer-events: none;" class="inline"/></a></p>
 <p >This is the official Arduino library for <a href="https://github.com/nthnn/n2cmu">N2CMU</a> (Neural Network Coprocessing Microcontroller Unit).</p>
+<p  align="center"></p>
+<p ><img src="pcb/n2cmu-shield.png" alt="Arduino N2CMU Shield" class="inline"/> </p>
 <h1><a class="anchor" id="autotoc_md1"></a>
 Getting Started</h1>
 <p >To start using <code>n2cmu-arduino</code> library in your Arduino projects, follow these simple steps:</p>
@@ -128,7 +130,7 @@ <h1><a class="anchor" id="autotoc_md2"></a>
 <div class="line"> </div>
 <div class="line">    <span class="comment">// Reset the CPU</span></div>
 <div class="line">    <span class="keywordflow">if</span>(coprocessor.<a class="code hl_function" href="classN2Coprocessor.html#a20ffb35de79237214ed89c2c6fd2c8ec">cpuReset</a>())</div>
-<div class="line">        Serial.println(F(<span class="stringliteral">&quot;CPU Resetted!&quot;</span>));</div>
+<div class="line">        Serial.println(F(<span class="stringliteral">&quot;CPU Reset!&quot;</span>));</div>
 <div class="line">    <span class="keywordflow">else</span> {</div>
 <div class="line">        Serial.println(F(<span class="stringliteral">&quot;Something went wrong. Halting...&quot;</span>));</div>
 <div class="line">        <span class="keywordflow">while</span>(<span class="keyword">true</span>);</div>
@@ -164,7 +166,7 @@ <h1><a class="anchor" id="autotoc_md2"></a>
 <div class="line">            Serial.print(F(<span class="stringliteral">&quot;]: &quot;</span>));</div>
 <div class="line">            Serial.println(output[0]);</div>
 <div class="line">        }</div>
-<div class="line">        <span class="keywordflow">else</span> Serial.println(F(<span class="stringliteral">&quot;Inference attemp failed.&quot;</span>));</div>
+<div class="line">        <span class="keywordflow">else</span> Serial.println(F(<span class="stringliteral">&quot;Inference attempt failed.&quot;</span>));</div>
 <div class="line">    }</div>
 <div class="line"> </div>
 <div class="line">    <span class="comment">// Reset the network</span></div>
@@ -185,6 +187,9 @@ <h1><a class="anchor" id="autotoc_md2"></a>
 <div class="ttc" id="aclassN2Coprocessor_html_ac0a0150730ec3242768fc016630410f7"><div class="ttname"><a href="classN2Coprocessor.html#ac0a0150730ec3242768fc016630410f7">N2Coprocessor::resetNetwork</a></div><div class="ttdeci">void resetNetwork()</div><div class="ttdoc">Reset the neural network parameters.</div><div class="ttdef"><b>Definition:</b> n2cmu.cpp:160</div></div>
 <div class="ttc" id="an2cmu_8h_html"><div class="ttname"><a href="n2cmu_8h.html">n2cmu.h</a></div><div class="ttdoc">Header file for N2CMU (Neural Network Coprocessing Microcontroller Unit).</div></div>
 </div><!-- fragment --><h1><a class="anchor" id="autotoc_md3"></a>
+PCB Schematic Diagram</h1>
+<p ><img src="pcb/n2cmu-shield-schematics.png" alt="Arduino N2CMU Shield Schematic Diagram" class="inline"/></p>
+<h1><a class="anchor" id="autotoc_md4"></a>
 License</h1>
 <p >Copyright (c) 2024 Nathanne Isip</p>
 <p ><code>n2cmu-arduino</code> is distributed under the GNU General Public License v3.0. For further details, refer to the LICENSE file.</p>

docs/n2cmu_8h_source.html

@@ -208,9 +208,15 @@
 <div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classN2Coprocessor.html#a997759257093cca965dcaa24cb8ea957">getHiddenGradient</a>(<span class="keywordtype">float</span>* hiddenGrad);</div>
 <div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span> </div>
 <div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classN2Coprocessor.html#ae5499645aab2d9305660fdd0762832cb">getOutputGradient</a>(<span class="keywordtype">float</span>* outputGrad);</div>
-<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span>};</div>
-<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span> </div>
-<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="preprocessor">#endif</span></div>
+<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span> </div>
+<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span>    <span class="comment">// Not yet implemented.</span></div>
+<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span>    <span class="keywordtype">void</span> loadFromFile(<span class="keyword">const</span> <span class="keywordtype">char</span> *modelFilename);</div>
+<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span> </div>
+<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span>    <span class="comment">// Not yet implemented.</span></div>
+<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span>    <span class="keywordtype">void</span> saveToFile(<span class="keyword">const</span> <span class="keywordtype">char</span>* modelFilename);</div>
+<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span>};</div>
+<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span> </div>
+<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="preprocessor">#endif</span></div>
 <div class="ttc" id="aclassN2Coprocessor_html"><div class="ttname"><a href="classN2Coprocessor.html">N2Coprocessor</a></div><div class="ttdoc">Class representing the N2CMU device.</div><div class="ttdef"><b>Definition:</b> n2cmu.h:47</div></div>
 <div class="ttc" id="aclassN2Coprocessor_html_a05fe20c4b0203a506f2721f2507232b2"><div class="ttname"><a href="classN2Coprocessor.html#a05fe20c4b0203a506f2721f2507232b2">N2Coprocessor::setHiddenCount</a></div><div class="ttdeci">void setHiddenCount(uint8_t hiddenCount)</div><div class="ttdoc">Set the number of hidden neurons.</div><div class="ttdef"><b>Definition:</b> n2cmu.cpp:178</div></div>
 <div class="ttc" id="aclassN2Coprocessor_html_a0743692b6d1abe21198b3a1fd2704e55"><div class="ttname"><a href="classN2Coprocessor.html#a0743692b6d1abe21198b3a1fd2704e55">N2Coprocessor::infer</a></div><div class="ttdeci">bool infer(float *input, float *output)</div><div class="ttdoc">Make inference with the neural network using provided input data.</div><div class="ttdef"><b>Definition:</b> n2cmu.cpp:146</div></div>

docs/navtreedata.js

@@ -28,7 +28,8 @@ var NAVTREE =
     [ "N2CMU Arduino Library", "index.html", [
       [ "Getting Started", "index.html#autotoc_md1", null ],
       [ "Example Usage", "index.html#autotoc_md2", null ],
-      [ "License", "index.html#autotoc_md3", null ]
+      [ "PCB Schematic Diagram", "index.html#autotoc_md3", null ],
+      [ "License", "index.html#autotoc_md4", null ]
     ] ],
     [ "Classes", "annotated.html", [
       [ "Class List", "annotated.html", "annotated_dup" ],

docs/navtreeindex0.js

@@ -49,6 +49,7 @@ var NAVTREEINDEX0 =
 "index.html#autotoc_md1":[0,0],
 "index.html#autotoc_md2":[0,1],
 "index.html#autotoc_md3":[0,2],
+"index.html#autotoc_md4":[0,3],
 "n2cmu_8h.html":[2,0,0,0],
 "n2cmu_8h.html#a66afc50ff26aace7f21713d756f63c57":[2,0,0,0,1],
 "n2cmu_8h.html#ac8118cdfd4100b5c0c1db9c38787915b":[2,0,0,0,3],