<!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: Main Page</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('index.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="PageDoc"><div class="header">
<div class="headertitle">
<div class="title">LIRC libraries Documentation</div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>The LIRC lib/ directory is indeed code used in various places. It offers four views:</p>
<ul>
<li>External C/C++ applications which neds to receive or send IR signals uses the <a class="el" href="lirc__client_8h.html" title="3-rd party application interface.">lirc_client.h</a> header file and links to liblirc.so using -llirc. This is a mature, reasonably stable interface. See <a class="el" href="group__lirc__client.html">Client API</a> and <a class="el" href="group__client__manual.html">Client API manual excerpt.</a>.</li>
<li>External python code could from 0.10.0 use the new python API. See <a class="el" href="group__python__bindings.html">Python client bindings</a> and <a class="el" href="group__client__manual.html">Client API manual excerpt.</a>.</li>
<li>User space drivers includes the <a class="el" href="lirc__driver_8h.html" title="Main include file for user space drivers.">lirc_driver.h</a> header and links to liblirc_driver.so using -llirc_driver. The other way around lirc accesses the driver as defined in the <a class="el" href="driver_8h.html" title="Interface to the userspace drivers.">driver.h</a> file (struct driver) This interface is new and willl probably need some time to stabilize. See <a class="el" href="group__driver__api.html">User-space driver API</a> and <a class="el" href="group__driver__manual.html">Driver API manual excerpt</a>.</li>
<li>Internal lirc applications includes the <a class="el" href="lirc__private_8h.html" title="Main include file for lirc applications.">lirc_private.h</a> header file and links to liblirc_private.so using -llirc_private. This interface is subject to change without notice.</li>
</ul>
<p>For build and configuration there are two pkg-config .pc files: lirc.pc and lirc_client.pc. These provides the proper compilation and link flags. See <a class="el" href="drivers_2default_2Makefile-example.html">drivers/default/Makefile</a> for an example how to use.</p>
<p>The bundled excerpts from the manual are the same as in the LIRC manual, but also here to be readily available and linked by doxygen in the API context. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<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>
