Showing content from https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/classIRGoodweatherAc.html below:
IRremoteESP8266: IRGoodweatherAc Class Reference
Class for handling detailed Goodweather A/C messages. More...
#include <ir_Goodweather.h>
IRGoodweatherAc (const uint16_t pin, const bool inverted=false, const bool use_modulation=true) Class constructor. More...
void stateReset (void) Reset the internal state to a fixed known good state. More...
void send (const uint16_t repeat=kGoodweatherMinRepeat) Send the current internal state as an IR message. More...
int8_t calibrate (void) Run the calibration to calculate uSec timing offsets for this platform. More...
void begin (void) Set up hardware to be able to send a message. More...
void on (void) Change the power setting to On. More...
void off (void) Change the power setting to Off. More...
void setPower (const bool on) Change the power setting. More...
bool getPower (void) const Get the value of the current power setting. More...
void setTemp (const uint8_t temp) Set the temperature. More...
uint8_t getTemp (void) const Get the current temperature setting. More...
void setFan (const uint8_t speed) Set the speed of the fan. More...
uint8_t getFan (void) const Get the current fan speed setting. More...
void setMode (const uint8_t mode) Set the operating mode of the A/C. More...
uint8_t getMode (void) const Get the operating mode setting of the A/C. More...
void setSwing (const uint8_t speed) Set the Vertical Swing speed of the A/C. More...
uint8_t getSwing (void) const Get the Vertical Swing speed of the A/C. More...
void setSleep (const bool toggle) Set the Sleep Toggle setting of the A/C. More...
bool getSleep (void) const Get the Sleep Toggle setting of the A/C. More...
void setTurbo (const bool toggle) Set the Turbo Toggle setting of the A/C. More...
bool getTurbo (void) const Get the Turbo Toggle setting of the A/C. More...
void setLight (const bool toggle) Set the Light (LED) Toggle setting of the A/C. More...
bool getLight (void) const Get the Light (LED) Toggle setting of the A/C. More...
void setCommand (const uint8_t cmd) Set the remote Command type/button pressed. More...
uint8_t getCommand (void) const Get the Command type/button pressed from the current settings. More...
uint64_t getRaw (void) Get a copy of the internal state as a valid code for this protocol. More...
void setRaw (const uint64_t state) Set the internal state from a valid code for this protocol. More...
stdAc::state_t toCommon (void) const Convert the current internal state into its stdAc::state_t equivalent. More...
String toString (void) const Convert the current internal state into a human readable string. More...
Class for handling detailed Goodweather A/C messages.
◆ IRGoodweatherAc() IRGoodweatherAc::IRGoodweatherAc ( const uint16_t pin, const bool inverted = false, const bool use_modulation = true ) explicit
Class constructor.
-
Parameters
-
[in] pin GPIO to be used when sending. [in] inverted Is the output signal to be inverted? [in] use_modulation Is frequency modulation to be used?
◆ begin() void IRGoodweatherAc::begin ( void )
Set up hardware to be able to send a message.
◆ calibrate() int8_t IRGoodweatherAc::calibrate ( void ) inline
Run the calibration to calculate uSec timing offsets for this platform.
-
Returns
-
The uSec timing offset needed per modulation of the IR Led.
-
Note
-
This will produce a 65ms IR signal pulse at 38kHz. Only ever needs to be run once per object instantiation, if at all.
◆ convertFan()
Convert a stdAc::fanspeed_t enum into it's native speed.
-
Parameters
-
[in] speed The enum to be converted.
-
Returns
-
The native equivalent of the enum.
◆ convertMode()
Convert a stdAc::opmode_t enum into its native mode.
-
Parameters
-
[in] mode The enum to be converted.
-
Returns
-
The native equivalent of the enum.
◆ convertSwingV()
Convert a stdAc::swingv_t enum into it's native setting.
-
Parameters
-
[in] swingv The enum to be converted.
-
Returns
-
The native equivalent of the enum.
◆ getCommand() uint8_t IRGoodweatherAc::getCommand ( void ) const
Get the Command type/button pressed from the current settings.
-
Returns
-
The command/button that was issued/pressed.
◆ getFan() uint8_t IRGoodweatherAc::getFan ( void ) const
Get the current fan speed setting.
-
Returns
-
The current fan speed.
◆ getLight() bool IRGoodweatherAc::getLight ( void ) const
Get the Light (LED) Toggle setting of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getMode() uint8_t IRGoodweatherAc::getMode ( void ) const
Get the operating mode setting of the A/C.
-
Returns
-
The current operating mode setting.
◆ getPower() bool IRGoodweatherAc::getPower ( void ) const
Get the value of the current power setting.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getRaw() uint64_t IRGoodweatherAc::getRaw ( void )
Get a copy of the internal state as a valid code for this protocol.
-
Returns
-
A valid code for this protocol based on the current internal state.
◆ getSleep() bool IRGoodweatherAc::getSleep ( void ) const
Get the Sleep Toggle setting of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getSwing() uint8_t IRGoodweatherAc::getSwing ( void ) const
Get the Vertical Swing speed of the A/C.
-
Returns
-
The native swing speed setting.
◆ getTemp() uint8_t IRGoodweatherAc::getTemp ( void ) const
Get the current temperature setting.
-
Returns
-
The current setting for temp. in degrees celsius.
◆ getTurbo() bool IRGoodweatherAc::getTurbo ( void ) const
Get the Turbo Toggle setting of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ off() void IRGoodweatherAc::off ( void )
Change the power setting to Off.
◆ on() void IRGoodweatherAc::on ( void )
Change the power setting to On.
◆ send()
Send the current internal state as an IR message.
-
Parameters
-
[in] repeat Nr. of times the message will be repeated.
◆ setCommand() void IRGoodweatherAc::setCommand ( const uint8_t cmd )
Set the remote Command type/button pressed.
-
Parameters
-
[in] cmd The command/button that was issued/pressed.
◆ setFan() void IRGoodweatherAc::setFan ( const uint8_t speed )
Set the speed of the fan.
-
Parameters
-
[in] speed The desired setting.
◆ setLight() void IRGoodweatherAc::setLight ( const bool toggle )
Set the Light (LED) Toggle setting of the A/C.
-
Parameters
-
[in] toggle true, the setting is on. false, the setting is off.
◆ setMode() void IRGoodweatherAc::setMode ( const uint8_t mode )
Set the operating mode of the A/C.
-
Parameters
-
[in] mode The desired operating mode.
◆ setPower() void IRGoodweatherAc::setPower ( const bool on )
Change the power setting.
-
Parameters
-
[in] on true, the setting is on. false, the setting is off.
◆ setRaw() void IRGoodweatherAc::setRaw ( const uint64_t state )
Set the internal state from a valid code for this protocol.
-
Parameters
-
[in] state A valid code for this protocol.
◆ setSleep() void IRGoodweatherAc::setSleep ( const bool toggle )
Set the Sleep Toggle setting of the A/C.
-
Parameters
-
[in] toggle true, the setting is on. false, the setting is off.
◆ setSwing() void IRGoodweatherAc::setSwing ( const uint8_t speed )
Set the Vertical Swing speed of the A/C.
-
Parameters
-
[in] speed The speed to set the swing to.
◆ setTemp() void IRGoodweatherAc::setTemp ( const uint8_t temp )
Set the temperature.
-
Parameters
-
[in] temp The temperature in degrees celsius.
◆ setTurbo() void IRGoodweatherAc::setTurbo ( const bool toggle )
Set the Turbo Toggle setting of the A/C.
-
Parameters
-
[in] toggle true, the setting is on. false, the setting is off.
◆ stateReset() void IRGoodweatherAc::stateReset ( void )
Reset the internal state to a fixed known good state.
◆ toCommon()
Convert the current internal state into its stdAc::state_t equivalent.
-
Returns
-
The stdAc equivalent of the native settings.
◆ toCommonFanSpeed()
Convert a native fan speed into its stdAc equivalent.
-
Parameters
-
[in] speed The native setting to be converted.
-
Returns
-
The stdAc equivalent of the native setting.
◆ toCommonMode()
Convert a native mode into its stdAc equivalent.
-
Parameters
-
[in] mode The native setting to be converted.
-
Returns
-
The stdAc equivalent of the native setting.
◆ toString() String IRGoodweatherAc::toString ( void ) const
Convert the current internal state into a human readable string.
-
Returns
-
A human readable string.
◆ _ ◆ _irsend IRsend IRGoodweatherAc::_irsend private
Instance of the IR send class.
The documentation for this class was generated from the following files:
RetroSearch is an open source project built by @garambo
| Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4