mirror
/
libx52
mirror of https://github.com/nirenjan/libx52.git
1
0
Fork 0
Code Releases Wiki Activity
libx52/group__libx52mfdled.html

457 lines
27 KiB
HTML
Raw Blame History

<!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.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>x52pro-linux: MFD &amp; LED control</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="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="projectalign" style="padding-left: 0.5em;">
<div id="projectname">x52pro-linux
&#160;<span id="projectnumber">0.2.1</span>
</div>
<div id="projectbrief">Saitek X52/X52Pro drivers for Linux/Unix</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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&amp;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 -->
<!-- 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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">MFD &amp; LED control</div> </div>
</div><!--header-->
<div class="contents">
<p>Control the MFD text and LED states.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gae97e6cb1be0d79960018f2a12ba7047f"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a> { <br />
&#160;&#160;<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fae89d2ce35f72608d41202764128afd00">LIBX52_LED_FIRE</a> = 0x01,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa455294ce1f2dd6bb89c7f48034e5ddbc">LIBX52_LED_A</a> = 0x02,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa614aceacc2f76589f6e89429c7886c69">LIBX52_LED_B</a> = 0x04,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa29aad41d6d4d2ba9955b76de9559b2d2">LIBX52_LED_D</a> = 0x06,
<br />
&#160;&#160;<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fabb61ccb8aa773f0b1bb44dcf46d91ece">LIBX52_LED_E</a> = 0x08,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fae3d5181cdca7054ea2a44bb6a33736f9">LIBX52_LED_T1</a> = 0x0a,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa3915d9b34e7cd0270c3c9945ea0366cb">LIBX52_LED_T2</a> = 0x0c,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa25d249c6a06efbf554928885834376e9">LIBX52_LED_T3</a> = 0x0e,
<br />
&#160;&#160;<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa18862e04f12337863251f7307e04d3bf">LIBX52_LED_POV</a> = 0x10,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fa3fa42fc0e323348cd453831950e51307">LIBX52_LED_CLUTCH</a> = 0x12,
<a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047faede82abd452be7da562c50e89160fcd7">LIBX52_LED_THROTTLE</a> = 0x14
<br />
}</td></tr>
<tr class="memdesc:gae97e6cb1be0d79960018f2a12ba7047f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported LED identifiers. <a href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">More...</a><br /></td></tr>
<tr class="separator:gae97e6cb1be0d79960018f2a12ba7047f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab1a633a40dcdcfc5cf6fc13a3ed8b68c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a> { <br />
&#160;&#160;<a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca0a25e41783e99046974964aee88f895a">LIBX52_LED_STATE_OFF</a>,
<a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca5a18783f20716411a77e3bfe7195d3d2">LIBX52_LED_STATE_ON</a>,
<a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca64b1620a9d10dc593660bf30d6c987d9">LIBX52_LED_STATE_RED</a>,
<a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68cacce900ab6a9325d72e0f084f9271634e">LIBX52_LED_STATE_AMBER</a>,
<br />
&#160;&#160;<a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca1e8346acab9ad3e4735079273808319c">LIBX52_LED_STATE_GREEN</a>
<br />
}</td></tr>
<tr class="memdesc:gab1a633a40dcdcfc5cf6fc13a3ed8b68c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported LED states. <a href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">More...</a><br /></td></tr>
<tr class="separator:gab1a633a40dcdcfc5cf6fc13a3ed8b68c"><td class="memSeparator" colspan="2">&#160;</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:ga4f2b73685a4eb307895e08a02903bb39"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#ga4f2b73685a4eb307895e08a02903bb39">libx52_set_text</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t line, const char *text, uint8_t length)</td></tr>
<tr class="memdesc:ga4f2b73685a4eb307895e08a02903bb39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the text on an MFD line. <a href="group__libx52mfdled.html#ga4f2b73685a4eb307895e08a02903bb39">More...</a><br /></td></tr>
<tr class="separator:ga4f2b73685a4eb307895e08a02903bb39"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1a435bb3057aae3307c70fb09912ef18"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#ga1a435bb3057aae3307c70fb09912ef18">libx52_set_led_state</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, <a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a> led, <a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a> state)</td></tr>
<tr class="memdesc:ga1a435bb3057aae3307c70fb09912ef18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the LED state. <a href="group__libx52mfdled.html#ga1a435bb3057aae3307c70fb09912ef18">More...</a><br /></td></tr>
<tr class="separator:ga1a435bb3057aae3307c70fb09912ef18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9bbf5e1ff83201f6124b2d3c75c837c6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#ga9bbf5e1ff83201f6124b2d3c75c837c6">libx52_set_brightness</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t mfd, uint16_t brightness)</td></tr>
<tr class="memdesc:ga9bbf5e1ff83201f6124b2d3c75c837c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the MFD or LED brightness. <a href="group__libx52mfdled.html#ga9bbf5e1ff83201f6124b2d3c75c837c6">More...</a><br /></td></tr>
<tr class="separator:ga9bbf5e1ff83201f6124b2d3c75c837c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4250ce5b06f65c086ef6f279a628f378"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#ga4250ce5b06f65c086ef6f279a628f378">libx52_set_shift</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t state)</td></tr>
<tr class="memdesc:ga4250ce5b06f65c086ef6f279a628f378"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the state of the shift indicator. <a href="group__libx52mfdled.html#ga4250ce5b06f65c086ef6f279a628f378">More...</a><br /></td></tr>
<tr class="separator:ga4250ce5b06f65c086ef6f279a628f378"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga944e06a76077d240ccea8c342a36a876"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52mfdled.html#ga944e06a76077d240ccea8c342a36a876">libx52_set_blink</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t state)</td></tr>
<tr class="memdesc:ga944e06a76077d240ccea8c342a36a876"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the blinking state. <a href="group__libx52mfdled.html#ga944e06a76077d240ccea8c342a36a876">More...</a><br /></td></tr>
<tr class="separator:ga944e06a76077d240ccea8c342a36a876"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Control the MFD text and LED states. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gae97e6cb1be0d79960018f2a12ba7047f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae97e6cb1be0d79960018f2a12ba7047f">&#9670;&nbsp;</a></span>libx52_led_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Supported LED identifiers. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fae89d2ce35f72608d41202764128afd00"></a>LIBX52_LED_FIRE&#160;</td><td class="fielddoc"><p>Fire indicator LED </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa455294ce1f2dd6bb89c7f48034e5ddbc"></a>LIBX52_LED_A&#160;</td><td class="fielddoc"><p>LED on button A </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa614aceacc2f76589f6e89429c7886c69"></a>LIBX52_LED_B&#160;</td><td class="fielddoc"><p>LED on button B </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa29aad41d6d4d2ba9955b76de9559b2d2"></a>LIBX52_LED_D&#160;</td><td class="fielddoc"><p>LED on button D </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fabb61ccb8aa773f0b1bb44dcf46d91ece"></a>LIBX52_LED_E&#160;</td><td class="fielddoc"><p>LED on button E </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fae3d5181cdca7054ea2a44bb6a33736f9"></a>LIBX52_LED_T1&#160;</td><td class="fielddoc"><p>LED on toggle T1 </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa3915d9b34e7cd0270c3c9945ea0366cb"></a>LIBX52_LED_T2&#160;</td><td class="fielddoc"><p>LED on toggle T2 </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa25d249c6a06efbf554928885834376e9"></a>LIBX52_LED_T3&#160;</td><td class="fielddoc"><p>LED on toggle T3 </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa18862e04f12337863251f7307e04d3bf"></a>LIBX52_LED_POV&#160;</td><td class="fielddoc"><p>LED on POV Hat </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047fa3fa42fc0e323348cd453831950e51307"></a>LIBX52_LED_CLUTCH&#160;</td><td class="fielddoc"><p>LED on clutch button </p>
</td></tr>
<tr><td class="fieldname"><a id="ggae97e6cb1be0d79960018f2a12ba7047faede82abd452be7da562c50e89160fcd7"></a>LIBX52_LED_THROTTLE&#160;</td><td class="fielddoc"><p>Throttle LED </p>
</td></tr>
</table>
</div>
</div>
<a id="gab1a633a40dcdcfc5cf6fc13a3ed8b68c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">&#9670;&nbsp;</a></span>libx52_led_state</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Supported LED states. </p>
<p>Not all LEDs support all states </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca0a25e41783e99046974964aee88f895a"></a>LIBX52_LED_STATE_OFF&#160;</td><td class="fielddoc"><p>LED is off </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca5a18783f20716411a77e3bfe7195d3d2"></a>LIBX52_LED_STATE_ON&#160;</td><td class="fielddoc"><p>LED is on. This is not supported by those LEDs which can display multiple colors </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca64b1620a9d10dc593660bf30d6c987d9"></a>LIBX52_LED_STATE_RED&#160;</td><td class="fielddoc"><p>LED displays red color. This is not supported by single color LEDs </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab1a633a40dcdcfc5cf6fc13a3ed8b68cacce900ab6a9325d72e0f084f9271634e"></a>LIBX52_LED_STATE_AMBER&#160;</td><td class="fielddoc"><p>LED displays amber color. This is not supported by single color LEDs </p>
</td></tr>
<tr><td class="fieldname"><a id="ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca1e8346acab9ad3e4735079273808319c"></a>LIBX52_LED_STATE_GREEN&#160;</td><td class="fielddoc"><p>LED displays green color. This is not supported by single color LEDs </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga944e06a76077d240ccea8c342a36a876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga944e06a76077d240ccea8c342a36a876">&#9670;&nbsp;</a></span>libx52_set_blink()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_blink </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *&#160;</td>
<td class="paramname"><em>x52</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>state</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the blinking state. </p>
<p>The X52 Pro has a "blink" state where it blinks the clutch and hat LEDs.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x52</td><td>Pointer to the device context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>0 for off, 1 for on</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>0 on success</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a049c93e363d70c5a6cc5a735371e5e3b">LIBX52_ERROR_INVALID_PARAM</a> if <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga9bbf5e1ff83201f6124b2d3c75c837c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9bbf5e1ff83201f6124b2d3c75c837c6">&#9670;&nbsp;</a></span>libx52_set_brightness()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_brightness </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *&#160;</td>
<td class="paramname"><em>x52</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mfd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t&#160;</td>
<td class="paramname"><em>brightness</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the MFD or LED brightness. </p>
<p>The brightness of the MFD display and the button LEDs can be controlled individually. <code>brightness</code> should be a value between 0 and 128. While the library does not fail on values higher than 128, the effect may not be what is intended.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x52</td><td>Pointer to the device context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mfd</td><td>0 for LED brightness, 1 for MFD brightness </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">brightness</td><td>Brightness level to set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>0 on success</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a049c93e363d70c5a6cc5a735371e5e3b">LIBX52_ERROR_INVALID_PARAM</a> if <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga1a435bb3057aae3307c70fb09912ef18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1a435bb3057aae3307c70fb09912ef18">&#9670;&nbsp;</a></span>libx52_set_led_state()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_led_state </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *&#160;</td>
<td class="paramname"><em>x52</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a>&#160;</td>
<td class="paramname"><em>led</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a>&#160;</td>
<td class="paramname"><em>state</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the LED state. </p>
<p>The X52 pro has several LEDs that can be individually controlled. This function allows you to set the state of each LED in the internal data structures.</p>
<p>Note that the LEDs referred to by <a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047fae89d2ce35f72608d41202764128afd00">LIBX52_LED_FIRE</a> and <a class="el" href="group__libx52mfdled.html#ggae97e6cb1be0d79960018f2a12ba7047faede82abd452be7da562c50e89160fcd7">LIBX52_LED_THROTTLE</a> support only the states <a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca0a25e41783e99046974964aee88f895a">LIBX52_LED_STATE_OFF</a> and <a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca5a18783f20716411a77e3bfe7195d3d2">LIBX52_LED_STATE_ON</a>. The remaining LEDs support all the states with the exception of <a class="el" href="group__libx52mfdled.html#ggab1a633a40dcdcfc5cf6fc13a3ed8b68ca5a18783f20716411a77e3bfe7195d3d2">LIBX52_LED_STATE_ON</a>.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x52</td><td>Pointer to the device context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">led</td><td>LED identifier (refer <a class="el" href="group__libx52mfdled.html#gae97e6cb1be0d79960018f2a12ba7047f">libx52_led_id</a>) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>State of the LED (refer <a class="el" href="group__libx52mfdled.html#gab1a633a40dcdcfc5cf6fc13a3ed8b68c">libx52_led_state</a>)</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>0 on success</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a049c93e363d70c5a6cc5a735371e5e3b">LIBX52_ERROR_INVALID_PARAM</a> if the <code>x52</code> parameter is not valid</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a97af04ffc3130e25c9eb03abaafbbaca">LIBX52_ERROR_NOT_SUPPORTED</a> if the <code>led</code> and <code>state</code> combination is not a supported one. The API also returns <a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a97af04ffc3130e25c9eb03abaafbbaca">LIBX52_ERROR_NOT_SUPPORTED</a> if the probed joystick is not an X52 Pro, but the non-Pro X52 variant. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga4250ce5b06f65c086ef6f279a628f378"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4250ce5b06f65c086ef6f279a628f378">&#9670;&nbsp;</a></span>libx52_set_shift()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_shift </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *&#160;</td>
<td class="paramname"><em>x52</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>state</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the state of the shift indicator. </p>
<p>The X52 Pro MFD has a single shift indicator that indicates when the "shift" button is pressed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x52</td><td>Pointer to the device context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">state</td><td>0 for off, 1 for on</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>0 on success</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a049c93e363d70c5a6cc5a735371e5e3b">LIBX52_ERROR_INVALID_PARAM</a> if <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga4f2b73685a4eb307895e08a02903bb39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f2b73685a4eb307895e08a02903bb39">&#9670;&nbsp;</a></span>libx52_set_text()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_text </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *&#160;</td>
<td class="paramname"><em>x52</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>line</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>length</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the text on an MFD line. </p>
<p>The Multifunction display (MFD) supports 3 lines of up to 16 characters. This function will set the text into the internal data structures.</p>
<p><code>text</code> must be a pointer to an array of bytes, each byte represents a code point on the MFD's internal character map. <code>length</code> is the length of this array.</p>
<p><code>line</code> must be <b>0</b>, <b>1</b>, or <b>2</b> and refers to the first, second or third line of the MFD respectively.</p>
<dl class="section user"><dt>Limitations</dt><dd>This function can only store a maximum of 16 characters per line. Any additional characters are silently discarded.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">x52</td><td>Pointer to the device context </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">line</td><td>Line to be updated (0, 1 or 2) </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">text</td><td>Pointer to the text string. The text must be mapped to the code page of the X52 display. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">length</td><td>Length of the text to display</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>0 on success</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a049c93e363d70c5a6cc5a735371e5e3b">LIBX52_ERROR_INVALID_PARAM</a> if either <code>x52</code> is invalid, or <code>line</code> is outside the accepted range. </li>
</ul>
</dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>
View Git Blame Copy Permalink