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

Class for handling detailed Amcor A/C messages. More...

#include <ir_Amcor.h>

Collaboration diagram for IRAmcorAc:
Collaboration graph
[legend]

Public Member Functions

 IRAmcorAc (const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
 Class constructor. More...
 
void stateReset ()
 Reset the internals of the object to a known good state. More...
 
void send (const uint16_t repeat=kAmcorDefaultRepeat)
 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 ()
 Set up hardware to be able to send a message. More...
 
void setPower (const bool state)
 Set the internal state to have the desired power. More...
 
bool getPower ()
 Get the power setting from the internal state. More...
 
void on ()
 Set the internal state to have the power on. More...
 
void off ()
 Set the internal state to have the power off. More...
 
void setTemp (const uint8_t temp)
 Set the temperature. More...
 
uint8_t getTemp ()
 Get the current temperature setting. More...
 
void setMax (const bool on)
 Control the current Maximum Cooling or Heating setting. (i.e. Turbo) More...
 
bool getMax (void)
 Is the Maximum Cooling or Heating setting (i.e. Turbo) setting on? More...
 
void setFan (const uint8_t speed)
 Set the speed of the fan. More...
 
uint8_t getFan ()
 Get the current fan speed setting. More...
 
void setMode (const uint8_t mode)
 Set the desired operation mode. More...
 
uint8_t getMode ()
 Get the current operation mode setting. More...
 
uint8_t * getRaw ()
 Get the raw state of the object, suitable to be sent with the appropriate IRsend object method. More...
 
void setRaw (const uint8_t state[])
 Set the raw state of the object. More...
 
uint8_t convertMode (const stdAc::opmode_t mode)
 Convert a stdAc::opmode_t enum into its native mode. More...
 
uint8_t convertFan (const stdAc::fanspeed_t speed)
 Convert a stdAc::fanspeed_t enum into it's native speed. More...
 
stdAc::state_t toCommon (void)
 Convert the current internal state into its stdAc::state_t equivilant. More...
 
String toString ()
 Convert the current internal state into a human readable string. More...
 

Static Public Member Functions

static uint8_t calcChecksum (const uint8_t state[], const uint16_t length=kAmcorStateLength)
 Calculate the checksum for the supplied state. More...
 
static bool validChecksum (const uint8_t state[], const uint16_t length=kAmcorStateLength)
 Verify the checksum is valid for a given state. More...
 
static stdAc::opmode_t toCommonMode (const uint8_t mode)
 Convert a native mode into its stdAc equivilant. More...
 
static stdAc::fanspeed_t toCommonFanSpeed (const uint8_t speed)
 Convert a native fan speed into its stdAc equivilant. More...
 

Private Member Functions

void checksum (void)
 Update the checksum value for the internal state. More...
 

Private Attributes

IRsend _irsend
 
uint8_t remote_state [kAmcorStateLength]
 

Detailed Description

Class for handling detailed Amcor A/C messages.

Constructor & Destructor Documentation

◆ IRAmcorAc()

IRAmcorAc::IRAmcorAc ( 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 IRAmcorAc::begin ( )

Set up hardware to be able to send a message.

◆ calcChecksum()

uint8_t IRAmcorAc::calcChecksum ( const uint8_t  state[],
const uint16_t  length = kAmcorStateLength 
)
static

Calculate the checksum for the supplied state.

Parameters
[in]stateThe source state to generate the checksum from.
[in]lengthLength of the supplied state to checksum.
Returns
The checksum value.

◆ calibrate()

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

Update the checksum value for the internal state.

◆ convertFan()

uint8_t IRAmcorAc::convertFan ( const stdAc::fanspeed_t  speed)

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

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

◆ convertMode()

uint8_t IRAmcorAc::convertMode ( const stdAc::opmode_t  mode)

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

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

◆ getFan()

uint8_t IRAmcorAc::getFan ( )

Get the current fan speed setting.

Returns
The current fan speed.

◆ getMax()

bool IRAmcorAc::getMax ( void  )

Is the Maximum Cooling or Heating setting (i.e. Turbo) setting on?

Returns
The current value.

◆ getMode()

uint8_t IRAmcorAc::getMode ( )

Get the current operation mode setting.

Returns
The current operation mode.

◆ getPower()

bool IRAmcorAc::getPower ( )

Get the power setting from the internal state.

Returns
A boolean indicating the power setting.

◆ getRaw()

uint8_t * IRAmcorAc::getRaw ( )

Get the raw state of the object, suitable to be sent with the appropriate IRsend object method.

Returns
A PTR to the internal state.

◆ getTemp()

uint8_t IRAmcorAc::getTemp ( )

Get the current temperature setting.

Returns
Get current setting for temp. in degrees celsius.

◆ off()

void IRAmcorAc::off ( )

Set the internal state to have the power off.

◆ on()

void IRAmcorAc::on ( )

Set the internal state to have the power on.

◆ send()

void IRAmcorAc::send ( const uint16_t  repeat = kAmcorDefaultRepeat)

Send the current internal state as an IR message.

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

◆ setFan()

void IRAmcorAc::setFan ( const uint8_t  speed)

Set the speed of the fan.

Parameters
[in]speedThe desired setting.

◆ setMax()

void IRAmcorAc::setMax ( const bool  on)

Control the current Maximum Cooling or Heating setting. (i.e. Turbo)

Note
Only allowed in Cool or Heat mode.
Parameters
[in]onThe desired setting.

◆ setMode()

void IRAmcorAc::setMode ( const uint8_t  mode)

Set the desired operation mode.

Parameters
[in]modeThe desired operation mode.

◆ setPower()

void IRAmcorAc::setPower ( const bool  on)

Set the internal state to have the desired power.

Parameters
[in]onThe desired power state.

◆ setRaw()

void IRAmcorAc::setRaw ( const uint8_t  state[])

Set the raw state of the object.

Parameters
[in]stateThe raw state from the native IR message.

◆ setTemp()

void IRAmcorAc::setTemp ( const uint8_t  degrees)

Set the temperature.

Parameters
[in]degreesThe temperature in degrees celsius.

◆ stateReset()

void IRAmcorAc::stateReset ( )

Reset the internals of the object to a known good state.

◆ toCommon()

stdAc::state_t IRAmcorAc::toCommon ( void  )

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

Returns
The stdAc equivilant of the native settings.

◆ toCommonFanSpeed()

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

Convert a native fan speed into its stdAc equivilant.

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

◆ toCommonMode()

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

Convert a native mode into its stdAc equivilant.

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

◆ toString()

String IRAmcorAc::toString ( )

Convert the current internal state into a human readable string.

Returns
A human readable string.

◆ validChecksum()

bool IRAmcorAc::validChecksum ( const uint8_t  state[],
const uint16_t  length = kAmcorStateLength 
)
static

Verify the checksum is valid for a given state.

Parameters
[in]stateThe array to verify the checksum of.
[in]lengthThe size of the state.
Returns
A boolean indicating if it's checksum is valid.

Member Data Documentation

◆ _irsend

IRsend IRAmcorAc::_irsend
private

◆ remote_state

uint8_t IRAmcorAc::remote_state[kAmcorStateLength]
private

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