Deploying to gh-pages from @ f809f17dc8 🚀
This commit is contained in:
jgromes
parent
69322420ca
commit
e16abd1cf1
1 changed files with 53 additions and 48 deletions
|
|
@ -165,55 +165,60 @@ $(document).ready(function(){initNavTree('_pager_8h_source.html',''); initResiza
|
|||
<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="line"><a name="l00145"></a><span class="lineno"> 145</span>  </div>
|
||||
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
||||
<div class="line"><a name="l00158"></a><span class="lineno"> 158</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="l00159"></a><span class="lineno"> 159</span>  </div>
|
||||
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span>  <span class="keywordtype">size_t</span> <a class="code" href="class_pager_client.html#aec073fa9e5adcff9730482d9583715e9">available</a>();</div>
|
||||
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  </div>
|
||||
<div class="line"><a name="l00179"></a><span class="lineno"> 179</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="l00180"></a><span class="lineno"> 180</span>  </div>
|
||||
<div class="line"><a name="l00194"></a><span class="lineno"> 194</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="l00195"></a><span class="lineno"> 195</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  </div>
|
||||
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="preprocessor">#if !defined(RADIOLIB_GODMODE)</span></div>
|
||||
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span>  <span class="keyword">private</span>:</div>
|
||||
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00200"></a><span class="lineno"> 200</span>  <a class="code" href="class_physical_layer.html">PhysicalLayer</a>* _phy;</div>
|
||||
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span>  </div>
|
||||
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span>  <span class="keywordtype">float</span> _base;</div>
|
||||
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span>  <span class="keywordtype">float</span> _speed;</div>
|
||||
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span>  uint32_t _baseRaw;</div>
|
||||
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span>  uint16_t _shift;</div>
|
||||
<div class="line"><a name="l00206"></a><span class="lineno"> 206</span>  uint16_t _shiftHz;</div>
|
||||
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span>  uint16_t _bitDuration;</div>
|
||||
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  uint32_t _filterAddr;</div>
|
||||
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span>  uint32_t _filterMask;</div>
|
||||
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span>  <span class="keywordtype">bool</span> inv = <span class="keyword">false</span>;</div>
|
||||
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span>  </div>
|
||||
<div class="line"><a name="l00212"></a><span class="lineno"> 212</span>  <span class="comment">// BCH encoder</span></div>
|
||||
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span>  int32_t _bchAlphaTo[RADIOLIB_PAGER_BCH_N + 1];</div>
|
||||
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span>  int32_t _bchIndexOf[RADIOLIB_PAGER_BCH_N + 1];</div>
|
||||
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span>  int32_t _bchG[RADIOLIB_PAGER_BCH_N - RADIOLIB_PAGER_BCH_K + 1];</div>
|
||||
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span>  </div>
|
||||
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span>  <span class="keywordtype">void</span> write(uint32_t* data, <span class="keywordtype">size_t</span> len);</div>
|
||||
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span>  <span class="keywordtype">void</span> write(uint32_t codeWord);</div>
|
||||
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span>  </div>
|
||||
<div class="line"><a name="l00220"></a><span class="lineno"> 220</span> <span class="preprocessor">#if !defined(RADIOLIB_EXCLUDE_DIRECT_RECEIVE)</span></div>
|
||||
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span>  uint32_t read();</div>
|
||||
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="preprocessor">#endif</span></div>
|
||||
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span>  </div>
|
||||
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span>  uint8_t encodeBCD(<span class="keywordtype">char</span> c);</div>
|
||||
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span>  <span class="keywordtype">char</span> decodeBCD(uint8_t b);</div>
|
||||
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  </div>
|
||||
<div class="line"><a name="l00227"></a><span class="lineno"> 227</span>  <span class="keywordtype">void</span> encoderInit();</div>
|
||||
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span>  uint32_t encodeBCH(uint32_t data);</div>
|
||||
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> };</div>
|
||||
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span>  </div>
|
||||
<div class="line"><a name="l00231"></a><span class="lineno"> 231</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:258</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:254</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:27</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:55</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:51</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:20</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:263</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:222</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:259</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 -->
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue