Deploying to gh-pages from @ b02a5c1867 🚀
This commit is contained in:
jgromes
parent
5c4823dbd5
commit
b53ac51399
1 changed files with 8 additions and 8 deletions
|
|
@ -256,11 +256,11 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_a4483f0a39a523dd1b37b467d81418f7d"><div class="ttname"><a href="class_module.html#a4483f0a39a523dd1b37b467d81418f7d">Module::hal</a></div><div class="ttdeci">RadioLibHal * hal</div><div class="ttdoc">Hardware abstraction layer to be used.</div><div class="ttdef"><b>Definition:</b> Module.h:122</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a45bd514a1f2859d9a867c8f9b13eb332"><div class="ttname"><a href="class_module.html#a45bd514a1f2859d9a867c8f9b13eb332">Module::term</a></div><div class="ttdeci">void term()</div><div class="ttdoc">Terminate low-level module control.</div><div class="ttdef"><b>Definition:</b> Module.cpp:49</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a466112286d19675ca2dbe481358e4365"><div class="ttname"><a href="class_module.html#a466112286d19675ca2dbe481358e4365">Module::SPInopCommand</a></div><div class="ttdeci">uint8_t SPInopCommand</div><div class="ttdoc">Basic SPI no-operation command. Defaults to 0x00.</div><div class="ttdef"><b>Definition:</b> Module.h:137</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_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:357</div></div>
|
||||
<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:375</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a47978200f7e2e408fb64f506c81cee9f"><div class="ttname"><a href="class_module.html#a47978200f7e2e408fb64f506c81cee9f">Module::waitForMicroseconds</a></div><div class="ttdeci">void waitForMicroseconds(uint32_t start, uint32_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:365</div></div>
|
||||
<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:383</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:355</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:490</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:498</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="ttdef"><b>Definition:</b> Module.h:61</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="ttdef"><b>Definition:</b> Module.h:71</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="ttdef"><b>Definition:</b> Module.h:67</div></div>
|
||||
|
|
@ -270,7 +270,7 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_a66b06e69d57b97116bed1c6f185381f1"><div class="ttname"><a href="class_module.html#a66b06e69d57b97116bed1c6f185381f1">Module::SPIstreamError</a></div><div class="ttdeci">int16_t SPIstreamError</div><div class="ttdoc">The last recorded SPI stream error.</div><div class="ttdef"><b>Definition:</b> Module.h:158</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a74ce586afa403130007a474d3295d762"><div class="ttname"><a href="class_module.html#a74ce586afa403130007a474d3295d762">Module::SPIwriteStream</a></div><div class="ttdeci">int16_t SPIwriteStream(uint8_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:207</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a78dd39aa71d97e2220a880df8162fdde"><div class="ttname"><a href="class_module.html#a78dd39aa71d97e2220a880df8162fdde">Module::SPItransfer</a></div><div class="ttdeci">void SPItransfer(uint8_t cmd, uint16_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:141</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:467</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:475</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_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:127</div></div>
|
||||
<div class="ttc" id="aclass_module_html_a874e030f1931e606e380930d37dd83ee"><div class="ttname"><a href="class_module.html#a874e030f1931e606e380930d37dd83ee">Module::SPIreadRegisterBurst</a></div><div class="ttdeci">void SPIreadRegisterBurst(uint16_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:103</div></div>
|
||||
|
|
@ -279,17 +279,17 @@ $(document).ready(function(){initNavTree('_module_8h_source.html',''); initResiz
|
|||
<div class="ttc" id="aclass_module_html_aa6cac04c7cb6d5278a318db0966ad1a7"><div class="ttname"><a href="class_module.html#aa6cac04c7cb6d5278a318db0966ad1a7">Module::getCs</a></div><div class="ttdeci">uint32_t 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:337</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:343</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ab9fc874adc8dbe7c3f1fd3c267c27708"><div class="ttname"><a href="class_module.html#ab9fc874adc8dbe7c3f1fd3c267c27708">Module::SPIreadStream</a></div><div class="ttdeci">int16_t SPIreadStream(uint8_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:190</div></div>
|
||||
<div class="ttc" id="aclass_module_html_abb13a50ed53b009c04dc2ed6caf78423"><div class="ttname"><a href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">Module::regdump</a></div><div class="ttdeci">void regdump(uint16_t start, size_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:428</div></div>
|
||||
<div class="ttc" id="aclass_module_html_abb13a50ed53b009c04dc2ed6caf78423"><div class="ttname"><a href="class_module.html#abb13a50ed53b009c04dc2ed6caf78423">Module::regdump</a></div><div class="ttdeci">void regdump(uint16_t start, size_t len)</div><div class="ttdoc">Function to dump device registers as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:436</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ac19a495026aae62f5c2f089aa1b2b57a"><div class="ttname"><a href="class_module.html#ac19a495026aae62f5c2f089aa1b2b57a">Module::SPIaddrWidth</a></div><div class="ttdeci">uint8_t SPIaddrWidth</div><div class="ttdoc">SPI address width. Defaults to 8, currently only supports 8 and 16-bit addresses.</div><div class="ttdef"><b>Definition:</b> Module.h:147</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:483</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:491</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ac3586c8d4013cbdd22cf34032632c181"><div class="ttname"><a href="class_module.html#ac3586c8d4013cbdd22cf34032632c181">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, uint32_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:243</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ad0532274dafe433ba68529945bfe6a1b"><div class="ttname"><a href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:383</div></div>
|
||||
<div class="ttc" id="aclass_module_html_ad0532274dafe433ba68529945bfe6a1b"><div class="ttname"><a href="class_module.html#ad0532274dafe433ba68529945bfe6a1b">Module::hexdump</a></div><div class="ttdeci">static void hexdump(uint8_t *data, size_t len, uint32_t offset=0, uint8_t width=1, bool be=false)</div><div class="ttdoc">Function to dump data as hex into the debug port.</div><div class="ttdef"><b>Definition:</b> Module.cpp:391</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:349</div></div>
|
||||
<div class="ttc" id="aclass_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:132</div></div>
|
||||
<div class="ttc" id="aclass_module_html_af474f82d00fffc1ee0fc8def2c7f220c"><div class="ttname"><a href="class_module.html#af474f82d00fffc1ee0fc8def2c7f220c">Module::SPIwriteRegisterBurst</a></div><div class="ttdeci">void SPIwriteRegisterBurst(uint16_t reg, uint8_t *data, size_t numBytes)</div><div class="ttdoc">SPI burst write method.</div><div class="ttdef"><b>Definition:</b> Module.cpp:123</div></div>
|
||||
<div class="ttc" id="aclass_module_html_af6e89e2bc4976e8c5dc42dedda9fa6a2"><div class="ttname"><a href="class_module.html#af6e89e2bc4976e8c5dc42dedda9fa6a2">Module::SPIparseStatusCb</a></div><div class="ttdeci">SPIparseStatusCb_t SPIparseStatusCb</div><div class="ttdoc">Callback to function that will parse the module-specific status codes to RadioLib status codes....</div><div class="ttdef"><b>Definition:</b> Module.h:169</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:500</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:508</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="ttdef"><b>Definition:</b> Hal.h:11</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="astruct_module_1_1_rf_switch_mode__t_html"><div class="ttname"><a href="struct_module_1_1_rf_switch_mode__t.html">Module::RfSwitchMode_t</a></div><div class="ttdef"><b>Definition:</b> Module.h:49</div></div>
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue