<!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: /home/iurt/rpmbuild/BUILD/lirc-0.10.1/python-pkg/lirc/client.py File 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('client_8py.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="#nested-classes">Classes</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">client.py File Reference<div class="ingroups"><a class="el" href="group__python__bindings.html">Python client bindings</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Top-level python bindings for the lircd socket interface.
<a href="#details">More...</a></p>
<p><a href="client_8py_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1BadPacketException.html">lirc.client.BadPacketException</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Malformed or otherwise unparsable packet received. <a href="classlirc_1_1client_1_1BadPacketException.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1TimeoutException.html">lirc.client.TimeoutException</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Timeout receiving data from remote host. <a href="classlirc_1_1client_1_1TimeoutException.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1AbstractConnection.html">lirc.client.AbstractConnection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Abstract interface for all connections. <a href="classlirc_1_1client_1_1AbstractConnection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1RawConnection.html">lirc.client.RawConnection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Interface to receive code strings as described in lircd(8). <a href="classlirc_1_1client_1_1RawConnection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1LircdConnection.html">lirc.client.LircdConnection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Interface to receive lircrc-translated keypresses. <a href="classlirc_1_1client_1_1LircdConnection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1CommandConnection.html">lirc.client.CommandConnection</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Extends the parent with a <a class="el" href="classlirc_1_1client_1_1CommandConnection.html#a6be9f0b6d8403dd7c7633fdbe8d321e6" title="Send single line over socket.">send()</a> method. <a href="classlirc_1_1client_1_1CommandConnection.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1Result.html">lirc.client.Result</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Public reply parser result, available when completed. <a href="classlirc_1_1client_1_1Result.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1Command.html">lirc.client.Command</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><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><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1Reply.html">lirc.client.Reply</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The status/result from parsing a command reply. <a href="classlirc_1_1client_1_1Reply.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1ReplyParser.html">lirc.client.ReplyParser</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Handles the actual parsing of a command reply. <a href="classlirc_1_1client_1_1ReplyParser.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1__State.html">lirc.client._State</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Internal FSM state. <a href="classlirc_1_1client_1_1__State.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1SimulateCommand.html">lirc.client.SimulateCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Simulate a button press, see SIMULATE in lircd(8) manpage. <a href="classlirc_1_1client_1_1SimulateCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1ListRemotesCommand.html">lirc.client.ListRemotesCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List available remotes, see LIST in lircd(8) manpage. <a href="classlirc_1_1client_1_1ListRemotesCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1ListKeysCommand.html">lirc.client.ListKeysCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">List available keys in given remote, see LIST in lircd(8) manpage. <a href="classlirc_1_1client_1_1ListKeysCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1StartRepeatCommand.html">lirc.client.StartRepeatCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Start repeating given key, see SEND_START in lircd(8) manpage. <a href="classlirc_1_1client_1_1StartRepeatCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1StopRepeatCommand.html">lirc.client.StopRepeatCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Stop repeating given key, see SEND_STOP in lircd(8) manpage. <a href="classlirc_1_1client_1_1StopRepeatCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1SendCommand.html">lirc.client.SendCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Send given key, see SEND_ONCE in lircd(8) manpage. <a href="classlirc_1_1client_1_1SendCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1SetTransmittersCommand.html">lirc.client.SetTransmittersCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Set transmitters to use, see SET_TRANSMITTERS in lircd(8) manpage. <a href="classlirc_1_1client_1_1SetTransmittersCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1VersionCommand.html">lirc.client.VersionCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Get lircd version, see VERSION in lircd(8) manpage. <a href="classlirc_1_1client_1_1VersionCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1DrvOptionCommand.html">lirc.client.DrvOptionCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Set a driver option value, see DRV_OPTION in lircd(8) manpage. <a href="classlirc_1_1client_1_1DrvOptionCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1SetLogCommand.html">lirc.client.SetLogCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Start/stop logging lircd output , see SET_INPUTLOG in lircd(8) manpage. <a href="classlirc_1_1client_1_1SetLogCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1IdentCommand.html">lirc.client.IdentCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Identify client using the prog token, see IDENT in lircrcd(8) <a href="classlirc_1_1client_1_1IdentCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1CodeCommand.html">lirc.client.CodeCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Translate a keypress to application string, see CODE in lircrcd(8) <a href="classlirc_1_1client_1_1CodeCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1GetModeCommand.html">lirc.client.GetModeCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Get current translation mode, see GETMODE in lircrcd(8) <a href="classlirc_1_1client_1_1GetModeCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classlirc_1_1client_1_1SetModeCommand.html">lirc.client.SetModeCommand</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Set current translation mode, see SETMODE in lircrcd(8) <a href="classlirc_1_1client_1_1SetModeCommand.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga4388cda807053ce0d28104333898065e"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="group__python__bindings.html#ga4388cda807053ce0d28104333898065e">lirc.client.get_default_socket_path</a> ()</td></tr>
<tr class="memdesc:ga4388cda807053ce0d28104333898065e"><td class="mdescLeft"> </td><td class="mdescRight">Get default value for the lircd socket path, using (falling priority): <a href="group__python__bindings.html#ga4388cda807053ce0d28104333898065e">More...</a><br /></td></tr>
<tr class="separator:ga4388cda807053ce0d28104333898065e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gabe5c8bd83f2de80db6dca3a0d11182e0"><td class="memItemLeft" align="right" valign="top">str </td><td class="memItemRight" valign="bottom"><a class="el" href="group__python__bindings.html#gabe5c8bd83f2de80db6dca3a0d11182e0">lirc.client.get_default_lircrc_path</a> ()</td></tr>
<tr class="memdesc:gabe5c8bd83f2de80db6dca3a0d11182e0"><td class="mdescLeft"> </td><td class="mdescRight">Get default path to the lircrc file according to (falling priority): <a href="group__python__bindings.html#gabe5c8bd83f2de80db6dca3a0d11182e0">More...</a><br /></td></tr>
<tr class="separator:gabe5c8bd83f2de80db6dca3a0d11182e0"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:ab2474eb9d86a31fb381fa185c45193ab"><td class="memItemLeft" align="right" valign="top"><a id="ab2474eb9d86a31fb381fa185c45193ab"></a>
 </td><td class="memItemRight" valign="bottom"><b>lirc.client.result</b></td></tr>
<tr class="separator:ab2474eb9d86a31fb381fa185c45193ab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a72e2697c36430bacb3d0633efd7820f5"><td class="memItemLeft" align="right" valign="top"><a id="a72e2697c36430bacb3d0633efd7820f5"></a>
 </td><td class="memItemRight" valign="bottom"><b>lirc.client.sighup</b></td></tr>
<tr class="separator:a72e2697c36430bacb3d0633efd7820f5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa5c7a5930d38aa4dc9c91e7dadc30585"><td class="memItemLeft" align="right" valign="top"><a id="aa5c7a5930d38aa4dc9c91e7dadc30585"></a>
 </td><td class="memItemRight" valign="bottom"><b>lirc.client.success</b></td></tr>
<tr class="separator:aa5c7a5930d38aa4dc9c91e7dadc30585"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Top-level python bindings for the lircd socket interface. </p>
<dl class="section author"><dt>Author</dt><dd>Alec Leamas Python bindings for a subset of the <a class="el" href="lirc__client_8h.html" title="3-rd party application interface.">lirc_client.h</a> interface. </dd></dl>
<p class="definition">Definition in file <a class="el" href="client_8py_source.html">client.py</a>.</p>
</div></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="dir_9c9327e253e064359f0fc89af76d6d9d.html">python-pkg</a></li><li class="navelem"><a class="el" href="dir_de06fbad444f0d6ad18055e8286d4c67.html">lirc</a></li><li class="navelem"><a class="el" href="client_8py.html">client.py</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>
