forks/RadioLibSmol
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Deploying to gh-pages from @ ffe271b0c6 🚀

Browse source
This commit is contained in:
jgromes 2021-11-29 07:06:42 +00:00
parent cfdb965d2b
commit a6925cca49
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
_physical_layer_8h_source.html
View file

@ -189,22 +189,22 @@ $(document).ready(function(){initNavTree('_physical_layer_8h_source.html',''); i
<div class="ttc" id="aclass_physical_layer_html_ab9060e8ab7a2da192b3bf53b3501553b"><div class="ttname"><a href="class_physical_layer.html#ab9060e8ab7a2da192b3bf53b3501553b">PhysicalLayer::setFrequencyDeviation</a></div><div class="ttdeci">virtual int16_t setFrequencyDeviation(float freqDev)=0</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Allowed values depend on bit rate setting and mu...</div></div>
<div class="ttc" id="aclass_physical_layer_html_a7d3419227d201d6912b77784636d437d"><div class="ttname"><a href="class_physical_layer.html#a7d3419227d201d6912b77784636d437d">PhysicalLayer::setEncoding</a></div><div class="ttdeci">virtual int16_t setEncoding(uint8_t encoding)=0</div><div class="ttdoc">Sets FSK data encoding. Only available in FSK mode. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_physical_layer_html_a4b04eb6155b06d8ef400131c647d54e7"><div class="ttname"><a href="class_physical_layer.html#a4b04eb6155b06d8ef400131c647d54e7">PhysicalLayer::transmitDirect</a></div><div class="ttdeci">virtual int16_t transmitDirect(uint32_t frf=0)=0</div><div class="ttdoc">Enables direct transmission mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module ...</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:186</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:191</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab76fe7d3e0f453a807b205161c980086"><div class="ttname"><a href="class_physical_layer.html#ab76fe7d3e0f453a807b205161c980086">PhysicalLayer::setDirectAction</a></div><div class="ttdeci">virtual void setDirectAction(void(*func)(void))=0</div><div class="ttdoc">Set interrupt service routine function to call when data bit is receveid in direct mode....</div></div>
<div class="ttc" id="aclass_physical_layer_html_a9b720e7776ad7ea805932578907b0058"><div class="ttname"><a href="class_physical_layer.html#a9b720e7776ad7ea805932578907b0058">PhysicalLayer::readBit</a></div><div class="ttdeci">virtual void readBit(RADIOLIB_PIN_TYPE pin)=0</div><div class="ttdoc">Function to read and process data bit in direct reception mode. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_physical_layer_html_ae8eed0e888a7c8742e89d2b850977de2"><div class="ttname"><a href="class_physical_layer.html#ae8eed0e888a7c8742e89d2b850977de2">PhysicalLayer::readData</a></div><div class="ttdeci">int16_t readData(String &amp;str, size_t len=0)</div><div class="ttdoc">Reads data that was received after calling startReceive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:59</div></div>
<div class="ttc" id="aclass_physical_layer_html_a46b22145b33e97cf6065ed826799b6b4"><div class="ttname"><a href="class_physical_layer.html#a46b22145b33e97cf6065ed826799b6b4">PhysicalLayer::receiveDirect</a></div><div class="ttdeci">virtual int16_t receiveDirect()=0</div><div class="ttdoc">Enables direct reception mode on pins DIO1 (clock) and DIO2 (data). Must be implemented in module cla...</div></div>
<div class="ttc" id="aclass_physical_layer_html_a929662904e9af2611e098dc13b91c977"><div class="ttname"><a href="class_physical_layer.html#a929662904e9af2611e098dc13b91c977">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read()</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:190</div></div>
<div class="ttc" id="aclass_physical_layer_html_a929662904e9af2611e098dc13b91c977"><div class="ttname"><a href="class_physical_layer.html#a929662904e9af2611e098dc13b91c977">PhysicalLayer::read</a></div><div class="ttdeci">uint8_t read()</div><div class="ttdoc">Get data from direct mode buffer.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:195</div></div>
<div class="ttc" id="aclass_physical_layer_html_a5e02457f1d519cf81b1590a182321c62"><div class="ttname"><a href="class_physical_layer.html#a5e02457f1d519cf81b1590a182321c62">PhysicalLayer::PhysicalLayer</a></div><div class="ttdeci">PhysicalLayer(float freqStep, size_t maxPacketLength)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:3</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 &quot;ham&quot; modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:172</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 &quot;ham&quot; modes like RTTY or AX....</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:177</div></div>
<div class="ttc" id="aclass_physical_layer_html_a34543b885aa57ade08a4c659991e523e"><div class="ttname"><a href="class_physical_layer.html#a34543b885aa57ade08a4c659991e523e">PhysicalLayer::randomByte</a></div><div class="ttdeci">virtual uint8_t randomByte()=0</div><div class="ttdoc">Get one truly random byte from RSSI noise. Must be implemented in module class.</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:144</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:149</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 class="ttc" id="aclass_physical_layer_html_afb1b090348d9091bfa3a0b5ba3d85b36"><div class="ttname"><a href="class_physical_layer.html#afb1b090348d9091bfa3a0b5ba3d85b36">PhysicalLayer::receive</a></div><div class="ttdeci">int16_t receive(String &amp;str, size_t len=0)</div><div class="ttdoc">Arduino String receive method.</div><div class="ttdef"><b>Definition:</b> PhysicalLayer.cpp:100</div></div>
<div class="ttc" id="aclass_physical_layer_html_a0bd6046e068ef63e3f2b6bead48e02a7"><div class="ttname"><a href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">PhysicalLayer::getPacketLength</a></div><div class="ttdeci">virtual size_t getPacketLength(bool update=true)=0</div><div class="ttdoc">Query modem for the packet length of received payload. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level methods to control the wireless module. Every module class contains o...</div><div class="ttdef"><b>Definition:</b> Module.h:16</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:199</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:140</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:204</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:145</div></div>
<div class="ttc" id="aclass_physical_layer_html_ab643a814dce48f71a13bf6ea23f44cbd"><div class="ttname"><a href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">PhysicalLayer::setDataShaping</a></div><div class="ttdeci">virtual int16_t setDataShaping(uint8_t sh)=0</div><div class="ttdoc">Sets GFSK data shaping. Only available in FSK mode. Must be implemented in module class.</div></div>
<div class="ttc" id="aclass_physical_layer_html_af068e6e862c99e39d0261a7971dd56db"><div class="ttname"><a href="class_physical_layer.html#af068e6e862c99e39d0261a7971dd56db">PhysicalLayer::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(String &amp;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:51</div></div>
<!-- start footer part -->