Showing content from https://crankyoldgit.github.io/IRremoteESP8266/doxygen/html/classIRKelvinatorAC.html below:
IRremoteESP8266: IRKelvinatorAC Class Reference
Class for handling detailed Kelvinator A/C messages. More...
#include <ir_Kelvinator.h>
void checksum (void) Calculate the checksum for the internal state. More...
void fixup (void) Fix up any odd conditions for the current state. More...
Class for handling detailed Kelvinator A/C messages.
◆ IRKelvinatorAC() IRKelvinatorAC::IRKelvinatorAC ( 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 IRKelvinatorAC::begin ( void )
Set up hardware to be able to send a message.
◆ calcBlockChecksum() uint8_t IRKelvinatorAC::calcBlockChecksum ( const uint8_t * block, const uint16_t length = kKelvinatorStateLength / 2 ) static
Calculate the checksum for a given block of state.
-
Parameters
-
[in] block A pointer to a block to calc the checksum of. [in] length Length of the block array to checksum.
-
Returns
-
The calculated checksum value.
-
Note
-
Many Bothans died to bring us this information.
◆ calibrate() int8_t IRKelvinatorAC::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.
◆ checksum() void IRKelvinatorAC::checksum ( void ) private
Calculate the checksum for the internal state.
◆ convertMode()
Convert a standard A/C mode (stdAc::opmode_t) into it a native mode.
-
Parameters
-
-
Returns
-
The native mode equivalent.
◆ 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.
◆ fixup() void IRKelvinatorAC::fixup ( void ) private
Fix up any odd conditions for the current state.
◆ getFan() uint8_t IRKelvinatorAC::getFan ( void ) const
Get the current fan speed setting.
-
Returns
-
The current fan speed.
◆ getIonFilter() bool IRKelvinatorAC::getIonFilter ( void ) const
Is the Ion Filter setting on?
-
Returns
-
The current value.
◆ getLight() bool IRKelvinatorAC::getLight ( void ) const
Is the Light (Display) setting on?
-
Returns
-
The current value.
◆ getMode() uint8_t IRKelvinatorAC::getMode ( void ) const
Get the current operation mode setting.
-
Returns
-
The current operation mode.
◆ getPower() bool IRKelvinatorAC::getPower ( void ) const
Get the power setting from the internal state.
-
Returns
-
A boolean indicating if the power setting.
◆ getQuiet() bool IRKelvinatorAC::getQuiet ( void ) const
Is the Quiet setting on?
-
Returns
-
The current value.
◆ getRaw() uint8_t * IRKelvinatorAC::getRaw ( void )
Get the raw state of the object, suitable to be sent with the appropriate IRsend object method.
-
Returns
-
A PTR to the internal state.
◆ getSwingHorizontal() bool IRKelvinatorAC::getSwingHorizontal ( void ) const
Is the horizontal swing setting on?
-
Returns
-
The current value.
◆ getSwingVerticalAuto() bool IRKelvinatorAC::getSwingVerticalAuto ( void ) const
Get the Vertical Swing Automatic mode setting of the A/C.
-
Returns
-
true, the setting is on. false, the setting is off.
◆ getSwingVerticalPosition() uint8_t IRKelvinatorAC::getSwingVerticalPosition ( void ) const
Get the Vertical Swing position setting of the A/C.
-
Returns
-
The native position/mode.
◆ getTemp() uint8_t IRKelvinatorAC::getTemp ( void ) const
Get the current temperature setting.
-
Returns
-
Get current setting for temp. in degrees celsius.
◆ getTurbo() bool IRKelvinatorAC::getTurbo ( void ) const
Is the Turbo setting on?
-
Returns
-
The current value.
◆ getXFan() bool IRKelvinatorAC::getXFan ( void ) const
Is the XFan setting on?
-
Returns
-
The current value.
◆ off() void IRKelvinatorAC::off ( void )
Set the internal state to have the power off.
◆ on() void IRKelvinatorAC::on ( void )
Set the internal state to have the power on.
◆ send()
Send the current internal state as an IR message.
-
Parameters
-
[in] repeat Nr. of times the message will be repeated.
◆ setFan() void IRKelvinatorAC::setFan ( const uint8_t speed )
Set the speed of the fan.
-
Parameters
-
[in] speed 0 is auto, 1-5 is the speed
◆ setIonFilter() void IRKelvinatorAC::setIonFilter ( const bool on )
Control the current Ion Filter setting.
-
Parameters
-
[in] on The desired setting.
◆ setLight() void IRKelvinatorAC::setLight ( const bool on )
Control the current Light setting. i.e. The LED display on the A/C unit that shows the basic settings.
-
Parameters
-
[in] on The desired setting.
◆ setMode() void IRKelvinatorAC::setMode ( const uint8_t mode )
Set the desired operation mode.
-
Parameters
-
[in] mode The desired operation mode.
◆ setPower() void IRKelvinatorAC::setPower ( const bool on )
Set the internal state to have the desired power.
-
Parameters
-
[in] on The desired power state.
◆ setQuiet() void IRKelvinatorAC::setQuiet ( const bool on )
Control the current Quiet setting.
-
Parameters
-
[in] on The desired setting.
◆ setRaw() void IRKelvinatorAC::setRaw ( const uint8_t new_code[] )
Set the raw state of the object.
-
Parameters
-
[in] new_code The raw state from the native IR message.
◆ setSwingHorizontal() void IRKelvinatorAC::setSwingHorizontal ( const bool on )
Control the current horizontal swing setting.
-
Parameters
-
[in] on The desired setting.
◆ setSwingVertical() void IRKelvinatorAC::setSwingVertical ( const bool automatic, const uint8_t position )
Set the Vertical Swing mode of the A/C.
-
Parameters
-
[in] automatic Do we use the automatic setting? [in] position The position/mode to set the vanes to.
◆ setTemp() void IRKelvinatorAC::setTemp ( const uint8_t degrees )
Set the temperature setting.
-
Parameters
-
[in] degrees The temperature in degrees celsius.
◆ setTurbo() void IRKelvinatorAC::setTurbo ( const bool on )
Control the current Turbo setting.
-
Note
-
Turbo mode is turned off if the fan speed is changed.
-
Parameters
-
[in] on The desired setting.
◆ setXFan() void IRKelvinatorAC::setXFan ( const bool on )
Control the current XFan setting. This setting will cause the unit blow air after power off to dry out the A/C device.
-
Note
-
XFan mode is only valid in Cool or Dry mode.
-
Parameters
-
[in] on The desired setting.
◆ stateReset() void IRKelvinatorAC::stateReset ( void )
Reset the internals of the object to a known good state.
◆ toCommon() ◆ toCommonFanSpeed() ◆ toCommonMode() ◆ toCommonSwingV() static stdAc::swingv_t IRKelvinatorAC::toCommonSwingV ( const uint8_t pos ) static ◆ toString() String IRKelvinatorAC::toString ( void ) const
Convert the internal settings into a human readable string.
-
Returns
-
A String.
◆ validChecksum()
Verify the checksum is valid for a given state.
-
Parameters
-
[in] state The array to verify the checksum of. [in] length The size of the state.
-
Returns
-
A boolean indicating if it is valid.
◆ _ ◆ _irsend IRsend IRKelvinatorAC::_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