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

Deploying to gh-pages from @ b3922470c4 🚀

Browse source
This commit is contained in:
jgromes 2022-01-31 22:16:05 +00:00
parent ca8ee6ab18
commit 117a5188dd
9 changed files with 29 additions and 32 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
_si443x_8h_source.html
View file

@ -752,32 +752,32 @@ $(document).ready(function(){initNavTree('_si443x_8h_source.html',''); initResiz
<div class="ttc" id="aclass_si443x_html_ac45d2776df3ff338db154ead143fb7b8"><div class="ttname"><a href="class_si443x.html#ac45d2776df3ff338db154ead143fb7b8">Si443x::standby</a></div><div class="ttdeci">int16_t standby() override</div><div class="ttdoc">Sets the module to standby.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:143</div></div>
<div class="ttc" id="aclass_si443x_html_ad43575e731dd7e66d5ad9e6dccd27170"><div class="ttname"><a href="class_si443x.html#ad43575e731dd7e66d5ad9e6dccd27170">Si443x::setBitRate</a></div><div class="ttdeci">int16_t setBitRate(float br)</div><div class="ttdoc">Sets FSK bit rate. Allowed values range from 0.123 to 256.0 kbps.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:320</div></div>
<div class="ttc" id="aclass_si443x_html_a4821a6141caf16141074615c976ecd91"><div class="ttname"><a href="class_si443x.html#a4821a6141caf16141074615c976ecd91">Si443x::setPreambleLength</a></div><div class="ttdeci">int16_t setPreambleLength(uint8_t preambleLen)</div><div class="ttdoc">Sets preamble length.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:498</div></div>
<div class="ttc" id="aclass_si443x_html_abcca8ab4a1229efb5e7c6b09e564a48a"><div class="ttname"><a href="class_si443x.html#abcca8ab4a1229efb5e7c6b09e564a48a">Si443x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in variable packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:601</div></div>
<div class="ttc" id="aclass_si443x_html_abcca8ab4a1229efb5e7c6b09e564a48a"><div class="ttname"><a href="class_si443x.html#abcca8ab4a1229efb5e7c6b09e564a48a">Si443x::variablePacketLengthMode</a></div><div class="ttdeci">int16_t variablePacketLengthMode(uint8_t maxLen=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in variable packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:604</div></div>
<div class="ttc" id="aclass_si443x_html_a616eb24c4b11c5d39caaade160be8092"><div class="ttname"><a href="class_si443x.html#a616eb24c4b11c5d39caaade160be8092">Si443x::packetMode</a></div><div class="ttdeci">int16_t packetMode()</div><div class="ttdoc">Disables direct mode and enables packet mode, allowing the module to receive packets.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:205</div></div>
<div class="ttc" id="aclass_si443x_html_a51e6b7c677e82042224798114f311175"><div class="ttname"><a href="class_si443x.html#a51e6b7c677e82042224798114f311175">Si443x::setRxBandwidth</a></div><div class="ttdeci">int16_t setRxBandwidth(float rxBw)</div><div class="ttdoc">Sets receiver bandwidth. Allowed values range from 2.6 to 620.7 kHz.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:374</div></div>
<div class="ttc" id="aclass_si443x_html_a453eda5436dc4dfe0dad676dc3977752"><div class="ttname"><a href="class_si443x.html#a453eda5436dc4dfe0dad676dc3977752">Si443x::begin</a></div><div class="ttdeci">int16_t begin(float br, float freqDev, float rxBw, uint8_t preambleLen)</div><div class="ttdoc">Initialization method.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:12</div></div>
<div class="ttc" id="aclass_si443x_html_a55252bda74e8c67636a8c1fa0e9f58d3"><div class="ttname"><a href="class_si443x.html#a55252bda74e8c67636a8c1fa0e9f58d3">Si443x::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:585</div></div>
<div class="ttc" id="aclass_si443x_html_a55252bda74e8c67636a8c1fa0e9f58d3"><div class="ttname"><a href="class_si443x.html#a55252bda74e8c67636a8c1fa0e9f58d3">Si443x::getChipVersion</a></div><div class="ttdeci">int16_t getChipVersion()</div><div class="ttdoc">Read version SPI register. Should return RADIOLIB_SI443X_DEVICE_VERSION (0x06) if Si443x is connected...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:588</div></div>
<div class="ttc" id="aclass_si443x_html_a801b51059e61f93d4e01ae6ba8eb0726"><div class="ttname"><a href="class_si443x.html#a801b51059e61f93d4e01ae6ba8eb0726">Si443x::setIrqAction</a></div><div class="ttdeci">void setIrqAction(void(*func)(void))</div><div class="ttdoc">Sets interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:212</div></div>
<div class="ttc" id="aclass_si443x_html_ada90718aeb67d7f0e9899da534de9695"><div class="ttname"><a href="class_si443x.html#ada90718aeb67d7f0e9899da534de9695">Si443x::sleep</a></div><div class="ttdeci">int16_t sleep()</div><div class="ttdoc">Sets the module to sleep to save power. Module will not be able to transmit or receive any data while...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:127</div></div>
<div class="ttc" id="aclass_si443x_html_ad00ff8b58c68118ad74fee82028aa71e"><div class="ttname"><a href="class_si443x.html#ad00ff8b58c68118ad74fee82028aa71e">Si443x::readData</a></div><div class="ttdeci">int16_t readData(uint8_t *data, size_t len) override</div><div class="ttdoc">Reads data that was received after calling startReceive method. This method reads len characters.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:286</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_si443x_html_a74848176d435227e601c86ff37b0edbe"><div class="ttname"><a href="class_si443x.html#a74848176d435227e601c86ff37b0edbe">Si443x::randomByte</a></div><div class="ttdeci">uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:566</div></div>
<div class="ttc" id="aclass_si443x_html_a74848176d435227e601c86ff37b0edbe"><div class="ttname"><a href="class_si443x.html#a74848176d435227e601c86ff37b0edbe">Si443x::randomByte</a></div><div class="ttdeci">uint8_t randomByte()</div><div class="ttdoc">Get one truly random byte from RSSI noise.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:569</div></div>
<div class="ttc" id="aclass_si443x_html_a8d019f58551346c3f3bd8b72d2486109"><div class="ttname"><a href="class_si443x.html#a8d019f58551346c3f3bd8b72d2486109">Si443x::clearIrqAction</a></div><div class="ttdeci">void clearIrqAction()</div><div class="ttdoc">Clears interrupt service routine to call when IRQ activates.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:216</div></div>
<div class="ttc" id="aclass_si443x_html_a402b4f5f11ba79e9cd4fb6ac0bfd9314"><div class="ttname"><a href="class_si443x.html#a402b4f5f11ba79e9cd4fb6ac0bfd9314">Si443x::startTransmit</a></div><div class="ttdeci">int16_t startTransmit(uint8_t *data, size_t len, uint8_t addr=0) override</div><div class="ttdoc">Interrupt-driven binary transmit method. Will start transmitting arbitrary binary data up to 64 bytes...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:220</div></div>
<div class="ttc" id="aclass_si443x_html_a2d944669dc69ccd47f9e6c360f2ffd10"><div class="ttname"><a href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">Si443x::getPacketLength</a></div><div class="ttdeci">size_t getPacketLength(bool update=true) override</div><div class="ttdoc">Query modem for the packet length of received payload.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:514</div></div>
<div class="ttc" id="aclass_si443x_html_ade08c79074c7e4414d34eefa25cee168"><div class="ttname"><a href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">Si443x::setDataShaping</a></div><div class="ttdeci">int16_t setDataShaping(uint8_t sh) override</div><div class="ttdoc">Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:543</div></div>
<div class="ttc" id="aclass_si443x_html_ae365087803b88b29932b5c793edff1d4"><div class="ttname"><a href="class_si443x.html#ae365087803b88b29932b5c793edff1d4">Si443x::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:562</div></div>
<div class="ttc" id="aclass_si443x_html_ade08c79074c7e4414d34eefa25cee168"><div class="ttname"><a href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">Si443x::setDataShaping</a></div><div class="ttdeci">int16_t setDataShaping(uint8_t sh) override</div><div class="ttdoc">Sets Gaussian filter bandwidth-time product that will be used for data shaping. Only available in FSK...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:546</div></div>
<div class="ttc" id="aclass_si443x_html_ae365087803b88b29932b5c793edff1d4"><div class="ttname"><a href="class_si443x.html#ae365087803b88b29932b5c793edff1d4">Si443x::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(RADIOLIB_PIN_TYPE rxEn, RADIOLIB_PIN_TYPE txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by two pins. This function gives RadioLib control ...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:565</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_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_si443x_html_a1382fc3b68f447e381613e6670747128"><div class="ttname"><a href="class_si443x.html#a1382fc3b68f447e381613e6670747128">Si443x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:524</div></div>
<div class="ttc" id="aclass_si443x_html_a1382fc3b68f447e381613e6670747128"><div class="ttname"><a href="class_si443x.html#a1382fc3b68f447e381613e6670747128">Si443x::setEncoding</a></div><div class="ttdeci">int16_t setEncoding(uint8_t encoding) override</div><div class="ttdoc">Sets transmission encoding. Only available in FSK mode. Allowed values are RADIOLIB_ENCODING_NRZ,...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:527</div></div>
<div class="ttc" id="aclass_si443x_html_ae782ee06e2c463c24f22f5d4c3dd8d97"><div class="ttname"><a href="class_si443x.html#ae782ee06e2c463c24f22f5d4c3dd8d97">Si443x::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Reset method. Will reset the chip to the default state using SDN pin.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:69</div></div>
<div class="ttc" id="aclass_si443x_html_a45d3ffcb312c34a2f6391be6d609d7b7"><div class="ttname"><a href="class_si443x.html#a45d3ffcb312c34a2f6391be6d609d7b7">Si443x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:593</div></div>
<div class="ttc" id="aclass_si443x_html_a45d3ffcb312c34a2f6391be6d609d7b7"><div class="ttname"><a href="class_si443x.html#a45d3ffcb312c34a2f6391be6d609d7b7">Si443x::readBit</a></div><div class="ttdeci">void readBit(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Function to read and process data bit in direct reception mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:596</div></div>
<div class="ttc" id="aclass_si443x_html_a4ed0da298c2418db4a88a19ef8938e0a"><div class="ttname"><a href="class_si443x.html#a4ed0da298c2418db4a88a19ef8938e0a">Si443x::setSyncWord</a></div><div class="ttdeci">int16_t setSyncWord(uint8_t *syncWord, size_t len)</div><div class="ttdoc">Sets sync word. Up to 4 bytes can be set as sync word.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:481</div></div>
<div class="ttc" id="aclass_si443x_html"><div class="ttname"><a href="class_si443x.html">Si443x</a></div><div class="ttdoc">Base class for Si443x series. All derived classes for Si443x (e.g. Si4431 or Si4432) inherit from thi...</div><div class="ttdef"><b>Definition:</b> Si443x.h:554</div></div>
<div class="ttc" id="aclass_si443x_html_ad2b3a961a99d9e8f3a7ead6e8b69e858"><div class="ttname"><a href="class_si443x.html#ad2b3a961a99d9e8f3a7ead6e8b69e858">Si443x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in fixed packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:597</div></div>
<div class="ttc" id="aclass_si443x_html_ad2b3a961a99d9e8f3a7ead6e8b69e858"><div class="ttname"><a href="class_si443x.html#ad2b3a961a99d9e8f3a7ead6e8b69e858">Si443x::fixedPacketLengthMode</a></div><div class="ttdeci">int16_t fixedPacketLengthMode(uint8_t len=RADIOLIB_SI443X_MAX_PACKET_LENGTH)</div><div class="ttdoc">Set modem in fixed packet length mode.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:600</div></div>
<div class="ttc" id="aclass_si443x_html_a7c4e6caa95e5622f6f515ba0339a1c66"><div class="ttname"><a href="class_si443x.html#a7c4e6caa95e5622f6f515ba0339a1c66">Si443x::setFrequencyDeviation</a></div><div class="ttdeci">int16_t setFrequencyDeviation(float freqDev) override</div><div class="ttdoc">Sets FSK frequency deviation from carrier frequency. Allowed values range from 0.625 to 320....</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:351</div></div>
<div class="ttc" id="aclass_si443x_html_a55fae20e81755c8b014d080741d61913"><div class="ttname"><a href="class_si443x.html#a55fae20e81755c8b014d080741d61913">Si443x::setDirectAction</a></div><div class="ttdeci">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> Si443x.cpp:589</div></div>
<div class="ttc" id="aclass_si443x_html_a55fae20e81755c8b014d080741d61913"><div class="ttname"><a href="class_si443x.html#a55fae20e81755c8b014d080741d61913">Si443x::setDirectAction</a></div><div class="ttdeci">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> Si443x.cpp:592</div></div>
<div class="ttc" id="aclass_si443x_html_aabca3ba8eda212938febab1df2e764b4"><div class="ttname"><a href="class_si443x.html#aabca3ba8eda212938febab1df2e764b4">Si443x::receive</a></div><div class="ttdeci">int16_t receive(uint8_t *data, size_t len) override</div><div class="ttdoc">Binary receive method. Will attempt to receive arbitrary binary data up to 64 bytes long....</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:105</div></div>
<div class="ttc" id="aclass_si443x_html_a782748025e19ec6e597293afb6570bff"><div class="ttname"><a href="class_si443x.html#a782748025e19ec6e597293afb6570bff">Si443x::transmit</a></div><div class="ttdeci">int16_t transmit(uint8_t *data, size_t len, uint8_t addr=0) override</div><div class="ttdoc">Binary transmit method. Will transmit arbitrary binary data up to 64 bytes long. For overloads to tra...</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:77</div></div>
<div class="ttc" id="aclass_si443x_html_ae7cfff2efebfa01c8a50a5cbbe8775b9"><div class="ttname"><a href="class_si443x.html#ae7cfff2efebfa01c8a50a5cbbe8775b9">Si443x::Si443x</a></div><div class="ttdeci">Si443x(Module *mod)</div><div class="ttdoc">Default constructor.</div><div class="ttdef"><b>Definition:</b> Si443x.cpp:4</div></div>

2
class_s_x1261.html
View file

@ -449,7 +449,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
</div>
</div>

2
class_s_x1262.html
View file

@ -652,7 +652,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000007">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
</div>
</div>

4
class_s_x1268.html
View file

@ -623,7 +623,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a></dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>integers only (all modules - frequency, data rate, bandwidth etc.) </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000008">Todo:</a></b></dt><dd>integers only (all modules - frequency, data rate, bandwidth etc.) </dd></dl>
</div>
</div>
@ -651,7 +651,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000009">Todo:</a></b></dt><dd>power ramp time configuration </dd></dl>
</div>
</div>

2
class_s_x127x.html
View file

@ -1325,7 +1325,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>fractional part of bit rate setting (not in OOK) </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000010">Todo:</a></b></dt><dd>fractional part of bit rate setting (not in OOK) </dd></dl>
</div>
</div>

2
class_s_x1282.html
View file

@ -372,7 +372,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</table>
</dd>
</dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000012">Todo:</a></b></dt><dd>implement advanced ranging </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>implement advanced ranging </dd></dl>
</div>
</div>

4
class_s_x128x.html
View file

@ -744,7 +744,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Expected time-on-air in microseconds. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000014">Todo:</a></b></dt><dd>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000013">Todo:</a></b></dt><dd>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd></dl>
</div>
</div>
@ -1621,7 +1621,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000013">Todo:</a></b></dt><dd>add support for multiple sync words </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000012">Todo:</a></b></dt><dd>add support for multiple sync words </dd></dl>
</div>
</div>

5
class_si443x.html
View file

@ -445,7 +445,6 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Length of last received packet in bytes. </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd>variable length mode </dd></dl>
<p>Implements <a class="el" href="class_physical_layer.html#a0bd6046e068ef63e3f2b6bead48e02a7">PhysicalLayer</a>.</p>
@ -818,7 +817,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000006">Todo:</a></b></dt><dd>implement fiter configuration - docs claim this should be possible, but seems undocumented </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd>implement fiter configuration - docs claim this should be possible, but seems undocumented </dd></dl>
<p>Implements <a class="el" href="class_physical_layer.html#ab643a814dce48f71a13bf6ea23f44cbd">PhysicalLayer</a>.</p>
@ -892,7 +891,7 @@ void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="clas
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000005">Todo:</a></b></dt><dd><ul>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000004">Todo:</a></b></dt><dd><ul>
<li>add inverted Manchester? </li>
</ul>
</dd></dl>

22
todo.html
View file

@ -87,12 +87,10 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
</div><!--header-->
<div class="contents">
<div class="textblock"><dl class="reflist">
<dt>Member <a class="el" href="class_si443x.html#a2d944669dc69ccd47f9e6c360f2ffd10">Si443x::getPacketLength</a> (bool update=true) override</dt>
<dd><a class="anchor" id="_todo000004"></a>variable length mode </dd>
<dt>Member <a class="el" href="class_si443x.html#ade08c79074c7e4414d34eefa25cee168">Si443x::setDataShaping</a> (uint8_t sh) override</dt>
<dd><a class="anchor" id="_todo000006"></a>implement fiter configuration - docs claim this should be possible, but seems undocumented </dd>
<dd><a class="anchor" id="_todo000005"></a>implement fiter configuration - docs claim this should be possible, but seems undocumented </dd>
<dt>Member <a class="el" href="class_si443x.html#a1382fc3b68f447e381613e6670747128">Si443x::setEncoding</a> (uint8_t encoding) override</dt>
<dd><a class="anchor" id="_todo000005"></a>- add inverted Manchester? </dd>
<dd><a class="anchor" id="_todo000004"></a>- add inverted Manchester? </dd>
<dt>Member <a class="el" href="class_si443x.html#a51e6b7c677e82042224798114f311175">Si443x::setRxBandwidth</a> (float rxBw)</dt>
<dd><a class="anchor" id="_todo000003"></a>float tolerance equality as macro? </dd>
<dt>Member <a class="el" href="class_si443x.html#a402b4f5f11ba79e9cd4fb6ac0bfd9314">Si443x::startTransmit</a> (uint8_t *data, size_t len, uint8_t addr=0) override</dt>
@ -100,21 +98,21 @@ $(document).ready(function(){initNavTree('todo.html',''); initResizable(); });
<dt>Member <a class="el" href="class_si443x.html#a5a86a2032c4b876c1c8e4a7cf4730c99">Si443x::transmitDirect</a> (uint32_t frf=0) override</dt>
<dd><a class="anchor" id="_todo000001"></a>integers only </dd>
<dt>Member <a class="el" href="class_s_x1261.html#aa541f927995a1756c651b93fd24edc65">SX1261::setOutputPower</a> (int8_t power)</dt>
<dd><a class="anchor" id="_todo000007"></a>power ramp time configuration </dd>
<dd><a class="anchor" id="_todo000006"></a>power ramp time configuration </dd>
<dt>Member <a class="el" href="class_s_x1262.html#aa149463283dc9cddfec836ec6620d4dc">SX1262::setOutputPower</a> (int8_t power)</dt>
<dd><a class="anchor" id="_todo000008"></a>power ramp time configuration </dd>
<dd><a class="anchor" id="_todo000007"></a>power ramp time configuration </dd>
<dt>Member <a class="el" href="class_s_x1268.html#a6ad998275281de5c6f24f8a64db88052">SX1268::setFrequency</a> (float freq, bool calibrate=true)</dt>
<dd><a class="anchor" id="_todo000009"></a>integers only (all modules - frequency, data rate, bandwidth etc.) </dd>
<dd><a class="anchor" id="_todo000008"></a>integers only (all modules - frequency, data rate, bandwidth etc.) </dd>
<dt>Member <a class="el" href="class_s_x1268.html#a5b0744aa46fbb4f8c738b010dfcc9b45">SX1268::setOutputPower</a> (int8_t power)</dt>
<dd><a class="anchor" id="_todo000010"></a>power ramp time configuration </dd>
<dd><a class="anchor" id="_todo000009"></a>power ramp time configuration </dd>
<dt>Member <a class="el" href="class_s_x127x.html#a606d839b3a992c681ac9ad7ca6020022">SX127x::setBitRate</a> (float br)</dt>
<dd><a class="anchor" id="_todo000011"></a>fractional part of bit rate setting (not in OOK) </dd>
<dd><a class="anchor" id="_todo000010"></a>fractional part of bit rate setting (not in OOK) </dd>
<dt>Member <a class="el" href="class_s_x1282.html#ae90b7dcd7167c4cbe20e33ced04e4232">SX1282::SX1282</a> (<a class="el" href="class_module.html" title="Implements all common low-level methods to control the wireless module. Every module class contains o...">Module</a> *mod)</dt>
<dd><a class="anchor" id="_todo000012"></a>implement advanced ranging </dd>
<dd><a class="anchor" id="_todo000011"></a>implement advanced ranging </dd>
<dt>Member <a class="el" href="class_s_x128x.html#a2361a94f2e12ebc93e750a027d633232">SX128x::getTimeOnAir</a> (size_t len)</dt>
<dd><a class="anchor" id="_todo000014"></a>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd>
<dd><a class="anchor" id="_todo000013"></a>implement this mess - <a class="el" href="class_s_x1280.html" title="Derived class for SX1280 modules.">SX1280</a> datasheet v3.0 section 7.4.4.2 </dd>
<dt>Member <a class="el" href="class_s_x128x.html#a0efa595867624a54153d693d16f9f731">SX128x::setSyncWord</a> (uint8_t *syncWord, uint8_t len)</dt>
<dd><a class="anchor" id="_todo000013"></a>add support for multiple sync words </dd>
<dd><a class="anchor" id="_todo000012"></a>add support for multiple sync words </dd>
</dl>
</div></div><!-- contents -->
</div><!-- PageDoc -->