2021-03-13 18:06:52 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2020-08-22 08:30:47 +00:00
< html xmlns = "http://www.w3.org/1999/xhtml" >
< head >
< meta http-equiv = "Content-Type" content = "text/xhtml;charset=UTF-8" / >
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
2022-12-06 06:59:09 +00:00
< meta name = "generator" content = "Doxygen 1.9.1" / >
2020-08-22 08:35:55 +00:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" / >
2020-08-22 08:30:47 +00:00
< title > RadioLib: src/modules/SX127x/SX1279.h Source File< / title >
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtreedata.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "search/searchdata.js" > < / script >
< script type = "text/javascript" src = "search/search.js" > < / script >
< link href = "doxygen.css" rel = "stylesheet" type = "text/css" / >
< / head >
< body >
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 56px;" >
< td id = "projectalign" style = "padding-left: 0.5em;" >
< div id = "projectname" > RadioLib
< / div >
< div id = "projectbrief" > Universal wireless communication library for Arduino< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
<!-- end header part -->
2022-12-06 06:59:09 +00:00
<!-- Generated by Doxygen 1.9.1 -->
2020-08-22 08:30:47 +00:00
< script type = "text/javascript" >
2021-03-13 18:06:52 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2022-12-06 06:59:09 +00:00
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
2021-03-13 18:06:52 +00:00
/* @license-end */
2020-08-22 08:30:47 +00:00
< / script >
2020-08-22 08:35:55 +00:00
< script type = "text/javascript" src = "menudata.js" > < / script >
< script type = "text/javascript" src = "menu.js" > < / script >
< script type = "text/javascript" >
2021-03-13 18:06:52 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
2020-08-22 08:35:55 +00:00
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
2021-03-13 18:06:52 +00:00
/* @license-end */< / script >
2020-08-22 08:35:55 +00:00
< div id = "main-nav" > < / div >
2020-08-22 08:30:47 +00:00
< / div > <!-- top -->
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
< div id = "nav-sync" class = "sync" > < / div >
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2021-03-13 18:06:52 +00:00
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3& dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('_s_x1279_8h_source.html',''); initResizable(); });
/* @license-end */
2020-08-22 08:30:47 +00:00
< / script >
< div id = "doc-content" >
<!-- window showing the filter options -->
< div id = "MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
< / div >
<!-- iframe showing the search results (closed by default) -->
< div id = "MSearchResultsWindow" >
< iframe src = "javascript:void(0)" frameborder = "0"
name="MSearchResults" id="MSearchResults">
< / iframe >
< / div >
< div class = "header" >
< div class = "headertitle" >
< div class = "title" > SX1279.h< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
2021-03-13 18:06:52 +00:00
< div class = "fragment" > < div class = "line" > < a name = "l00001" > < / a > < span class = "lineno" > 1< / span >   < span class = "preprocessor" > #if !defined(_RADIOLIB_SX1279_H)< / span > < / div >
< div class = "line" > < a name = "l00002" > < / a > < span class = "lineno" > 2< / span >   < span class = "preprocessor" > #define _RADIOLIB_SX1279_H< / span > < / div >
< div class = "line" > < a name = "l00003" > < / a > < span class = "lineno" > 3< / span >   < / div >
< div class = "line" > < a name = "l00004" > < / a > < span class = "lineno" > 4< / span >   < span class = "preprocessor" > #include " ../../TypeDef.h" < / span > < / div >
< div class = "line" > < a name = "l00005" > < / a > < span class = "lineno" > 5< / span >   < / div >
2023-11-27 20:19:39 +00:00
< div class = "line" > < a name = "l00006" > < / a > < span class = "lineno" > 6< / span >   < span class = "preprocessor" > #if !RADIOLIB_EXCLUDE_SX127X< / span > < / div >
2021-03-13 18:06:52 +00:00
< div class = "line" > < a name = "l00007" > < / a > < span class = "lineno" > 7< / span >   < / div >
< div class = "line" > < a name = "l00008" > < / a > < span class = "lineno" > 8< / span >   < span class = "preprocessor" > #include " SX1278.h" < / span > < / div >
< div class = "line" > < a name = "l00009" > < / a > < span class = "lineno" > 9< / span >   < / div >
2023-04-23 20:42:55 +00:00
< div class = "line" > < a name = "l00014" > < / a > < span class = "lineno" > < a class = "line" href = "class_s_x1279.html" > 14< / a > < / span >   < span class = "keyword" > class < / span > < a class = "code" href = "class_s_x1279.html" > SX1279< / a > : < span class = "keyword" > public< / span > < a class = "code" href = "class_s_x1278.html" > SX1278< / a > {< / div >
< div class = "line" > < a name = "l00015" > < / a > < span class = "lineno" > 15< / span >   < span class = "keyword" > public< / span > :< / div >
< div class = "line" > < a name = "l00016" > < / a > < span class = "lineno" > 16< / span >   < / div >
< div class = "line" > < a name = "l00017" > < / a > < span class = "lineno" > 17< / span >   < span class = "comment" > // constructor< / span > < / div >
< div class = "line" > < a name = "l00018" > < / a > < span class = "lineno" > 18< / span >   < / div >
< div class = "line" > < a name = "l00023" > < / a > < span class = "lineno" > 23< / span >   < a class = "code" href = "class_s_x1279.html#abc606ad06ee77b6830dab4331793d22a" > SX1279< / a > (< a class = "code" href = "class_module.html" > Module< / a > * mod);< / div >
< div class = "line" > < a name = "l00024" > < / a > < span class = "lineno" > 24< / span >   < / div >
< div class = "line" > < a name = "l00025" > < / a > < span class = "lineno" > 25< / span >   < span class = "comment" > // basic methods< / span > < / div >
2021-03-13 18:06:52 +00:00
< div class = "line" > < a name = "l00026" > < / a > < span class = "lineno" > 26< / span >   < / div >
2023-04-23 20:42:55 +00:00
< div class = "line" > < a name = "l00041" > < / a > < span class = "lineno" > 41< / span >   int16_t < a class = "code" href = "class_s_x1279.html#a324a37dee0522f43692cd414141becc2" > begin< / a > (< span class = "keywordtype" > float< / span > freq = 434.0, < span class = "keywordtype" > float< / span > bw = 125.0, uint8_t sf = 9, uint8_t cr = 7, uint8_t syncWord = RADIOLIB_SX127X_SYNC_WORD, int8_t power = 10, uint16_t preambleLength = 8, uint8_t gain = 0);< / div >
< div class = "line" > < a name = "l00042" > < / a > < span class = "lineno" > 42< / span >   < / div >
< div class = "line" > < a name = "l00055" > < / a > < span class = "lineno" > 55< / span >   int16_t < a class = "code" href = "class_s_x1279.html#ab5cb738ed4bf6f40e777f797af2a8b4b" > beginFSK< / a > (< span class = "keywordtype" > float< / span > freq = 434.0, < span class = "keywordtype" > float< / span > br = 4.8, < span class = "keywordtype" > float< / span > freqDev = 5.0, < span class = "keywordtype" > float< / span > rxBw = 125.0, int8_t power = 10, uint16_t preambleLength = 16, < span class = "keywordtype" > bool< / span > enableOOK = < span class = "keyword" > false< / span > );< / div >
< div class = "line" > < a name = "l00056" > < / a > < span class = "lineno" > 56< / span >   < / div >
< div class = "line" > < a name = "l00057" > < / a > < span class = "lineno" > 57< / span >   < span class = "comment" > // configuration methods< / span > < / div >
< div class = "line" > < a name = "l00058" > < / a > < span class = "lineno" > 58< / span >   < / div >
< div class = "line" > < a name = "l00064" > < / a > < span class = "lineno" > 64< / span >   int16_t < a class = "code" href = "class_s_x1279.html#acf9b2087f5b661f06e9512bad36b3817" > setFrequency< / a > (< span class = "keywordtype" > float< / span > freq);< / div >
< div class = "line" > < a name = "l00065" > < / a > < span class = "lineno" > 65< / span >   < / div >
2023-11-27 20:19:39 +00:00
< div class = "line" > < a name = "l00066" > < / a > < span class = "lineno" > 66< / span >   < span class = "preprocessor" > #if !RADIOLIB_GODMODE< / span > < / div >
2023-04-23 20:42:55 +00:00
< div class = "line" > < a name = "l00067" > < / a > < span class = "lineno" > 67< / span >   < span class = "keyword" > private< / span > :< / div >
< div class = "line" > < a name = "l00068" > < / a > < span class = "lineno" > 68< / span >   < span class = "preprocessor" > #endif< / span > < / div >
< div class = "line" > < a name = "l00069" > < / a > < span class = "lineno" > 69< / span >   < / div >
< div class = "line" > < a name = "l00070" > < / a > < span class = "lineno" > 70< / span >   };< / div >
< div class = "line" > < a name = "l00071" > < / a > < span class = "lineno" > 71< / span >   < / div >
< div class = "line" > < a name = "l00072" > < / a > < span class = "lineno" > 72< / span >   < span class = "preprocessor" > #endif< / span > < / div >
< div class = "line" > < a name = "l00073" > < / a > < span class = "lineno" > 73< / span >   < / div >
< div class = "line" > < a name = "l00074" > < / a > < span class = "lineno" > 74< / span >   < span class = "preprocessor" > #endif< / span > < / div >
2024-04-07 15:05:51 +00:00
< 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:68< / div > < / div >
2023-09-24 16:19:54 +00:00
< div class = "ttc" id = "aclass_s_x1278_html" > < div class = "ttname" > < a href = "class_s_x1278.html" > SX1278< / a > < / div > < div class = "ttdoc" > Derived class for SX1278 modules. Also used as base class for SX1276, SX1277, SX1279,...< / div > < div class = "ttdef" > < b > Definition:< / b > SX1278.h:105< / div > < / div >
2023-04-23 20:42:55 +00:00
< div class = "ttc" id = "aclass_s_x1279_html" > < div class = "ttname" > < a href = "class_s_x1279.html" > SX1279< / a > < / div > < div class = "ttdoc" > Derived class for SX1279 modules. Overrides some methods from SX1278 due to different parameter range...< / div > < div class = "ttdef" > < b > Definition:< / b > SX1279.h:14< / div > < / div >
2021-11-14 12:50:15 +00:00
< div class = "ttc" id = "aclass_s_x1279_html_a324a37dee0522f43692cd414141becc2" > < div class = "ttname" > < a href = "class_s_x1279.html#a324a37dee0522f43692cd414141becc2" > SX1279::begin< / a > < / div > < div class = "ttdeci" > int16_t begin(float freq=434.0, float bw=125.0, uint8_t sf=9, uint8_t cr=7, uint8_t syncWord=RADIOLIB_SX127X_SYNC_WORD, int8_t power=10, uint16_t preambleLength=8, uint8_t gain=0)< / div > < div class = "ttdoc" > LoRa modem initialization method. Must be called at least once from Arduino sketch to initialize the ...< / div > < div class = "ttdef" > < b > Definition:< / b > SX1279.cpp:8< / div > < / div >
2023-09-24 16:19:54 +00:00
< div class = "ttc" id = "aclass_s_x1279_html_ab5cb738ed4bf6f40e777f797af2a8b4b" > < div class = "ttname" > < a href = "class_s_x1279.html#ab5cb738ed4bf6f40e777f797af2a8b4b" > SX1279::beginFSK< / a > < / div > < div class = "ttdeci" > int16_t beginFSK(float freq=434.0, float br=4.8, float freqDev=5.0, float rxBw=125.0, int8_t power=10, uint16_t preambleLength=16, bool enableOOK=false)< / div > < div class = "ttdoc" > FSK modem initialization method. Must be called at least once from Arduino sketch to initialize the m...< / div > < div class = "ttdef" > < b > Definition:< / b > SX1279.cpp:40< / div > < / div >
2022-12-06 06:59:09 +00:00
< div class = "ttc" id = "aclass_s_x1279_html_abc606ad06ee77b6830dab4331793d22a" > < div class = "ttname" > < a href = "class_s_x1279.html#abc606ad06ee77b6830dab4331793d22a" > SX1279::SX1279< / a > < / div > < div class = "ttdeci" > SX1279(Module *mod)< / div > < div class = "ttdoc" > Default constructor. Called from Arduino sketch when creating new LoRa instance.< / div > < div class = "ttdef" > < b > Definition:< / b > SX1279.cpp:4< / div > < / div >
2023-09-24 16:19:54 +00:00
< div class = "ttc" id = "aclass_s_x1279_html_acf9b2087f5b661f06e9512bad36b3817" > < div class = "ttname" > < a href = "class_s_x1279.html#acf9b2087f5b661f06e9512bad36b3817" > SX1279::setFrequency< / a > < / div > < div class = "ttdeci" > int16_t setFrequency(float freq)< / div > < div class = "ttdoc" > Sets carrier frequency. Allowed values range from 137.0 MHz to 960.0 MHz.< / div > < div class = "ttdef" > < b > Definition:< / b > SX1279.cpp:71< / div > < / div >
2022-12-06 06:59:09 +00:00
< / div > <!-- fragment --> < / div > <!-- contents -->
< / div > <!-- doc - content -->
2020-08-22 08:30:47 +00:00
<!-- start footer part -->
< div id = "nav-path" class = "navpath" > <!-- id is needed for treeview function! -->
< ul >
< li class = "navelem" > < a class = "el" href = "dir_68267d1309a1af8e8297ef4c3efbcdba.html" > src< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_ddb4d7e95cc2d6c8e1ade10a20d7247d.html" > modules< / a > < / li > < li class = "navelem" > < a class = "el" href = "dir_f980efad9544c0545d0fa50a84ff12f2.html" > SX127x< / a > < / li > < li class = "navelem" > < b > SX1279.h< / b > < / li >
2022-12-06 06:59:09 +00:00
< li class = "footer" > Generated by < a href = "https://www.doxygen.org/index.html" > < img class = "footer" src = "doxygen.svg" width = "104" height = "31" alt = "doxygen" / > < / a > 1.9.1 < / li >
2020-08-22 08:30:47 +00:00
< / ul >
< / div >
< / body >
< / html >