189 lines
20 KiB
HTML
189 lines
20 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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/protocols/M17/M17.h Source File</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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<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.1 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(document).ready(function(){initNavTree('_m17_8h_source.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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">M17.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_M17_H)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_M17_H</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>  </div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>  </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#if !RADIOLIB_EXCLUDE_M17</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#include "../FSK4/FSK4.h"</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>  </div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">// basic M17 properties</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define RADIOLIB_M17_SHIFT_HZ (1600)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="preprocessor">#define RADIOLIB_M17_RATE_BAUD (4800)</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>  </div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">// preamble</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define RADIOLIB_M17_PRE_LEN_BYTES (192/4)</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define RADIOLIB_M17_PRE_PATTERN_LSF (0x77)</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define RADIOLIB_M17_PRE_PATTERN_BERT (0xDD)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">// end-of-transmission</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define RADIOLIB_M17_EOT_LEN_BYTES (192/4)</span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define RADIOLIB_M17_EOT_PATTERN (0x555D)</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">// sync-burst</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define RADIOLIB_M17_SYNC_BURST_LSF (0x55F7)</span></div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define RADIOLIB_M17_SYNC_BURST_BERT (0xDF55)</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define RADIOLIB_M17_SYNC_BURST_STREAM (0xFF5D)</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define RADIOLIB_M17_SYNC_BURST_PACKET (0x75FF)</span></div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>  </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// link setup frame (LFS) bit fields MSB LSB DESCRIPTION</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_MODE_PACKET (0x00UL << 0) </span><span class="comment">// 0 0 LSF packet/stream indicator: packet</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_MODE_STREAM (0x01UL << 0) </span><span class="comment">// 0 0 stream</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_DATA_TYPE_DATA (0x01UL << 1) </span><span class="comment">// 2 1 data type: data</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_DATA_TYPE_VOICE (0x02UL << 1) </span><span class="comment">// 2 1 voice</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_DATA_TYPE_VOICE_DATA (0x03UL << 1) </span><span class="comment">// 2 1 data + voice</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_ENC_NONE (0x00UL << 3) </span><span class="comment">// 4 3 encryption: none</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_ENC_SCRAMBLER (0x01UL << 3) </span><span class="comment">// 4 3 scrambler</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_ENC_AES (0x02UL << 3) </span><span class="comment">// 4 3 AES</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_ENC_OTHER (0x03UL << 3) </span><span class="comment">// 4 3 other</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_AES_LEN_128 (0x00UL << 5) </span><span class="comment">// 6 5 encryption key length: 128-bit</span></div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_AES_LEN_192 (0x01UL << 5) </span><span class="comment">// 6 5 192-bit</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_AES_LEN_256 (0x02UL << 5) </span><span class="comment">// 6 5 256-bit</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_SCRAMLER_LEN_8 (0x00UL << 5) </span><span class="comment">// 6 5 scrambler length: 8-bit</span></div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_SCRAMLER_LEN_16 (0x01UL << 5) </span><span class="comment">// 6 5 16-bit</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_SCRAMLER_LEN_24 (0x02UL << 5) </span><span class="comment">// 6 5 24-bit</span></div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">// maximum length of LSF frame before puncturing</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define RADIOLIB_M17_LSF_MAXLEN_BYTES_ENCODED (368/8)</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  </div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define RADIOLIB_M17_ADDR_LEN (6)</span></div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  </div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#define RADIOLIB_M17_RANDOMIZER_LEN (46)</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="keyword">static</span> <span class="keyword">const</span> uint8_t m17_randomizer[RADIOLIB_M17_RANDOMIZER_LEN] = {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  0xD6, 0xB5, 0xE2, 0x30, 0x82, 0xFF, 0x84, 0x62,</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  0xBA, 0x4E, 0x96, 0x90, 0xD8, 0x98, 0xDD, 0x5D,</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  0x0C, 0xC8, 0x52, 0x43, 0x91, 0x1D, 0xF8, 0x6E,</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  0x68, 0x2F, 0x35, 0xDA, 0x14, 0xEA, 0xCD, 0x76,</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  0x19, 0x8D, 0xD5, 0x80, 0xD1, 0x33, 0x87, 0x13,</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  0x57, 0x18, 0x2D, 0x29, 0x78, 0xC3</div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> };</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="class_m17_client.html"> 67</a></span> <span class="keyword">class </span><a class="code" href="class_m17_client.html">M17Client</a>: <span class="keyword">public</span> <a class="code" href="class_f_s_k4_client.html">FSK4Client</a> {</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keyword">explicit</span> <a class="code" href="class_m17_client.html#abf9011b3d951f650bf23ecc70ef6b9b1">M17Client</a>(<a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phy);</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  int16_t <a class="code" href="class_m17_client.html#a2ea9518bd13a2ff929096685c405297c">begin</a>(<span class="keywordtype">float</span> base, <span class="keywordtype">char</span>* addr);</div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  </div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  int16_t transmit(uint8_t* data, <span class="keywordtype">size_t</span> len, <span class="keywordtype">char</span>* dst);</div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  </div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  uint8_t src[RADIOLIB_M17_ADDR_LEN] = { 0 };</div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  uint8_t randIndex = 0;</div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  </div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  int16_t encodeAddr(<span class="keywordtype">char</span>* in, uint8_t* out);</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  <span class="keywordtype">size_t</span> encodeLsf(<span class="keywordtype">char</span>* dst, uint16_t type, uint8_t* out, uint8_t* meta = NULL, <span class="keywordtype">size_t</span> metaLen = 0);</div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  <span class="keywordtype">void</span> randomize(uint8_t* buff, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_f_s_k4_client_html"><div class="ttname"><a href="class_f_s_k4_client.html">FSK4Client</a></div><div class="ttdoc">Client for FSK-4 communication. The public interface is the same as Arduino Serial.</div><div class="ttdef"><b>Definition:</b> FSK4.h:15</div></div>
|
|
<div class="ttc" id="aclass_m17_client_html"><div class="ttname"><a href="class_m17_client.html">M17Client</a></div><div class="ttdoc">Client for M17 transmissions.</div><div class="ttdef"><b>Definition:</b> M17.h:67</div></div>
|
|
<div class="ttc" id="aclass_m17_client_html_a2ea9518bd13a2ff929096685c405297c"><div class="ttname"><a href="class_m17_client.html#a2ea9518bd13a2ff929096685c405297c">M17Client::begin</a></div><div class="ttdeci">int16_t begin(float base, char *addr)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> M17.cpp:14</div></div>
|
|
<div class="ttc" id="aclass_m17_client_html_abf9011b3d951f650bf23ecc70ef6b9b1"><div class="ttname"><a href="class_m17_client.html#abf9011b3d951f650bf23ecc70ef6b9b1">M17Client::M17Client</a></div><div class="ttdeci">M17Client(PhysicalLayer *phy)</div><div class="ttdoc">Constructor for 4-FSK mode.</div><div class="ttdef"><b>Definition:</b> M17.cpp:10</div></div>
|
|
<div class="ttc" id="aclass_physical_layer_html"><div class="ttname"><a href="class_physical_layer.html">PhysicalLayer</a></div><div class="ttdoc">Provides common interface for protocols that run on LoRa/FSK modules, such as RTTY or LoRaWAN....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.h:151</div></div>
|
|
</div><!-- fragment --></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="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_79690749eba542503bb1a9a3dbb495e1.html">protocols</a></li><li class="navelem"><a class="el" href="dir_6f58081cd2e9d169ec7decccfc9ebeeb.html">M17</a></li><li class="navelem"><b>M17.h</b></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.1 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|