Deploying to gh-pages from @ 7209690bf6 🚀
This commit is contained in:
jgromes
parent
5f12c22715
commit
1163604322
1 changed files with 4 additions and 4 deletions
|
|
@ -296,7 +296,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_a4add1a875bb88e91da232118201a78a8"><div class="ttname"><a href="class_module.html#a4add1a875bb88e91da232118201a78a8">Module::reflect</a></div><div class="ttdeci">static uint32_t reflect(uint32_t in, uint8_t bits)</div><div class="ttdoc">Function to reflect bits within a byte.</div><div class="ttdef"><b>Definition:</b> Module.cpp:462</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a4ea888758b4a7784082d513a1e7849a4"><div class="ttname"><a href="class_module.html#a4ea888758b4a7784082d513a1e7849a4">Module::operator=</a></div><div class="ttdeci">Module & operator=(const Module &mod)</div><div class="ttdoc">Overload for assignment operator.</div><div class="ttdef"><b>Definition:</b> Module.cpp:33</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a4ec27f0ba5e0009ea9661a5110526b52"><div class="ttname"><a href="class_module.html#a4ec27f0ba5e0009ea9661a5110526b52">Module::getGpio</a></div><div class="ttdeci">uint32_t 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:400</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a5699a937b62ba41387567b4d679b9377"><div class="ttname"><a href="class_module.html#a5699a937b62ba41387567b4d679b9377">Module::findRfSwitchMode</a></div><div class="ttdeci">const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const</div><div class="ttdoc">Find a mode in the RfSwitchTable.</div><div class="ttdef"><b>Definition:</b> Module.cpp:582</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a5699a937b62ba41387567b4d679b9377"><div class="ttname"><a href="class_module.html#a5699a937b62ba41387567b4d679b9377">Module::findRfSwitchMode</a></div><div class="ttdeci">const RfSwitchMode_t * findRfSwitchMode(uint8_t mode) const</div><div class="ttdoc">Find a mode in the RfSwitchTable.</div><div class="ttdef"><b>Definition:</b> Module.cpp:588</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bf"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bf">Module::OpMode_t</a></div><div class="ttdeci">OpMode_t</div><div class="ttdoc">Constants to use in a mode table set be setRfSwitchTable. These constants work for most radios,...</div><div class="ttdef"><b>Definition:</b> Module.h:100</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa269f4bc8ba3eb3d8568feb7b2decf571">Module::MODE_TX</a></div><div class="ttdeci">@ MODE_TX</div><div class="ttdoc">Transmission mode.</div><div class="ttdef"><b>Definition:</b> Module.h:114</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671"><div class="ttname"><a href="class_module.html#a5a67b3a63420d762ecba9448671c99bfa505acc66c5e0faa83d2216aca5f3e671">Module::MODE_IDLE</a></div><div class="ttdeci">@ MODE_IDLE</div><div class="ttdoc">Idle mode.</div><div class="ttdef"><b>Definition:</b> Module.h:108</div></div>
|
||||
|
|
@ -305,7 +305,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_a5efa7ae78cab1d7f43005e965923f769"><div class="ttname"><a href="class_module.html#a5efa7ae78cab1d7f43005e965923f769">Module::SPIcheckStream</a></div><div class="ttdeci">int16_t SPIcheckStream()</div><div class="ttdoc">Method to check the result of last SPI stream transfer.</div><div class="ttdef"><b>Definition:</b> Module.cpp:293</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a60ca6b4cae98f7d935191a569d519913"><div class="ttname"><a href="class_module.html#a60ca6b4cae98f7d935191a569d519913">Module::SPIwriteRegister</a></div><div class="ttdeci">void SPIwriteRegister(uint32_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:159</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a67483fff5d818c7d68dfcfce10e81160"><div class="ttname"><a href="class_module.html#a67483fff5d818c7d68dfcfce10e81160">Module::SPItransferStream</a></div><div class="ttdeci">int16_t SPItransferStream(uint8_t *cmd, uint8_t cmdLen, bool write, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes, bool waitForGpio, RadioLibTime_t timeout)</div><div class="ttdoc">SPI single transfer method for modules with stream-type SPI interface (SX126x, SX128x etc....</div><div class="ttdef"><b>Definition:</b> Module.cpp:316</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a7d3adea64acab11c47c804afc74bd4f3"><div class="ttname"><a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:559</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a7d3adea64acab11c47c804afc74bd4f3"><div class="ttname"><a href="class_module.html#a7d3adea64acab11c47c804afc74bd4f3">Module::setRfSwitchPins</a></div><div class="ttdeci">void setRfSwitchPins(uint32_t rxEn, uint32_t txEn)</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:565</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a7df4c687249c07af2594a5f7ad0a946f"><div class="ttname"><a href="class_module.html#a7df4c687249c07af2594a5f7ad0a946f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(RadioLibTime_t start, RadioLibTime_t len)</div><div class="ttdoc">Wait for time to elapse, either using the microsecond timer, or the TimerFlag. Note that in interrupt...</div><div class="ttdef"><b>Definition:</b> Module.cpp:444</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a817178405f125e068e88bad62aeb6f3b"><div class="ttname"><a href="class_module.html#a817178405f125e068e88bad62aeb6f3b">Module::Module</a></div><div class="ttdeci">Module(RadioLibHal *hal, uint32_t cs, uint32_t irq, uint32_t rst, uint32_t gpio=RADIOLIB_NC)</div><div class="ttdoc">Module constructor.</div><div class="ttdef"><b>Definition:</b> Module.cpp:25</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a9393088249856eab568126aeb2493e4a"><div class="ttname"><a href="class_module.html#a9393088249856eab568126aeb2493e4a">Module::SPIparseStatusCb_t</a></div><div class="ttdeci">int16_t(* SPIparseStatusCb_t)(uint8_t in)</div><div class="ttdoc">Callback for parsing SPI status.</div><div class="ttdef"><b>Definition:</b> Module.h:166</div></div>
|
||||
|
|
@ -313,14 +313,14 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_aa6df70520aa015dd3a1bccdceae67232"><div class="ttname"><a href="class_module.html#aa6df70520aa015dd3a1bccdceae67232">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint16_t cmd, uint32_t reg, uint8_t *dataOut, uint8_t *dataIn, size_t numBytes)</div><div class="ttdoc">SPI single transfer method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:175</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ab250eb929068e0c890e16e8e6d7cd7e6"><div class="ttname"><a href="class_module.html#ab250eb929068e0c890e16e8e6d7cd7e6">Module::SPIreadRegister</a></div><div class="ttdeci">uint8_t SPIreadRegister(uint32_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:125</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ab61bc5066c356e2d0d79f08a2bd0fbc9"><div class="ttname"><a href="class_module.html#ab61bc5066c356e2d0d79f08a2bd0fbc9">Module::getIrq</a></div><div class="ttdeci">uint32_t getIrq() const</div><div class="ttdoc">Access method to get the pin number of interrupt/GPIO.</div><div class="ttdef"><b>Definition:</b> Module.h:388</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ac308fa817a5c36c5dc724a0d15cefd4d"><div class="ttname"><a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:575</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ac308fa817a5c36c5dc724a0d15cefd4d"><div class="ttname"><a href="class_module.html#ac308fa817a5c36c5dc724a0d15cefd4d">Module::setRfSwitchTable</a></div><div class="ttdeci">void setRfSwitchTable(const uint32_t(&pins)[RFSWITCH_MAX_PINS], const RfSwitchMode_t table[])</div><div class="ttdoc">Some modules contain external RF switch controlled by pins. This function gives RadioLib control over...</div><div class="ttdef"><b>Definition:</b> Module.cpp:581</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ac993ab8e2ea0f5aa93339d1f6ffb54ee"><div class="ttname"><a href="class_module.html#ac993ab8e2ea0f5aa93339d1f6ffb54ee">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint32_t reg, size_t numBytes, uint8_t *inBytes)</div><div class="ttdoc">SPI burst read method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:109</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ad1956ac81429ec1f61f83dbc081cf18c"><div class="ttname"><a href="class_module.html#ad1956ac81429ec1f61f83dbc081cf18c">Module::init</a></div><div class="ttdeci">void init()</div><div class="ttdoc">Initialize low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:43</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ad6cddbf3aebec9717a1a381dd81ad398"><div class="ttname"><a href="class_module.html#ad6cddbf3aebec9717a1a381dd81ad398">Module::getRst</a></div><div class="ttdeci">uint32_t 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:394</div></div>
|
||||
<div class="ttc" id="aclass_module_html_adacceb57ecfecb09150c135b2b44436f"><div class="ttname"><a href="class_module.html#adacceb57ecfecb09150c135b2b44436f">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a read transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:237</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ade75c5403a05156b43cc7562563ae2d7"><div class="ttname"><a href="class_module.html#ade75c5403a05156b43cc7562563ae2d7">Module::SPIsetRegValue</a></div><div class="ttdeci">int16_t SPIsetRegValue(uint32_t reg, uint8_t value, uint8_t msb=7, uint8_t lsb=0, uint8_t checkInterval=2, uint8_t checkMask=0xFF)</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:65</div></div>
|
||||
<div class="ttc" id="aclass_module_html_af99b0e74e67417a88f500ab7261ddd20"><div class="ttname"><a href="class_module.html#af99b0e74e67417a88f500ab7261ddd20">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint16_t cmd, uint8_t *data, size_t numBytes, bool waitForGpio=true, bool verify=true)</div><div class="ttdoc">Method to perform a write transaction with SPI stream.</div><div class="ttdef"><b>Definition:</b> Module.cpp:265</div></div>
|
||||
<div class="ttc" id="aclass_module_html_afbed643f082286012bf44bba22381ae6"><div class="ttname"><a href="class_module.html#afbed643f082286012bf44bba22381ae6">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(uint8_t mode)</div><div class="ttdoc">Set RF switch state.</div><div class="ttdef"><b>Definition:</b> Module.cpp:592</div></div>
|
||||
<div class="ttc" id="aclass_module_html_afbed643f082286012bf44bba22381ae6"><div class="ttname"><a href="class_module.html#afbed643f082286012bf44bba22381ae6">Module::setRfSwitchState</a></div><div class="ttdeci">void setRfSwitchState(uint8_t mode)</div><div class="ttdoc">Set RF switch state.</div><div class="ttdef"><b>Definition:</b> Module.cpp:598</div></div>
|
||||
<div class="ttc" id="aclass_radio_lib_hal_html"><div class="ttname"><a href="class_radio_lib_hal.html">RadioLibHal</a></div><div class="ttdoc">Hardware abstraction library base interface.</div><div class="ttdef"><b>Definition:</b> Hal.h:13</div></div>
|
||||
<div class="ttc" id="agroup__status__codes_html_gacc0baeb3e5fc99760a07d18ba55531b6"><div class="ttname"><a href="group__status__codes.html#gacc0baeb3e5fc99760a07d18ba55531b6">RADIOLIB_ERR_UNKNOWN</a></div><div class="ttdeci">#define RADIOLIB_ERR_UNKNOWN</div><div class="ttdoc">There was an unexpected, unknown error. If you see this, something went incredibly wrong....</div><div class="ttdef"><b>Definition:</b> TypeDef.h:110</div></div>
|
||||
<div class="ttc" id="agroup__typedefs_html_ga210f31dd2bff7fb80563275648a5bbbd"><div class="ttname"><a href="group__typedefs.html#ga210f31dd2bff7fb80563275648a5bbbd">RadioLibTime_t</a></div><div class="ttdeci">unsigned long RadioLibTime_t</div><div class="ttdoc">Type used for durations in RadioLib.</div><div class="ttdef"><b>Definition:</b> TypeDef.h:579</div></div>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue