IRremoteESP8266: IRHaierAC Class Reference (original) (raw)
Class for handling detailed Haier A/C messages. More...
#include <[ir_Haier.h](ir%5F%5FHaier%5F8h%5Fsource.html)>
| Public Member Functions | |
|---|---|
| IRHaierAC (const uint16_t pin, const bool inverted=false, const bool use_modulation=true) | |
| Class constructor. More... | |
| void | send (const uint16_t repeat=kHaierAcDefaultRepeat) |
| 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 | setCommand (const uint8_t command) |
| Set the Command/Button setting of the A/C. More... | |
| uint8_t | getCommand (void) const |
| Get the Command/Button 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 | 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... | |
| int16_t | getOnTimer (void) const |
| Get the On Timer value/setting of the A/C. More... | |
| void | setOnTimer (const uint16_t mins) |
| Set & enable the On Timer. More... | |
| int16_t | getOffTimer (void) const |
| Get the Off Timer value/setting of the A/C. More... | |
| void | setOffTimer (const uint16_t mins) |
| Set & enable the Off Timer. More... | |
| void | cancelTimers (void) |
| Cancel/disable the On & Off timers. More... | |
| uint16_t | getCurrTime (void) const |
| Get the clock value of the A/C. More... | |
| void | setCurrTime (const uint16_t mins) |
| Set the clock value for the A/C. More... | |
| uint8_t | getSwingV (void) const |
| Get the Vertical Swing position setting of the A/C. More... | |
| void | setSwingV (const uint8_t state) |
| Set the Vertical Swing mode of the A/C. More... | |
| uint8_t * | getRaw (void) |
| Get a PTR to the internal state/code for this protocol. More... | |
| 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 (uint8_t state[], const uint16_t length=kHaierACStateLength) |
| 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... | |
| HaierProtocol | _ |
Class for handling detailed Haier A/C messages.
| IRHaierAC::IRHaierAC ( 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 IRHaierAC::begin | ( | void | ) |
|---|
Set up hardware to be able to send a message.
◆ calibrate()
| int8_t IRHaierAC::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.
◆ cancelTimers()
| void IRHaierAC::cancelTimers | ( | void | ) |
|---|
Cancel/disable the On & Off timers.
◆ checksum()
| void IRHaierAC::checksum ( void ) | private |
|---|
Calculate and set the checksum values for the internal state.
◆ 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] | position | The enum to be converted. |
|---|
Returns
The native equivalent of the enum.
◆ getCommand()
| uint8_t IRHaierAC::getCommand | ( | void | ) | const |
|---|
Get the Command/Button setting of the A/C.
Returns
The value of the command/button that was pressed.
◆ getCurrTime()
| uint16_t IRHaierAC::getCurrTime | ( | void | ) | const |
|---|
Get the clock value of the A/C.
Returns
The clock time, in Nr of minutes past midnight.
◆ getFan()
| uint8_t IRHaierAC::getFan | ( | void | ) | const |
|---|
Get the current fan speed setting.
Returns
The current fan speed.
◆ getHealth()
| bool IRHaierAC::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 IRHaierAC::getMode | ( | void | ) | const |
|---|
Get the operating mode setting of the A/C.
Returns
The current operating mode setting.
◆ getOffTimer()
| int16_t IRHaierAC::getOffTimer | ( | void | ) | const |
|---|
Get the Off Timer value/setting of the A/C.
Returns
Nr of minutes the timer is set to. -1 is Off/not set etc.
◆ getOnTimer()
| int16_t IRHaierAC::getOnTimer | ( | void | ) | const |
|---|
Get the On Timer value/setting of the A/C.
Returns
Nr of minutes the timer is set to. -1 is Off/not set etc.
◆ getRaw()
| uint8_t * IRHaierAC::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 IRHaierAC::getSleep | ( | void | ) | const |
|---|
Get the Sleep setting of the A/C.
Returns
true, the setting is on. false, the setting is off.
◆ getSwingV()
| uint8_t IRHaierAC::getSwingV | ( | void | ) | const |
|---|
Get the Vertical Swing position setting of the A/C.
Returns
The native vertical swing mode.
◆ getTemp()
| uint8_t IRHaierAC::getTemp | ( | void | ) | const |
|---|
Get the current temperature setting.
Returns
The current setting for temp. in degrees celsius.
◆ send()
Send the current internal state as an IR message.
Parameters
| [in] | repeat | Nr. of times the message will be repeated. |
|---|
◆ setCommand()
| void IRHaierAC::setCommand | ( | const uint8_t | command | ) |
|---|
Set the Command/Button setting of the A/C.
Parameters
| [in] | command | The value of the command/button that was pressed. |
|---|
◆ setCurrTime()
| void IRHaierAC::setCurrTime | ( | const uint16_t | nr_mins | ) |
|---|
Set the clock value for the A/C.
Parameters
| [in] | nr_mins | The clock time, in Nr of minutes past midnight. |
|---|
◆ setFan()
| void IRHaierAC::setFan | ( | const uint8_t | speed | ) |
|---|
Set the speed of the fan.
Parameters
| [in] | speed | The desired setting. |
|---|
◆ setHealth()
| void IRHaierAC::setHealth | ( | const bool | on | ) |
|---|
Set the Health (filter) setting of the A/C.
Parameters
| [in] | on | true, the setting is on. false, the setting is off. |
|---|
◆ setMode()
| void IRHaierAC::setMode | ( | const uint8_t | mode | ) |
|---|
Set the operating mode of the A/C.
Parameters
| [in] | mode | The desired operating mode. |
|---|
◆ setOffTimer()
| void IRHaierAC::setOffTimer | ( | const uint16_t | nr_mins | ) |
|---|
Set & enable the Off Timer.
Parameters
| [in] | nr_mins | The time expressed in total number of minutes. |
|---|
◆ setOnTimer()
| void IRHaierAC::setOnTimer | ( | const uint16_t | nr_mins | ) |
|---|
Set & enable the On Timer.
Parameters
| [in] | nr_mins | The time expressed in total number of minutes. |
|---|
◆ setRaw()
| void IRHaierAC::setRaw | ( | const uint8_t | _new_code_[] | ) |
|---|
Set the internal state from a valid code for this protocol.
Parameters
| [in] | new_code | A valid code for this protocol. |
|---|
◆ setSleep()
| void IRHaierAC::setSleep | ( | const bool | on | ) |
|---|
Set the Sleep setting of the A/C.
Parameters
| [in] | on | true, the setting is on. false, the setting is off. |
|---|
◆ setSwingV()
| void IRHaierAC::setSwingV | ( | const uint8_t | state | ) |
|---|
Set the Vertical Swing mode of the A/C.
Parameters
| [in] | state | The mode to set the vanes to. |
|---|
◆ setTemp()
| void IRHaierAC::setTemp | ( | const uint8_t | degrees | ) |
|---|
Set the temperature.
Parameters
| [in] | degrees | The temperature in degrees celsius. |
|---|
◆ stateReset()
| void IRHaierAC::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.
◆ toCommonSwingV()
Convert a stdAc::swingv_t enum into it's native setting.
Parameters
| [in] | pos | The enum to be converted. |
|---|
Returns
The native equivalent of the enum.
◆ toString()
| String IRHaierAC::toString | ( | void | ) | const |
|---|
Convert the current internal state into a human readable string.
Returns
A human readable string.
◆ validChecksum()
| bool IRHaierAC::validChecksum ( uint8_t _state_[], const uint16_t length = kHaierACStateLength ) | static |
|---|
Verify the checksum is valid for a given state.
Parameters
| [in] | state | The array to verify the checksum of. |
|---|---|---|
| [in] | length | The length of the state array. |
Returns
true, if the state has a valid checksum. Otherwise, false.
◆ _
◆ _irsend
Instance of the IR send class.
The documentation for this class was generated from the following files:
- src/ir_Haier.h
- src/ir_Haier.cpp