228 lines
25 KiB
HTML
228 lines
25 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/Pager/Pager.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('_pager_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">Pager.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_PAGER_H) && !defined(RADIOLIB_EXCLUDE_PAGER)</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_PAGER_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> <span class="preprocessor">#include "../PhysicalLayer/PhysicalLayer.h"</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>  </div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// frequency shift in Hz</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define RADIOLIB_PAGER_FREQ_SHIFT_HZ (4500)</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>  </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">// supported encoding schemes</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define RADIOLIB_PAGER_ASCII (0)</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCD (1)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>  </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">// preamble length in 32-bit code words</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define RADIOLIB_PAGER_PREAMBLE_LENGTH (18)</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>  </div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">// protocol-specified code words</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define RADIOLIB_PAGER_PREAMBLE_CODE_WORD (0xAAAAAAAA)</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define RADIOLIB_PAGER_FRAME_SYNC_CODE_WORD (0x7CD215D8)</span></div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define RADIOLIB_PAGER_IDLE_CODE_WORD (0x7A89C197)</span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">// code word type identification flags</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define RADIOLIB_PAGER_ADDRESS_CODE_WORD (0UL)</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define RADIOLIB_PAGER_MESSAGE_CODE_WORD (1UL)</span></div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">// length of code word in bits</span></div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define RADIOLIB_PAGER_CODE_WORD_LEN (32)</span></div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>  </div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// number of message bits in a single code block</span></div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define RADIOLIB_PAGER_ADDRESS_POS (13)</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define RADIOLIB_PAGER_FUNC_BITS_POS (11)</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define RADIOLIB_PAGER_MESSAGE_BITS_LENGTH (20)</span></div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#define RADIOLIB_PAGER_MESSAGE_END_POS (11)</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">// number of code words in a batch</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="preprocessor">#define RADIOLIB_PAGER_BATCH_LEN (16)</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment">// mask for address bits in a single code word</span></div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define RADIOLIB_PAGER_ADDRESS_BITS_MASK (0x7FFFE000UL)</span></div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">// mask for function bits in a single code word</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#define RADIOLIB_PAGER_FUNCTION_BITS_MASK (0x00001800UL)</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment">// mask for BCH bits in a single code word</span></div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_BITS_MASK (0x000007FFUL)</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">// message type functional bits</span></div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#define RADIOLIB_PAGER_FUNC_BITS_NUMERIC (0b00UL << RADIOLIB_PAGER_FUNC_BITS_POS)</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#define RADIOLIB_PAGER_FUNC_BITS_TONE (0b01UL << RADIOLIB_PAGER_FUNC_BITS_POS)</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#define RADIOLIB_PAGER_FUNC_BITS_ALPHA (0b11UL << RADIOLIB_PAGER_FUNC_BITS_POS)</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="comment">// the maximum allowed address (2^22 - 1)</span></div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#define RADIOLIB_PAGER_ADDRESS_MAX (2097151)</span></div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment">// BCH(31, 21) code constants</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_M (5)</span></div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_N (31)</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_K (21)</span></div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_D (5)</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="comment">// BCH(31, 21) primitive polynomial x^5 + x^2 + 1</span></div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define RADIOLIB_PAGER_BCH_PRIMITIVE_POLY (0x25)</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="class_pager_client.html"> 69</a></span> <span class="keyword">class </span><a class="code" href="class_pager_client.html">PagerClient</a> {</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keyword">explicit</span> <a class="code" href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient</a>(<a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phy);</div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  </div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="comment">// basic methods</span></div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  int16_t <a class="code" href="class_pager_client.html#a1a1dc569f9b60b0ddd6ead7af5a8244f">begin</a>(<span class="keywordtype">float</span> base, uint16_t speed, <span class="keywordtype">bool</span> invert = <span class="keyword">false</span>, uint16_t shift = RADIOLIB_PAGER_FREQ_SHIFT_HZ);</div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  int16_t <a class="code" href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">sendTone</a>(uint32_t addr);</div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  </div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  int16_t <a class="code" href="class_pager_client.html#a897f990002a4a2196fcdb31c547e0648">transmit</a>(String& str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);</div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span>  </div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  int16_t <a class="code" href="class_pager_client.html#a897f990002a4a2196fcdb31c547e0648">transmit</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* str, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);</div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  int16_t <a class="code" href="class_pager_client.html#a897f990002a4a2196fcdb31c547e0648">transmit</a>(uint8_t* data, <span class="keywordtype">size_t</span> len, uint32_t addr, uint8_t encoding = RADIOLIB_PAGER_BCD);</div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span>  </div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  int16_t <a class="code" href="class_pager_client.html#ad6f4f034b71311144f76b629a8ef8f8d">startReceive</a>(RADIOLIB_PIN_TYPE pin, uint32_t addr, uint32_t mask = 0xFFFFF);</div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">available</a>();</div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  </div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>  int16_t <a class="code" href="class_pager_client.html#ac000d0d6b1eb389ead95290f8895d02d">readData</a>(String& str, <span class="keywordtype">size_t</span> len = 0, uint32_t* addr = NULL);</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  </div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  int16_t <a class="code" href="class_pager_client.html#ac000d0d6b1eb389ead95290f8895d02d">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span>* len, uint32_t* addr = NULL);</div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  </div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>  <span class="keyword">private</span>:</div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* _phy;</div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  </div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>  <span class="keywordtype">float</span> _base;</div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <span class="keywordtype">float</span> _speed;</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  uint32_t _baseRaw;</div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  uint16_t _shift;</div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  uint16_t _shiftHz;</div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  uint16_t _bitDuration;</div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  uint32_t _readBatchPos;</div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  uint32_t _filterAddr;</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  uint32_t _filterMask;</div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  <span class="keywordtype">bool</span> inv = <span class="keyword">false</span>;</div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  </div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="comment">// BCH encoder</span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  int32_t _bchAlphaTo[RADIOLIB_PAGER_BCH_N + 1];</div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  int32_t _bchIndexOf[RADIOLIB_PAGER_BCH_N + 1];</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  int32_t _bchG[RADIOLIB_PAGER_BCH_N - RADIOLIB_PAGER_BCH_K + 1];</div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  </div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  <span class="keywordtype">void</span> write(uint32_t* data, <span class="keywordtype">size_t</span> len);</div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  <span class="keywordtype">void</span> write(uint32_t codeWord);</div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  uint32_t read();</div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  </div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  uint8_t encodeBCD(<span class="keywordtype">char</span> c);</div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span>  <span class="keywordtype">char</span> decodeBCD(uint8_t b);</div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  </div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span>  <span class="keywordtype">void</span> encoderInit();</div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  uint32_t encodeBCH(uint32_t data);</div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> };</div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  </div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="preprocessor">#endif</span></div>
|
|
<div class="ttc" id="aclass_pager_client_html"><div class="ttname"><a href="class_pager_client.html">PagerClient</a></div><div class="ttdoc">Client for Pager communication.</div><div class="ttdef"><b>Definition:</b> Pager.h:69</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_a1a1dc569f9b60b0ddd6ead7af5a8244f"><div class="ttname"><a href="class_pager_client.html#a1a1dc569f9b60b0ddd6ead7af5a8244f">PagerClient::begin</a></div><div class="ttdeci">int16_t begin(float base, uint16_t speed, bool invert=false, uint16_t shift=RADIOLIB_PAGER_FREQ_SHIFT_HZ)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:23</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_a897f990002a4a2196fcdb31c547e0648"><div class="ttname"><a href="class_pager_client.html#a897f990002a4a2196fcdb31c547e0648">PagerClient::transmit</a></div><div class="ttdeci">int16_t transmit(String &str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD)</div><div class="ttdoc">Arduino String transmit method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:51</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_a8f9af4c0a5c2e9de7cdfa1a907479111"><div class="ttname"><a href="class_pager_client.html#a8f9af4c0a5c2e9de7cdfa1a907479111">PagerClient::sendTone</a></div><div class="ttdeci">int16_t sendTone(uint32_t addr)</div><div class="ttdoc">Method to send a tone-only alert to a destination pager.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:47</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_a9f978120467b13104fb356e9b7d855ec"><div class="ttname"><a href="class_pager_client.html#a9f978120467b13104fb356e9b7d855ec">PagerClient::PagerClient</a></div><div class="ttdeci">PagerClient(PhysicalLayer *phy)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:18</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_ac000d0d6b1eb389ead95290f8895d02d"><div class="ttname"><a href="class_pager_client.html#ac000d0d6b1eb389ead95290f8895d02d">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(String &str, size_t len=0, uint32_t *addr=NULL)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:249</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_ad6f4f034b71311144f76b629a8ef8f8d"><div class="ttname"><a href="class_pager_client.html#ad6f4f034b71311144f76b629a8ef8f8d">PagerClient::startReceive</a></div><div class="ttdeci">int16_t startReceive(RADIOLIB_PIN_TYPE pin, uint32_t addr, uint32_t mask=0xFFFFF)</div><div class="ttdoc">Start reception of POCSAG packets.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:217</div></div>
|
|
<div class="ttc" id="aclass_pager_client_html_aec073fa9e5adcff9730482d9583715e9"><div class="ttname"><a href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">PagerClient::available</a></div><div class="ttdeci">size_t available()</div><div class="ttdoc">Get the number of POCSAG batches available in buffer. Limited by the size of direct mode buffer!</div><div class="ttdef"><b>Definition:</b> Pager.cpp:245</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:14</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_6dea20bfcf2e1a380cdc520d491b79a2.html">Pager</a></li><li class="navelem"><b>Pager.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>
|