Deploying to gh-pages from @ cf561733d2 🚀

gh-pages
jgromes 2024-03-02 17:10:28 +00:00
rodzic d877f60233
commit 54b25d1293
2 zmienionych plików z 46 dodań i 45 usunięć

Wyświetl plik

@ -164,57 +164,57 @@ $(document).ready(function(){initNavTree('_pager_8h_source.html',''); initResiza
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>&#160;<span class="preprocessor"> #if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span>&#160; int16_t <a class="code" href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">startReceive</a>(uint32_t pin, uint32_t addr, uint32_t mask = 0xFFFFF);</div>
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span>&#160; </div>
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span>&#160; int16_t <a class="code" href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">startReceive</a>(uint32_t pin, uint32_t *addrs, uint32_t *masks, <span class="keywordtype">size_t</span> numAddress);</div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; </div>
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">available</a>();</div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; </div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160;<span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span>&#160; int16_t <a class="code" href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">readData</a>(String&amp; str, <span class="keywordtype">size_t</span> len = 0, uint32_t* addr = NULL);</div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160; </div>
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span>&#160; int16_t <a class="code" href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span>* len, uint32_t* addr = NULL);</div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160; </div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160; <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; </div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; <span class="keywordtype">float</span> baseFreq;</div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordtype">float</span> dataRate;</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; uint32_t baseFreqRaw;</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; uint16_t shiftFreq;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; uint16_t shiftFreqHz;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; uint16_t bitDuration;</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; uint32_t filterAddr;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; uint32_t filterMask;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; uint32_t *filterAddresses;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; uint32_t *filterMasks;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; <span class="keywordtype">size_t</span> filterNumAddresses;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordtype">bool</span> inv = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; </div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; <span class="keywordtype">void</span> write(uint32_t* data, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keywordtype">void</span> write(uint32_t codeWord);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; uint16_t startReceiveCommon();</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; <span class="keywordtype">bool</span> addressMatched(uint32_t addr);</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; </div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160;<span class="preprocessor">#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160; uint32_t read();</div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160; </div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; uint8_t encodeBCD(<span class="keywordtype">char</span> c);</div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; <span class="keywordtype">char</span> decodeBCD(uint8_t b);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160;};</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160; </div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span>&#160; int16_t <a class="code" href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">startReceive</a>(uint32_t pin, uint32_t *addrs, uint32_t *masks, <span class="keywordtype">size_t</span> numAddress);</div>
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span>&#160; </div>
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span>&#160; <span class="keywordtype">size_t</span> <a class="code" href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">available</a>();</div>
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span>&#160; </div>
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span>&#160;<span class="preprocessor"> #if defined(RADIOLIB_BUILD_ARDUINO)</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span>&#160; int16_t <a class="code" href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">readData</a>(String&amp; str, <span class="keywordtype">size_t</span> len = 0, uint32_t* addr = NULL);</div>
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span>&#160;<span class="preprocessor"> #endif</span></div>
<div class="line"><a name="l00161"></a><span class="lineno"> 161</span>&#160; </div>
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span>&#160; int16_t <a class="code" href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">readData</a>(uint8_t* data, <span class="keywordtype">size_t</span>* len, uint32_t* addr = NULL);</div>
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span>&#160; </div>
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span>&#160;<span class="preprocessor">#if !RADIOLIB_GODMODE</span></div>
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span>&#160; <span class="keyword">private</span>:</div>
<div class="line"><a name="l00177"></a><span class="lineno"> 177</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span>&#160; <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* phyLayer;</div>
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span>&#160; </div>
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span>&#160; <span class="keywordtype">float</span> baseFreq;</div>
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span>&#160; <span class="keywordtype">float</span> dataRate;</div>
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span>&#160; uint32_t baseFreqRaw;</div>
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span>&#160; uint16_t shiftFreq;</div>
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span>&#160; uint16_t shiftFreqHz;</div>
<div class="line"><a name="l00185"></a><span class="lineno"> 185</span>&#160; uint16_t bitDuration;</div>
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span>&#160; uint32_t filterAddr;</div>
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span>&#160; uint32_t filterMask;</div>
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span>&#160; uint32_t *filterAddresses;</div>
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span>&#160; uint32_t *filterMasks;</div>
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>&#160; <span class="keywordtype">size_t</span> filterNumAddresses;</div>
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span>&#160; <span class="keywordtype">bool</span> inv = <span class="keyword">false</span>;</div>
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span>&#160; </div>
<div class="line"><a name="l00193"></a><span class="lineno"> 193</span>&#160; <span class="keywordtype">void</span> write(uint32_t* data, <span class="keywordtype">size_t</span> len);</div>
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span>&#160; <span class="keywordtype">void</span> write(uint32_t codeWord);</div>
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span>&#160; int16_t startReceiveCommon();</div>
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>&#160; <span class="keywordtype">bool</span> addressMatched(uint32_t addr);</div>
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span>&#160; </div>
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>&#160;<span class="preprocessor">#if !RADIOLIB_EXCLUDE_DIRECT_RECEIVE</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span>&#160; uint32_t read();</div>
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>&#160; </div>
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>&#160; uint8_t encodeBCD(<span class="keywordtype">char</span> c);</div>
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>&#160; <span class="keywordtype">char</span> decodeBCD(uint8_t b);</div>
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>&#160;};</div>
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>&#160; </div>
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>&#160;<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:62</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:36</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:60</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:26</div></div>
<div class="ttc" id="aclass_pager_client_html_ac232570ac012ff315a1971ab0422fed3"><div class="ttname"><a href="class_pager_client.html#ac232570ac012ff315a1971ab0422fed3">PagerClient::startReceive</a></div><div class="ttdeci">int16_t startReceive(uint32_t 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:246</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, 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:349</div></div>
<div class="ttc" id="aclass_pager_client_html_ad2c6132819a84712b929c0bb22ba172b"><div class="ttname"><a href="class_pager_client.html#ad2c6132819a84712b929c0bb22ba172b">PagerClient::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t *len, 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:351</div></div>
<div class="ttc" id="aclass_pager_client_html_adbab4e162a5719bd4407a42a85d26ff6"><div class="ttname"><a href="class_pager_client.html#adbab4e162a5719bd4407a42a85d26ff6">PagerClient::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint32_t addr, uint8_t encoding=RADIOLIB_PAGER_BCD, uint8_t function=RADIOLIB_PAGER_FUNC_AUTO)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> Pager.cpp:70</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:298</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:300</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:34</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->

Wyświetl plik

@ -351,6 +351,7 @@ Public Member Functions</h2></td></tr>
<tr><td class="paramname">pin</td><td>Pin to receive digital data on (e.g., DIO2 for <a class="el" href="class_s_x127x.html" title="Base class for SX127x series. All derived classes for SX127x (e.g. SX1278 or SX1272) inherit from thi...">SX127x</a>). </td></tr>
<tr><td class="paramname">addrs</td><td>Array of addresses to receive. </td></tr>
<tr><td class="paramname">masks</td><td>Array of address masks to use for filtering. Masks will be applied to corresponding addresses in addr array. </td></tr>
<tr><td class="paramname">numAddress</td><td>Number of addresses/masks to match. </td></tr>
</table>
</dd>
</dl>