Deploying to gh-pages from @ 3968e611af 🚀
This commit is contained in:
jgromes
parent
b53ac51399
commit
5dafc8529c
1 changed files with 11 additions and 11 deletions
|
|
@ -249,31 +249,31 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
|
|||
<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:68</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:15</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a13dbafeeb9dd9ede72cc4d907738ac48"><div class="ttname"><a href="class_physical_layer.html#a13dbafeeb9dd9ede72cc4d907738ac48">PhysicalLayer::startReceive</a></div><div class="ttdeci">virtual int16_t startReceive(uint32_t timeout, uint16_t irqFlags, uint16_t irqMask, size_t len)</div><div class="ttdoc">Interrupt-driven receive method. A DIO pin will be activated when full packet is received....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:131</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a1a5985308904261dd431f373d47ddee4"><div class="ttname"><a href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:290</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a1a5985308904261dd431f373d47ddee4"><div class="ttname"><a href="class_physical_layer.html#a1a5985308904261dd431f373d47ddee4">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:289</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a1de26f68b939f5af79ec29cc34c7be18"><div class="ttname"><a href="class_physical_layer.html#a1de26f68b939f5af79ec29cc34c7be18">PhysicalLayer::finishTransmit</a></div><div class="ttdeci">virtual int16_t finishTransmit()</div><div class="ttdoc">Clean up after transmission is done.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:156</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a2f4f9b428d9ea9af886ca85e5088ed7b"><div class="ttname"><a href="class_physical_layer.html#a2f4f9b428d9ea9af886ca85e5088ed7b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Only available in FSK mode. Must be implemented ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:230</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a2fe95169b5cdc8cabe1f2af66cad6ef6"><div class="ttname"><a href="class_physical_layer.html#a2fe95169b5cdc8cabe1f2af66cad6ef6">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:249</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a349e8a22cd28ad89d45460fdeeefc05c"><div class="ttname"><a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:389</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a349e8a22cd28ad89d45460fdeeefc05c"><div class="ttname"><a href="class_physical_layer.html#a349e8a22cd28ad89d45460fdeeefc05c">PhysicalLayer::setDIOMapping</a></div><div class="ttdeci">virtual int16_t setDIOMapping(uint32_t pin, uint32_t value)</div><div class="ttdoc">Configure DIO pin mapping to get a given signal on a DIO pin (if available).</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:388</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a3563453988a83d22dd07d4691543a300"><div class="ttname"><a href="class_physical_layer.html#a3563453988a83d22dd07d4691543a300">PhysicalLayer::readData</a></div><div class="ttdeci">virtual int16_t readData(uint8_t *data, size_t len)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:205</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a429796eb2e7ea86781a2e8ca42af43f3"><div class="ttname"><a href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">PhysicalLayer::dropSync</a></div><div class="ttdeci">void dropSync()</div><div class="ttdoc">Forcefully drop synchronization.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:313</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a429796eb2e7ea86781a2e8ca42af43f3"><div class="ttname"><a href="class_physical_layer.html#a429796eb2e7ea86781a2e8ca42af43f3">PhysicalLayer::dropSync</a></div><div class="ttdeci">void dropSync()</div><div class="ttdoc">Forcefully drop synchronization.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:312</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a492b2d057dd803c3884fa1adc8e22534"><div class="ttname"><a href="class_physical_layer.html#a492b2d057dd803c3884fa1adc8e22534">PhysicalLayer::transmit</a></div><div class="ttdeci">int16_t transmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">C-string transmit method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:52</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a4d5b30493c8d7fcfb784e128362d596c"><div class="ttname"><a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read(bool drop=true)</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:320</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a63c0beb4990876947f746751d45ac41d"><div class="ttname"><a href="class_physical_layer.html#a63c0beb4990876947f746751d45ac41d">PhysicalLayer::setDio1Action</a></div><div class="ttdeci">virtual void setDio1Action(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:395</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a88a10657bd2215a11a2331f937414b55"><div class="ttname"><a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">PhysicalLayer::startDirect</a></div><div class="ttdeci">int16_t startDirect()</div><div class="ttdoc">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:294</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a4d5b30493c8d7fcfb784e128362d596c"><div class="ttname"><a href="class_physical_layer.html#a4d5b30493c8d7fcfb784e128362d596c">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read(bool drop=true)</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:319</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a63c0beb4990876947f746751d45ac41d"><div class="ttname"><a href="class_physical_layer.html#a63c0beb4990876947f746751d45ac41d">PhysicalLayer::setDio1Action</a></div><div class="ttdeci">virtual void setDio1Action(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:394</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a88a10657bd2215a11a2331f937414b55"><div class="ttname"><a href="class_physical_layer.html#a88a10657bd2215a11a2331f937414b55">PhysicalLayer::startDirect</a></div><div class="ttdeci">int16_t startDirect()</div><div class="ttdoc">Configure module parameters for direct modes. Must be called prior to "ham" modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:293</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a8a194b0fbb66b1a953288bf3b9478d6e"><div class="ttname"><a href="class_physical_layer.html#a8a194b0fbb66b1a953288bf3b9478d6e">PhysicalLayer::setFrequency</a></div><div class="ttdeci">virtual int16_t setFrequency(float freq)</div><div class="ttdoc">Sets carrier frequency. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:220</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a8e378fe136a498ea485a9c10f5e15aab"><div class="ttname"><a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">PhysicalLayer::setDirectSyncWord</a></div><div class="ttdeci">int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)</div><div class="ttdoc">Set sync word to be used to determine start of packet in direct reception mode.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:328</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a8e378fe136a498ea485a9c10f5e15aab"><div class="ttname"><a href="class_physical_layer.html#a8e378fe136a498ea485a9c10f5e15aab">PhysicalLayer::setDirectSyncWord</a></div><div class="ttdeci">int16_t setDirectSyncWord(uint32_t syncWord, uint8_t len)</div><div class="ttdoc">Set sync word to be used to determine start of packet in direct reception mode.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:327</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a923654706eff5118ef6e84214e837f27"><div class="ttname"><a href="class_physical_layer.html#a923654706eff5118ef6e84214e837f27">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(const char *str, uint8_t addr=0)</div><div class="ttdoc">Interrupt-driven Arduino String transmit method. Unlike the standard transmit method,...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:145</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_a977e5236693960bb1c79090a201e9e1c"><div class="ttname"><a href="class_physical_layer.html#a977e5236693960bb1c79090a201e9e1c">PhysicalLayer::getFreqStep</a></div><div class="ttdeci">float getFreqStep() const</div><div class="ttdoc">Gets the module frequency step size that was set in constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:245</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_aa4c99ac794ee653c2061be4201724b65"><div class="ttname"><a href="class_physical_layer.html#aa4c99ac794ee653c2061be4201724b65">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:211</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_aabc94ab27a9ee6daaafa9b47dde5f75b"><div class="ttname"><a href="class_physical_layer.html#aabc94ab27a9ee6daaafa9b47dde5f75b">PhysicalLayer::getRSSI</a></div><div class="ttdeci">virtual float getRSSI()</div><div class="ttdoc">Gets RSSI (Recorded Signal Strength Indicator) of the last received packet.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:254</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ab57182d32646861ef0d865e2740d6b26"><div class="ttname"><a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">PhysicalLayer::available</a></div><div class="ttdeci">int16_t available()</div><div class="ttdoc">Get the number of direct mode bytes currently available in buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:309</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ab57182d32646861ef0d865e2740d6b26"><div class="ttname"><a href="class_physical_layer.html#ab57182d32646861ef0d865e2740d6b26">PhysicalLayer::available</a></div><div class="ttdeci">int16_t available()</div><div class="ttdoc">Get the number of direct mode bytes currently available in buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:308</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ab82617fa3fa9f21d4cd427314ecc4af8"><div class="ttname"><a href="class_physical_layer.html#ab82617fa3fa9f21d4cd427314ecc4af8">PhysicalLayer::receive</a></div><div class="ttdeci">virtual int16_t receive(uint8_t *data, size_t len)</div><div class="ttdoc">Binary receive method. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:112</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_abf96cf4f3cb4c82d44be581dbe615966"><div class="ttname"><a href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:379</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_abf96cf4f3cb4c82d44be581dbe615966"><div class="ttname"><a href="class_physical_layer.html#abf96cf4f3cb4c82d44be581dbe615966">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:378</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_acb45b2342400a03a914a91d2ac7fb488"><div class="ttname"><a href="class_physical_layer.html#acb45b2342400a03a914a91d2ac7fb488">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:240</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_acbcaf6aefcb77a354797e66222fe5018"><div class="ttname"><a href="class_physical_layer.html#acbcaf6aefcb77a354797e66222fe5018">PhysicalLayer::standby</a></div><div class="ttdeci">virtual int16_t standby()</div><div class="ttdoc">Sets module to standby.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:122</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_acd9171bd71aa80fb86113b612c42de53"><div class="ttname"><a href="class_physical_layer.html#acd9171bd71aa80fb86113b612c42de53">PhysicalLayer::random</a></div><div class="ttdeci">int32_t random(int32_t max)</div><div class="ttdoc">Get truly random number in range 0 - max.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:262</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_acda61fc99cfa373153c50c78380ed885"><div class="ttname"><a href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(uint32_t pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:383</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ad30127e094d8148870b9631007ec6b29"><div class="ttname"><a href="class_physical_layer.html#ad30127e094d8148870b9631007ec6b29">PhysicalLayer::clearDio1Action</a></div><div class="ttdeci">virtual void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:399</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_acda61fc99cfa373153c50c78380ed885"><div class="ttname"><a href="class_physical_layer.html#acda61fc99cfa373153c50c78380ed885">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(uint32_t pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:382</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ad30127e094d8148870b9631007ec6b29"><div class="ttname"><a href="class_physical_layer.html#ad30127e094d8148870b9631007ec6b29">PhysicalLayer::clearDio1Action</a></div><div class="ttdeci">virtual void clearDio1Action()</div><div class="ttdoc">Clears interrupt service routine to call when DIO1 activates.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:398</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_ad9d1dbb2041e87af5a80e12f125a60e6"><div class="ttname"><a href="class_physical_layer.html#ad9d1dbb2041e87af5a80e12f125a60e6">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:216</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_add63d7d4fa8b14df5e185813794a49d5"><div class="ttname"><a href="class_physical_layer.html#add63d7d4fa8b14df5e185813794a49d5">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float step, size_t maxLen)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:4</div></div>
|
||||
<div class="ttc" id="aclass_physical_layer_html_aeba04366a0cf05ff3d8227c4f7c8e1e9"><div class="ttname"><a href="class_physical_layer.html#aeba04366a0cf05ff3d8227c4f7c8e1e9">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:235</div></div>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue