198 lines
11 KiB
HTML
198 lines
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: RadioLibCRC Class Reference</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>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript" src="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectalign">
|
|
<div id="projectname">RadioLib
|
|
</div>
|
|
<div id="projectbrief">Universal wireless communication library for Arduino</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('class_radio_lib_c_r_c.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="class_radio_lib_c_r_c-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">RadioLibCRC Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class to calculate CRCs of varying formats.
|
|
<a href="class_radio_lib_c_r_c.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_c_r_c_8h_source.html">CRC.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a4f4042a369d55e234f4fc28f189139d5" id="r_a4f4042a369d55e234f4fc28f189139d5"><td class="memItemLeft" align="right" valign="top"><a id="a4f4042a369d55e234f4fc28f189139d5" name="a4f4042a369d55e234f4fc28f189139d5"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>RadioLibCRC</b> ()</td></tr>
|
|
<tr class="memdesc:a4f4042a369d55e234f4fc28f189139d5"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr>
|
|
<tr class="separator:a4f4042a369d55e234f4fc28f189139d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a92328d778fe59c046c6e74296eb5fb23" id="r_a92328d778fe59c046c6e74296eb5fb23"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_radio_lib_c_r_c.html#a92328d778fe59c046c6e74296eb5fb23">checksum</a> (const uint8_t *buff, size_t len)</td></tr>
|
|
<tr class="memdesc:a92328d778fe59c046c6e74296eb5fb23"><td class="mdescLeft"> </td><td class="mdescRight">Calculate checksum of a buffer. <br /></td></tr>
|
|
<tr class="separator:a92328d778fe59c046c6e74296eb5fb23"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:ad09b067c00cda1cc676c13602dee2f5a" id="r_ad09b067c00cda1cc676c13602dee2f5a"><td class="memItemLeft" align="right" valign="top"><a id="ad09b067c00cda1cc676c13602dee2f5a" name="ad09b067c00cda1cc676c13602dee2f5a"></a>
|
|
uint8_t </td><td class="memItemRight" valign="bottom"><b>size</b> = 8</td></tr>
|
|
<tr class="memdesc:ad09b067c00cda1cc676c13602dee2f5a"><td class="mdescLeft"> </td><td class="mdescRight">CRC size in bits. <br /></td></tr>
|
|
<tr class="separator:ad09b067c00cda1cc676c13602dee2f5a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:af3942e08bde9d9d127f735bd10392f6d" id="r_af3942e08bde9d9d127f735bd10392f6d"><td class="memItemLeft" align="right" valign="top"><a id="af3942e08bde9d9d127f735bd10392f6d" name="af3942e08bde9d9d127f735bd10392f6d"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>poly</b> = 0</td></tr>
|
|
<tr class="memdesc:af3942e08bde9d9d127f735bd10392f6d"><td class="mdescLeft"> </td><td class="mdescRight">CRC polynomial. <br /></td></tr>
|
|
<tr class="separator:af3942e08bde9d9d127f735bd10392f6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a579acc51fe7a01b0b9b3f2e0e57b7d5f" id="r_a579acc51fe7a01b0b9b3f2e0e57b7d5f"><td class="memItemLeft" align="right" valign="top"><a id="a579acc51fe7a01b0b9b3f2e0e57b7d5f" name="a579acc51fe7a01b0b9b3f2e0e57b7d5f"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>init</b> = 0</td></tr>
|
|
<tr class="memdesc:a579acc51fe7a01b0b9b3f2e0e57b7d5f"><td class="mdescLeft"> </td><td class="mdescRight">Initial value. <br /></td></tr>
|
|
<tr class="separator:a579acc51fe7a01b0b9b3f2e0e57b7d5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a46616ef58e9eeeca646de0c9fe681050" id="r_a46616ef58e9eeeca646de0c9fe681050"><td class="memItemLeft" align="right" valign="top"><a id="a46616ef58e9eeeca646de0c9fe681050" name="a46616ef58e9eeeca646de0c9fe681050"></a>
|
|
uint32_t </td><td class="memItemRight" valign="bottom"><b>out</b> = 0</td></tr>
|
|
<tr class="memdesc:a46616ef58e9eeeca646de0c9fe681050"><td class="mdescLeft"> </td><td class="mdescRight">Final XOR value. <br /></td></tr>
|
|
<tr class="separator:a46616ef58e9eeeca646de0c9fe681050"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac65a358753efd05067c19fcf1098ec04" id="r_ac65a358753efd05067c19fcf1098ec04"><td class="memItemLeft" align="right" valign="top"><a id="ac65a358753efd05067c19fcf1098ec04" name="ac65a358753efd05067c19fcf1098ec04"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>refIn</b> = false</td></tr>
|
|
<tr class="memdesc:ac65a358753efd05067c19fcf1098ec04"><td class="mdescLeft"> </td><td class="mdescRight">Whether to reflect input bytes. <br /></td></tr>
|
|
<tr class="separator:ac65a358753efd05067c19fcf1098ec04"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1b5aa578ed5818a7618df8c6cf98087" id="r_ab1b5aa578ed5818a7618df8c6cf98087"><td class="memItemLeft" align="right" valign="top"><a id="ab1b5aa578ed5818a7618df8c6cf98087" name="ab1b5aa578ed5818a7618df8c6cf98087"></a>
|
|
bool </td><td class="memItemRight" valign="bottom"><b>refOut</b> = false</td></tr>
|
|
<tr class="memdesc:ab1b5aa578ed5818a7618df8c6cf98087"><td class="mdescLeft"> </td><td class="mdescRight">Whether to reflect the result. <br /></td></tr>
|
|
<tr class="separator:ab1b5aa578ed5818a7618df8c6cf98087"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class to calculate CRCs of varying formats. </p>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="a92328d778fe59c046c6e74296eb5fb23" name="a92328d778fe59c046c6e74296eb5fb23"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a92328d778fe59c046c6e74296eb5fb23">◆ </a></span>checksum()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t RadioLibCRC::checksum </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t * </td>
|
|
<td class="paramname"><em>buff</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>len</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Calculate checksum of a buffer. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">buff</td><td>Buffer to calculate the checksum over. </td></tr>
|
|
<tr><td class="paramname">len</td><td>Size of the buffer in bytes. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The resulting checksum. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/utils/<a class="el" href="_c_r_c_8h_source.html">CRC.h</a></li>
|
|
<li>src/utils/<b>CRC.cpp</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_radio_lib_c_r_c.html">RadioLibCRC</a></li>
|
|
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|