<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> <html> <!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ --> <HEAD> <meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8"> <meta name="keywords" content="stage, robot, simulation, player, player/stage"> <link href="doxygen.css" rel="stylesheet" type="text/css"> <style type="text/css"> .floatright { float: right; margin: 0 0 1em 1em; } body { font-family: sans-serif; #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; background-color: #FFF; color:#000; } a:link { color: #A00; } a:visited { color: #800; } a { text-decoration: none; } a:hover { text-decoration: underline; } .timestamp { text-align:right; background-color: #DDD; font-size:75%;} h1 { font-size:160%; } h2 { font-size:110%; #color: #FFF; #background-color: #666; #padding:3px; } h3 { text-align:left; } img { border: 0; } ul.menu { position:relative; left:-2.5em; margin-bottom:0px; margin-top:0px; } ul.menu1 { position:relative; left:-2.1em; margin-bottom:0px; margin-top:0px; } li.menu { list-style-type: none; position:relative; #left:-0.5em; } #sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;} #content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; } div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em; } div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;} div.topbar { position: absolute; top:0px; left:9em; margin:1em; } </style> <TITLE>Player Manual</TITLE> </HEAD> <body> <div id="sidebar"> <h2 style="text-align:center;"> <a href="index.html"> <img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a> </h2> <div class="box"> <div class=title>Player</div> <ul class=menu> <li class=menu><a href="index.html">Frontpage</a> <li class=menu><a href="modules.html">Contents</a> </ul> </div> <div class="box"> <div class=title>User</div> <ul class=menu> <li class=menu><a href="install.html">Installation</a> <li class=menu><a href="start.html">Quick start</a> <li class=menu><a href="supported_hardware.html">Supported devices</a> <li class=menu><a href="group__tutorials.html">Tutorials</a> <li class=menu><a href="group__utils.html">Utilities</a> <li class=menu><a href="group__clientlibs.html">Client libraries</a> <li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a> <li class=menu><a href="help.html">Help</a> </ul> </div> <div class=box> <div class="title">Developer</div> <ul class=menu> <li class=menu><a href="architecture.html">Architecture</a> <li class=menu><a href="group__libplayercore.html">libplayercore</a> <ul class=menu1> <li class=menu><a href="group__interfaces.html">interfaces</a></li> </ul> <li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a> <ul class=menu1> <li class=menu><a href="group__drivers.html">drivers</a></li> </ul> <li class=menu><a href="group__libplayercommon.html">libplayercommon</a> <li class=menu><a href="group__libplayerutils.html">libplayerutils</a> <li class=menu><a href="group__libplayersd.html">libplayersd</a> <li class=menu><a href="group__libplayertcp.html">libplayertcp</a> <li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a> <li class=menu><a href="todo.html">TODO</a> </ul> </div> <div class=box> <!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> --> <div class="title">Online</div> <a href="http://playerstage.sourceforge.net">Homepage</a><br> <a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br> <a href="http://sourceforge.net/projects/playerstage">Project</a><br> <a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br> <a href="http://sourceforge.net/mail/?group_id=42445">Help</a> </div> </div> <div id="content" > <!-- Generated by Doxygen 1.7.1 --> <div class="header"> <div class="headertitle"> <h1>wsn<br/> <small> [<a class="el" href="group__interfaces.html">Interface specifications</a>]</small> </h1> </div> </div> <div class="contents"> <p>Wireless Sensor Networks. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab5d5dc7634ae54a8fc1a093979ee7090"></a><!-- doxytag: member="interface_wsn::PLAYER_WSN_DATA_STATE" ref="gab5d5dc7634ae54a8fc1a093979ee7090" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gab5d5dc7634ae54a8fc1a093979ee7090">PLAYER_WSN_DATA_STATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtypes. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga89f65ea4ba1f61d5ecaa0d9834619d8e"></a><!-- doxytag: member="interface_wsn::PLAYER_WSN_CMD_DEVSTATE" ref="ga89f65ea4ba1f61d5ecaa0d9834619d8e" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#ga89f65ea4ba1f61d5ecaa0d9834619d8e">PLAYER_WSN_CMD_DEVSTATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: set device state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#ga1bada8408d3f636d9b07ff5b71266e17">PLAYER_WSN_REQ_POWER</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: put the node in sleep mode (0) or wake it up (1). <a href="#ga1bada8408d3f636d9b07ff5b71266e17"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gac368bb9f7076570e6a9fe1376d6c0e53">PLAYER_WSN_REQ_DATATYPE</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: change the data type to RAW or converted metric units. <a href="#gac368bb9f7076570e6a9fe1376d6c0e53"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gafe8bcbd6a559db612aa706deda760ea0">PLAYER_WSN_REQ_DATAFREQ</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: change the receiving data frequency. <a href="#gafe8bcbd6a559db612aa706deda760ea0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__wsn__node__data.html">player_wsn_node_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gac1ac3c31bf71fb51af0eccd51437eea8">player_wsn_node_data_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Structure describing the WSN node's data packet. <a href="#gac1ac3c31bf71fb51af0eccd51437eea8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__wsn__data.html">player_wsn_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gab94a6a037671d9b5b94287869ea301c0">player_wsn_data_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data (PLAYER_WSN_DATA). <a href="#gab94a6a037671d9b5b94287869ea301c0"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__wsn__cmd.html">player_wsn_cmd</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#ga8f4c8279720fb0344c5cd9519793ebe5">player_wsn_cmd_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: set device state (<a class="el" href="group__interface__wsn.html#ga89f65ea4ba1f61d5ecaa0d9834619d8e">PLAYER_WSN_CMD_DEVSTATE</a>) This <code>wsn</code> command sets the state of the node's indicator lights or its buzzer/sounder (if equipped with one). <a href="#ga8f4c8279720fb0344c5cd9519793ebe5"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__wsn__power__config.html">player_wsn_power_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#gafb6c2d55ff7292d0ce8c0e7de5d6c30a">player_wsn_power_config_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Put the node in sleep mode (0) or wake it up (1). <a href="#gafb6c2d55ff7292d0ce8c0e7de5d6c30a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__wsn__datatype__config.html">player_wsn_datatype_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#ga53b4de03576e0b298464e14f95084cd7">player_wsn_datatype_config_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: change the data type to RAW or converted engineering units. <a href="#ga53b4de03576e0b298464e14f95084cd7"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__wsn__datafreq__config.html">player_wsn_datafreq_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__wsn.html#ga04495f6274eb386a27299b10f6ff439f">player_wsn_datafreq_config_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Change data delivery frequency. <a href="#ga04495f6274eb386a27299b10f6ff439f"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Wireless Sensor Networks. </p> <p>The WSN interface provides access to a Wireless Sensor Network (driver implementations include WSN's such as Crossbow's MICA2 motes and TeCo's RCore particles).</p> <p>The current implementation supports a single group of network nodes. Support for multiple groups will be added in the future. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="gafe8bcbd6a559db612aa706deda760ea0"></a><!-- doxytag: member="player_interfaces.h::PLAYER_WSN_REQ_DATAFREQ" ref="gafe8bcbd6a559db612aa706deda760ea0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_WSN_REQ_DATAFREQ 3</td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: change the receiving data frequency. </p> </div> </div> <a class="anchor" id="gac368bb9f7076570e6a9fe1376d6c0e53"></a><!-- doxytag: member="player_interfaces.h::PLAYER_WSN_REQ_DATATYPE" ref="gac368bb9f7076570e6a9fe1376d6c0e53" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_WSN_REQ_DATATYPE 2</td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: change the data type to RAW or converted metric units. </p> </div> </div> <a class="anchor" id="ga1bada8408d3f636d9b07ff5b71266e17"></a><!-- doxytag: member="player_interfaces.h::PLAYER_WSN_REQ_POWER" ref="ga1bada8408d3f636d9b07ff5b71266e17" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_WSN_REQ_POWER 1</td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: put the node in sleep mode (0) or wake it up (1). </p> </div> </div> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga8f4c8279720fb0344c5cd9519793ebe5"></a><!-- doxytag: member="player_interfaces.h::player_wsn_cmd_t" ref="ga8f4c8279720fb0344c5cd9519793ebe5" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__cmd.html">player_wsn_cmd</a> <a class="el" href="structplayer__wsn__cmd.html">player_wsn_cmd_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Command: set device state (<a class="el" href="group__interface__wsn.html#ga89f65ea4ba1f61d5ecaa0d9834619d8e">PLAYER_WSN_CMD_DEVSTATE</a>) This <code>wsn</code> command sets the state of the node's indicator lights or its buzzer/sounder (if equipped with one). </p> </div> </div> <a class="anchor" id="gab94a6a037671d9b5b94287869ea301c0"></a><!-- doxytag: member="player_interfaces.h::player_wsn_data_t" ref="gab94a6a037671d9b5b94287869ea301c0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__data.html">player_wsn_data</a> <a class="el" href="structplayer__wsn__data.html">player_wsn_data_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data (PLAYER_WSN_DATA). </p> <p>The WSN data packet describes a wireless sensor network node. </p> </div> </div> <a class="anchor" id="ga04495f6274eb386a27299b10f6ff439f"></a><!-- doxytag: member="player_interfaces.h::player_wsn_datafreq_config_t" ref="ga04495f6274eb386a27299b10f6ff439f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__datafreq__config.html">player_wsn_datafreq_config</a> <a class="el" href="structplayer__wsn__datafreq__config.html">player_wsn_datafreq_config_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Change data delivery frequency. </p> <p>By default, the frequency set for receiving data is set on the wireless node. Send a <a class="el" href="group__interface__wsn.html#gafe8bcbd6a559db612aa706deda760ea0">PLAYER_WSN_REQ_DATAFREQ</a> request to change the frequency. Fill in the node ID or set -1 for all nodes. Null response. </p> </div> </div> <a class="anchor" id="ga53b4de03576e0b298464e14f95084cd7"></a><!-- doxytag: member="player_interfaces.h::player_wsn_datatype_config_t" ref="ga53b4de03576e0b298464e14f95084cd7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__datatype__config.html">player_wsn_datatype_config</a> <a class="el" href="structplayer__wsn__datatype__config.html">player_wsn_datatype_config_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: change the data type to RAW or converted engineering units. </p> <p>Send a <a class="el" href="group__interface__wsn.html#gac368bb9f7076570e6a9fe1376d6c0e53">PLAYER_WSN_REQ_DATATYPE</a> request to switch between RAW or converted engineering units values in the data packet. Null response. </p> </div> </div> <a class="anchor" id="gac1ac3c31bf71fb51af0eccd51437eea8"></a><!-- doxytag: member="player_interfaces.h::player_wsn_node_data_t" ref="gac1ac3c31bf71fb51af0eccd51437eea8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__node__data.html">player_wsn_node_data</a> <a class="el" href="structplayer__wsn__node__data.html">player_wsn_node_data_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Structure describing the WSN node's data packet. </p> </div> </div> <a class="anchor" id="gafb6c2d55ff7292d0ce8c0e7de5d6c30a"></a><!-- doxytag: member="player_interfaces.h::player_wsn_power_config_t" ref="gafb6c2d55ff7292d0ce8c0e7de5d6c30a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__wsn__power__config.html">player_wsn_power_config</a> <a class="el" href="structplayer__wsn__power__config.html">player_wsn_power_config_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Put the node in sleep mode (0) or wake it up (1). </p> <p>Send a <a class="el" href="group__interface__wsn.html#ga1bada8408d3f636d9b07ff5b71266e17">PLAYER_WSN_REQ_POWER</a> request to power or wake up a node in the WSN. Null response. </p> </div> </div> </div> <!-- render the modification time of the source file --> <div class="timestamp"> <hr> <table style="width:100%;"> <tr> <td style="text-align:left;"> Last updated 12 September 2005 21:38:45 <!-- <td style="text-align:right;"> <a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!"></a> <a href="http://jigsaw.w3.org/css-validator/"> <img style="vertical-align:middle;border:0;width:88px;height:31px" src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"> </a> --> </tr> </table> </div> </tr> </table> </BODY> </HTML>