<!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>blinkenlight<br/> <small> [<a class="el" href="group__interfaces.html">Interface specifications</a>]</small> </h1> </div> </div> <div class="contents"> <p>An indicator light. <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">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#gaa73e6add570be58a883b31c4b1542466"></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__blinkenlight.html#gade36bd6ad2804d0c6f347cc216eadcc7">PLAYER_BLINKENLIGHT_CMD_STATE</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#gade36bd6ad2804d0c6f347cc216eadcc7"></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__blinkenlight.html#gac88afad8c57aff4cedddc424c7533f7f">PLAYER_BLINKENLIGHT_CMD_POWER</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#gac88afad8c57aff4cedddc424c7533f7f"></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__blinkenlight.html#ga10b9bdf303a7c8d00eb23595208e0d0c">PLAYER_BLINKENLIGHT_CMD_COLOR</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#ga10b9bdf303a7c8d00eb23595208e0d0c"></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__blinkenlight.html#ga9c0ecddfa0f357d4d0ca69f887c89ff8">PLAYER_BLINKENLIGHT_CMD_FLASH</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#ga9c0ecddfa0f357d4d0ca69f887c89ff8"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__blinkenlight__data.html">player_blinkenlight_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#gaab16b6e093f9bce9b1a6fda1c1b03984">player_blinkenlight_data_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. <a href="#gaab16b6e093f9bce9b1a6fda1c1b03984"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__blinkenlight__cmd.html">player_blinkenlight_cmd</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#gad917bc75685839af46d00f1bac4e3c8b">player_blinkenlight_cmd_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: state (<a class="el" href="group__interface__blinkenlight.html#gade36bd6ad2804d0c6f347cc216eadcc7">PLAYER_BLINKENLIGHT_CMD_STATE</a>) This <code>blinkenlight</code> command sets the complete current state of the indicator light. <a href="#gad917bc75685839af46d00f1bac4e3c8b"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga77c447c018ef2bec2292ad5f55c2c618"></a><!-- doxytag: member="interface_blinkenlight::player_blinkenlight_cmd_power_t" ref="ga77c447c018ef2bec2292ad5f55c2c618" args="" --> typedef struct <br class="typebreak"/> <a class="el" href="structplayer__blinkenlight__cmd__power.html">player_blinkenlight_cmd_power</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#ga77c447c018ef2bec2292ad5f55c2c618">player_blinkenlight_cmd_power_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: power (<a class="el" href="group__interface__blinkenlight.html#gac88afad8c57aff4cedddc424c7533f7f">PLAYER_BLINKENLIGHT_CMD_POWER</a>) This <code>blinkenlight</code> command turns the light on or off. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaf9c36bd3cf4965b253df2711e1a95e10"></a><!-- doxytag: member="interface_blinkenlight::player_blinkenlight_cmd_color_t" ref="gaf9c36bd3cf4965b253df2711e1a95e10" args="" --> typedef struct <br class="typebreak"/> <a class="el" href="structplayer__blinkenlight__cmd__color.html">player_blinkenlight_cmd_color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#gaf9c36bd3cf4965b253df2711e1a95e10">player_blinkenlight_cmd_color_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: color (<a class="el" href="group__interface__blinkenlight.html#ga10b9bdf303a7c8d00eb23595208e0d0c">PLAYER_BLINKENLIGHT_CMD_COLOR</a>) This <code>blinkenlight</code> command sets the color of the light. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga15a13f61e169340731df473a75b58982"></a><!-- doxytag: member="interface_blinkenlight::player_blinkenlight_cmd_flash_t" ref="ga15a13f61e169340731df473a75b58982" args="" --> typedef struct <br class="typebreak"/> <a class="el" href="structplayer__blinkenlight__cmd__flash.html">player_blinkenlight_cmd_flash</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__blinkenlight.html#ga15a13f61e169340731df473a75b58982">player_blinkenlight_cmd_flash_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: flash (<a class="el" href="group__interface__blinkenlight.html#ga9c0ecddfa0f357d4d0ca69f887c89ff8">PLAYER_BLINKENLIGHT_CMD_FLASH</a>) This <code>blinkenlight</code> command sets the duration of one on/off blink cycle in seconds and the ratio of light on/off time (0.0 to 1.0 ). <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>An indicator light. </p> <p>The <code>blinkenlight</code> interface is used to switch on and off an indicator light, set its color (if supported) and to set its flash period and duty cycle (if supported).</p> <p>This interface accepts no configuration requests. </p> <hr/><h2>Define Documentation</h2> <a class="anchor" id="ga10b9bdf303a7c8d00eb23595208e0d0c"></a><!-- doxytag: member="player_interfaces.h::PLAYER_BLINKENLIGHT_CMD_COLOR" ref="ga10b9bdf303a7c8d00eb23595208e0d0c" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_BLINKENLIGHT_CMD_COLOR 3</td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </p> </div> </div> <a class="anchor" id="ga9c0ecddfa0f357d4d0ca69f887c89ff8"></a><!-- doxytag: member="player_interfaces.h::PLAYER_BLINKENLIGHT_CMD_FLASH" ref="ga9c0ecddfa0f357d4d0ca69f887c89ff8" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_BLINKENLIGHT_CMD_FLASH 4</td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </p> </div> </div> <a class="anchor" id="gac88afad8c57aff4cedddc424c7533f7f"></a><!-- doxytag: member="player_interfaces.h::PLAYER_BLINKENLIGHT_CMD_POWER" ref="gac88afad8c57aff4cedddc424c7533f7f" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_BLINKENLIGHT_CMD_POWER 2</td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </p> </div> </div> <a class="anchor" id="gade36bd6ad2804d0c6f347cc216eadcc7"></a><!-- doxytag: member="player_interfaces.h::PLAYER_BLINKENLIGHT_CMD_STATE" ref="gade36bd6ad2804d0c6f347cc216eadcc7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_BLINKENLIGHT_CMD_STATE 1</td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </p> </div> </div> <a class="anchor" id="gaa73e6add570be58a883b31c4b1542466"></a><!-- doxytag: member="player_interfaces.h::PLAYER_BLINKENLIGHT_DATA_STATE" ref="gaa73e6add570be58a883b31c4b1542466" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define PLAYER_BLINKENLIGHT_DATA_STATE 1</td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </p> </div> </div> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="gad917bc75685839af46d00f1bac4e3c8b"></a><!-- doxytag: member="player_interfaces.h::player_blinkenlight_cmd_t" ref="gad917bc75685839af46d00f1bac4e3c8b" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__blinkenlight__cmd.html">player_blinkenlight_cmd</a> <a class="el" href="structplayer__blinkenlight__cmd.html">player_blinkenlight_cmd_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Command: state (<a class="el" href="group__interface__blinkenlight.html#gade36bd6ad2804d0c6f347cc216eadcc7">PLAYER_BLINKENLIGHT_CMD_STATE</a>) This <code>blinkenlight</code> command sets the complete current state of the indicator light. </p> </div> </div> <a class="anchor" id="gaab16b6e093f9bce9b1a6fda1c1b03984"></a><!-- doxytag: member="player_interfaces.h::player_blinkenlight_data_t" ref="gaab16b6e093f9bce9b1a6fda1c1b03984" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__blinkenlight__data.html">player_blinkenlight_data</a> <a class="el" href="structplayer__blinkenlight__data.html">player_blinkenlight_data_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: state (<a class="el" href="group__interface__blinkenlight.html#gaa73e6add570be58a883b31c4b1542466">PLAYER_BLINKENLIGHT_DATA_STATE</a>) The <code>blinkenlight</code> data provides the current state of the indicator light. </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>