392 lines
18 KiB
HTML
392 lines
18 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.11"/>
|
|
<title>RadioLib: XBee Class Reference</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);
|
|
$(window).load(resizeHeight);
|
|
</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>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { init_search(); });
|
|
</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.11 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</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('class_x_bee.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="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="class_x_bee-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">XBee Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Control class for XBee modules.
|
|
<a href="class_x_bee.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_x_bee_8h_source.html">XBee.h</a>></code></p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a8a60ce7fd2b58e495b436d046e730e0b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a8a60ce7fd2b58e495b436d046e730e0b">XBee</a> (<a class="el" href="class_module.html">Module</a> *mod)</td></tr>
|
|
<tr class="memdesc:a8a60ce7fd2b58e495b436d046e730e0b"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <a href="#a8a60ce7fd2b58e495b436d046e730e0b">More...</a><br /></td></tr>
|
|
<tr class="separator:a8a60ce7fd2b58e495b436d046e730e0b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a84b4593723cab4d5ce14e2bf4ee6dbe4"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a84b4593723cab4d5ce14e2bf4ee6dbe4">begin</a> (long speed)</td></tr>
|
|
<tr class="memdesc:a84b4593723cab4d5ce14e2bf4ee6dbe4"><td class="mdescLeft"> </td><td class="mdescRight">Initialization method. <a href="#a84b4593723cab4d5ce14e2bf4ee6dbe4">More...</a><br /></td></tr>
|
|
<tr class="separator:a84b4593723cab4d5ce14e2bf4ee6dbe4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a10a4b3df9d5980e89a126848ec31613c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10a4b3df9d5980e89a126848ec31613c"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a10a4b3df9d5980e89a126848ec31613c">reset</a> ()</td></tr>
|
|
<tr class="memdesc:a10a4b3df9d5980e89a126848ec31613c"><td class="mdescLeft"> </td><td class="mdescRight">Resets module using interrupt/GPIO pin 1. <br /></td></tr>
|
|
<tr class="separator:a10a4b3df9d5980e89a126848ec31613c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1573e0aa0421cbcc767a968dda65819"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#ac1573e0aa0421cbcc767a968dda65819">transmit</a> (uint8_t *dest, const char *payload, uint8_t radius=1)</td></tr>
|
|
<tr class="memdesc:ac1573e0aa0421cbcc767a968dda65819"><td class="mdescLeft"> </td><td class="mdescRight">Sends data to the destination 64-bit (global) address, when destination 16-bit (local) address is unknown. <a href="#ac1573e0aa0421cbcc767a968dda65819">More...</a><br /></td></tr>
|
|
<tr class="separator:ac1573e0aa0421cbcc767a968dda65819"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a697bfb6969560ef25bfb6c7bc64c3f09"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a697bfb6969560ef25bfb6c7bc64c3f09">transmit</a> (uint8_t *dest, uint8_t *destNetwork, const char *payload, uint8_t radius=1)</td></tr>
|
|
<tr class="memdesc:a697bfb6969560ef25bfb6c7bc64c3f09"><td class="mdescLeft"> </td><td class="mdescRight">Sends data to the destination 64-bit (global) address, when destination 16-bit (local) address is known. <a href="#a697bfb6969560ef25bfb6c7bc64c3f09">More...</a><br /></td></tr>
|
|
<tr class="separator:a697bfb6969560ef25bfb6c7bc64c3f09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5ecae4c93f7aaaf85146f75eebd38891"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a5ecae4c93f7aaaf85146f75eebd38891">available</a> ()</td></tr>
|
|
<tr class="memdesc:a5ecae4c93f7aaaf85146f75eebd38891"><td class="mdescLeft"> </td><td class="mdescRight">Gets the number of payload bytes received. <a href="#a5ecae4c93f7aaaf85146f75eebd38891">More...</a><br /></td></tr>
|
|
<tr class="separator:a5ecae4c93f7aaaf85146f75eebd38891"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abcffe611d9a823d66a8a2c12720ff70b"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#abcffe611d9a823d66a8a2c12720ff70b">getPacketSource</a> ()</td></tr>
|
|
<tr class="memdesc:abcffe611d9a823d66a8a2c12720ff70b"><td class="mdescLeft"> </td><td class="mdescRight">Gets packet source 64-bit address. <a href="#abcffe611d9a823d66a8a2c12720ff70b">More...</a><br /></td></tr>
|
|
<tr class="separator:abcffe611d9a823d66a8a2c12720ff70b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab911ae5476a3a7c89dbac46adc1c843b"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#ab911ae5476a3a7c89dbac46adc1c843b">getPacketData</a> ()</td></tr>
|
|
<tr class="memdesc:ab911ae5476a3a7c89dbac46adc1c843b"><td class="mdescLeft"> </td><td class="mdescRight">Gets packet payload. <a href="#ab911ae5476a3a7c89dbac46adc1c843b">More...</a><br /></td></tr>
|
|
<tr class="separator:ab911ae5476a3a7c89dbac46adc1c843b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88745c61a1dc2d1139c34d6cc385d35b"><td class="memItemLeft" align="right" valign="top">int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="class_x_bee.html#a88745c61a1dc2d1139c34d6cc385d35b">setPanId</a> (uint8_t *panId)</td></tr>
|
|
<tr class="memdesc:a88745c61a1dc2d1139c34d6cc385d35b"><td class="mdescLeft"> </td><td class="mdescRight">Sets PAN (Personal Area Network) ID. All XBees must be in the same PAN in order to communicate. <a href="#a88745c61a1dc2d1139c34d6cc385d35b">More...</a><br /></td></tr>
|
|
<tr class="separator:a88745c61a1dc2d1139c34d6cc385d35b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Control class for XBee modules. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="a8a60ce7fd2b58e495b436d046e730e0b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">XBee::XBee </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="class_module.html">Module</a> * </td>
|
|
<td class="paramname"><em>mod</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Default constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">mod</td><td>Instance of <a class="el" href="class_module.html" title="Implements all common low-level SPI/UART/I2C methods to control the wireless module. Every module class contains one private instance of this class. ">Module</a> that will be used to communicate with the radio. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a5ecae4c93f7aaaf85146f75eebd38891"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">size_t XBee::available </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the number of payload bytes received. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Number of available payload bytes, or 0 if nothing was received. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a84b4593723cab4d5ce14e2bf4ee6dbe4"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t XBee::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>speed</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Initialization method. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">speed</td><td>Baud rate to use for UART interface.</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="group__status__codes.html">Status Codes</a> </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ab911ae5476a3a7c89dbac46adc1c843b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">String XBee::getPacketData </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets packet payload. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Packet payload, in the form of Arduino String. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="abcffe611d9a823d66a8a2c12720ff70b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">String XBee::getPacketSource </td>
|
|
<td>(</td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets packet source 64-bit address. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Packet source address, in the form of uppercase hexadecimal Arduino String (i.e. 16 characters). </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a88745c61a1dc2d1139c34d6cc385d35b"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t XBee::setPanId </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>panId</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets PAN (Personal Area Network) ID. All XBees must be in the same PAN in order to communicate. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">panId</td><td>8-byte PAN ID to be used, in the form of uppercase hexadecimal string (i.e. 16 characters). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="ac1573e0aa0421cbcc767a968dda65819"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t XBee::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>payload</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>radius</em> = <code>1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sends data to the destination 64-bit (global) address, when destination 16-bit (local) address is unknown. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>Destination 64-bit address, in the form of 8-byte array.</td></tr>
|
|
<tr><td class="paramname">payload</td><td>String of payload bytes.</td></tr>
|
|
<tr><td class="paramname">radius</td><td>Number of maximum "hops" for a broadcast transmission. Defaults to 1, set to 0 for unlimited number of hops. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a697bfb6969560ef25bfb6c7bc64c3f09"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int16_t XBee::transmit </td>
|
|
<td>(</td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>dest</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t * </td>
|
|
<td class="paramname"><em>destNetwork</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const char * </td>
|
|
<td class="paramname"><em>payload</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">uint8_t </td>
|
|
<td class="paramname"><em>radius</em> = <code>1</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sends data to the destination 64-bit (global) address, when destination 16-bit (local) address is known. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">dest</td><td>Destination 64-bit address, in the form of 8-byte array.</td></tr>
|
|
<tr><td class="paramname">destNetwork</td><td>Destination 16-bit address, in the form of 2-byte array.</td></tr>
|
|
<tr><td class="paramname">payload</td><td>String of payload bytes.</td></tr>
|
|
<tr><td class="paramname">radius</td><td>Number of maximum "hops" for a broadcast transmission. Defaults to 1, set to 0 for unlimited number of hops. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/modules/XBee/<a class="el" href="_x_bee_8h_source.html">XBee.h</a></li>
|
|
<li>src/modules/XBee/XBee.cpp</li>
|
|
</ul>
|
|
</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="class_x_bee.html">XBee</a></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.11 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|