IRremoteESP8266
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
IRHaierAC176 Class Reference

Class for handling detailed Haier 176 bit A/C messages. More...

#include <ir_Haier.h>

Inheritance diagram for IRHaierAC176:
Inheritance graph
[legend]
Collaboration diagram for IRHaierAC176:
Collaboration graph
[legend]

Public Member Functions

 IRHaierAC176 (const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
 Class constructor. More...
 
virtual void send (const uint16_t repeat=kHaierAc176DefaultRepeat)
 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 stateReset (void)
 Reset the internal state to a fixed known good state. More...
 
void setButton (const uint8_t button)
 Set the Button/Command setting of the A/C. More...
 
uint8_t getButton (void) const
 Get the Button/Command setting of the A/C. 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...
 
uint8_t getMode (void) const
 Get the operating mode setting of the A/C. More...
 
void setMode (const uint8_t mode)
 Set the operating mode of the A/C. More...
 
bool getPower (void) const
 Get the value of the current power setting. More...
 
void setPower (const bool on)
 Change the power setting. More...
 
void on (void)
 Change the power setting to On. More...
 
void off (void)
 Change the power setting to Off. More...
 
bool getSleep (void) const
 Get the Sleep setting of the A/C. More...
 
void setSleep (const bool on)
 Set the Sleep setting of the A/C. More...
 
bool getHealth (void) const
 Get the Health (filter) setting of the A/C. More...
 
void setHealth (const bool on)
 Set the Health (filter) setting of the A/C. More...
 
uint8_t getTurbo (void) const
 Get the Turbo setting of the A/C. More...
 
void setTurbo (const uint8_t speed)
 Set the Turbo setting of the A/C. More...
 
uint8_t getSwing (void) const
 Get the Vertical Swing position setting of the A/C. More...
 
void setSwing (const uint8_t pos)
 Set the Vertical Swing mode of the A/C. More...
 
void setTimerMode (const uint8_t setting)
 Set the Timer operating mode. More...
 
uint8_t getTimerMode (void) const
 Get the Timer operating mode. More...
 
void setOnTimer (const uint16_t mins)
 Set the number of minutes of the On Timer setting. More...
 
uint16_t getOnTimer (void) const
 Get the number of minutes of the On Timer setting. More...
 
void setOffTimer (const uint16_t mins)
 Set the number of minutes of the Off Timer setting. More...
 
uint16_t getOffTimer (void) const
 Get the number of minutes of the Off Timer setting. More...
 
uint8_t * getRaw (void)
 Get a PTR to the internal state/code for this protocol. More...
 
virtual void setRaw (const uint8_t new_code[])
 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...
 

Static Public Member Functions

static bool validChecksum (const uint8_t state[], const uint16_t length=kHaierAC176StateLength)
 Verify the checksum is valid for a given state. More...
 
static uint8_t convertMode (const stdAc::opmode_t mode)
 Convert a stdAc::opmode_t enum into its native mode. More...
 
static uint8_t convertFan (const stdAc::fanspeed_t speed)
 Convert a stdAc::fanspeed_t enum into it's native speed. More...
 
static uint8_t convertSwingV (const stdAc::swingv_t position)
 Convert a stdAc::swingv_t enum into it's native setting. More...
 
static stdAc::opmode_t toCommonMode (const uint8_t mode)
 Convert a native mode into its stdAc equivalent. More...
 
static stdAc::fanspeed_t toCommonFanSpeed (const uint8_t speed)
 Convert a native fan speed into its stdAc equivalent. More...
 
static stdAc::swingv_t toCommonSwingV (const uint8_t pos)
 Convert a stdAc::swingv_t enum into it's native setting. More...
 

Private Member Functions

void checksum (void)
 Calculate and set the checksum values for the internal state. More...
 

Private Attributes

IRsend _irsend
 Instance of the IR send class. More...
 
HaierAc176Protocol _
 

Friends

class IRHaierACYRW02
 

Detailed Description

Class for handling detailed Haier 176 bit A/C messages.

Constructor & Destructor Documentation

◆ IRHaierAC176()

IRHaierAC176::IRHaierAC176 ( const uint16_t  pin,
const bool  inverted = false,
const bool  use_modulation = true 
)
explicit

Class constructor.

Parameters
[in]pinGPIO to be used when sending.
[in]invertedIs the output signal to be inverted?
[in]use_modulationIs frequency modulation to be used?

Member Function Documentation

◆ begin()

void IRHaierAC176::begin ( void  )

Set up hardware to be able to send a message.

◆ calibrate()

int8_t IRHaierAC176::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 IRHaierAC176::checksum ( void  )
private

Calculate and set the checksum values for the internal state.

◆ convertFan()

uint8_t IRHaierAC176::convertFan ( const stdAc::fanspeed_t  speed)
static

Convert a stdAc::fanspeed_t enum into it's native speed.

Parameters
[in]speedThe enum to be converted.
Returns
The native equivalent of the enum.

◆ convertMode()

uint8_t IRHaierAC176::convertMode ( const stdAc::opmode_t  mode)
static

Convert a stdAc::opmode_t enum into its native mode.

Parameters
[in]modeThe enum to be converted.
Returns
The native equivalent of the enum.

◆ convertSwingV()

uint8_t IRHaierAC176::convertSwingV ( const stdAc::swingv_t  position)
static

Convert a stdAc::swingv_t enum into it's native setting.

Parameters
[in]positionThe enum to be converted.
Returns
The native equivalent of the enum.

◆ getButton()

uint8_t IRHaierAC176::getButton ( void  ) const

Get the Button/Command setting of the A/C.

Returns
The value of the button/command that was pressed.

◆ getFan()

uint8_t IRHaierAC176::getFan ( void  ) const

Get the current fan speed setting.

Returns
The current fan speed.

◆ getHealth()

bool IRHaierAC176::getHealth ( void  ) const

Get the Health (filter) setting of the A/C.

Returns
true, the setting is on. false, the setting is off.

◆ getMode()

uint8_t IRHaierAC176::getMode ( void  ) const

Get the operating mode setting of the A/C.

Returns
The current operating mode setting.

◆ getOffTimer()

uint16_t IRHaierAC176::getOffTimer ( void  ) const

Get the number of minutes of the Off Timer setting.

Returns
Nr of minutes.

◆ getOnTimer()

uint16_t IRHaierAC176::getOnTimer ( void  ) const

Get the number of minutes of the On Timer setting.

Returns
Nr of minutes.

◆ getPower()

bool IRHaierAC176::getPower ( void  ) const

Get the value of the current power setting.

Returns
true, the setting is on. false, the setting is off.

◆ getRaw()

uint8_t * IRHaierAC176::getRaw ( void  )

Get a PTR to the internal state/code for this protocol.

Returns
PTR to a code for this protocol based on the current internal state.

◆ getSleep()

bool IRHaierAC176::getSleep ( void  ) const

Get the Sleep setting of the A/C.

Returns
true, the setting is on. false, the setting is off.

◆ getSwing()

uint8_t IRHaierAC176::getSwing ( void  ) const

Get the Vertical Swing position setting of the A/C.

Returns
The native position/mode.

◆ getTemp()

uint8_t IRHaierAC176::getTemp ( void  ) const

Get the current temperature setting.

Returns
The current setting for temp. in degrees celsius.

◆ getTimerMode()

uint8_t IRHaierAC176::getTimerMode ( void  ) const

Get the Timer operating mode.

Returns
The mode of the timer is currently configured to.

◆ getTurbo()

uint8_t IRHaierAC176::getTurbo ( void  ) const

Get the Turbo setting of the A/C.

Returns
The current turbo speed setting.

◆ off()

void IRHaierAC176::off ( void  )

Change the power setting to Off.

◆ on()

void IRHaierAC176::on ( void  )

Change the power setting to On.

◆ send()

void IRHaierAC176::send ( const uint16_t  repeat = kHaierAc176DefaultRepeat)
virtual

Send the current internal state as an IR message.

Parameters
[in]repeatNr. of times the message will be repeated.

Reimplemented in IRHaierACYRW02.

◆ setButton()

void IRHaierAC176::setButton ( const uint8_t  button)

Set the Button/Command setting of the A/C.

Parameters
[in]buttonThe value of the button/command that was pressed.

◆ setFan()

void IRHaierAC176::setFan ( const uint8_t  speed)

Set the speed of the fan.

Parameters
[in]speedThe desired setting.

◆ setHealth()

void IRHaierAC176::setHealth ( const bool  on)

Set the Health (filter) setting of the A/C.

Parameters
[in]ontrue, the setting is on. false, the setting is off.

◆ setMode()

void IRHaierAC176::setMode ( const uint8_t  mode)

Set the operating mode of the A/C.

Parameters
[in]modeThe desired operating mode.

◆ setOffTimer()

void IRHaierAC176::setOffTimer ( const uint16_t  mins)

Set the number of minutes of the Off Timer setting.

Parameters
[in]minsNr. of Minutes for the Timer. 0 means disable the timer.

◆ setOnTimer()

void IRHaierAC176::setOnTimer ( const uint16_t  mins)

Set the number of minutes of the On Timer setting.

Parameters
[in]minsNr. of Minutes for the Timer. 0 means disable the timer.

◆ setPower()

void IRHaierAC176::setPower ( const bool  on)

Change the power setting.

Parameters
[in]ontrue, the setting is on. false, the setting is off.

◆ setRaw()

void IRHaierAC176::setRaw ( const uint8_t  new_code[])
virtual

Set the internal state from a valid code for this protocol.

Parameters
[in]new_codeA valid code for this protocol.

Reimplemented in IRHaierACYRW02.

◆ setSleep()

void IRHaierAC176::setSleep ( const bool  on)

Set the Sleep setting of the A/C.

Parameters
[in]ontrue, the setting is on. false, the setting is off.

◆ setSwing()

void IRHaierAC176::setSwing ( const uint8_t  pos)

Set the Vertical Swing mode of the A/C.

Parameters
[in]posThe position/mode to set the vanes to.

◆ setTemp()

void IRHaierAC176::setTemp ( const uint8_t  celsius)

Set the temperature.

Parameters
[in]celsiusThe temperature in degrees celsius.

◆ setTimerMode()

void IRHaierAC176::setTimerMode ( const uint8_t  mode)

Set the Timer operating mode.

Parameters
[in]modeThe timer mode to use.

◆ setTurbo()

void IRHaierAC176::setTurbo ( const uint8_t  speed)

Set the Turbo setting of the A/C.

Parameters
[in]speedThe desired turbo speed setting.
Note
Valid speeds are kHaierAcYrw02TurboOff, kHaierAcYrw02TurboLow, & kHaierAcYrw02TurboHigh.

◆ stateReset()

void IRHaierAC176::stateReset ( void  )

Reset the internal state to a fixed known good state.

◆ toCommon()

stdAc::state_t IRHaierAC176::toCommon ( void  ) const

Convert the current internal state into its stdAc::state_t equivalent.

Returns
The stdAc equivalent of the native settings.

◆ toCommonFanSpeed()

stdAc::fanspeed_t IRHaierAC176::toCommonFanSpeed ( const uint8_t  speed)
static

Convert a native fan speed into its stdAc equivalent.

Parameters
[in]speedThe native setting to be converted.
Returns
The stdAc equivalent of the native setting.

◆ toCommonMode()

stdAc::opmode_t IRHaierAC176::toCommonMode ( const uint8_t  mode)
static

Convert a native mode into its stdAc equivalent.

Parameters
[in]modeThe native setting to be converted.
Returns
The stdAc equivalent of the native setting.

◆ toCommonSwingV()

stdAc::swingv_t IRHaierAC176::toCommonSwingV ( const uint8_t  pos)
static

Convert a stdAc::swingv_t enum into it's native setting.

Parameters
[in]posThe enum to be converted.
Returns
The native equivalent of the enum.

◆ toString()

String IRHaierAC176::toString ( void  ) const

Convert the current internal state into a human readable string.

Returns
A human readable string.

◆ validChecksum()

bool IRHaierAC176::validChecksum ( const uint8_t  state[],
const uint16_t  length = kHaierAC176StateLength 
)
static

Verify the checksum is valid for a given state.

Parameters
[in]stateThe array to verify the checksum of.
[in]lengthThe length of the state array.
Returns
true, if the state has a valid checksum. Otherwise, false.

Friends And Related Function Documentation

◆ IRHaierACYRW02

friend class IRHaierACYRW02
friend

Member Data Documentation

◆ _

HaierAc176Protocol IRHaierAC176::_
private

◆ _irsend

IRsend IRHaierAC176::_irsend
private

Instance of the IR send class.


The documentation for this class was generated from the following files: