IRremoteESP8266: IRArgoACBase< ARGO_PROTOCOL_T > Class Template Reference (original) (raw)

Base class for handling common support for Argo remote protocols (functionality is shared across WREM-2 and WREM-3 IR protocols) More...

#include <[ir_Argo.h](ir%5F%5FArgo%5F8h%5Fsource.html)>

template<typename ARGO_PROTOCOL_T>

class IRArgoACBase< ARGO_PROTOCOL_T >

Base class for handling common support for Argo remote protocols (functionality is shared across WREM-2 and WREM-3 IR protocols)

Note

This class uses static polymorphism and full template specializations when required, to avoid a performance penalty of doing v-table lookup. 2 instantiations are forced in impl. file: for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") and [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.")

This class is abstract (though does not declare a pure-virtual fn. for abovementioned reasons), and instead declares protected c-tor

Template Parameters

template

Class constructor.

Parameters

◆ _checksum()

template<typename ARGO_PROTOCOL_T >

◆ _stateReset()

template<typename ARGO_PROTOCOL_T >

◆ begin()

template

Set up hardware to be able to send a message.

◆ calcChecksum()

template<typename ARGO_PROTOCOL_T >

Calculate the checksum for a given state (WREM-3).

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

Returns

The 8-bit calculated result. <ARGO_PROTOCOL_T>

◆ calibrate()

template<typename ARGO_PROTOCOL_T >

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()

Update the checksum for the internal state.

◆ convertCommand()

Convert a stdAc::ac_command_t enum into its native message type.

Parameters

Returns

The native equivalent of the enum.

◆ convertFan()

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

Parameters

Returns

The native equivalent of the enum.

◆ convertMode()

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

Parameters

Returns

The native equivalent of the enum.

◆ convertSwingV()

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

Parameters

Returns

The native equivalent of the enum.

◆ getChecksum()

template<typename ARGO_PROTOCOL_T >

Retrieve the checksum value from transmitted state.

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

Returns

Checksum value (8-bit) <ARGO_PROTOCOL_T>

◆ getFanEx()

template<typename ARGO_PROTOCOL_T >

-Ex for backw. compat w/ [IRArgoAC](classIRArgoAC.html "Supports Argo A/C SAC-WREM2 IR remote protocol.")

Get the current fan mode setting as a strongly typed value (WREM3).

Get the current fan mode setting as a strongly typed value (WREM2).

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Returns

The current fan mode. <ARGO_PROTOCOL_T>

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Returns

The current fan mode. <ARGO_PROTOCOL_T>

◆ getFlapEx()

-Ex for backw. compat w/ [IRArgoAC](classIRArgoAC.html "Supports Argo A/C SAC-WREM2 IR remote protocol.")

Get Flap (VSwing) value as a strongly-typed value.

Note

This [getFlapEx()](classIRArgoACBase.html#ad5465ccf35143d0898ed837d39b3fde6 "-Ex for backw. compat w/ IRArgoAC") method has been introduced to be able to retain old implementation of getFlap() for IRArgoAc which used uint8_t

Returns

Flap setting

◆ getiFeel()

template

Get the status of iFeel mode.

Returns

true if on, false if off.

◆ getMax()

template

Is the Max (i.e. Turbo) setting on?

Returns

The current value.

◆ getMessageType() [1/2]

template<typename ARGO_PROTOCOL_T >

Get message type from raw WREM-3 data.

Parameters

Returns

IR message type

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function <ARGO_PROTOCOL_T>

◆ getMessageType() [2/2]

Get the message type.

Returns

Message type currently set

◆ getModeEx()

template<typename ARGO_PROTOCOL_T >

-Ex for backw. compat w/ [IRArgoAC](classIRArgoAC.html "Supports Argo A/C SAC-WREM2 IR remote protocol.")

Get the current operation mode setting.

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Returns

The current operation mode.

Note

This [getModeEx()](classIRArgoACBase.html#a5b3a48dd4ebaef8ba73b300893213cf7 "-Ex for backw. compat w/ IRArgoAC") method has been introduced to be able to retain old implementation of getMode() for IRArgoAc which used uint8_t <ARGO_PROTOCOL_T>

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function.

Returns

The current operation mode.

Note

This [getModeEx()](classIRArgoACBase.html#a5b3a48dd4ebaef8ba73b300893213cf7 "-Ex for backw. compat w/ IRArgoAC") method has been introduced to be able to retain old implementation of getMode() for IRArgoAc which used uint8_t <ARGO_PROTOCOL_T>

◆ getNight()

template

Get the status of Night mode. i.e. Sleep.

Returns

true if on, false if off.

◆ getPower()

template<typename ARGO_PROTOCOL_T >

Get the power setting from the internal state.

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Returns

A boolean indicating the power setting. <ARGO_PROTOCOL_T>

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Returns

A boolean indicating the power setting. <ARGO_PROTOCOL_T>

◆ getRaw()

template

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

Returns

A PTR to the internal state.

◆ getRawByteLength() [1/2]

Get actual raw state byte length for the current state.

Returns

Actual length of state (in bytes)

◆ getRawByteLength() [2/2]

template<typename ARGO_PROTOCOL_T >

◆ getSensorTemp()

template

Get the currently stored value for the room temperature setting.

Note

Depending on message type - this will get sensor or roomTemp value

Returns

The current setting for the room temp. in degrees celsius.

◆ getStateLengthForIrMsgType()

template<typename ARGO_PROTOCOL_T >

Get byte length of raw WREM-3 message based on IR cmd type.

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

Returns

Byte length of state command <ARGO_PROTOCOL_T>

◆ getTemp()

template

Get the current temperature setting.

Returns

The current setting for temp. in degrees celsius.

◆ off()

Set the internal state to have the power off.

◆ on()

Set the internal state to have the power on.

◆ send()

Send the current internal state as an IR message.

Parameters

◆ setFan()

template<typename ARGO_PROTOCOL_T >

Set the desired fan mode (WREM3).

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ setFanEx()

template<typename ARGO_PROTOCOL_T >

◆ setFlap()

Set the desired flap mode.

Parameters

◆ setFlapEx()

template<typename ARGO_PROTOCOL_T >

◆ setiFeel()

template

Turn on/off the iFeel mode.

Parameters

◆ setMax()

template

Control the current Max setting. (i.e. Turbo)

Parameters

◆ setMessageType()

Set the message type of the next command (setting this resets state)

Parameters

◆ setMode()

template<typename ARGO_PROTOCOL_T >

Set the desired operation mode.

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ setModeEx()

template<typename ARGO_PROTOCOL_T >

◆ setNight()

template

Turn on/off the Night mode. i.e. Sleep.

Parameters

◆ setPower()

template<typename ARGO_PROTOCOL_T >

Set the internal state to have the desired power.

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ setRaw()

template

Set the raw state of the object.

Parameters

◆ setSensorTemp()

template

Set the value for the current room temperature.

Note

Depending on message type - this will set sensor or roomTemp value

Parameters

◆ setTemp()

template

Set the temperature.

Parameters

Note

Sending 0 equals +4

◆ stateReset()

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

Parameters

◆ toCommonCommand()

Convert a native message type into its stdAc equivalent.

Parameters

Returns

The stdAc equivalent of the native setting.

◆ toCommonFanSpeed()

Convert a native fan speed into its stdAc equivalent.

Parameters

Returns

The stdAc equivalent of the native setting.

◆ toCommonMode()

Convert a native mode into its stdAc equivalent.

Parameters

Returns

The stdAc equivalent of the native setting.

◆ toCommonSwingV()

template<typename ARGO_PROTOCOL_T >

Convert a native flap mode into its stdAc equivalent (WREM3).

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

Returns

The stdAc equivalent of the native setting. <ARGO_PROTOCOL_T>

◆ validChecksum()

template

Verify the checksum is valid for a given state.

Parameters

Returns

A boolean indicating if it's checksum is valid.

◆ _checksum() [1/2]

Update the checksum for a given state (WREM2).

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Warning

This impl does not support short message format (iFeel)

Parameters

◆ _checksum() [2/2]

Update the checksum for a given state (WREM3).

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ _stateReset() [1/2]

Reset the given state to a known good state.

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ _stateReset() [2/2]

Reset the given state to a known good state.

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function

Parameters

◆ getRawByteLength() [1/2]

Get actual raw state byte length for the current state _param 1st param ignored: WREM-2 does not caryy type in payload, allegedly.

Parameters

Returns

Actual length of state (in bytes)

Note

This is a full specialization for [ArgoProtocol](unionArgoProtocol.html "Native representation of a Argo A/C message for WREM-2 remote.") type and while it semantically belongs to IrArgoAC class impl., it has not been pushed there, to avoid having to use a virtual function <ARGO_PROTOCOL_T>

◆ getRawByteLength() [2/2]

Get actual raw state byte length for the current state.

Parameters

Returns

Actual length of state (in bytes)

Note

This is a full specialization for [ArgoProtocolWREM3](unionArgoProtocolWREM3.html "Native representation of A/C IR message for WREM-3 remote.") type and while it semantically belongs to IrArgoAC_WREM3 class impl., it has not been pushed there, to avoid having to use a virtual function <ARGO_PROTOCOL_T>

◆ _

template<typename ARGO_PROTOCOL_T >

The raw protocol data.

◆ _irsend

template<typename ARGO_PROTOCOL_T >

instance of the IR send class

◆ _length

template<typename ARGO_PROTOCOL_T >

◆ _messageType

template<typename ARGO_PROTOCOL_T >

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

• src/ir_Argo.h
• src/ir_Argo.cpp