Deploying to gh-pages from @ 5d92240f89 🚀
This commit is contained in:
jgromes
parent
79b6b8dcd8
commit
40842e1c38
1 changed files with 10 additions and 10 deletions
|
|
@ -95,38 +95,38 @@ $(document).ready(function(){initNavTree('_module_8h_source.html','');});
|
|||
<div class="ttc" id="class_module_html_a99556decb983f682b98220ae5434b004"><div class="ttname"><a href="class_module.html#a99556decb983f682b98220ae5434b004">Module::ModuleSerial</a></div><div class="ttdeci">SoftwareSerial * ModuleSerial</div><div class="ttdoc">Internal SoftwareSerial instance. </div><div class="ttdef"><b>Definition:</b> Module.h:140</div></div>
|
||||
<div class="ttc" id="class_module_html_aefd955f1cd6d588b2cc229db87cb2121"><div class="ttname"><a href="class_module.html#aefd955f1cd6d588b2cc229db87cb2121">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint8_t reg, uint8_t *dataOut, uint8_t *dataIn, uint8_t numBytes)</div><div class="ttdoc">SPI single transfer method. </div><div class="ttdef"><b>Definition:</b> Module.cpp:272</div></div>
|
||||
<div class="ttc" id="class_module_html_aeb4c7447372d56a7cae6db91994aacfc"><div class="ttname"><a href="class_module.html#aeb4c7447372d56a7cae6db91994aacfc">Module::getGpio</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getGpio() const</div><div class="ttdoc">Access method to get the pin number of second interrupt/GPIO. </div><div class="ttdef"><b>Definition:</b> Module.h:328</div></div>
|
||||
<div class="ttc" id="class_module_html_af0f870b09b9dd9636f1587d708f07d38"><div class="ttname"><a href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">Module::delay</a></div><div class="ttdeci">static void delay(uint32_t ms)</div><div class="ttdoc">Arduino core delay override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:368</div></div>
|
||||
<div class="ttc" id="class_module_html_af0f870b09b9dd9636f1587d708f07d38"><div class="ttname"><a href="class_module.html#af0f870b09b9dd9636f1587d708f07d38">Module::delay</a></div><div class="ttdeci">static void delay(uint32_t ms)</div><div class="ttdoc">Arduino core delay override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:384</div></div>
|
||||
<div class="ttc" id="class_module_html_a5d66f76c11ac91a35a3a1d9647aa6f6d"><div class="ttname"><a href="class_module.html#a5d66f76c11ac91a35a3a1d9647aa6f6d">Module::getRx</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRx() const</div><div class="ttdoc">Access method to get the pin number of UART Rx. </div><div class="ttdef"><b>Definition:</b> Module.h:335</div></div>
|
||||
<div class="ttc" id="class_module_html_a227d2d38e4747d0f49bb4df1c80b45d7"><div class="ttname"><a href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">Module::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Arduino core yield override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:364</div></div>
|
||||
<div class="ttc" id="class_module_html_a227d2d38e4747d0f49bb4df1c80b45d7"><div class="ttname"><a href="class_module.html#a227d2d38e4747d0f49bb4df1c80b45d7">Module::yield</a></div><div class="ttdeci">static void yield()</div><div class="ttdoc">Arduino core yield override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:380</div></div>
|
||||
<div class="ttc" id="class_module_html_a46ad10b113df7c7e0a932be19eff63cd"><div class="ttname"><a href="class_module.html#a46ad10b113df7c7e0a932be19eff63cd">Module::digitalWrite</a></div><div class="ttdeci">static void digitalWrite(RADIOLIB_PIN_TYPE pin, RADIOLIB_PIN_STATUS value)</div><div class="ttdoc">Arduino core digitalWrite override that checks RADIOLIB_NC as alias for unused pin. </div><div class="ttdef"><b>Definition:</b> Module.cpp:325</div></div>
|
||||
<div class="ttc" id="class_module_html_a849ad85fc1bc3a7130e660c13973ab26"><div class="ttname"><a href="class_module.html#a849ad85fc1bc3a7130e660c13973ab26">Module::SPIreadCommand</a></div><div class="ttdeci">uint8_t SPIreadCommand</div><div class="ttdoc">Basic SPI read command. Defaults to 0x00. </div><div class="ttdef"><b>Definition:</b> Module.h:156</div></div>
|
||||
<div class="ttc" id="class_module_html_a128ead3f3198e3b06d39a128a5d6c777"><div class="ttname"><a href="class_module.html#a128ead3f3198e3b06d39a128a5d6c777">Module::baudrate</a></div><div class="ttdeci">uint32_t baudrate</div><div class="ttdoc">Baud rate of SoftwareSerial UART communication. Defaults to 9600 baud. </div><div class="ttdef"><b>Definition:</b> Module.h:146</div></div>
|
||||
<div class="ttc" id="class_module_html_af0569f6930da7bee761eeca8158aed3a"><div class="ttname"><a href="class_module.html#af0569f6930da7bee761eeca8158aed3a">Module::term</a></div><div class="ttdeci">void term(uint8_t interface)</div><div class="ttdoc">Terminate low-level module control. </div><div class="ttdef"><b>Definition:</b> Module.cpp:137</div></div>
|
||||
<div class="ttc" id="class_module_html_ae53e355a77f2b7ce6473c62ac5f37334"><div class="ttname"><a href="class_module.html#ae53e355a77f2b7ce6473c62ac5f37334">Module::getCs</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getCs() const</div><div class="ttdoc">Access method to get the pin number of SPI chip select. </div><div class="ttdef"><b>Definition:</b> Module.h:307</div></div>
|
||||
<div class="ttc" id="class_module_html_a14d7cd8220bfa4440bda055ce5be748c"><div class="ttname"><a href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">Module::delayMicroseconds</a></div><div class="ttdeci">static void delayMicroseconds(uint32_t us)</div><div class="ttdoc">Arduino core delayMicroseconds override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:372</div></div>
|
||||
<div class="ttc" id="class_module_html_a14d7cd8220bfa4440bda055ce5be748c"><div class="ttname"><a href="class_module.html#a14d7cd8220bfa4440bda055ce5be748c">Module::delayMicroseconds</a></div><div class="ttdeci">static void delayMicroseconds(uint32_t us)</div><div class="ttdoc">Arduino core delayMicroseconds override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:388</div></div>
|
||||
<div class="ttc" id="class_module_html_adb22d89bc5f532f1d056d9a9f3a6589c"><div class="ttname"><a href="class_module.html#adb22d89bc5f532f1d056d9a9f3a6589c">Module::init</a></div><div class="ttdeci">void init(uint8_t interface)</div><div class="ttdoc">Initialize low-level module control. </div><div class="ttdef"><b>Definition:</b> Module.cpp:113</div></div>
|
||||
<div class="ttc" id="class_module_html_ad5767216ba9340ae6d86915b12e89bd6"><div class="ttname"><a href="class_module.html#ad5767216ba9340ae6d86915b12e89bd6">Module::ATemptyBuffer</a></div><div class="ttdeci">void ATemptyBuffer()</div><div class="ttdoc">Empty internal AT buffer. </div><div class="ttdef"><b>Definition:</b> Module.cpp:152</div></div>
|
||||
<div class="ttc" id="class_module_html_a32ba59613a2f1e77038956e18d9fedd7"><div class="ttname"><a href="class_module.html#a32ba59613a2f1e77038956e18d9fedd7">Module::tone</a></div><div class="ttdeci">static void tone(RADIOLIB_PIN_TYPE pin, uint16_t value)</div><div class="ttdoc">Arduino core tone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPPOR...</div><div class="ttdef"><b>Definition:</b> Module.cpp:338</div></div>
|
||||
<div class="ttc" id="class_module_html_a4a87d59ad2bf6bb1bb9de1856a81b824"><div class="ttname"><a href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</div><div class="ttdoc">Set RF switch state. </div><div class="ttdef"><b>Definition:</b> Module.cpp:392</div></div>
|
||||
<div class="ttc" id="class_module_html_a4a87d59ad2bf6bb1bb9de1856a81b824"><div class="ttname"><a href="class_module.html#a4a87d59ad2bf6bb1bb9de1856a81b824">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(RADIOLIB_PIN_STATUS rxPinState, RADIOLIB_PIN_STATUS txPinState)</div><div class="ttdoc">Set RF switch state. </div><div class="ttdef"><b>Definition:</b> Module.cpp:408</div></div>
|
||||
<div class="ttc" id="class_module_html_ad1aadc2b52eea2bf9d26591091eec3f1"><div class="ttname"><a href="class_module.html#ad1aadc2b52eea2bf9d26591091eec3f1">Module::ATgetResponse</a></div><div class="ttdeci">bool ATgetResponse()</div><div class="ttdoc">Get response after sending AT command. </div><div class="ttdef"><b>Definition:</b> Module.cpp:175</div></div>
|
||||
<div class="ttc" id="class_module_html"><div class="ttname"><a href="class_module.html">Module</a></div><div class="ttdoc">Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. </div><div class="ttdef"><b>Definition:</b> Module.h:17</div></div>
|
||||
<div class="ttc" id="class_module_html_a623aee6405b330b7c935013ff3d01100"><div class="ttname"><a href="class_module.html#a623aee6405b330b7c935013ff3d01100">Module::ATsendData</a></div><div class="ttdeci">bool ATsendData(uint8_t *data, uint32_t len)</div><div class="ttdoc">Send raw AT data. Will also call ATgetResponse. </div><div class="ttdef"><b>Definition:</b> Module.cpp:165</div></div>
|
||||
<div class="ttc" id="class_module_html_ad7ca9ae5a22cdacdf9437ca9cd37c9b4"><div class="ttname"><a href="class_module.html#ad7ca9ae5a22cdacdf9437ca9cd37c9b4">Module::SPIgetRegValue</a></div><div class="ttdeci">int16_t SPIgetRegValue(uint8_t reg, uint8_t msb=7, uint8_t lsb=0)</div><div class="ttdoc">SPI read method that automatically masks unused bits. This method is the preferred SPI read mechanism...</div><div class="ttdef"><b>Definition:</b> Module.cpp:199</div></div>
|
||||
<div class="ttc" id="class_module_html_a216dd0c6ce140857f2b003ab8d89fbac"><div class="ttname"><a href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">Module::millis</a></div><div class="ttdeci">static uint32_t millis()</div><div class="ttdoc">Arduino core millis override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:376</div></div>
|
||||
<div class="ttc" id="class_module_html_a216dd0c6ce140857f2b003ab8d89fbac"><div class="ttname"><a href="class_module.html#a216dd0c6ce140857f2b003ab8d89fbac">Module::millis</a></div><div class="ttdeci">static uint32_t millis()</div><div class="ttdoc">Arduino core millis override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:392</div></div>
|
||||
<div class="ttc" id="class_module_html_ab814614ddd34b57f5a612a20f5fe4c57"><div class="ttname"><a href="class_module.html#ab814614ddd34b57f5a612a20f5fe4c57">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint8_t reg, uint8_t data)</div><div class="ttdoc">SPI basic write method. Use of this method is reserved for special cases, SPIsetRegValue should be us...</div><div class="ttdef"><b>Definition:</b> Module.cpp:268</div></div>
|
||||
<div class="ttc" id="class_module_html_a1d1a279cc7e1ab92e30c29c4dcca26a3"><div class="ttname"><a href="class_module.html#a1d1a279cc7e1ab92e30c29c4dcca26a3">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint8_t reg)</div><div class="ttdoc">SPI basic read method. Use of this method is reserved for special cases, SPIgetRegValue should be use...</div><div class="ttdef"><b>Definition:</b> Module.cpp:258</div></div>
|
||||
<div class="ttc" id="class_module_html_af998b86ce1243f616f6fcb6df5336207"><div class="ttname"><a href="class_module.html#af998b86ce1243f616f6fcb6df5336207">Module::noTone</a></div><div class="ttdeci">static void noTone(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...</div><div class="ttdef"><b>Definition:</b> Module.cpp:347</div></div>
|
||||
<div class="ttc" id="class_module_html_af998b86ce1243f616f6fcb6df5336207"><div class="ttname"><a href="class_module.html#af998b86ce1243f616f6fcb6df5336207">Module::noTone</a></div><div class="ttdeci">static void noTone(RADIOLIB_PIN_TYPE pin)</div><div class="ttdoc">Arduino core noTone override that checks RADIOLIB_NC as alias for unused pin and RADIOLIB_TONE_UNSUPP...</div><div class="ttdef"><b>Definition:</b> Module.cpp:357</div></div>
|
||||
<div class="ttc" id="class_module_html_a5ea76bc25ef979ec1ff90c032e476004"><div class="ttname"><a href="class_module.html#a5ea76bc25ef979ec1ff90c032e476004">Module::Module</a></div><div class="ttdeci">Module(RADIOLIB_PIN_TYPE rx, RADIOLIB_PIN_TYPE tx, HardwareSerial *serial=nullptr, RADIOLIB_PIN_TYPE rst=RADIOLIB_NC)</div><div class="ttdoc">UART-based module constructor. </div><div class="ttdef"><b>Definition:</b> Module.cpp:29</div></div>
|
||||
<div class="ttc" id="class_module_html_a656738f2fe41fb236d27aed02efa8ad4"><div class="ttname"><a href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">Module::detachInterrupt</a></div><div class="ttdeci">static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)</div><div class="ttdoc">Arduino core detachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:360</div></div>
|
||||
<div class="ttc" id="class_module_html_a656738f2fe41fb236d27aed02efa8ad4"><div class="ttname"><a href="class_module.html#a656738f2fe41fb236d27aed02efa8ad4">Module::detachInterrupt</a></div><div class="ttdeci">static void detachInterrupt(RADIOLIB_PIN_TYPE interruptNum)</div><div class="ttdoc">Arduino core detachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:376</div></div>
|
||||
<div class="ttc" id="class_module_html_a5c09c878b55f56990dd0c2972a3440c4"><div class="ttname"><a href="class_module.html#a5c09c878b55f56990dd0c2972a3440c4">Module::ATsendCommand</a></div><div class="ttdeci">bool ATsendCommand(const char *cmd)</div><div class="ttdoc">Send AT command. Will also call ATgetResponse. </div><div class="ttdef"><b>Definition:</b> Module.cpp:158</div></div>
|
||||
<div class="ttc" id="class_module_html_a91aaa34aecdfeaf24948551b037033be"><div class="ttname"><a href="class_module.html#a91aaa34aecdfeaf24948551b037033be">Module::attachInterrupt</a></div><div class="ttdeci">static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</div><div class="ttdoc">Arduino core attachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:356</div></div>
|
||||
<div class="ttc" id="class_module_html_a91aaa34aecdfeaf24948551b037033be"><div class="ttname"><a href="class_module.html#a91aaa34aecdfeaf24948551b037033be">Module::attachInterrupt</a></div><div class="ttdeci">static void attachInterrupt(RADIOLIB_PIN_TYPE interruptNum, void(*userFunc)(void), RADIOLIB_INTERRUPT_STATUS mode)</div><div class="ttdoc">Arduino core attachInterrupt override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:372</div></div>
|
||||
<div class="ttc" id="class_module_html_ae89764d15e8df5694a6aec0e18f72d3f"><div class="ttname"><a href="class_module.html#ae89764d15e8df5694a6aec0e18f72d3f">Module::SPIwriteCommand</a></div><div class="ttdeci">uint8_t SPIwriteCommand</div><div class="ttdoc">Basic SPI write command. Defaults to 0x80. </div><div class="ttdef"><b>Definition:</b> Module.h:161</div></div>
|
||||
<div class="ttc" id="class_module_html_a6fa5239d73379e4140f5c4f513b1b8d2"><div class="ttname"><a href="class_module.html#a6fa5239d73379e4140f5c4f513b1b8d2">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint8_t reg, uint8_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method. </div><div class="ttdef"><b>Definition:</b> Module.cpp:254</div></div>
|
||||
<div class="ttc" id="class_module_html_ae352c7a7b997fc1b17189c1312a8347f"><div class="ttname"><a href="class_module.html#ae352c7a7b997fc1b17189c1312a8347f">Module::getRst</a></div><div class="ttdeci">RADIOLIB_PIN_TYPE getRst() const</div><div class="ttdoc">Access method to get the pin number of hardware reset pin. </div><div class="ttdef"><b>Definition:</b> Module.h:321</div></div>
|
||||
<div class="ttc" id="class_module_html_ae867ebfef795d63d1df234394510b96e"><div class="ttname"><a href="class_module.html#ae867ebfef795d63d1df234394510b96e">Module::getSpi</a></div><div class="ttdeci">SPIClass * getSpi() const</div><div class="ttdoc">Access method to get the SPI interface. </div><div class="ttdef"><b>Definition:</b> Module.h:349</div></div>
|
||||
<div class="ttc" id="class_module_html_a87ca265fa2d1fe7c251b4230ef6bd6ca"><div class="ttname"><a href="class_module.html#a87ca265fa2d1fe7c251b4230ef6bd6ca">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint8_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2)</div><div class="ttdoc">Overwrite-safe SPI write method with verification. This method is the preferred SPI write mechanism...</div><div class="ttdef"><b>Definition:</b> Module.cpp:209</div></div>
|
||||
<div class="ttc" id="class_module_html_af3f51e517a825949891ad29e30fd3f59"><div class="ttname"><a href="class_module.html#af3f51e517a825949891ad29e30fd3f59">Module::micros</a></div><div class="ttdeci">static uint32_t micros()</div><div class="ttdoc">Arduino core micros override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:380</div></div>
|
||||
<div class="ttc" id="class_module_html_a0ecbb4e1e98094c1296b1e823dc14703"><div class="ttname"><a href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">Module::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> Module.cpp:384</div></div>
|
||||
<div class="ttc" id="class_module_html_af3f51e517a825949891ad29e30fd3f59"><div class="ttname"><a href="class_module.html#af3f51e517a825949891ad29e30fd3f59">Module::micros</a></div><div class="ttdeci">static uint32_t micros()</div><div class="ttdoc">Arduino core micros override. </div><div class="ttdef"><b>Definition:</b> Module.cpp:396</div></div>
|
||||
<div class="ttc" id="class_module_html_a0ecbb4e1e98094c1296b1e823dc14703"><div class="ttname"><a href="class_module.html#a0ecbb4e1e98094c1296b1e823dc14703">Module::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> Module.cpp:400</div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
<!-- start footer part -->
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue