<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>LIRC libraries: lirc.client.Command 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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(initResizable); /* @license-end */</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="projectlogo"><img alt="Logo" src="diode-2.gif"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">LIRC libraries </div> <div id="projectbrief">LinuxInfraredRemoteControl</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</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"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(document).ready(function(){initNavTree('classlirc_1_1client_1_1Command.html','');}); /* @license-end */ </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="classlirc_1_1client_1_1Command-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">lirc.client.Command Class Reference<div class="ingroups"><a class="el" href="group__python__bindings.html">Python client bindings</a> » <a class="el" href="group__sending.html">Classes to send commands</a></div></div> </div> </div><!--header--> <div class="contents"> <p><a class="el" href="classlirc_1_1client_1_1Command.html" title="Command, parser and connection container with a run() method.">Command</a>, parser and connection container with a <a class="el" href="classlirc_1_1client_1_1Command.html#ace1c074e3c861bf806687e1316076991" title="Run the command and return a Reply.">run()</a> method. <a href="classlirc_1_1client_1_1Command.html#details">More...</a></p> <div class="dynheader"> Inheritance diagram for lirc.client.Command:</div> <div class="dyncontent"> <div class="center"> <img src="classlirc_1_1client_1_1Command.png" usemap="#lirc.client.Command_map" alt=""/> <map id="lirc.client.Command_map" name="lirc.client.Command_map"> <area href="classlirc_1_1client_1_1CodeCommand.html" title="Translate a keypress to application string, see CODE in lircrcd(8)" alt="lirc.client.CodeCommand" shape="rect" coords="219,112,428,136"/> <area href="classlirc_1_1client_1_1DrvOptionCommand.html" title="Set a driver option value, see DRV_OPTION in lircd(8) manpage." alt="lirc.client.DrvOptionCommand" shape="rect" coords="219,168,428,192"/> <area href="classlirc_1_1client_1_1GetModeCommand.html" title="Get current translation mode, see GETMODE in lircrcd(8)" alt="lirc.client.GetModeCommand" shape="rect" coords="219,224,428,248"/> <area href="classlirc_1_1client_1_1IdentCommand.html" title="Identify client using the prog token, see IDENT in lircrcd(8)" alt="lirc.client.IdentCommand" shape="rect" coords="219,280,428,304"/> <area href="classlirc_1_1client_1_1ListKeysCommand.html" title="List available keys in given remote, see LIST in lircd(8) manpage." alt="lirc.client.ListKeysCommand" shape="rect" coords="219,336,428,360"/> <area href="classlirc_1_1client_1_1ListRemotesCommand.html" title="List available remotes, see LIST in lircd(8) manpage." alt="lirc.client.ListRemotesCommand" shape="rect" coords="219,392,428,416"/> <area href="classlirc_1_1client_1_1SendCommand.html" title="Send given key, see SEND_ONCE in lircd(8) manpage." alt="lirc.client.SendCommand" shape="rect" coords="219,448,428,472"/> <area href="classlirc_1_1client_1_1SetLogCommand.html" title="Start/stop logging lircd output , see SET_INPUTLOG in lircd(8) manpage." alt="lirc.client.SetLogCommand" shape="rect" coords="219,504,428,528"/> <area href="classlirc_1_1client_1_1SetModeCommand.html" title="Set current translation mode, see SETMODE in lircrcd(8)" alt="lirc.client.SetModeCommand" shape="rect" coords="219,560,428,584"/> <area href="classlirc_1_1client_1_1SetTransmittersCommand.html" title="Set transmitters to use, see SET_TRANSMITTERS in lircd(8) manpage." alt="lirc.client.SetTransmittersCommand" shape="rect" coords="219,616,428,640"/> <area href="classlirc_1_1client_1_1SimulateCommand.html" title="Simulate a button press, see SIMULATE in lircd(8) manpage." alt="lirc.client.SimulateCommand" shape="rect" coords="219,672,428,696"/> <area href="classlirc_1_1client_1_1StartRepeatCommand.html" title="Start repeating given key, see SEND_START in lircd(8) manpage." alt="lirc.client.StartRepeatCommand" shape="rect" coords="219,728,428,752"/> <area href="classlirc_1_1client_1_1StopRepeatCommand.html" title="Stop repeating given key, see SEND_STOP in lircd(8) manpage." alt="lirc.client.StopRepeatCommand" shape="rect" coords="219,784,428,808"/> <area href="classlirc_1_1client_1_1VersionCommand.html" title="Get lircd version, see VERSION in lircd(8) manpage." alt="lirc.client.VersionCommand" shape="rect" coords="219,840,428,864"/> </map> </div></div> <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:af9e9f5716eb82bb770aff7e8f1c54d79"><td class="memItemLeft" align="right" valign="top"><a id="af9e9f5716eb82bb770aff7e8f1c54d79"></a> def </td><td class="memItemRight" valign="bottom"><b>__init__</b> (self, str cmd, <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html">AbstractConnection</a> connection, float timeout=0.4)</td></tr> <tr class="separator:af9e9f5716eb82bb770aff7e8f1c54d79"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace1c074e3c861bf806687e1316076991"><td class="memItemLeft" align="right" valign="top">def </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1Command.html#ace1c074e3c861bf806687e1316076991">run</a> (self, float timeout=None)</td></tr> <tr class="memdesc:ace1c074e3c861bf806687e1316076991"><td class="mdescLeft"> </td><td class="mdescRight">Run the command and return a <a class="el" href="classlirc_1_1client_1_1Reply.html" title="The status/result from parsing a command reply.">Reply</a>. <a href="#ace1c074e3c861bf806687e1316076991">More...</a><br /></td></tr> <tr class="separator:ace1c074e3c861bf806687e1316076991"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p><a class="el" href="classlirc_1_1client_1_1Command.html" title="Command, parser and connection container with a run() method.">Command</a>, parser and connection container with a <a class="el" href="classlirc_1_1client_1_1Command.html#ace1c074e3c861bf806687e1316076991" title="Run the command and return a Reply.">run()</a> method. </p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00389">389</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div><h2 class="groupheader">Member Function Documentation</h2> <a id="ace1c074e3c861bf806687e1316076991"></a> <h2 class="memtitle"><span class="permalink"><a href="#ace1c074e3c861bf806687e1316076991">◆ </a></span>run()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">def lirc.client.Command.run </td> <td>(</td> <td class="paramtype"> </td> <td class="paramname"><em>self</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">float  </td> <td class="paramname"><em>timeout</em> = <code>None</code> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div><div class="memdoc"> <p>Run the command and return a <a class="el" href="classlirc_1_1client_1_1Reply.html" title="The status/result from parsing a command reply.">Reply</a>. </p> <p>Timeout as of <a class="el" href="classlirc_1_1client_1_1AbstractConnection.html#afb11fea525fdc5cc948a90f51a09d99a" title="Read a buffered line.">AbstractConnection.readline()</a> </p> <p class="definition">Definition at line <a class="el" href="client_8py_source.html#l00401">401</a> of file <a class="el" href="client_8py_source.html">client.py</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li>/home/iurt/rpmbuild/BUILD/lirc-0.10.1/python-pkg/lirc/<a class="el" href="client_8py_source.html">client.py</a></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"><b>lirc</b></li><li class="navelem"><b>client</b></li><li class="navelem"><a class="el" href="classlirc_1_1client_1_1Command.html">Command</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.15 </li> </ul> </div> </body> </html>