taigrr/arduinolibs
1
0
Fork 0
mirror of https://github.com/taigrr/arduinolibs synced 2025-01-18 04:33:12 -08:00
Code Issues Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Rhys Weatherley
2016-03-26 19:05:43 +10:00
parent 328b82e3fb
commit 73c9ce4455
422 changed files with 3036 additions and 561 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
hierarchy.html
View File

@@ -149,34 +149,35 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
<tr id="row_20_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRingOscillatorNoiseSource.html" target="_self">RingOscillatorNoiseSource</a></td><td class="desc">Processes the signal from a ring oscillator based noise source </td></tr>
<tr id="row_20_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTransistorNoiseSource.html" target="_self">TransistorNoiseSource</a></td><td class="desc">Processes the signal from a transistor-based noise source </td></tr>
<tr id="row_21_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classOMAC.html" target="_self">OMAC</a></td><td class="desc">Implementation of the <a class="el" href="classOMAC.html" title="Implementation of the OMAC message authenticator. ">OMAC</a> message authenticator </td></tr>
<tr id="row_22_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classPoly1305.html" target="_self">Poly1305</a></td><td class="desc"><a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator </td></tr>
<tr id="row_23_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRNGClass.html" target="_self">RNGClass</a></td><td class="desc">Pseudo random number generator suitable for cryptography </td></tr>
<tr id="row_24_" class="even"><td class="entry"><img id="arr_24_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('24_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRTC.html" target="_self">RTC</a></td><td class="desc">Base class for realtime clock handlers </td></tr>
<tr id="row_24_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS1307RTC.html" target="_self">DS1307RTC</a></td><td class="desc">Communicates with a DS1307 realtime clock chip via I2C </td></tr>
<tr id="row_24_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS3231RTC.html" target="_self">DS3231RTC</a></td><td class="desc">Communicates with a DS3231 realtime clock chip via I2C </td></tr>
<tr id="row_24_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS3232RTC.html" target="_self">DS3232RTC</a></td><td class="desc">Communicates with a DS3232 realtime clock chip via I2C </td></tr>
<tr id="row_25_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCAlarm.html" target="_self">RTCAlarm</a></td><td class="desc">Stores alarm information from a realtime clock chip </td></tr>
<tr id="row_26_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCDate.html" target="_self">RTCDate</a></td><td class="desc">Stores date information from a realtime clock chip </td></tr>
<tr id="row_27_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCTime.html" target="_self">RTCTime</a></td><td class="desc">Stores time information from a realtime clock chip </td></tr>
<tr id="row_28_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classShellArguments.html" target="_self">ShellArguments</a></td><td class="desc">Convenience class that encapsulates an array of shell command arguments </td></tr>
<tr id="row_29_" class="even"><td class="entry"><img id="arr_29_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('29_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><b>Stream</b></td><td class="desc"></td></tr>
<tr id="row_29_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_29_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('29_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTerminal.html" target="_self">Terminal</a></td><td class="desc">Extended stream interface for terminal operations </td></tr>
<tr id="row_29_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_29_0_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('29_0_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classShell.html" target="_self">Shell</a></td><td class="desc">Command-line shell access </td></tr>
<tr id="row_29_0_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLoginShell.html" target="_self">LoginShell</a></td><td class="desc">Command-line shell access via a login shell </td></tr>
<tr id="row_30_" class="even"><td class="entry"><img id="arr_30_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('30_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXOF.html" target="_self">XOF</a></td><td class="desc">Abstract base class for Extendable-Output Functions (XOFs) </td></tr>
<tr id="row_30_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_30_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('30_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE.html" target="_self">SHAKE</a></td><td class="desc">Abstract base class for the <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Functions (XOFs) </td></tr>
<tr id="row_30_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE128.html" target="_self">SHAKE128</a></td><td class="desc"><a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 128-bit security </td></tr>
<tr id="row_30_0_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE256.html" target="_self">SHAKE256</a></td><td class="desc"><a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 256-bit security </td></tr>
<tr id="row_31_" class="even"><td class="entry"><img id="arr_31_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('31_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSCommon.html" target="_self">XTSCommon</a></td><td class="desc">Concrete base class to assist with implementing <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_31_0_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTS.html" target="_self">XTS&lt; T1, T2 &gt;</a></td><td class="desc">Implementation of the <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_31_1_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_31_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('31_1_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSSingleKeyCommon.html" target="_self">XTSSingleKeyCommon</a></td><td class="desc">Concrete base class to assist with implementing single-key <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_31_1_0_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSSingleKey.html" target="_self">XTSSingleKey&lt; T &gt;</a></td><td class="desc">Implementation of the single-key <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_22_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classP521.html" target="_self">P521</a></td><td class="desc">Elliptic curve operations with the NIST P-521 curve </td></tr>
<tr id="row_23_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classPoly1305.html" target="_self">Poly1305</a></td><td class="desc"><a class="el" href="classPoly1305.html" title="Poly1305 message authenticator. ">Poly1305</a> message authenticator </td></tr>
<tr id="row_24_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRNGClass.html" target="_self">RNGClass</a></td><td class="desc">Pseudo random number generator suitable for cryptography </td></tr>
<tr id="row_25_"><td class="entry"><img id="arr_25_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('25_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classRTC.html" target="_self">RTC</a></td><td class="desc">Base class for realtime clock handlers </td></tr>
<tr id="row_25_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS1307RTC.html" target="_self">DS1307RTC</a></td><td class="desc">Communicates with a DS1307 realtime clock chip via I2C </td></tr>
<tr id="row_25_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS3231RTC.html" target="_self">DS3231RTC</a></td><td class="desc">Communicates with a DS3231 realtime clock chip via I2C </td></tr>
<tr id="row_25_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classDS3232RTC.html" target="_self">DS3232RTC</a></td><td class="desc">Communicates with a DS3232 realtime clock chip via I2C </td></tr>
<tr id="row_26_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCAlarm.html" target="_self">RTCAlarm</a></td><td class="desc">Stores alarm information from a realtime clock chip </td></tr>
<tr id="row_27_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCDate.html" target="_self">RTCDate</a></td><td class="desc">Stores date information from a realtime clock chip </td></tr>
<tr id="row_28_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="structRTCTime.html" target="_self">RTCTime</a></td><td class="desc">Stores time information from a realtime clock chip </td></tr>
<tr id="row_29_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classShellArguments.html" target="_self">ShellArguments</a></td><td class="desc">Convenience class that encapsulates an array of shell command arguments </td></tr>
<tr id="row_30_"><td class="entry"><img id="arr_30_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('30_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><b>Stream</b></td><td class="desc"></td></tr>
<tr id="row_30_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_30_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('30_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classTerminal.html" target="_self">Terminal</a></td><td class="desc">Extended stream interface for terminal operations </td></tr>
<tr id="row_30_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_30_0_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('30_0_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classShell.html" target="_self">Shell</a></td><td class="desc">Command-line shell access </td></tr>
<tr id="row_30_0_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classLoginShell.html" target="_self">LoginShell</a></td><td class="desc">Command-line shell access via a login shell </td></tr>
<tr id="row_31_"><td class="entry"><img id="arr_31_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('31_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXOF.html" target="_self">XOF</a></td><td class="desc">Abstract base class for Extendable-Output Functions (XOFs) </td></tr>
<tr id="row_31_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_31_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('31_0_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE.html" target="_self">SHAKE</a></td><td class="desc">Abstract base class for the <a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Functions (XOFs) </td></tr>
<tr id="row_31_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE128.html" target="_self">SHAKE128</a></td><td class="desc"><a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 128-bit security </td></tr>
<tr id="row_31_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classSHAKE256.html" target="_self">SHAKE256</a></td><td class="desc"><a class="el" href="classSHAKE.html" title="Abstract base class for the SHAKE Extendable-Output Functions (XOFs). ">SHAKE</a> Extendable-Output Function (<a class="el" href="classXOF.html" title="Abstract base class for Extendable-Output Functions (XOFs). ">XOF</a>) with 256-bit security </td></tr>
<tr id="row_32_"><td class="entry"><img id="arr_32_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('32_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSCommon.html" target="_self">XTSCommon</a></td><td class="desc">Concrete base class to assist with implementing <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_32_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTS.html" target="_self">XTS&lt; T1, T2 &gt;</a></td><td class="desc">Implementation of the <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_32_1_"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img id="arr_32_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('32_1_')"/><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSSingleKeyCommon.html" target="_self">XTSSingleKeyCommon</a></td><td class="desc">Concrete base class to assist with implementing single-key <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
<tr id="row_32_1_0_" class="even"><td class="entry"><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2blank.png" alt="&#160;" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><img src="ftv2cl.png" alt="C" width="24" height="22" /><a class="el" href="classXTSSingleKey.html" target="_self">XTSSingleKey&lt; T &gt;</a></td><td class="desc">Implementation of the single-key <a class="el" href="classXTS.html" title="Implementation of the XTS mode for 128-bit block ciphers. ">XTS</a> mode for 128-bit block ciphers </td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 23 2016 19:08:47 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
Generated on Sat Mar 26 2016 19:04:41 for ArduinoLibs by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>