Deploying to gh-pages from @ d91c6d0712 🚀
This commit is contained in:
jgromes
parent
734aed6caf
commit
01b6ddf81d
1 changed files with 56 additions and 42 deletions
|
|
@ -499,52 +499,66 @@ $(document).ready(function(){initNavTree('_build_opt_8h_source.html',''); initRe
|
||||||
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor">#define RADIOLIB_CHECK_PARAMS</span></div>
|
<div class="line"><a name="l00411"></a><span class="lineno"> 411</span> <span class="preprocessor">#define RADIOLIB_CHECK_PARAMS</span></div>
|
||||||
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  </div>
|
<div class="line"><a name="l00412"></a><span class="lineno"> 412</span>  </div>
|
||||||
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment">/*</span></div>
|
<div class="line"><a name="l00413"></a><span class="lineno"> 413</span> <span class="comment">/*</span></div>
|
||||||
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.</span></div>
|
<div class="line"><a name="l00414"></a><span class="lineno"> 414</span> <span class="comment"> * Uncomment to enable SX127x errata fix</span></div>
|
||||||
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.</span></div>
|
<div class="line"><a name="l00415"></a><span class="lineno"> 415</span> <span class="comment"> * Warning: SX127x errata fix has been reported to cause issues with LoRa bandwidths lower than 62.5 kHz.</span></div>
|
||||||
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * Failure to heed the above warning may result in bricked module.</span></div>
|
<div class="line"><a name="l00416"></a><span class="lineno"> 416</span> <span class="comment"> * It should only be enabled if you really are observing some errata-related issue.</span></div>
|
||||||
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> */</span></div>
|
<div class="line"><a name="l00417"></a><span class="lineno"> 417</span> <span class="comment"> * Note: Disabled by default.</span></div>
|
||||||
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment">//#define RADIOLIB_GODMODE</span></div>
|
<div class="line"><a name="l00418"></a><span class="lineno"> 418</span> <span class="comment"> */</span></div>
|
||||||
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span>  </div>
|
<div class="line"><a name="l00419"></a><span class="lineno"> 419</span> <span class="comment">//#define RADIOLIB_FIX_ERRATA_SX127X</span></div>
|
||||||
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span> <span class="comment">/*</span></div>
|
<div class="line"><a name="l00420"></a><span class="lineno"> 420</span>  </div>
|
||||||
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="comment"> * Uncomment to enable low-level hardware access</span></div>
|
<div class="line"><a name="l00421"></a><span class="lineno"> 421</span> <span class="preprocessor">#if defined(RADIOLIB_FIX_ERRATA_SX127X)</span></div>
|
||||||
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="comment"> * This will make some hardware methods like SPI get/set accessible from the user sketch - think of it as "god mode lite"</span></div>
|
<div class="line"><a name="l00422"></a><span class="lineno"> 422</span> <span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) { errataFix(__VA_ARGS__); }</span></div>
|
||||||
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="comment"> * Warning: RadioLib won't stop you from writing invalid stuff into your device, so it's quite easy to brick your module with this.</span></div>
|
<div class="line"><a name="l00423"></a><span class="lineno"> 423</span> <span class="preprocessor">#else</span></div>
|
||||||
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="comment"> */</span></div>
|
<div class="line"><a name="l00424"></a><span class="lineno"> 424</span> <span class="preprocessor"> #define RADIOLIB_ERRATA_SX127X(...) {}</span></div>
|
||||||
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="comment">//#define RADIOLIB_LOW_LEVEL</span></div>
|
<div class="line"><a name="l00425"></a><span class="lineno"> 425</span> <span class="preprocessor">#endif</span></div>
|
||||||
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  </div>
|
<div class="line"><a name="l00426"></a><span class="lineno"> 426</span>  </div>
|
||||||
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment">/*</span></div>
|
<div class="line"><a name="l00427"></a><span class="lineno"> 427</span> <span class="comment">/*</span></div>
|
||||||
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * Uncomment to enable pre-defined modules when using RadioShield.</span></div>
|
<div class="line"><a name="l00428"></a><span class="lineno"> 428</span> <span class="comment"> * Uncomment to enable god mode - all methods and member variables in all classes will be made public, thus making them accessible from Arduino code.</span></div>
|
||||||
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> */</span></div>
|
<div class="line"><a name="l00429"></a><span class="lineno"> 429</span> <span class="comment"> * Warning: Come on, it's called GOD mode - obviously only use this if you know what you're doing.</span></div>
|
||||||
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment">//#define RADIOLIB_RADIOSHIELD</span></div>
|
<div class="line"><a name="l00430"></a><span class="lineno"> 430</span> <span class="comment"> * Failure to heed the above warning may result in bricked module.</span></div>
|
||||||
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span>  </div>
|
<div class="line"><a name="l00431"></a><span class="lineno"> 431</span> <span class="comment"> */</span></div>
|
||||||
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">/*</span></div>
|
<div class="line"><a name="l00432"></a><span class="lineno"> 432</span> <span class="comment">//#define RADIOLIB_GODMODE</span></div>
|
||||||
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span> <span class="comment"> * Uncomment to enable static-only memory management: no dynamic allocation will be performed.</span></div>
|
<div class="line"><a name="l00433"></a><span class="lineno"> 433</span>  </div>
|
||||||
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment"> * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.</span></div>
|
<div class="line"><a name="l00434"></a><span class="lineno"> 434</span> <span class="comment">/*</span></div>
|
||||||
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> */</span></div>
|
<div class="line"><a name="l00435"></a><span class="lineno"> 435</span> <span class="comment"> * Uncomment to enable low-level hardware access</span></div>
|
||||||
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment">//#define RADIOLIB_STATIC_ONLY</span></div>
|
<div class="line"><a name="l00436"></a><span class="lineno"> 436</span> <span class="comment"> * This will make some hardware methods like SPI get/set accessible from the user sketch - think of it as "god mode lite"</span></div>
|
||||||
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span>  </div>
|
<div class="line"><a name="l00437"></a><span class="lineno"> 437</span> <span class="comment"> * Warning: RadioLib won't stop you from writing invalid stuff into your device, so it's quite easy to brick your module with this.</span></div>
|
||||||
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment">// set the size of static arrays to use</span></div>
|
<div class="line"><a name="l00438"></a><span class="lineno"> 438</span> <span class="comment"> */</span></div>
|
||||||
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="preprocessor">#if !defined(RADIOLIB_STATIC_ARRAY_SIZE)</span></div>
|
<div class="line"><a name="l00439"></a><span class="lineno"> 439</span> <span class="comment">//#define RADIOLIB_LOW_LEVEL</span></div>
|
||||||
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span> <span class="preprocessor">#define RADIOLIB_STATIC_ARRAY_SIZE 256</span></div>
|
<div class="line"><a name="l00440"></a><span class="lineno"> 440</span>  </div>
|
||||||
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="preprocessor">#endif</span></div>
|
<div class="line"><a name="l00441"></a><span class="lineno"> 441</span> <span class="comment">/*</span></div>
|
||||||
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span>  </div>
|
<div class="line"><a name="l00442"></a><span class="lineno"> 442</span> <span class="comment"> * Uncomment to enable pre-defined modules when using RadioShield.</span></div>
|
||||||
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="preprocessor">#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }</span></div>
|
<div class="line"><a name="l00443"></a><span class="lineno"> 443</span> <span class="comment"> */</span></div>
|
||||||
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span>  </div>
|
<div class="line"><a name="l00444"></a><span class="lineno"> 444</span> <span class="comment">//#define RADIOLIB_RADIOSHIELD</span></div>
|
||||||
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span> <span class="preprocessor">#if defined(RADIOLIB_CHECK_PARAMS)</span></div>
|
<div class="line"><a name="l00445"></a><span class="lineno"> 445</span>  </div>
|
||||||
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="preprocessor">#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }</span></div>
|
<div class="line"><a name="l00446"></a><span class="lineno"> 446</span> <span class="comment">/*</span></div>
|
||||||
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor">#else</span></div>
|
<div class="line"><a name="l00447"></a><span class="lineno"> 447</span> <span class="comment"> * Uncomment to enable static-only memory management: no dynamic allocation will be performed.</span></div>
|
||||||
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor">#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}</span></div>
|
<div class="line"><a name="l00448"></a><span class="lineno"> 448</span> <span class="comment"> * Warning: Large static arrays will be created in some methods. It is not advised to send large packets in this mode.</span></div>
|
||||||
|
<div class="line"><a name="l00449"></a><span class="lineno"> 449</span> <span class="comment"> */</span></div>
|
||||||
|
<div class="line"><a name="l00450"></a><span class="lineno"> 450</span> <span class="comment">//#define RADIOLIB_STATIC_ONLY</span></div>
|
||||||
|
<div class="line"><a name="l00451"></a><span class="lineno"> 451</span>  </div>
|
||||||
|
<div class="line"><a name="l00452"></a><span class="lineno"> 452</span> <span class="comment">// set the size of static arrays to use</span></div>
|
||||||
|
<div class="line"><a name="l00453"></a><span class="lineno"> 453</span> <span class="preprocessor">#if !defined(RADIOLIB_STATIC_ARRAY_SIZE)</span></div>
|
||||||
|
<div class="line"><a name="l00454"></a><span class="lineno"> 454</span> <span class="preprocessor">#define RADIOLIB_STATIC_ARRAY_SIZE 256</span></div>
|
||||||
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor">#endif</span></div>
|
<div class="line"><a name="l00455"></a><span class="lineno"> 455</span> <span class="preprocessor">#endif</span></div>
|
||||||
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  </div>
|
<div class="line"><a name="l00456"></a><span class="lineno"> 456</span>  </div>
|
||||||
<div class="line"><a name="l00457"></a><span class="lineno"> 457</span> <span class="comment">// version definitions</span></div>
|
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor">#define RADIOLIB_ASSERT(STATEVAR) { if((STATEVAR) != ERR_NONE) { return(STATEVAR); } }</span></div>
|
||||||
<div class="line"><a name="l00458"></a><span class="lineno"> 458</span> <span class="preprocessor">#define RADIOLIB_VERSION_MAJOR (0x04)</span></div>
|
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span>  </div>
|
||||||
<div class="line"><a name="l00459"></a><span class="lineno"> 459</span> <span class="preprocessor">#define RADIOLIB_VERSION_MINOR (0x05)</span></div>
|
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor">#if defined(RADIOLIB_CHECK_PARAMS)</span></div>
|
||||||
<div class="line"><a name="l00460"></a><span class="lineno"> 460</span> <span class="preprocessor">#define RADIOLIB_VERSION_PATCH (0x00)</span></div>
|
<div class="line"><a name="l00466"></a><span class="lineno"> 466</span> <span class="preprocessor">#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) { if(!(((VAR) >= (MIN)) && ((VAR) <= (MAX)))) { return(ERR); } }</span></div>
|
||||||
<div class="line"><a name="l00461"></a><span class="lineno"> 461</span> <span class="preprocessor">#define RADIOLIB_VERSION_EXTRA (0x00)</span></div>
|
<div class="line"><a name="l00467"></a><span class="lineno"> 467</span> <span class="preprocessor">#else</span></div>
|
||||||
<div class="line"><a name="l00462"></a><span class="lineno"> 462</span>  </div>
|
<div class="line"><a name="l00468"></a><span class="lineno"> 468</span> <span class="preprocessor">#define RADIOLIB_CHECK_RANGE(VAR, MIN, MAX, ERR) {}</span></div>
|
||||||
<div class="line"><a name="l00463"></a><span class="lineno"> 463</span> <span class="preprocessor">#define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))</span></div>
|
<div class="line"><a name="l00469"></a><span class="lineno"> 469</span> <span class="preprocessor">#endif</span></div>
|
||||||
<div class="line"><a name="l00464"></a><span class="lineno"> 464</span>  </div>
|
<div class="line"><a name="l00470"></a><span class="lineno"> 470</span>  </div>
|
||||||
<div class="line"><a name="l00465"></a><span class="lineno"> 465</span> <span class="preprocessor">#endif</span></div>
|
<div class="line"><a name="l00471"></a><span class="lineno"> 471</span> <span class="comment">// version definitions</span></div>
|
||||||
|
<div class="line"><a name="l00472"></a><span class="lineno"> 472</span> <span class="preprocessor">#define RADIOLIB_VERSION_MAJOR (0x04)</span></div>
|
||||||
|
<div class="line"><a name="l00473"></a><span class="lineno"> 473</span> <span class="preprocessor">#define RADIOLIB_VERSION_MINOR (0x05)</span></div>
|
||||||
|
<div class="line"><a name="l00474"></a><span class="lineno"> 474</span> <span class="preprocessor">#define RADIOLIB_VERSION_PATCH (0x00)</span></div>
|
||||||
|
<div class="line"><a name="l00475"></a><span class="lineno"> 475</span> <span class="preprocessor">#define RADIOLIB_VERSION_EXTRA (0x00)</span></div>
|
||||||
|
<div class="line"><a name="l00476"></a><span class="lineno"> 476</span>  </div>
|
||||||
|
<div class="line"><a name="l00477"></a><span class="lineno"> 477</span> <span class="preprocessor">#define RADIOLIB_VERSION ((RADIOLIB_VERSION_MAJOR << 24) | (RADIOLIB_VERSION_MINOR << 16) | (RADIOLIB_VERSION_PATCH << 8) | (RADIOLIB_VERSION_EXTRA))</span></div>
|
||||||
|
<div class="line"><a name="l00478"></a><span class="lineno"> 478</span>  </div>
|
||||||
|
<div class="line"><a name="l00479"></a><span class="lineno"> 479</span> <span class="preprocessor">#endif</span></div>
|
||||||
</div><!-- fragment --></div><!-- contents -->
|
</div><!-- fragment --></div><!-- contents -->
|
||||||
</div><!-- doc-content -->
|
</div><!-- doc-content -->
|
||||||
<!-- start footer part -->
|
<!-- start footer part -->
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue