KrzysztofC/nRF52840_PTT
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: c9320eb9db

Browse Source
This commit is contained in:
ci
2026-05-21 22:42:06 +00:00
commit 82622c49db
138 changed files with 11505 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

267
fhss_8h.html Normal file
View File

@@ -0,0 +1,267 @@
<!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>ptt-fhss: include/fhss.h File 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="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">ptt-fhss
</div>
<div id="projectbrief">Bare-metal PTT firmware for nRF52840 with FHSS</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&amp;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&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">fhss.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>FHSS channel sequencer based on AES-128-ECB.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="fhss_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a6874b77e366ca7dd46cd88c41b4b1759" id="r_a6874b77e366ca7dd46cd88c41b4b1759"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#a6874b77e366ca7dd46cd88c41b4b1759">FHSS_DWELL_MS</a>&#160;&#160;&#160;2u</td></tr>
<tr class="memdesc:a6874b77e366ca7dd46cd88c41b4b1759"><td class="mdescLeft">&#160;</td><td class="mdescRight">Dwell time per channel in milliseconds. <br /></td></tr>
<tr class="separator:a6874b77e366ca7dd46cd88c41b4b1759"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af92d3579d3a9e88e73dd54a7bcad6341" id="r_af92d3579d3a9e88e73dd54a7bcad6341"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#af92d3579d3a9e88e73dd54a7bcad6341">FHSS_CHANNELS</a>&#160;&#160;&#160;40u</td></tr>
<tr class="memdesc:af92d3579d3a9e88e73dd54a7bcad6341"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of channels in the hopping sequence. <br /></td></tr>
<tr class="separator:af92d3579d3a9e88e73dd54a7bcad6341"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a44cfe02274ceefa5de0fed51e1c4e741" id="r_a44cfe02274ceefa5de0fed51e1c4e741"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#a44cfe02274ceefa5de0fed51e1c4e741">fhss_init</a> (void)</td></tr>
<tr class="memdesc:a44cfe02274ceefa5de0fed51e1c4e741"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reset the slot counter to zero. <br /></td></tr>
<tr class="separator:a44cfe02274ceefa5de0fed51e1c4e741"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a28190a786a8da0f56bfbe8261dfc359a" id="r_a28190a786a8da0f56bfbe8261dfc359a"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#a28190a786a8da0f56bfbe8261dfc359a">fhss_next_channel</a> (void)</td></tr>
<tr class="memdesc:a28190a786a8da0f56bfbe8261dfc359a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the next channel in the hopping sequence and advance the slot. <br /></td></tr>
<tr class="separator:a28190a786a8da0f56bfbe8261dfc359a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa254dd2e4da40c6ac7f1d1b189666eca" id="r_aa254dd2e4da40c6ac7f1d1b189666eca"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#aa254dd2e4da40c6ac7f1d1b189666eca">fhss_sync_tick</a> (void)</td></tr>
<tr class="memdesc:aa254dd2e4da40c6ac7f1d1b189666eca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advance the slot counter by one (receiver side, no packet received). <br /></td></tr>
<tr class="separator:aa254dd2e4da40c6ac7f1d1b189666eca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4db6a04939b3d885681ebd1bbab03cb2" id="r_a4db6a04939b3d885681ebd1bbab03cb2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#a4db6a04939b3d885681ebd1bbab03cb2">fhss_set_slot</a> (uint32_t s)</td></tr>
<tr class="memdesc:a4db6a04939b3d885681ebd1bbab03cb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Force the slot counter to a specific value for RX synchronisation. <br /></td></tr>
<tr class="separator:a4db6a04939b3d885681ebd1bbab03cb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c45cff675465f11798eaf0a0e0b8d0e" id="r_a7c45cff675465f11798eaf0a0e0b8d0e"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="fhss_8h.html#a7c45cff675465f11798eaf0a0e0b8d0e">fhss_get_slot</a> (void)</td></tr>
<tr class="memdesc:a7c45cff675465f11798eaf0a0e0b8d0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return the current slot counter value. <br /></td></tr>
<tr class="separator:a7c45cff675465f11798eaf0a0e0b8d0e"><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>FHSS channel sequencer based on AES-128-ECB. </p>
<p>Both link endpoints derive the same hopping sequence independently from a shared 128-bit key and a monotonically increasing slot counter. No synchronisation traffic is required as long as both sides start from the same slot. </p>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="af92d3579d3a9e88e73dd54a7bcad6341" name="af92d3579d3a9e88e73dd54a7bcad6341"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af92d3579d3a9e88e73dd54a7bcad6341">&#9670;&#160;</a></span>FHSS_CHANNELS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FHSS_CHANNELS&#160;&#160;&#160;40u</td>
</tr>
</table>
</div><div class="memdoc">
<p>Number of channels in the hopping sequence. </p>
</div>
</div>
<a id="a6874b77e366ca7dd46cd88c41b4b1759" name="a6874b77e366ca7dd46cd88c41b4b1759"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6874b77e366ca7dd46cd88c41b4b1759">&#9670;&#160;</a></span>FHSS_DWELL_MS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define FHSS_DWELL_MS&#160;&#160;&#160;2u</td>
</tr>
</table>
</div><div class="memdoc">
<p>Dwell time per channel in milliseconds. </p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a7c45cff675465f11798eaf0a0e0b8d0e" name="a7c45cff675465f11798eaf0a0e0b8d0e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7c45cff675465f11798eaf0a0e0b8d0e">&#9670;&#160;</a></span>fhss_get_slot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t fhss_get_slot </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the current slot counter value. </p>
</div>
</div>
<a id="a44cfe02274ceefa5de0fed51e1c4e741" name="a44cfe02274ceefa5de0fed51e1c4e741"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a44cfe02274ceefa5de0fed51e1c4e741">&#9670;&#160;</a></span>fhss_init()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fhss_init </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the slot counter to zero. </p>
</div>
</div>
<a id="a28190a786a8da0f56bfbe8261dfc359a" name="a28190a786a8da0f56bfbe8261dfc359a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a28190a786a8da0f56bfbe8261dfc359a">&#9670;&#160;</a></span>fhss_next_channel()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t fhss_next_channel </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the next channel in the hopping sequence and advance the slot. </p>
<dl class="section return"><dt>Returns</dt><dd>Channel index in [0, 39]. </dd></dl>
</div>
</div>
<a id="a4db6a04939b3d885681ebd1bbab03cb2" name="a4db6a04939b3d885681ebd1bbab03cb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4db6a04939b3d885681ebd1bbab03cb2">&#9670;&#160;</a></span>fhss_set_slot()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fhss_set_slot </td>
<td>(</td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>s</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Force the slot counter to a specific value for RX synchronisation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">s</td><td>New slot value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa254dd2e4da40c6ac7f1d1b189666eca" name="aa254dd2e4da40c6ac7f1d1b189666eca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa254dd2e4da40c6ac7f1d1b189666eca">&#9670;&#160;</a></span>fhss_sync_tick()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fhss_sync_tick </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Advance the slot counter by one (receiver side, no packet received). </p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>