mirror of https://github.com/arendst/Tasmota.git
1079 lines
55 KiB
HTML
1079 lines
55 KiB
HTML
<!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: IRTranscoldAc Class 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&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>
|
|
<!-- 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="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
|
<a href="#pri-methods">Private Member Functions</a> |
|
|
<a href="#pri-attribs">Private Attributes</a> |
|
|
<a href="classIRTranscoldAc-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">IRTranscoldAc Class Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Class for handling detailed Transcold A/C messages.
|
|
<a href="classIRTranscoldAc.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="ir__Transcold_8h_source.html">ir_Transcold.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Collaboration diagram for IRTranscoldAc:</div>
|
|
<div class="dyncontent">
|
|
<div class="center"><img src="classIRTranscoldAc__coll__graph.png" border="0" usemap="#IRTranscoldAc_coll__map" alt="Collaboration graph"/></div>
|
|
<map name="IRTranscoldAc_coll__map" id="IRTranscoldAc_coll__map">
|
|
<area shape="rect" title="Class for handling detailed Transcold A/C messages." alt="" coords="46,95,157,121"/>
|
|
<area shape="rect" href="classIRsend.html" title="Class for sending all basic IR protocols." alt="" coords="5,5,72,32"/>
|
|
<area shape="rect" href="unionTranscoldProtocol.html" title="Native representation of a Transcold A/C message." alt="" coords="96,5,232,32"/>
|
|
</map>
|
|
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a155278b9e5803aacf69a1ae20ed5b652"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a155278b9e5803aacf69a1ae20ed5b652">IRTranscoldAc</a> (const uint16_t pin, const bool inverted=false, const bool use_modulation=true)</td></tr>
|
|
<tr class="memdesc:a155278b9e5803aacf69a1ae20ed5b652"><td class="mdescLeft"> </td><td class="mdescRight">Class constructor. <a href="classIRTranscoldAc.html#a155278b9e5803aacf69a1ae20ed5b652">More...</a><br /></td></tr>
|
|
<tr class="separator:a155278b9e5803aacf69a1ae20ed5b652"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a88018c184feed75774ad01a41fdb3e69"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a88018c184feed75774ad01a41fdb3e69">stateReset</a> (void)</td></tr>
|
|
<tr class="memdesc:a88018c184feed75774ad01a41fdb3e69"><td class="mdescLeft"> </td><td class="mdescRight">Reset the internal state to a fixed known good state. <a href="classIRTranscoldAc.html#a88018c184feed75774ad01a41fdb3e69">More...</a><br /></td></tr>
|
|
<tr class="separator:a88018c184feed75774ad01a41fdb3e69"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad9807a5c56b9797e4d9ef2fe4b95d3bf"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ad9807a5c56b9797e4d9ef2fe4b95d3bf">send</a> (const uint16_t repeat=<a class="el" href="IRremoteESP8266_8h.html#a17cef98fbfae6a84c0a3e009fb3c31d0">kTranscoldDefaultRepeat</a>)</td></tr>
|
|
<tr class="memdesc:ad9807a5c56b9797e4d9ef2fe4b95d3bf"><td class="mdescLeft"> </td><td class="mdescRight">Send the current internal state as an IR message. <a href="classIRTranscoldAc.html#ad9807a5c56b9797e4d9ef2fe4b95d3bf">More...</a><br /></td></tr>
|
|
<tr class="separator:ad9807a5c56b9797e4d9ef2fe4b95d3bf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae91dbd4a94ff4cd648c283b9f18bc149"><td class="memItemLeft" align="right" valign="top">int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ae91dbd4a94ff4cd648c283b9f18bc149">calibrate</a> (void)</td></tr>
|
|
<tr class="memdesc:ae91dbd4a94ff4cd648c283b9f18bc149"><td class="mdescLeft"> </td><td class="mdescRight">Run the calibration to calculate uSec timing offsets for this platform. <a href="classIRTranscoldAc.html#ae91dbd4a94ff4cd648c283b9f18bc149">More...</a><br /></td></tr>
|
|
<tr class="separator:ae91dbd4a94ff4cd648c283b9f18bc149"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad3daf2c7108712b6e54eba9c68071910"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ad3daf2c7108712b6e54eba9c68071910">begin</a> (void)</td></tr>
|
|
<tr class="memdesc:ad3daf2c7108712b6e54eba9c68071910"><td class="mdescLeft"> </td><td class="mdescRight">Set up hardware to be able to send a message. <a href="classIRTranscoldAc.html#ad3daf2c7108712b6e54eba9c68071910">More...</a><br /></td></tr>
|
|
<tr class="separator:ad3daf2c7108712b6e54eba9c68071910"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4af8e44cb2d9c1751cd0dac3e096c06a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a4af8e44cb2d9c1751cd0dac3e096c06a">on</a> (void)</td></tr>
|
|
<tr class="memdesc:a4af8e44cb2d9c1751cd0dac3e096c06a"><td class="mdescLeft"> </td><td class="mdescRight">Change the power setting to On. <a href="classIRTranscoldAc.html#a4af8e44cb2d9c1751cd0dac3e096c06a">More...</a><br /></td></tr>
|
|
<tr class="separator:a4af8e44cb2d9c1751cd0dac3e096c06a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a54ecdef5ff2c9a1ce8c476ff2ad16801"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a54ecdef5ff2c9a1ce8c476ff2ad16801">off</a> (void)</td></tr>
|
|
<tr class="memdesc:a54ecdef5ff2c9a1ce8c476ff2ad16801"><td class="mdescLeft"> </td><td class="mdescRight">Change the power setting to Off. <a href="classIRTranscoldAc.html#a54ecdef5ff2c9a1ce8c476ff2ad16801">More...</a><br /></td></tr>
|
|
<tr class="separator:a54ecdef5ff2c9a1ce8c476ff2ad16801"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3a19128eaf81ec52f752d79d718d43a3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a3a19128eaf81ec52f752d79d718d43a3">setPower</a> (const bool state)</td></tr>
|
|
<tr class="memdesc:a3a19128eaf81ec52f752d79d718d43a3"><td class="mdescLeft"> </td><td class="mdescRight">Change the power setting. <a href="classIRTranscoldAc.html#a3a19128eaf81ec52f752d79d718d43a3">More...</a><br /></td></tr>
|
|
<tr class="separator:a3a19128eaf81ec52f752d79d718d43a3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6ac4a00b6b9340e2a6ce304a928b148b"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a6ac4a00b6b9340e2a6ce304a928b148b">getPower</a> (void) const</td></tr>
|
|
<tr class="memdesc:a6ac4a00b6b9340e2a6ce304a928b148b"><td class="mdescLeft"> </td><td class="mdescRight">Get the value of the current power setting. <a href="classIRTranscoldAc.html#a6ac4a00b6b9340e2a6ce304a928b148b">More...</a><br /></td></tr>
|
|
<tr class="separator:a6ac4a00b6b9340e2a6ce304a928b148b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa183d51c121c70704f6b0a5957911986"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#aa183d51c121c70704f6b0a5957911986">setTemp</a> (const uint8_t temp)</td></tr>
|
|
<tr class="memdesc:aa183d51c121c70704f6b0a5957911986"><td class="mdescLeft"> </td><td class="mdescRight">Set the temperature. <a href="classIRTranscoldAc.html#aa183d51c121c70704f6b0a5957911986">More...</a><br /></td></tr>
|
|
<tr class="separator:aa183d51c121c70704f6b0a5957911986"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a73c260bf13212948872a96ce17d5adb7"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a73c260bf13212948872a96ce17d5adb7">getTemp</a> (void) const</td></tr>
|
|
<tr class="memdesc:a73c260bf13212948872a96ce17d5adb7"><td class="mdescLeft"> </td><td class="mdescRight">Get the current temperature setting. <a href="classIRTranscoldAc.html#a73c260bf13212948872a96ce17d5adb7">More...</a><br /></td></tr>
|
|
<tr class="separator:a73c260bf13212948872a96ce17d5adb7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a444593321998f04b4ef5e9c9ceb5b511"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a444593321998f04b4ef5e9c9ceb5b511">setFan</a> (const uint8_t speed, const bool modecheck=true)</td></tr>
|
|
<tr class="memdesc:a444593321998f04b4ef5e9c9ceb5b511"><td class="mdescLeft"> </td><td class="mdescRight">Set the speed of the fan. <a href="classIRTranscoldAc.html#a444593321998f04b4ef5e9c9ceb5b511">More...</a><br /></td></tr>
|
|
<tr class="separator:a444593321998f04b4ef5e9c9ceb5b511"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a084be3ebe2b371a4b7ff3d08f287d56e"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a084be3ebe2b371a4b7ff3d08f287d56e">getFan</a> (void) const</td></tr>
|
|
<tr class="memdesc:a084be3ebe2b371a4b7ff3d08f287d56e"><td class="mdescLeft"> </td><td class="mdescRight">Get the current fan speed setting. <a href="classIRTranscoldAc.html#a084be3ebe2b371a4b7ff3d08f287d56e">More...</a><br /></td></tr>
|
|
<tr class="separator:a084be3ebe2b371a4b7ff3d08f287d56e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9371bf7cdc08067d4afb2dffa1c584c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a9371bf7cdc08067d4afb2dffa1c584c4">setMode</a> (const uint8_t mode)</td></tr>
|
|
<tr class="memdesc:a9371bf7cdc08067d4afb2dffa1c584c4"><td class="mdescLeft"> </td><td class="mdescRight">Set the operating mode of the A/C. <a href="classIRTranscoldAc.html#a9371bf7cdc08067d4afb2dffa1c584c4">More...</a><br /></td></tr>
|
|
<tr class="separator:a9371bf7cdc08067d4afb2dffa1c584c4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a12e32c7b7a708ff6ee6b895ca3a884a8"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a12e32c7b7a708ff6ee6b895ca3a884a8">getMode</a> (void) const</td></tr>
|
|
<tr class="memdesc:a12e32c7b7a708ff6ee6b895ca3a884a8"><td class="mdescLeft"> </td><td class="mdescRight">Get the operating mode setting of the A/C. <a href="classIRTranscoldAc.html#a12e32c7b7a708ff6ee6b895ca3a884a8">More...</a><br /></td></tr>
|
|
<tr class="separator:a12e32c7b7a708ff6ee6b895ca3a884a8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8ee39074ca2ac9fc6546be09b5f67e6b"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a8ee39074ca2ac9fc6546be09b5f67e6b">setSwing</a> (void)</td></tr>
|
|
<tr class="memdesc:a8ee39074ca2ac9fc6546be09b5f67e6b"><td class="mdescLeft"> </td><td class="mdescRight">Toggle the Swing mode of the A/C. <a href="classIRTranscoldAc.html#a8ee39074ca2ac9fc6546be09b5f67e6b">More...</a><br /></td></tr>
|
|
<tr class="separator:a8ee39074ca2ac9fc6546be09b5f67e6b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9d427219a71afa71fb5518b2abb6d202"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a9d427219a71afa71fb5518b2abb6d202">getSwing</a> (void) const</td></tr>
|
|
<tr class="memdesc:a9d427219a71afa71fb5518b2abb6d202"><td class="mdescLeft"> </td><td class="mdescRight">Get the Swing setting of the A/C. <a href="classIRTranscoldAc.html#a9d427219a71afa71fb5518b2abb6d202">More...</a><br /></td></tr>
|
|
<tr class="separator:a9d427219a71afa71fb5518b2abb6d202"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aaf7aa5d00d7447bfcb82d17ed1f66a6d"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#aaf7aa5d00d7447bfcb82d17ed1f66a6d">getRaw</a> (void) const</td></tr>
|
|
<tr class="memdesc:aaf7aa5d00d7447bfcb82d17ed1f66a6d"><td class="mdescLeft"> </td><td class="mdescRight">Get a copy of the internal state as a valid code for this protocol. <a href="classIRTranscoldAc.html#aaf7aa5d00d7447bfcb82d17ed1f66a6d">More...</a><br /></td></tr>
|
|
<tr class="separator:aaf7aa5d00d7447bfcb82d17ed1f66a6d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac8d5395411aa44efffe3bb1a068eaf4f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ac8d5395411aa44efffe3bb1a068eaf4f">setRaw</a> (const uint32_t new_code)</td></tr>
|
|
<tr class="memdesc:ac8d5395411aa44efffe3bb1a068eaf4f"><td class="mdescLeft"> </td><td class="mdescRight">Set the internal state from a valid code for this protocol. <a href="classIRTranscoldAc.html#ac8d5395411aa44efffe3bb1a068eaf4f">More...</a><br /></td></tr>
|
|
<tr class="separator:ac8d5395411aa44efffe3bb1a068eaf4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:abbd4d9ba01a8e27a719dcf00c2890d38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structstdAc_1_1state__t.html">stdAc::state_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#abbd4d9ba01a8e27a719dcf00c2890d38">toCommon</a> (const <a class="el" href="structstdAc_1_1state__t.html">stdAc::state_t</a> *prev=NULL) const</td></tr>
|
|
<tr class="memdesc:abbd4d9ba01a8e27a719dcf00c2890d38"><td class="mdescLeft"> </td><td class="mdescRight">Convert the A/C state to it's common <a class="el" href="structstdAc_1_1state__t.html" title="Structure to hold a common A/C state.">stdAc::state_t</a> equivalent. <a href="classIRTranscoldAc.html#abbd4d9ba01a8e27a719dcf00c2890d38">More...</a><br /></td></tr>
|
|
<tr class="separator:abbd4d9ba01a8e27a719dcf00c2890d38"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a8be351a7df54e6606eeebc8630ee4029"><td class="memItemLeft" align="right" valign="top"><a class="el" href="IRremoteESP8266_8h.html#afbeda3fd1bdc8c37d01bdf9f5c8274ff">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a8be351a7df54e6606eeebc8630ee4029">toString</a> (void) const</td></tr>
|
|
<tr class="memdesc:a8be351a7df54e6606eeebc8630ee4029"><td class="mdescLeft"> </td><td class="mdescRight">Convert the internal state into a human readable string. <a href="classIRTranscoldAc.html#a8be351a7df54e6606eeebc8630ee4029">More...</a><br /></td></tr>
|
|
<tr class="separator:a8be351a7df54e6606eeebc8630ee4029"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
|
Static Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a45372965e8735a1fb54173eb1ed31c9d"><td class="memItemLeft" align="right" valign="top">static uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a45372965e8735a1fb54173eb1ed31c9d">convertMode</a> (const <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f">stdAc::opmode_t</a> mode)</td></tr>
|
|
<tr class="memdesc:a45372965e8735a1fb54173eb1ed31c9d"><td class="mdescLeft"> </td><td class="mdescRight">Convert a standard A/C mode into its native mode. <a href="classIRTranscoldAc.html#a45372965e8735a1fb54173eb1ed31c9d">More...</a><br /></td></tr>
|
|
<tr class="separator:a45372965e8735a1fb54173eb1ed31c9d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5d67793bc5174f1c9f415b43fe6fb584"><td class="memItemLeft" align="right" valign="top">static uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a5d67793bc5174f1c9f415b43fe6fb584">convertFan</a> (const <a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383">stdAc::fanspeed_t</a> speed)</td></tr>
|
|
<tr class="memdesc:a5d67793bc5174f1c9f415b43fe6fb584"><td class="mdescLeft"> </td><td class="mdescRight">Convert a <a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383" title="Common A/C settings for Fan Speeds.">stdAc::fanspeed_t</a> enum into it's native speed. <a href="classIRTranscoldAc.html#a5d67793bc5174f1c9f415b43fe6fb584">More...</a><br /></td></tr>
|
|
<tr class="separator:a5d67793bc5174f1c9f415b43fe6fb584"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4316d539b0a5270fab794fc7c3cef20a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f">stdAc::opmode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a4316d539b0a5270fab794fc7c3cef20a">toCommonMode</a> (const uint8_t mode)</td></tr>
|
|
<tr class="memdesc:a4316d539b0a5270fab794fc7c3cef20a"><td class="mdescLeft"> </td><td class="mdescRight">Convert a native mode to it's common <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f" title="Common A/C settings for A/C operating modes.">stdAc::opmode_t</a> equivalent. <a href="classIRTranscoldAc.html#a4316d539b0a5270fab794fc7c3cef20a">More...</a><br /></td></tr>
|
|
<tr class="separator:a4316d539b0a5270fab794fc7c3cef20a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad373dbb4df435d9a191710e5bce56883"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383">stdAc::fanspeed_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ad373dbb4df435d9a191710e5bce56883">toCommonFanSpeed</a> (const uint8_t speed)</td></tr>
|
|
<tr class="memdesc:ad373dbb4df435d9a191710e5bce56883"><td class="mdescLeft"> </td><td class="mdescRight">Convert a native fan speed into its <a class="el" href="namespacestdAc.html" title="Enumerators and Structures for the Common A/C API.">stdAc</a> equivalent. <a href="classIRTranscoldAc.html#ad373dbb4df435d9a191710e5bce56883">More...</a><br /></td></tr>
|
|
<tr class="separator:ad373dbb4df435d9a191710e5bce56883"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a>
|
|
Private Member Functions</h2></td></tr>
|
|
<tr class="memitem:aacef65f9dc6c1315db1e1af7a09a5dc6"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#aacef65f9dc6c1315db1e1af7a09a5dc6">isSpecialState</a> (void) const</td></tr>
|
|
<tr class="memdesc:aacef65f9dc6c1315db1e1af7a09a5dc6"><td class="mdescLeft"> </td><td class="mdescRight">Is the current state is a special state? <a href="classIRTranscoldAc.html#aacef65f9dc6c1315db1e1af7a09a5dc6">More...</a><br /></td></tr>
|
|
<tr class="separator:aacef65f9dc6c1315db1e1af7a09a5dc6"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a01a3e3f8f92b8fb3b6d023e595f3ce17"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a01a3e3f8f92b8fb3b6d023e595f3ce17">handleSpecialState</a> (const uint32_t data)</td></tr>
|
|
<tr class="memdesc:a01a3e3f8f92b8fb3b6d023e595f3ce17"><td class="mdescLeft"> </td><td class="mdescRight">Adjust any internal settings based on the type of special state we are supplied. Does nothing if it isn't a special state. <a href="classIRTranscoldAc.html#a01a3e3f8f92b8fb3b6d023e595f3ce17">More...</a><br /></td></tr>
|
|
<tr class="separator:a01a3e3f8f92b8fb3b6d023e595f3ce17"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a>
|
|
Private Attributes</h2></td></tr>
|
|
<tr class="memitem:a3f7136d98c100a67b97f4f8afb750fc4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classIRsend.html">IRsend</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a3f7136d98c100a67b97f4f8afb750fc4">_irsend</a></td></tr>
|
|
<tr class="memdesc:a3f7136d98c100a67b97f4f8afb750fc4"><td class="mdescLeft"> </td><td class="mdescRight">Instance of the IR send class. <a href="classIRTranscoldAc.html#a3f7136d98c100a67b97f4f8afb750fc4">More...</a><br /></td></tr>
|
|
<tr class="separator:a3f7136d98c100a67b97f4f8afb750fc4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acaaa6c7fc022b3a259692bfd61258f49"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#acaaa6c7fc022b3a259692bfd61258f49">swingFlag</a></td></tr>
|
|
<tr class="separator:acaaa6c7fc022b3a259692bfd61258f49"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a15da6840a234b2ff739a86d19f15c58d"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a15da6840a234b2ff739a86d19f15c58d">swingHFlag</a></td></tr>
|
|
<tr class="separator:a15da6840a234b2ff739a86d19f15c58d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2aa4d5a19dd9056606ca20d03c893df"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#ae2aa4d5a19dd9056606ca20d03c893df">swingVFlag</a></td></tr>
|
|
<tr class="separator:ae2aa4d5a19dd9056606ca20d03c893df"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a50d0d2c8a2f25855ca721ef3f477284b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="unionTranscoldProtocol.html">TranscoldProtocol</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a50d0d2c8a2f25855ca721ef3f477284b">_</a></td></tr>
|
|
<tr class="separator:a50d0d2c8a2f25855ca721ef3f477284b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a634858a8d3987fa95cb355083c1276da"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classIRTranscoldAc.html#a634858a8d3987fa95cb355083c1276da">special_state</a></td></tr>
|
|
<tr class="memdesc:a634858a8d3987fa95cb355083c1276da"><td class="mdescLeft"> </td><td class="mdescRight">special mode. <a href="classIRTranscoldAc.html#a634858a8d3987fa95cb355083c1276da">More...</a><br /></td></tr>
|
|
<tr class="separator:a634858a8d3987fa95cb355083c1276da"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Class for handling detailed Transcold A/C messages. </p>
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
|
<a id="a155278b9e5803aacf69a1ae20ed5b652"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a155278b9e5803aacf69a1ae20ed5b652">◆ </a></span>IRTranscoldAc()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">IRTranscoldAc::IRTranscoldAc </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>pin</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>inverted</em> = <code>false</code>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>use_modulation</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Class constructor. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">pin</td><td>GPIO to be used when sending. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">inverted</td><td>Is the output signal to be inverted? </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">use_modulation</td><td>Is frequency modulation to be used? </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="ad3daf2c7108712b6e54eba9c68071910"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad3daf2c7108712b6e54eba9c68071910">◆ </a></span>begin()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::begin </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set up hardware to be able to send a message. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae91dbd4a94ff4cd648c283b9f18bc149"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae91dbd4a94ff4cd648c283b9f18bc149">◆ </a></span>calibrate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">int8_t IRTranscoldAc::calibrate </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Run the calibration to calculate uSec timing offsets for this platform. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The uSec timing offset needed per modulation of the IR Led. </dd></dl>
|
|
<dl class="section note"><dt>Note</dt><dd>This will produce a 65ms IR signal pulse at 38kHz. Only ever needs to be run once per object instantiation, if at all. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a5d67793bc5174f1c9f415b43fe6fb584"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a5d67793bc5174f1c9f415b43fe6fb584">◆ </a></span>convertFan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t IRTranscoldAc::convertFan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383">stdAc::fanspeed_t</a> </td>
|
|
<td class="paramname"><em>speed</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a <a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383" title="Common A/C settings for Fan Speeds.">stdAc::fanspeed_t</a> enum into it's native speed. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The enum to be converted. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The native equivalent of the enum. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a45372965e8735a1fb54173eb1ed31c9d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a45372965e8735a1fb54173eb1ed31c9d">◆ </a></span>convertMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t IRTranscoldAc::convertMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f">stdAc::opmode_t</a> </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a standard A/C mode into its native mode. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>A <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f" title="Common A/C settings for A/C operating modes.">stdAc::opmode_t</a> to be converted to it's native equivalent. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding native mode. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a084be3ebe2b371a4b7ff3d08f287d56e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a084be3ebe2b371a4b7ff3d08f287d56e">◆ </a></span>getFan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t IRTranscoldAc::getFan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current fan speed setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current fan speed. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a12e32c7b7a708ff6ee6b895ca3a884a8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a12e32c7b7a708ff6ee6b895ca3a884a8">◆ </a></span>getMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t IRTranscoldAc::getMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the operating mode setting of the A/C. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current operating mode setting. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a6ac4a00b6b9340e2a6ce304a928b148b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a6ac4a00b6b9340e2a6ce304a928b148b">◆ </a></span>getPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::getPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the value of the current power setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true, the setting is on. false, the setting is off. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aaf7aa5d00d7447bfcb82d17ed1f66a6d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaf7aa5d00d7447bfcb82d17ed1f66a6d">◆ </a></span>getRaw()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t IRTranscoldAc::getRaw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get a copy of the internal state as a valid code for this protocol. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>A valid code for this protocol based on the current internal state. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9d427219a71afa71fb5518b2abb6d202"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9d427219a71afa71fb5518b2abb6d202">◆ </a></span>getSwing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::getSwing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the Swing setting of the A/C. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true, the setting is on. false, the setting is off. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a73c260bf13212948872a96ce17d5adb7"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a73c260bf13212948872a96ce17d5adb7">◆ </a></span>getTemp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint8_t IRTranscoldAc::getTemp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Get the current temperature setting. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current setting for temp. in degrees celsius. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a01a3e3f8f92b8fb3b6d023e595f3ce17"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a01a3e3f8f92b8fb3b6d023e595f3ce17">◆ </a></span>handleSpecialState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::handleSpecialState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Adjust any internal settings based on the type of special state we are supplied. Does nothing if it isn't a special state. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>The state we need to act upon. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section note"><dt>Note</dt><dd>Special state means commands that are not affecting Temperature/Mode/Fan </dd></dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>true, if it is a special state. false if it isn't. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aacef65f9dc6c1315db1e1af7a09a5dc6"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aacef65f9dc6c1315db1e1af7a09a5dc6">◆ </a></span>isSpecialState()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::isSpecialState </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Is the current state is a special state? </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>true, if it is. false if it isn't. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a54ecdef5ff2c9a1ce8c476ff2ad16801"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a54ecdef5ff2c9a1ce8c476ff2ad16801">◆ </a></span>off()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::off </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Change the power setting to Off. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4af8e44cb2d9c1751cd0dac3e096c06a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4af8e44cb2d9c1751cd0dac3e096c06a">◆ </a></span>on()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::on </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Change the power setting to On. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad9807a5c56b9797e4d9ef2fe4b95d3bf"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad9807a5c56b9797e4d9ef2fe4b95d3bf">◆ </a></span>send()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::send </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint16_t </td>
|
|
<td class="paramname"><em>repeat</em> = <code><a class="el" href="IRremoteESP8266_8h.html#a17cef98fbfae6a84c0a3e009fb3c31d0">kTranscoldDefaultRepeat</a></code></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Send the current internal state as an IR message. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">repeat</td><td>Nr. of times the message will be repeated. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a444593321998f04b4ef5e9c9ceb5b511"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a444593321998f04b4ef5e9c9ceb5b511">◆ </a></span>setFan()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setFan </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>speed</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>modecheck</em> = <code>true</code> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the speed of the fan. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The desired setting. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">modecheck</td><td>Do we enforce any mode limitations before setting? </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9371bf7cdc08067d4afb2dffa1c584c4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9371bf7cdc08067d4afb2dffa1c584c4">◆ </a></span>setMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the operating mode of the A/C. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>The desired operating mode. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3a19128eaf81ec52f752d79d718d43a3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3a19128eaf81ec52f752d79d718d43a3">◆ </a></span>setPower()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setPower </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const bool </td>
|
|
<td class="paramname"><em>on</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Change the power setting. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">on</td><td>true, the setting is on. false, the setting is off. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ac8d5395411aa44efffe3bb1a068eaf4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ac8d5395411aa44efffe3bb1a068eaf4f">◆ </a></span>setRaw()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setRaw </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint32_t </td>
|
|
<td class="paramname"><em>new_code</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the internal state from a valid code for this protocol. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">new_code</td><td>A valid code for this protocol. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8ee39074ca2ac9fc6546be09b5f67e6b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8ee39074ca2ac9fc6546be09b5f67e6b">◆ </a></span>setSwing()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setSwing </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Toggle the Swing mode of the A/C. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="aa183d51c121c70704f6b0a5957911986"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa183d51c121c70704f6b0a5957911986">◆ </a></span>setTemp()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::setTemp </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>desired</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Set the temperature. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">desired</td><td>The temperature in degrees celsius. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a88018c184feed75774ad01a41fdb3e69"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a88018c184feed75774ad01a41fdb3e69">◆ </a></span>stateReset()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void IRTranscoldAc::stateReset </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Reset the internal state to a fixed known good state. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="abbd4d9ba01a8e27a719dcf00c2890d38"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#abbd4d9ba01a8e27a719dcf00c2890d38">◆ </a></span>toCommon()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structstdAc_1_1state__t.html">stdAc::state_t</a> IRTranscoldAc::toCommon </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structstdAc_1_1state__t.html">stdAc::state_t</a> * </td>
|
|
<td class="paramname"><em>prev</em> = <code>NULL</code></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert the A/C state to it's common <a class="el" href="structstdAc_1_1state__t.html" title="Structure to hold a common A/C state.">stdAc::state_t</a> equivalent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">prev</td><td>Ptr to the previous state if required. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="structstdAc_1_1state__t.html" title="Structure to hold a common A/C state.">stdAc::state_t</a> state. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad373dbb4df435d9a191710e5bce56883"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad373dbb4df435d9a191710e5bce56883">◆ </a></span>toCommonFanSpeed()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacestdAc.html#a8bb0dbf18fe69f639f4ac0b3ff133383">stdAc::fanspeed_t</a> IRTranscoldAc::toCommonFanSpeed </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>speed</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a native fan speed into its <a class="el" href="namespacestdAc.html" title="Enumerators and Structures for the Common A/C API.">stdAc</a> equivalent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">speed</td><td>The native setting to be converted. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="namespacestdAc.html" title="Enumerators and Structures for the Common A/C API.">stdAc</a> equivalent of the native setting. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4316d539b0a5270fab794fc7c3cef20a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4316d539b0a5270fab794fc7c3cef20a">◆ </a></span>toCommonMode()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f">stdAc::opmode_t</a> IRTranscoldAc::toCommonMode </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const uint8_t </td>
|
|
<td class="paramname"><em>mode</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert a native mode to it's common <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f" title="Common A/C settings for A/C operating modes.">stdAc::opmode_t</a> equivalent. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">mode</td><td>A native operation mode to be converted. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The corresponding common <a class="el" href="namespacestdAc.html#a99ad268c783486f9b3207cb78f48444f" title="Common A/C settings for A/C operating modes.">stdAc::opmode_t</a> mode. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a8be351a7df54e6606eeebc8630ee4029"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a8be351a7df54e6606eeebc8630ee4029">◆ </a></span>toString()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="IRremoteESP8266_8h.html#afbeda3fd1bdc8c37d01bdf9f5c8274ff">String</a> IRTranscoldAc::toString </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Convert the internal state into a human readable string. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>The current internal state expressed as a human readable String. </dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="a50d0d2c8a2f25855ca721ef3f477284b"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a50d0d2c8a2f25855ca721ef3f477284b">◆ </a></span>_</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="unionTranscoldProtocol.html">TranscoldProtocol</a> IRTranscoldAc::_</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a3f7136d98c100a67b97f4f8afb750fc4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a3f7136d98c100a67b97f4f8afb750fc4">◆ </a></span>_irsend</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classIRsend.html">IRsend</a> IRTranscoldAc::_irsend</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Instance of the IR send class. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a634858a8d3987fa95cb355083c1276da"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a634858a8d3987fa95cb355083c1276da">◆ </a></span>special_state</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">uint32_t IRTranscoldAc::special_state</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>special mode. </p>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="acaaa6c7fc022b3a259692bfd61258f49"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acaaa6c7fc022b3a259692bfd61258f49">◆ </a></span>swingFlag</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::swingFlag</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a15da6840a234b2ff739a86d19f15c58d"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a15da6840a234b2ff739a86d19f15c58d">◆ </a></span>swingHFlag</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::swingHFlag</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2aa4d5a19dd9056606ca20d03c893df"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2aa4d5a19dd9056606ca20d03c893df">◆ </a></span>swingVFlag</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool IRTranscoldAc::swingVFlag</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">private</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/<a class="el" href="ir__Transcold_8h_source.html">ir_Transcold.h</a></li>
|
|
<li>src/<a class="el" href="ir__Transcold_8cpp.html">ir_Transcold.cpp</a></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|