<!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>imu<br/> <small> [<a class="el" href="group__interfaces.html">Interface specifications</a>]</small> </h1> </div> </div> <div class="contents"> <p>Inertial Measurement Unit. <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="gad86e4b7aadbb41f58bb77c6634fb2121"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_DATA_STATE" ref="gad86e4b7aadbb41f58bb77c6634fb2121" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#gad86e4b7aadbb41f58bb77c6634fb2121">PLAYER_IMU_DATA_STATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: IMU position/orientation data. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaebf284ee836a3d1144fbb5615ead4b01"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_DATA_CALIB" ref="gaebf284ee836a3d1144fbb5615ead4b01" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#gaebf284ee836a3d1144fbb5615ead4b01">PLAYER_IMU_DATA_CALIB</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: Calibrated IMU data. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga388b28870d30814915b4343f6ead66d7"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_DATA_QUAT" ref="ga388b28870d30814915b4343f6ead66d7" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga388b28870d30814915b4343f6ead66d7">PLAYER_IMU_DATA_QUAT</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: Quaternions orientation data. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga993255084bdb82f41f5665d9b80eec4d"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_DATA_EULER" ref="ga993255084bdb82f41f5665d9b80eec4d" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga993255084bdb82f41f5665d9b80eec4d">PLAYER_IMU_DATA_EULER</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: Euler orientation data. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga55dd80201004a4e1f0b05104aaca535f"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_DATA_FULLSTATE" ref="ga55dd80201004a4e1f0b05104aaca535f" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga55dd80201004a4e1f0b05104aaca535f">PLAYER_IMU_DATA_FULLSTATE</a> 5</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data subtype: All IMU position/orientation data. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacc47985ce3bab911445420dfd37de1c1"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_REQ_SET_DATATYPE" ref="gacc47985ce3bab911445420dfd37de1c1" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#gacc47985ce3bab911445420dfd37de1c1">PLAYER_IMU_REQ_SET_DATATYPE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: set data type. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga28b5064fe6b9f171add5d556c2da8bb6"></a><!-- doxytag: member="interface_imu::PLAYER_IMU_REQ_RESET_ORIENTATION" ref="ga28b5064fe6b9f171add5d556c2da8bb6" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga28b5064fe6b9f171add5d556c2da8bb6">PLAYER_IMU_REQ_RESET_ORIENTATION</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply subtype: reset orientation. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__data__state.html">player_imu_data_state</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga7c71672c576fa557e67456df41ec5975">player_imu_data_state_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: calibrated IMU data (<a class="el" href="group__interface__imu.html#gad86e4b7aadbb41f58bb77c6634fb2121">PLAYER_IMU_DATA_STATE</a>). <a href="#ga7c71672c576fa557e67456df41ec5975"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__data__calib.html">player_imu_data_calib</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga848126ee2eb0aa1d21af127d7664e243">player_imu_data_calib_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: calibrated IMU data (<a class="el" href="group__interface__imu.html#gaebf284ee836a3d1144fbb5615ead4b01">PLAYER_IMU_DATA_CALIB</a>). <a href="#ga848126ee2eb0aa1d21af127d7664e243"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__imu__data__quat.html">player_imu_data_quat</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga8144dd18ee06aad9821a7560f195426a">player_imu_data_quat_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: Quaternions orientation data (<a class="el" href="group__interface__imu.html#ga388b28870d30814915b4343f6ead66d7">PLAYER_IMU_DATA_QUAT</a>). <a href="#ga8144dd18ee06aad9821a7560f195426a"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__data__euler.html">player_imu_data_euler</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga175698c491a53e3c6123478107bfb467">player_imu_data_euler_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: Euler orientation data (<a class="el" href="group__interface__imu.html#ga993255084bdb82f41f5665d9b80eec4d">PLAYER_IMU_DATA_EULER</a>). <a href="#ga175698c491a53e3c6123478107bfb467"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__data__fullstate.html">player_imu_data_fullstate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga6318e6bad145025ef26473cf596ff711">player_imu_data_fullstate_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: all of the calibrated IMU data (<a class="el" href="group__interface__imu.html#ga55dd80201004a4e1f0b05104aaca535f">PLAYER_IMU_DATA_FULLSTATE</a>). <a href="#ga6318e6bad145025ef26473cf596ff711"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__datatype__config.html">player_imu_datatype_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#gab5353c0ad15e68f560bf318dfa6d6020">player_imu_datatype_config_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: change the data type to one of the predefined data structures. <a href="#gab5353c0ad15e68f560bf318dfa6d6020"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__imu__reset__orientation__config.html">player_imu_reset_orientation_config</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__imu.html#ga9b85bcd913930b6a21c1816c4912d2f9">player_imu_reset_orientation_config_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Request/reply: Reset orientation. <a href="#ga9b85bcd913930b6a21c1816c4912d2f9"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Inertial Measurement Unit. </p> <p>The <code>imu</code> interface provides access to an Inertial Measurement Unit sensor (such as the XSens MTx/MTi). </p> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga848126ee2eb0aa1d21af127d7664e243"></a><!-- doxytag: member="player_interfaces.h::player_imu_data_calib_t" ref="ga848126ee2eb0aa1d21af127d7664e243" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__data__calib.html">player_imu_data_calib</a> <a class="el" href="structplayer__imu__data__calib.html">player_imu_data_calib_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: calibrated IMU data (<a class="el" href="group__interface__imu.html#gaebf284ee836a3d1144fbb5615ead4b01">PLAYER_IMU_DATA_CALIB</a>). </p> <p>The <code>imu</code> interface returns calibrated acceleration, gyro and magnetic values from the IMU sensor. </p> </div> </div> <a class="anchor" id="ga175698c491a53e3c6123478107bfb467"></a><!-- doxytag: member="player_interfaces.h::player_imu_data_euler_t" ref="ga175698c491a53e3c6123478107bfb467" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__data__euler.html">player_imu_data_euler</a> <a class="el" href="structplayer__imu__data__euler.html">player_imu_data_euler_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: Euler orientation data (<a class="el" href="group__interface__imu.html#ga993255084bdb82f41f5665d9b80eec4d">PLAYER_IMU_DATA_EULER</a>). </p> <p>The <code>imu</code> interface returns calibrated IMU values as well as orientation data as Euler angles. </p> </div> </div> <a class="anchor" id="ga6318e6bad145025ef26473cf596ff711"></a><!-- doxytag: member="player_interfaces.h::player_imu_data_fullstate_t" ref="ga6318e6bad145025ef26473cf596ff711" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__data__fullstate.html">player_imu_data_fullstate</a> <a class="el" href="structplayer__imu__data__fullstate.html">player_imu_data_fullstate_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: all of the calibrated IMU data (<a class="el" href="group__interface__imu.html#ga55dd80201004a4e1f0b05104aaca535f">PLAYER_IMU_DATA_FULLSTATE</a>). </p> <p>The <code>imu</code> interface returns the complete 3D coordinates + angles position in space, as well as velocity and acceleration of the IMU sensor. </p> </div> </div> <a class="anchor" id="ga8144dd18ee06aad9821a7560f195426a"></a><!-- doxytag: member="player_interfaces.h::player_imu_data_quat_t" ref="ga8144dd18ee06aad9821a7560f195426a" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__data__quat.html">player_imu_data_quat</a> <a class="el" href="structplayer__imu__data__quat.html">player_imu_data_quat_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: Quaternions orientation data (<a class="el" href="group__interface__imu.html#ga388b28870d30814915b4343f6ead66d7">PLAYER_IMU_DATA_QUAT</a>). </p> <p>The <code>imu</code> interface returns calibrated IMU values as well as orientation data as quaternions. </p> </div> </div> <a class="anchor" id="ga7c71672c576fa557e67456df41ec5975"></a><!-- doxytag: member="player_interfaces.h::player_imu_data_state_t" ref="ga7c71672c576fa557e67456df41ec5975" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__data__state.html">player_imu_data_state</a> <a class="el" href="structplayer__imu__data__state.html">player_imu_data_state_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: calibrated IMU data (<a class="el" href="group__interface__imu.html#gad86e4b7aadbb41f58bb77c6634fb2121">PLAYER_IMU_DATA_STATE</a>). </p> <p>The <code>imu</code> interface returns the complete 3D coordinates + angles position in space, of the IMU sensor. </p> </div> </div> <a class="anchor" id="gab5353c0ad15e68f560bf318dfa6d6020"></a><!-- doxytag: member="player_interfaces.h::player_imu_datatype_config_t" ref="gab5353c0ad15e68f560bf318dfa6d6020" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__datatype__config.html">player_imu_datatype_config</a> <a class="el" href="structplayer__imu__datatype__config.html">player_imu_datatype_config_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: change the data type to one of the predefined data structures. </p> <p>Send a <a class="el" href="group__interface__imu.html#gacc47985ce3bab911445420dfd37de1c1">PLAYER_IMU_REQ_SET_DATATYPE</a> request to switch between calibrated data, 3D pose and orientation, Euler orientation or Quaternions orientation in the data packet. Null response. </p> </div> </div> <a class="anchor" id="ga9b85bcd913930b6a21c1816c4912d2f9"></a><!-- doxytag: member="player_interfaces.h::player_imu_reset_orientation_config_t" ref="ga9b85bcd913930b6a21c1816c4912d2f9" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__imu__reset__orientation__config.html">player_imu_reset_orientation_config</a> <a class="el" href="structplayer__imu__reset__orientation__config.html">player_imu_reset_orientation_config_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Request/reply: Reset orientation. </p> <p>To reset the IMU's orientation, send a <a class="el" href="group__interface__imu.html#ga28b5064fe6b9f171add5d556c2da8bb6">PLAYER_IMU_REQ_RESET_ORIENTATION</a> request. 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>