108 lines
22 KiB
HTML
108 lines
22 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<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"/>
|
|
<meta name="generator" content="Doxygen 1.8.13"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>RadioLib: src/modules/XBee/XBee.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>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</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 -->
|
|
<!-- Generated by Doxygen 1.8.13 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
</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">
|
|
$(document).ready(function(){initNavTree('_x_bee_8h_source.html','');});
|
|
</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">XBee.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="preprocessor">#if !defined(_RADIOLIB_XBEE_H) && !defined(RADIOLIB_EXCLUDE_XBEE)</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="preprocessor">#define _RADIOLIB_XBEE_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 "../../ISerial.h"</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#include "../../TypeDef.h"</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> </div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">// API reserved characters</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#define XBEE_API_START 0x7E</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="preprocessor">#define XBEE_API_ESCAPE 0x7D</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#define XBEE_API_XON 0x11</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#define XBEE_API_XOFF 0x13</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">// API frame IDs</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="preprocessor">#define XBEE_API_FRAME_AT_COMMAND 0x08</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#define XBEE_API_FRAME_AT_COMMAND_QUEUE 0x09</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_TRANSMIT_REQUEST 0x10</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_ADDRESS_EXPLICIT 0x11</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#define XBEE_API_FRAME_REMOTE_COMMAND 0x17</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#define XBEE_API_FRAME_CREATE_SOURCE_ROUTE 0x21</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define XBEE_API_FRAME_AT_COMMAND_RESPONSE 0x88</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#define XBEE_API_FRAME_MODEM_STATUS 0x8A</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_TRANSMIT_STATUS 0x8B</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_RECEIVE_PACKET 0x90</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_EXPLICIT_RX 0x91</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define XBEE_API_FRAME_ZIGBEE_IO_DATA_SAMPLE_RX 0x92</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#define XBEE_API_FRAME_SENSOR_READ 0x94</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#define XBEE_API_FRAME_NODE_ID 0x95</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#define XBEE_API_FRAME_REMOTE_COMMAND_RESPONSE 0x97</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#define XBEE_API_FRAME_EXTENDED_MODEM_STATUS 0x98</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#define XBEE_API_FRAME_OTA_FW_UPDATE_STATUS 0xA0</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#define XBEE_API_FRAME_ROUTE_RECORD 0xA1</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#define XBEE_API_FRAME_MANY_TO_ONE_ROUTE_REQUEST 0xA3</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div><div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="class_x_bee_serial.html"> 39</a></span> <span class="keyword">class </span><a class="code" href="class_x_bee_serial.html">XBeeSerial</a>: <span class="keyword">public</span> <a class="code" href="class_i_serial.html">ISerial</a> {</div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <a class="code" href="class_x_bee_serial.html#a9ee7ddd4b45096a6112798be1be09080">XBeeSerial</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// basic methods</span></div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  int16_t <a class="code" href="class_x_bee_serial.html#ac184a4dec32eaeafdb8e68079c3fd932">begin</a>(<span class="keywordtype">long</span> speed);</div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">void</span> <a class="code" href="class_x_bee_serial.html#a1870183689e2a2a17aa36e0d6d30ea3f">reset</a>();</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="comment">// configuration methods</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div><div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  int16_t <a class="code" href="class_x_bee_serial.html#ae485a8ebeaf574ffe0c2c56a61583f13">setDestinationAddress</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* destinationAddressHigh, <span class="keyword">const</span> <span class="keywordtype">char</span>* destinationAddressLow);</div><div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div><div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  int16_t <a class="code" href="class_x_bee_serial.html#ad429a47dc445765d2dec7ff64b922306">setPanId</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* panId);</div><div class="line"><a name="l00083"></a><span class="lineno"> 83</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> enterCmdMode();</div><div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div><div class="line"><a name="l00089"></a><span class="lineno"> 89</span> };</div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="class_x_bee.html"> 96</a></span> <span class="keyword">class </span><a class="code" href="class_x_bee.html">XBee</a> {</div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keyword">public</span>:</div><div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <a class="code" href="class_x_bee.html">XBee</a>(<a class="code" href="class_module.html">Module</a>* mod);</div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> </div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="comment">// basic methods</span></div><div class="line"><a name="l00106"></a><span class="lineno"> 106</span> </div><div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  int16_t <a class="code" href="class_x_bee_serial.html#ac184a4dec32eaeafdb8e68079c3fd932">begin</a>(<span class="keywordtype">long</span> speed);</div><div class="line"><a name="l00115"></a><span class="lineno"> 115</span> </div><div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <span class="keywordtype">void</span> <a class="code" href="class_x_bee_serial.html#a1870183689e2a2a17aa36e0d6d30ea3f">reset</a>();</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  int16_t transmit(uint8_t* dest, <span class="keyword">const</span> <span class="keywordtype">char</span>* payload, uint8_t radius = 1);</div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> </div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span>  int16_t transmit(uint8_t* dest, uint8_t* destNetwork, <span class="keyword">const</span> <span class="keywordtype">char</span>* payload, uint8_t radius = 1);</div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> </div><div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordtype">size_t</span> available();</div><div class="line"><a name="l00151"></a><span class="lineno"> 151</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  String getPacketSource();</div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div><div class="line"><a name="l00164"></a><span class="lineno"> 164</span>  String getPacketData();</div><div class="line"><a name="l00165"></a><span class="lineno"> 165</span> </div><div class="line"><a name="l00166"></a><span class="lineno"> 166</span>  <span class="comment">// configuration methods</span></div><div class="line"><a name="l00167"></a><span class="lineno"> 167</span> </div><div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  int16_t <a class="code" href="class_x_bee_serial.html#ad429a47dc445765d2dec7ff64b922306">setPanId</a>(uint8_t* panId);</div><div class="line"><a name="l00174"></a><span class="lineno"> 174</span> </div><div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="preprocessor">#ifndef RADIOLIB_GODMODE</span></div><div class="line"><a name="l00176"></a><span class="lineno"> 176</span>  <span class="keyword">private</span>:</div><div class="line"><a name="l00177"></a><span class="lineno"> 177</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00178"></a><span class="lineno"> 178</span>  <a class="code" href="class_module.html">Module</a>* _mod;</div><div class="line"><a name="l00179"></a><span class="lineno"> 179</span>  uint8_t _frameID = 0x01;</div><div class="line"><a name="l00180"></a><span class="lineno"> 180</span>  <span class="keywordtype">size_t</span> _frameLength = 0;</div><div class="line"><a name="l00181"></a><span class="lineno"> 181</span>  <span class="keywordtype">bool</span> _frameHeaderProcessed = <span class="keyword">false</span>;</div><div class="line"><a name="l00182"></a><span class="lineno"> 182</span> </div><div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="preprocessor"> #ifdef RADIOLIB_STATIC_ONLY</span></div><div class="line"><a name="l00184"></a><span class="lineno"> 184</span>  <span class="keywordtype">char</span> _packetData[RADIOLIB_STATIC_ARRAY_SIZE];</div><div class="line"><a name="l00185"></a><span class="lineno"> 185</span> <span class="preprocessor"> #else</span></div><div class="line"><a name="l00186"></a><span class="lineno"> 186</span>  <span class="keywordtype">char</span>* _packetData = <span class="keyword">new</span> <span class="keywordtype">char</span>[0];</div><div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="preprocessor"> #endif</span></div><div class="line"><a name="l00188"></a><span class="lineno"> 188</span>  uint8_t _packetSource[8] = {0, 0, 0, 0, 0, 0, 0, 0};</div><div class="line"><a name="l00189"></a><span class="lineno"> 189</span> </div><div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  int16_t confirmChanges();</div><div class="line"><a name="l00191"></a><span class="lineno"> 191</span> </div><div class="line"><a name="l00192"></a><span class="lineno"> 192</span>  <span class="keywordtype">void</span> sendApiFrame(uint8_t type, uint8_t <span class="keywordtype">id</span>, <span class="keyword">const</span> <span class="keywordtype">char</span>* data);</div><div class="line"><a name="l00193"></a><span class="lineno"> 193</span>  <span class="keywordtype">void</span> sendApiFrame(uint8_t type, uint8_t <span class="keywordtype">id</span>, uint8_t* data, uint16_t length);</div><div class="line"><a name="l00194"></a><span class="lineno"> 194</span>  int16_t readApiFrame(uint8_t frameID, uint8_t codePos, uint16_t timeout = 5000);</div><div class="line"><a name="l00195"></a><span class="lineno"> 195</span> </div><div class="line"><a name="l00196"></a><span class="lineno"> 196</span>  uint16_t getNumBytes(uint32_t timeout = 10000, <span class="keywordtype">size_t</span> minBytes = 10);</div><div class="line"><a name="l00197"></a><span class="lineno"> 197</span> };</div><div class="line"><a name="l00198"></a><span class="lineno"> 198</span> </div><div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="class_x_bee_serial_html_ad429a47dc445765d2dec7ff64b922306"><div class="ttname"><a href="class_x_bee_serial.html#ad429a47dc445765d2dec7ff64b922306">XBeeSerial::setPanId</a></div><div class="ttdeci">int16_t setPanId(const char *panId)</div><div class="ttdoc">Sets PAN (Personal Area Network) ID. Both XBees must be in the same PAN in order to use transparent m...</div><div class="ttdef"><b>Definition:</b> XBee.cpp:276</div></div>
|
|
<div class="ttc" id="class_x_bee_serial_html_ae485a8ebeaf574ffe0c2c56a61583f13"><div class="ttname"><a href="class_x_bee_serial.html#ae485a8ebeaf574ffe0c2c56a61583f13">XBeeSerial::setDestinationAddress</a></div><div class="ttdeci">int16_t setDestinationAddress(const char *destinationAddressHigh, const char *destinationAddressLow)</div><div class="ttdoc">Sets destination XBee address. </div><div class="ttdef"><b>Definition:</b> XBee.cpp:226</div></div>
|
|
<div class="ttc" id="class_x_bee_serial_html"><div class="ttname"><a href="class_x_bee_serial.html">XBeeSerial</a></div><div class="ttdoc">XBee Serial interface. This class is used for XBees in transparent mode, i.e. when two XBees act as a...</div><div class="ttdef"><b>Definition:</b> XBee.h:39</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_i_serial_html"><div class="ttname"><a href="class_i_serial.html">ISerial</a></div><div class="ttdoc">Interface class for Arduino Serial. Only calls the appropriate methods for the active UART interface...</div><div class="ttdef"><b>Definition:</b> ISerial.h:16</div></div>
|
|
<div class="ttc" id="class_x_bee_serial_html_a9ee7ddd4b45096a6112798be1be09080"><div class="ttname"><a href="class_x_bee_serial.html#a9ee7ddd4b45096a6112798be1be09080">XBeeSerial::XBeeSerial</a></div><div class="ttdeci">XBeeSerial(Module *mod)</div><div class="ttdoc">Default constructor. </div><div class="ttdef"><b>Definition:</b> XBee.cpp:180</div></div>
|
|
<div class="ttc" id="class_x_bee_html"><div class="ttname"><a href="class_x_bee.html">XBee</a></div><div class="ttdoc">Control class for XBee modules. </div><div class="ttdef"><b>Definition:</b> XBee.h:96</div></div>
|
|
<div class="ttc" id="class_x_bee_serial_html_a1870183689e2a2a17aa36e0d6d30ea3f"><div class="ttname"><a href="class_x_bee_serial.html#a1870183689e2a2a17aa36e0d6d30ea3f">XBeeSerial::reset</a></div><div class="ttdeci">void reset()</div><div class="ttdoc">Resets module using interrupt/GPIO pin 1. </div><div class="ttdef"><b>Definition:</b> XBee.cpp:218</div></div>
|
|
<div class="ttc" id="class_x_bee_serial_html_ac184a4dec32eaeafdb8e68079c3fd932"><div class="ttname"><a href="class_x_bee_serial.html#ac184a4dec32eaeafdb8e68079c3fd932">XBeeSerial::begin</a></div><div class="ttdeci">int16_t begin(long speed)</div><div class="ttdoc">Initialization method. </div><div class="ttdef"><b>Definition:</b> XBee.cpp:184</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- 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_7b8feacc70eb38d5fd56f060c649a59c.html">XBee</a></li><li class="navelem"><b>XBee.h</b></li>
|
|
<li class="footer">Generated by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|