jeans/Tasmota
jeans/Tasmota
1
0
Fork 0
mirror of https://github.com/arendst/Tasmota.git synced 2025-07-07 10:56:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Tasmota/lib/lib_basic/IRremoteESP8266/docs/doxygen/html/namespaceIRXmpUtils.html
Stephan Hadinger d729f22309 IRremoteESP8266 library from v2.7.15 to v2.7.16
2021-03-25 08:40:27 +01:00

327 lines
15 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>IRremoteESP8266: IRXmpUtils Namespace 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="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">IRremoteESP8266
</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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">IRXmpUtils Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a60f5e4774b9ff0e08ae54844b132d5fb"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#a60f5e4774b9ff0e08ae54844b132d5fb">getSectionChecksum</a> (const uint32_t data, const uint16_t nbits)</td></tr>
<tr class="memdesc:a60f5e4774b9ff0e08ae54844b132d5fb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the current checksum value from an XMP data section. <a href="namespaceIRXmpUtils.html#a60f5e4774b9ff0e08ae54844b132d5fb">More...</a><br /></td></tr>
<tr class="separator:a60f5e4774b9ff0e08ae54844b132d5fb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a170c46b9aa59d1717fdff6f932353dca"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#a170c46b9aa59d1717fdff6f932353dca">calcSectionChecksum</a> (const uint32_t data, const uint16_t nbits)</td></tr>
<tr class="memdesc:a170c46b9aa59d1717fdff6f932353dca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the correct checksum value for an XMP data section. <a href="namespaceIRXmpUtils.html#a170c46b9aa59d1717fdff6f932353dca">More...</a><br /></td></tr>
<tr class="separator:a170c46b9aa59d1717fdff6f932353dca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0ada8200316c402f268dd621a3b0695a"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#a0ada8200316c402f268dd621a3b0695a">updateChecksums</a> (const uint64_t data, const uint16_t nbits)</td></tr>
<tr class="memdesc:a0ada8200316c402f268dd621a3b0695a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Recalculate a XMP message code ensuring it has the checksums valid. <a href="namespaceIRXmpUtils.html#a0ada8200316c402f268dd621a3b0695a">More...</a><br /></td></tr>
<tr class="separator:a0ada8200316c402f268dd621a3b0695a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbf7d8c8f73c5c9beca3094871d6a7c2"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#adbf7d8c8f73c5c9beca3094871d6a7c2">calcRepeatOffset</a> (const uint16_t nbits)</td></tr>
<tr class="memdesc:adbf7d8c8f73c5c9beca3094871d6a7c2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Calculate the bit offset the repeat nibble in an XMP code. <a href="namespaceIRXmpUtils.html#adbf7d8c8f73c5c9beca3094871d6a7c2">More...</a><br /></td></tr>
<tr class="separator:adbf7d8c8f73c5c9beca3094871d6a7c2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25e2d3af57d86fecf7b01b6a0639d0cc"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#a25e2d3af57d86fecf7b01b6a0639d0cc">isRepeat</a> (const uint64_t data, const uint16_t nbits)</td></tr>
<tr class="memdesc:a25e2d3af57d86fecf7b01b6a0639d0cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Test if an XMP message code is a repeat or not. <a href="namespaceIRXmpUtils.html#a25e2d3af57d86fecf7b01b6a0639d0cc">More...</a><br /></td></tr>
<tr class="separator:a25e2d3af57d86fecf7b01b6a0639d0cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8e7705ba4373589a651e662a3debb0a8"><td class="memItemLeft" align="right" valign="top">uint64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceIRXmpUtils.html#a8e7705ba4373589a651e662a3debb0a8">adjustRepeat</a> (const uint64_t data, const uint16_t nbits, const uint8_t repeat_code)</td></tr>
<tr class="memdesc:a8e7705ba4373589a651e662a3debb0a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adjust an XMP message code to make it a valid repeat or non-repeat code. <a href="namespaceIRXmpUtils.html#a8e7705ba4373589a651e662a3debb0a8">More...</a><br /></td></tr>
<tr class="separator:a8e7705ba4373589a651e662a3debb0a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a8e7705ba4373589a651e662a3debb0a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8e7705ba4373589a651e662a3debb0a8">&#9670;&nbsp;</a></span>adjustRepeat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IRXmpUtils::adjustRepeat </td>
<td>(</td>
<td class="paramtype">const uint64_t&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint8_t&#160;</td>
<td class="paramname"><em>repeat_code</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Adjust an XMP message code to make it a valid repeat or non-repeat code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The value of the XMP message code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the entire message code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">repeat_code</td><td>The value of the XMP repeat nibble to use. A value of <code>8</code> is the normal value for a repeat. <code>9</code> has also been seen. A value of <code>0</code> will convert the code to a non-repeat code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The valud of the modified XMP code. </dd></dl>
</div>
</div>
<a id="adbf7d8c8f73c5c9beca3094871d6a7c2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adbf7d8c8f73c5c9beca3094871d6a7c2">&#9670;&nbsp;</a></span>calcRepeatOffset()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint16_t IRXmpUtils::calcRepeatOffset </td>
<td>(</td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the bit offset the repeat nibble in an XMP code. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the entire message code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The offset to the start of the XMP repeat nibble. </dd></dl>
</div>
</div>
<a id="a170c46b9aa59d1717fdff6f932353dca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a170c46b9aa59d1717fdff6f932353dca">&#9670;&nbsp;</a></span>calcSectionChecksum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t IRXmpUtils::calcSectionChecksum </td>
<td>(</td>
<td class="paramtype">const uint32_t&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calculate the correct checksum value for an XMP data section. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The value of the data section. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the section. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the correct checksum. </dd></dl>
</div>
</div>
<a id="a60f5e4774b9ff0e08ae54844b132d5fb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60f5e4774b9ff0e08ae54844b132d5fb">&#9670;&nbsp;</a></span>getSectionChecksum()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t IRXmpUtils::getSectionChecksum </td>
<td>(</td>
<td class="paramtype">const uint32_t&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current checksum value from an XMP data section. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The value of the data section. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the section. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value of the stored checksum. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Returns 0 if we can't obtain a valid checksum. </dd></dl>
</div>
</div>
<a id="a25e2d3af57d86fecf7b01b6a0639d0cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25e2d3af57d86fecf7b01b6a0639d0cc">&#9670;&nbsp;</a></span>isRepeat()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool IRXmpUtils::isRepeat </td>
<td>(</td>
<td class="paramtype">const uint64_t&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Test if an XMP message code is a repeat or not. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The value of the XMP message code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the entire message code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true, if it looks like a repeat, false if not. </dd></dl>
</div>
</div>
<a id="a0ada8200316c402f268dd621a3b0695a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0ada8200316c402f268dd621a3b0695a">&#9670;&nbsp;</a></span>updateChecksums()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t IRXmpUtils::updateChecksums </td>
<td>(</td>
<td class="paramtype">const uint64_t&#160;</td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const uint16_t&#160;</td>
<td class="paramname"><em>nbits</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Recalculate a XMP message code ensuring it has the checksums valid. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The value of the XMP message code. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">nbits</td><td>The number of data bits in the entire message code. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The corrected XMP message with valid checksum sections. </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>
Reference in New Issue View Git Blame Copy Permalink