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

509 lines
31 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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libx52: Clock 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">libx52
&#160;<span id="projectnumber">0.3.2</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.9.1 -->
<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','.html');
/* @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">Clock control</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga08c48a43f70bebb61b553e0ec12d917c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a> { <a class="el" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917ca85dccae177b78d35e21875772738ac70">LIBX52_CLOCK_1</a>
, <a class="el" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282">LIBX52_CLOCK_2</a>
, <a class="el" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917ca422990d812ea1dd9e94a5b3d03565945">LIBX52_CLOCK_3</a>
}</td></tr>
<tr class="memdesc:ga08c48a43f70bebb61b553e0ec12d917c"><td class="mdescLeft">&#160;</td><td class="mdescRight">List of supported clocks on the MFD. <a href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">More...</a><br /></td></tr>
<tr class="separator:ga08c48a43f70bebb61b553e0ec12d917c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0c9c90bdba150b6e48ddab30aea45268"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a> { <a class="el" href="group__libx52clock.html#gga0c9c90bdba150b6e48ddab30aea45268a7e216a257012c9aa2a5b847a4cb96332">LIBX52_CLOCK_FORMAT_12HR</a>
, <a class="el" href="group__libx52clock.html#gga0c9c90bdba150b6e48ddab30aea45268a1a60fdc6dacbf9a46a93a161d2644908">LIBX52_CLOCK_FORMAT_24HR</a>
}</td></tr>
<tr class="memdesc:ga0c9c90bdba150b6e48ddab30aea45268"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported clock formats. <a href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">More...</a><br /></td></tr>
<tr class="separator:ga0c9c90bdba150b6e48ddab30aea45268"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0da0bde31d817eaa42465b0dea2ccf5a"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a> { <a class="el" href="group__libx52clock.html#gga0da0bde31d817eaa42465b0dea2ccf5aa81d30d59013fcef952c9d10a30942abc">LIBX52_DATE_FORMAT_DDMMYY</a>
, <a class="el" href="group__libx52clock.html#gga0da0bde31d817eaa42465b0dea2ccf5aad91220edc91513325af1def4bcdfc07c">LIBX52_DATE_FORMAT_MMDDYY</a>
, <a class="el" href="group__libx52clock.html#gga0da0bde31d817eaa42465b0dea2ccf5aad2c9819fc5590f542a22c42a3243bd5e">LIBX52_DATE_FORMAT_YYMMDD</a>
}</td></tr>
<tr class="memdesc:ga0da0bde31d817eaa42465b0dea2ccf5a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Supported date formats. <a href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">More...</a><br /></td></tr>
<tr class="separator:ga0da0bde31d817eaa42465b0dea2ccf5a"><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:ga3ebdd7bf3cd2f419d9a13c46a139922e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga3ebdd7bf3cd2f419d9a13c46a139922e">libx52_set_clock</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, time_t time, int local)</td></tr>
<tr class="memdesc:ga3ebdd7bf3cd2f419d9a13c46a139922e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the clock. <a href="group__libx52clock.html#ga3ebdd7bf3cd2f419d9a13c46a139922e">More...</a><br /></td></tr>
<tr class="separator:ga3ebdd7bf3cd2f419d9a13c46a139922e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga04c0429e7fd7d9d5b5b371b88831381e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">libx52_set_clock_timezone</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, <a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a> clock, int offset)</td></tr>
<tr class="memdesc:ga04c0429e7fd7d9d5b5b371b88831381e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the timezone for the secondary and tertiary clocks. <a href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">More...</a><br /></td></tr>
<tr class="separator:ga04c0429e7fd7d9d5b5b371b88831381e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gacd82a744b1d33e0a9989fca4d8aad42b"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#gacd82a744b1d33e0a9989fca4d8aad42b">libx52_set_clock_format</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, <a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a> clock, <a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a> format)</td></tr>
<tr class="memdesc:gacd82a744b1d33e0a9989fca4d8aad42b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set whether the clock is displayed in 12 hour or 24 hour format. <a href="group__libx52clock.html#gacd82a744b1d33e0a9989fca4d8aad42b">More...</a><br /></td></tr>
<tr class="separator:gacd82a744b1d33e0a9989fca4d8aad42b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga42b5b1f00dea64f0706c31e0b3dd1840"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga42b5b1f00dea64f0706c31e0b3dd1840">libx52_set_time</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t hour, uint8_t minute)</td></tr>
<tr class="memdesc:ga42b5b1f00dea64f0706c31e0b3dd1840"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the hour and minute on clock 1. <a href="group__libx52clock.html#ga42b5b1f00dea64f0706c31e0b3dd1840">More...</a><br /></td></tr>
<tr class="separator:ga42b5b1f00dea64f0706c31e0b3dd1840"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4f49341bca8a343931858ff008d2d5ca"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#ga4f49341bca8a343931858ff008d2d5ca">libx52_set_date</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, uint8_t dd, uint8_t mm, uint8_t yy)</td></tr>
<tr class="memdesc:ga4f49341bca8a343931858ff008d2d5ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the date. <a href="group__libx52clock.html#ga4f49341bca8a343931858ff008d2d5ca">More...</a><br /></td></tr>
<tr class="separator:ga4f49341bca8a343931858ff008d2d5ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gabfa0aa6cb8742f29b3b8cfbc16fdadb2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__libx52clock.html#gabfa0aa6cb8742f29b3b8cfbc16fdadb2">libx52_set_date_format</a> (<a class="el" href="group__libx52init.html#gaca59b8d8f249fed58a0ec3253328e131">libx52_device</a> *x52, <a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a> format)</td></tr>
<tr class="memdesc:gabfa0aa6cb8742f29b3b8cfbc16fdadb2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the date format for the MFD date display. <a href="group__libx52clock.html#gabfa0aa6cb8742f29b3b8cfbc16fdadb2">More...</a><br /></td></tr>
<tr class="separator:gabfa0aa6cb8742f29b3b8cfbc16fdadb2"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Control the clocks on the MFD </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ga0c9c90bdba150b6e48ddab30aea45268"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0c9c90bdba150b6e48ddab30aea45268">&#9670;&nbsp;</a></span>libx52_clock_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Supported clock formats. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0c9c90bdba150b6e48ddab30aea45268a7e216a257012c9aa2a5b847a4cb96332"></a>LIBX52_CLOCK_FORMAT_12HR&#160;</td><td class="fielddoc"><p>12-hour display on the MFD clock </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0c9c90bdba150b6e48ddab30aea45268a1a60fdc6dacbf9a46a93a161d2644908"></a>LIBX52_CLOCK_FORMAT_24HR&#160;</td><td class="fielddoc"><p>24-hour display on the MFD clock </p>
</td></tr>
</table>
</div>
</div>
<a id="ga08c48a43f70bebb61b553e0ec12d917c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga08c48a43f70bebb61b553e0ec12d917c">&#9670;&nbsp;</a></span>libx52_clock_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>List of supported clocks on the MFD. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga08c48a43f70bebb61b553e0ec12d917ca85dccae177b78d35e21875772738ac70"></a>LIBX52_CLOCK_1&#160;</td><td class="fielddoc"><p>Primary clock on the MFD, indicated by the number 1 </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282"></a>LIBX52_CLOCK_2&#160;</td><td class="fielddoc"><p>Secondary clock on the MFD, indicated by the number 2 </p>
</td></tr>
<tr><td class="fieldname"><a id="gga08c48a43f70bebb61b553e0ec12d917ca422990d812ea1dd9e94a5b3d03565945"></a>LIBX52_CLOCK_3&#160;</td><td class="fielddoc"><p>Tertiary clock on the MFD, indicated by the number 3 </p>
</td></tr>
</table>
</div>
</div>
<a id="ga0da0bde31d817eaa42465b0dea2ccf5a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0da0bde31d817eaa42465b0dea2ccf5a">&#9670;&nbsp;</a></span>libx52_date_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Supported date formats. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="gga0da0bde31d817eaa42465b0dea2ccf5aa81d30d59013fcef952c9d10a30942abc"></a>LIBX52_DATE_FORMAT_DDMMYY&#160;</td><td class="fielddoc"><p>Date format DD-MM-YY </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0da0bde31d817eaa42465b0dea2ccf5aad91220edc91513325af1def4bcdfc07c"></a>LIBX52_DATE_FORMAT_MMDDYY&#160;</td><td class="fielddoc"><p>Date format MM-DD-YY </p>
</td></tr>
<tr><td class="fieldname"><a id="gga0da0bde31d817eaa42465b0dea2ccf5aad2c9819fc5590f542a22c42a3243bd5e"></a>LIBX52_DATE_FORMAT_YYMMDD&#160;</td><td class="fielddoc"><p>Date format YY-MM-DD </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga3ebdd7bf3cd2f419d9a13c46a139922e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3ebdd7bf3cd2f419d9a13c46a139922e">&#9670;&nbsp;</a></span>libx52_set_clock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_clock </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">time_t&#160;</td>
<td class="paramname"><em>time</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>local</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the clock. </p>
<p>This function sets the primary clock's date and time with the specified Unix time value. <code>time</code> can be obtained from <code>time(2)</code>. <code>local</code> controls whether the primary clock displays local time or GMT.</p>
<p>If this function is called again within the same minute as calculated by <code>localtime(3)</code> or <code>gmtime(3)</code>, it will return <a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a9e4acff4906865192086c8957047b35f">LIBX52_ERROR_TRY_AGAIN</a>, as it does not require any updates to be written to the joystick. However, if the call changes the timezone from local time to GMT or vice-versa, then the function will return 0, since it requires a write to the device to update the clock with the new timezone.</p>
<p>The secondary and tertiary clocks are driven off the primary clock and set using <a class="el" href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">libx52_set_clock_timezone</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">time</td><td>Time value from <code>time(3)</code> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">local</td><td>0 for GM time, non-zero for localtime</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#gga93b777d9cea6e733b63c222e6115ccb7a9e4acff4906865192086c8957047b35f">LIBX52_ERROR_TRY_AGAIN</a> if no change from previous time</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="gacd82a744b1d33e0a9989fca4d8aad42b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacd82a744b1d33e0a9989fca4d8aad42b">&#9670;&nbsp;</a></span>libx52_set_clock_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_clock_format </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__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a>&#160;</td>
<td class="paramname"><em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</a>&#160;</td>
<td class="paramname"><em>format</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set whether the clock is displayed in 12 hour or 24 hour format. </p>
<p>The clocks on the X52 Pro MFD are all displayed as HH:MM, but can be set to display it in 12-hour (AM/PM) or 24-hour format. The default format if not specified is 12-hour.</p>
<dl class="section user"><dt>Limitations</dt><dd>The hardware has a limitation that it cannot display 12:00 am in 12 hour mode - instead it will display as 00:00 am</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">clock</td><td><a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">format</td><td><a class="el" href="group__libx52clock.html#ga0c9c90bdba150b6e48ddab30aea45268">libx52_clock_format</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 <code>x52</code> is not valid, or if either of <code>clock</code> or <code>format</code> are outside their respective ranges. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga04c0429e7fd7d9d5b5b371b88831381e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga04c0429e7fd7d9d5b5b371b88831381e">&#9670;&nbsp;</a></span>libx52_set_clock_timezone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_clock_timezone </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__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a>&#160;</td>
<td class="paramname"><em>clock</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>offset</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the timezone for the secondary and tertiary clocks. </p>
<p>The X52 Pro has a total of 3 clock displays. The secondary and tertiary clocks are controlled as an offset from the primary clock in minutes. However, for convenience, the X52 library calculates this offset internally and only requires you to set the timezone as the number of minutes east of UTC. <code>offset</code> is limited to &plusmn; 1440 minutes, and any offset outside this range will result in a return value of <a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7ac329401de31cc6c50160c1fafcdc5efa">LIBX52_ERROR_OUT_OF_RANGE</a></p>
<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// Set clock 2 timezone to Pacific Standard Time (UTC-08:00)</span></div>
<div class="line">rc = <a class="code" href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">libx52_set_clock_timezone</a>(dev, <a class="code" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282">LIBX52_CLOCK_2</a>, -480);</div>
<div class="line"><span class="comment">// Set clock 3 timezone to Indian Standard Time (UTC+05:30)</span></div>
<div class="line">rc = <a class="code" href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">libx52_set_clock_timezone</a>(dev, <a class="code" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282">LIBX52_CLOCK_2</a>, 330);</div>
<div class="ttc" id="agroup__libx52clock_html_ga04c0429e7fd7d9d5b5b371b88831381e"><div class="ttname"><a href="group__libx52clock.html#ga04c0429e7fd7d9d5b5b371b88831381e">libx52_set_clock_timezone</a></div><div class="ttdeci">int libx52_set_clock_timezone(libx52_device *x52, libx52_clock_id clock, int offset)</div><div class="ttdoc">Set the timezone for the secondary and tertiary clocks.</div></div>
<div class="ttc" id="agroup__libx52clock_html_gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282"><div class="ttname"><a href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917cab2d9e9967646a797dfb652d81a964282">LIBX52_CLOCK_2</a></div><div class="ttdeci">@ LIBX52_CLOCK_2</div><div class="ttdef"><b>Definition:</b> libx52.h:57</div></div>
</div><!-- fragment --></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">clock</td><td><a class="el" href="group__libx52clock.html#ga08c48a43f70bebb61b553e0ec12d917c">libx52_clock_id</a>, cannot be <a class="el" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917ca85dccae177b78d35e21875772738ac70">LIBX52_CLOCK_1</a> </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">offset</td><td>Offset in minutes from GMT (east is positive, west is negative)</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 invalid</li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7a97af04ffc3130e25c9eb03abaafbbaca">LIBX52_ERROR_NOT_SUPPORTED</a> if <code>clock</code> is <a class="el" href="group__libx52clock.html#gga08c48a43f70bebb61b553e0ec12d917ca85dccae177b78d35e21875772738ac70">LIBX52_CLOCK_1</a></li>
<li><a class="el" href="group__libx52misc.html#gga93b777d9cea6e733b63c222e6115ccb7ac329401de31cc6c50160c1fafcdc5efa">LIBX52_ERROR_OUT_OF_RANGE</a> if <code>offset</code> is more than &plusmn; 24 hours. </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga4f49341bca8a343931858ff008d2d5ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4f49341bca8a343931858ff008d2d5ca">&#9670;&nbsp;</a></span>libx52_set_date()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_date </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>dd</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>mm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>yy</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the date. </p>
<p>This is a raw API which can be used for manual control if the user so desires, however, it will not update the timezone or the time values.</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">dd</td><td>Day to display </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">mm</td><td>Month to display </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">yy</td><td>Year 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 <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
<a id="gabfa0aa6cb8742f29b3b8cfbc16fdadb2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gabfa0aa6cb8742f29b3b8cfbc16fdadb2">&#9670;&nbsp;</a></span>libx52_set_date_format()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_date_format </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__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</a>&#160;</td>
<td class="paramname"><em>format</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the date format for the MFD date display. </p>
<p>If not set, the date format defaults to DD-MM-YY</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">format</td><td><a class="el" href="group__libx52clock.html#ga0da0bde31d817eaa42465b0dea2ccf5a">libx52_date_format</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 <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
<a id="ga42b5b1f00dea64f0706c31e0b3dd1840"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga42b5b1f00dea64f0706c31e0b3dd1840">&#9670;&nbsp;</a></span>libx52_set_time()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int libx52_set_time </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>hour</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>minute</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the hour and minute on clock 1. </p>
<p>This is a raw API which can be used for manual control if the user so desires, however, it will not update the timezone or the date values.</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">hour</td><td>Hour to display </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Minute 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 <code>x52</code> is not valid </li>
</ul>
</dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>
View Git Blame Copy Permalink