Class for handling detailed Daikin 312-bit A/C messages. More...

#include <ir_Daikin.h>

Collaboration diagram for IRDaikin312:

[legend]

Public Member Functions
	IRDaikin312 (const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
	Class constructor.

void	send (const uint16_t repeat=kDaikin312DefaultRepeat)
	Send the current internal state as an IR message.

int8_t	calibrate (void)
	Run the calibration to calculate uSec timing offsets for this platform.

void	begin (void)
	Set up hardware to be able to send a message.

void	on (void)
	Change the power setting to On.

void	off (void)
	Change the power setting to Off.

void	setPower (const bool state)
	Change the power setting.

bool	getPower (void) const
	Get the value of the current power setting.

void	setTemp (const float temp)
	Set the temperature.

float	getTemp (void) const
	Get the current temperature setting.

void	setFan (const uint8_t fan)
	Set the speed of the fan.

uint8_t	getFan (void) const
	Get the current fan speed setting.

uint8_t	getMode (void) const
	Get the operating mode setting of the A/C.

void	setMode (const uint8_t mode)
	Set the operating mode of the A/C.

void	setSwingVertical (const uint8_t position)
	Set the Vertical Swing mode of the A/C.

uint8_t	getSwingVertical (void) const
	Get the Vertical Swing mode of the A/C.

void	setSwingHorizontal (const uint8_t position)
	Set the Horizontal Swing mode of the A/C.

uint8_t	getSwingHorizontal (void) const
	Get the Horizontal Swing mode of the A/C.

bool	getQuiet (void) const
	Get the Quiet mode status of the A/C.

void	setQuiet (const bool on)
	Set the Quiet mode of the A/C.

bool	getPowerful (void) const
	Get the Powerful (Turbo) mode of the A/C.

void	setPowerful (const bool on)
	Set the Powerful (Turbo) mode of the A/C.

void	setEcono (const bool on)
	Set the Economy mode of the A/C.

bool	getEcono (void) const
	Get the Economical mode of the A/C.

void	setEye (const bool on)
	Set the Eye (Sensor) mode of the A/C.

bool	getEye (void) const
	Get the Eye (Sensor) mode status of the A/C.

void	setEyeAuto (const bool on)
	Set the Automatic Eye (Sensor) mode of the A/C.

bool	getEyeAuto (void) const
	Get the Automatic Eye (Sensor) mode status of the A/C.

void	setEyeTimer (const uint8_t duration)
	Set the Eye (Sensor) timer duration of the A/C.

uint8_t	getEyeTimer (void) const
	Get the Eye (Sensor) timer duration of the A/C.

void	setPurify (const bool on)
	Set the Purify (Filter) mode of the A/C.

bool	getPurify (void) const
	Get the Purify (Filter) mode status of the A/C.

void	setMold (const bool on)
	Set the Mould (filter) mode of the A/C.

bool	getMold (void) const
	Get the Mould (filter) mode status of the A/C.

void	enableOnTimer (const uint16_t starttime)
	Set the enable status & time of the On Timer.

void	disableOnTimer (void)
	Disable the On timer.

uint16_t	getOnTime (void) const
	Get the On Timer time to be sent to the A/C unit.

bool	getOnTimerEnabled (void) const
	Get the enable status of the On Timer.

void	enableSleepTimer (const uint16_t sleeptime)
	Set the enable status & time of the Sleep Timer.

void	disableSleepTimer (void)
	Disable the sleep timer.

uint16_t	getSleepTime (void) const
	Get the Sleep Timer time to be sent to the A/C unit.

bool	getSleepTimerEnabled (void) const
	Get the Sleep timer enabled status of the A/C.

void	enableOffTimer (const uint16_t endtime)
	Set the enable status & time of the Off Timer.

void	disableOffTimer (void)
	Disable the Off timer.

uint16_t	getOffTime (void) const
	Get the Off Timer time to be sent to the A/C unit.

bool	getOffTimerEnabled (void) const
	Get the enable status of the Off Timer.

void	setCurrentTime (const uint16_t time)
	Set the clock on the A/C unit.

uint16_t	getCurrentTime (void) const
	Get the clock time to be sent to the A/C unit.

void	setBeep (const uint8_t beep)
	Set the Beep mode of the A/C.

uint8_t	getBeep (void) const
	Get the Beep status of the A/C.

void	setLight (const uint8_t light)
	Set the Light (LED) mode of the A/C.

uint8_t	getLight (void) const
	Get the Light status of the A/C.

void	setAnnounce (const uint8_t category)
	Set the verbal announcement item. The AC uses this to decide what state update to read aloud after receiving a command. Note that you will not hear the announcement if setBeep is set to kDaikinBeepOff. Additionally, the AC does not announce the mode (e.g., cool, heat) and simply beeps if it didn't change. Invalid item (e.g., kDaikin312AnnouncePower for operations other than powering off) will be ignored (AC simply beeps).

uint8_t	getAnnounce (void) const
	Get the current announce category.

void	setClean (const bool on)
	Set the Auto clean mode of the A/C.

bool	getClean (void) const
	Get the Auto Clean mode status of the A/C.

void	setFreshAir (const bool on)
	Set the Fresh Air mode of the A/C.

bool	getFreshAir (void) const
	Get the Fresh Air mode status of the A/C.

void	setFreshAirHigh (const bool on)
	Set the (High) Fresh Air mode of the A/C.

bool	getFreshAirHigh (void) const
	Get the (High) Fresh Air mode status of the A/C.

uint8_t	getHumidity (void) const
	Get the Humidity percentage setting of the A/C.

void	setHumidity (const uint8_t percent)
	Set the Humidity percentage setting of the A/C.

uint8_t *	getRaw (void)
	Get a PTR to the internal state/code for this protocol.

void	setRaw (const uint8_t new_code[])
	Set the internal state from a valid code for this protocol.

stdAc::state_t	toCommon (void) const
	Convert the current internal state into its stdAc::state_t equivalent.

String	toString (void) const
	Convert the current internal state into a human readable string.

Static Public Member Functions
static bool	validChecksum (uint8_t state[], const uint16_t length=kDaikin312StateLength)
	Verify the checksum is valid for a given state.

static uint8_t	convertMode (const stdAc::opmode_t mode)
	Convert a stdAc::opmode_t enum into its native mode.

static uint8_t	convertFan (const stdAc::fanspeed_t speed)
	Convert a stdAc::fanspeed_t enum into it's native speed.

static uint8_t	convertSwingV (const stdAc::swingv_t position)
	Convert a stdAc::swingv_t enum into it's native setting.

static uint8_t	convertSwingH (const stdAc::swingh_t position)
	Convert a stdAc::swingh_t enum into it's native setting.

static stdAc::swingv_t	toCommonSwingV (const uint8_t setting)
	Convert a native vertical swing postion to it's common equivalent.

static stdAc::swingh_t	toCommonSwingH (const uint8_t setting)
	Convert a native horizontal swing postion to it's common equivalent.

Private Member Functions
void	stateReset (void)
	Reset the internal state to a fixed known good state.

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

void	clearOnTimerFlag (void)
	Clear the On Timer flag.

void	clearSleepTimerFlag (void)
	Clear the sleep timer flag.

Private Attributes
IRsend	_irsend
	instance of the IR send class

Daikin312Protocol	_

Detailed Description

Class for handling detailed Daikin 312-bit A/C messages.

Note: Code by crankyoldgit, Reverse engineering analysis by AntonWert

Constructor & Destructor Documentation

◆ IRDaikin312()

IRDaikin312::IRDaikin312	(	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?

Member Function Documentation

◆ begin()

void IRDaikin312::begin ( void )

Set up hardware to be able to send a message.

◆ calibrate()

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

private

Calculate and set the checksum values for the internal state.

◆ clearOnTimerFlag()

void IRDaikin312::clearOnTimerFlag ( void )

private

Clear the On Timer flag.

◆ clearSleepTimerFlag()

void IRDaikin312::clearSleepTimerFlag ( void )

private

Clear the sleep timer flag.

◆ convertFan()

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

static

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

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

static

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.

◆ convertSwingH()

uint8_t IRDaikin312::convertSwingH ( const stdAc::swingh_t position )

static

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

Parameters

[in] position The enum to be converted.

Returns: The native equivalent of the enum.

◆ convertSwingV()

uint8_t IRDaikin312::convertSwingV ( const stdAc::swingv_t position )

static

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.

◆ disableOffTimer()

void IRDaikin312::disableOffTimer ( void )

Disable the Off timer.

◆ disableOnTimer()

void IRDaikin312::disableOnTimer ( void )

Disable the On timer.

◆ disableSleepTimer()

void IRDaikin312::disableSleepTimer ( void )

Disable the sleep timer.

◆ enableOffTimer()

void IRDaikin312::enableOffTimer ( const uint16_t endtime )

Set the enable status & time of the Off Timer.

Parameters

[in] endtime The number of minutes past midnight.

◆ enableOnTimer()

void IRDaikin312::enableOnTimer ( const uint16_t starttime )

Set the enable status & time of the On Timer.

Parameters

[in] starttime The number of minutes past midnight.

Note: Timer location is shared with sleep timer.

◆ enableSleepTimer()

void IRDaikin312::enableSleepTimer ( const uint16_t sleeptime )

Set the enable status & time of the Sleep Timer.

Parameters

[in] sleeptime The number of minutes past midnight.

Note: The Timer location is shared with On Timer.

◆ getAnnounce()

uint8_t IRDaikin312::getAnnounce ( void ) const

Get the current announce category.

Returns: A kDaikin312Announce* constant, or kDaikin312AnnounceDisable if disabled.

◆ getBeep()

uint8_t IRDaikin312::getBeep ( void ) const

Get the Beep status of the A/C.

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

◆ getClean()

bool IRDaikin312::getClean ( void ) const

Get the Auto Clean mode status of the A/C.

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

◆ getCurrentTime()

uint16_t IRDaikin312::getCurrentTime ( void ) const

Get the clock time to be sent to the A/C unit.

Returns: The number of minutes past midnight.

◆ getEcono()

bool IRDaikin312::getEcono ( void ) const

Get the Economical mode of the A/C.

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

◆ getEye()

bool IRDaikin312::getEye ( void ) const

Get the Eye (Sensor) mode status of the A/C.

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

◆ getEyeAuto()

bool IRDaikin312::getEyeAuto ( void ) const

Get the Automatic Eye (Sensor) mode status of the A/C.

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

◆ getEyeTimer()

uint8_t IRDaikin312::getEyeTimer ( void ) const

Get the Eye (Sensor) timer duration of the A/C.

Returns: kDaikin312EyeTimerOff, kDaikin312EyeTimer1Hr, or kDaikin312EyeTimer3Hr.

◆ getFan()

uint8_t IRDaikin312::getFan ( void ) const

Get the current fan speed setting.

Returns: The current fan speed.

◆ getFreshAir()

bool IRDaikin312::getFreshAir ( void ) const

Get the Fresh Air mode status of the A/C.

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

◆ getFreshAirHigh()

bool IRDaikin312::getFreshAirHigh ( void ) const

Get the (High) Fresh Air mode status of the A/C.

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

◆ getHumidity()

uint8_t IRDaikin312::getHumidity ( void ) const

Get the Humidity percentage setting of the A/C.

Returns: The setting percentage. 255 is Automatic. 0 is Off.

◆ getLight()

uint8_t IRDaikin312::getLight ( void ) const

Get the Light status of the A/C.

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

◆ getMode()

uint8_t IRDaikin312::getMode ( void ) const

Get the operating mode setting of the A/C.

Returns: The current operating mode setting.

◆ getMold()

bool IRDaikin312::getMold ( void ) const

Get the Mould (filter) mode status of the A/C.

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

◆ getOffTime()

uint16_t IRDaikin312::getOffTime ( void ) const

Get the Off Timer time to be sent to the A/C unit.

Returns: The number of minutes past midnight.

◆ getOffTimerEnabled()

bool IRDaikin312::getOffTimerEnabled ( void ) const

Get the enable status of the Off Timer.

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

◆ getOnTime()

uint16_t IRDaikin312::getOnTime ( void ) const

Get the On Timer time to be sent to the A/C unit.

Returns: The number of minutes past midnight.

◆ getOnTimerEnabled()

bool IRDaikin312::getOnTimerEnabled ( void ) const

Get the enable status of the On Timer.

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

◆ getPower()

bool IRDaikin312::getPower ( void ) const

Get the value of the current power setting.

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

◆ getPowerful()

bool IRDaikin312::getPowerful ( void ) const

Get the Powerful (Turbo) mode of the A/C.

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

◆ getPurify()

bool IRDaikin312::getPurify ( void ) const

Get the Purify (Filter) mode status of the A/C.

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

◆ getQuiet()

bool IRDaikin312::getQuiet ( void ) const

Get the Quiet mode status of the A/C.

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

◆ getRaw()

uint8_t * IRDaikin312::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.

◆ getSleepTime()

uint16_t IRDaikin312::getSleepTime ( void ) const

Get the Sleep Timer time to be sent to the A/C unit.

Returns: The number of minutes past midnight.

◆ getSleepTimerEnabled()

bool IRDaikin312::getSleepTimerEnabled ( void ) const

Get the Sleep timer enabled status of the A/C.

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

◆ getSwingHorizontal()

uint8_t IRDaikin312::getSwingHorizontal ( void ) const

Get the Horizontal Swing mode of the A/C.

Returns: The native position/mode setting.

◆ getSwingVertical()

uint8_t IRDaikin312::getSwingVertical ( void ) const

Get the Vertical Swing mode of the A/C.

Returns: The native position/mode setting.

◆ getTemp()

float IRDaikin312::getTemp ( void ) const

Get the current temperature setting.

Returns: The current setting for temp. in degrees celsius.

◆ off()

void IRDaikin312::off ( void )

Change the power setting to Off.

◆ on()

void IRDaikin312::on ( void )

Change the power setting to On.

◆ send()

void IRDaikin312::send ( const uint16_t repeat = kDaikin312DefaultRepeat )

Send the current internal state as an IR message.

Parameters

[in] repeat Nr. of times the message will be repeated.

◆ setAnnounce()

void IRDaikin312::setAnnounce ( const uint8_t item )

Set the verbal announcement item. The AC uses this to decide what state update to read aloud after receiving a command. Note that you will not hear the announcement if setBeep is set to kDaikinBeepOff. Additionally, the AC does not announce the mode (e.g., cool, heat) and simply beeps if it didn't change. Invalid item (e.g., kDaikin312AnnouncePower for operations other than powering off) will be ignored (AC simply beeps).

Parameters

[in] item A kDaikin312Announce* constant. kDaikin312AnnounceDisable disables the announcement.

◆ setBeep()

void IRDaikin312::setBeep ( const uint8_t beep )

Set the Beep mode of the A/C.

Parameters

[in] beep true, the setting is on. false, the setting is off.

◆ setClean()

void IRDaikin312::setClean ( const bool on )

Set the Auto clean mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setCurrentTime()

void IRDaikin312::setCurrentTime ( const uint16_t numMins )

Set the clock on the A/C unit.

Parameters

[in] numMins Nr. of minutes past midnight.

◆ setEcono()

void IRDaikin312::setEcono ( const bool on )

Set the Economy mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setEye()

void IRDaikin312::setEye ( const bool on )

Set the Eye (Sensor) mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setEyeAuto()

void IRDaikin312::setEyeAuto ( const bool on )

Set the Automatic Eye (Sensor) mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setEyeTimer()

void IRDaikin312::setEyeTimer ( const uint8_t duration )

Set the Eye (Sensor) timer duration of the A/C.

Parameters

[in] duration kDaikin312EyeTimerOff, kDaikin312EyeTimer1Hr, or kDaikin312EyeTimer3Hr.

◆ setFan()

void IRDaikin312::setFan ( const uint8_t fan )

Set the speed of the fan.

Parameters

[in] fan The desired setting.

Note: 1-5 or kDaikinFanAuto or kDaikinFanQuiet

◆ setFreshAir()

void IRDaikin312::setFreshAir ( const bool on )

Set the Fresh Air mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setFreshAirHigh()

void IRDaikin312::setFreshAirHigh ( const bool on )

Set the (High) Fresh Air mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setHumidity()

void IRDaikin312::setHumidity ( const uint8_t percent )

Set the Humidity percentage setting of the A/C.

Parameters

[in] percent Percentage humidty. 255 is Auto. 0 is Off.

Note: Only available in Dry & Heat modes, otherwise it is Off.

◆ setLight()

void IRDaikin312::setLight ( const uint8_t light )

Set the Light (LED) mode of the A/C.

Parameters

[in] light true, the setting is on. false, the setting is off.

◆ setMode()

void IRDaikin312::setMode ( const uint8_t desired_mode )

Set the operating mode of the A/C.

Parameters

[in] desired_mode The desired operating mode.

◆ setMold()

void IRDaikin312::setMold ( const bool on )

Set the Mould (filter) mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setPower()

void IRDaikin312::setPower ( const bool on )

Change the power setting.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setPowerful()

void IRDaikin312::setPowerful ( const bool on )

Set the Powerful (Turbo) mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setPurify()

void IRDaikin312::setPurify ( const bool on )

Set the Purify (Filter) mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setQuiet()

void IRDaikin312::setQuiet ( const bool on )

Set the Quiet mode of the A/C.

Parameters

[in] on true, the setting is on. false, the setting is off.

◆ setRaw()

void IRDaikin312::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.

◆ setSwingHorizontal()

void IRDaikin312::setSwingHorizontal ( const uint8_t position )

Set the Horizontal Swing mode of the A/C.

Parameters

[in] position The position/mode to set the swing to.

◆ setSwingVertical()

void IRDaikin312::setSwingVertical ( const uint8_t position )

Set the Vertical Swing mode of the A/C.

Parameters

[in] position The position/mode to set the swing to.

◆ setTemp()

void IRDaikin312::setTemp ( const float desired )

Set the temperature.

Parameters

[in] desired The temperature in degrees celsius.

Note: The temperature is used in half degrees, so multiply by 2

◆ stateReset()

void IRDaikin312::stateReset ( void )

private

Reset the internal state to a fixed known good state.

◆ toCommon()

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

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

Returns: The stdAc equivalent of the native settings.

◆ toCommonSwingH()

stdAc::swingh_t IRDaikin312::toCommonSwingH ( const uint8_t setting )

static

Convert a native horizontal swing postion to it's common equivalent.

Parameters

[in] setting A native position to convert.

Returns: The common horizontal swing position.

◆ toCommonSwingV()

stdAc::swingv_t IRDaikin312::toCommonSwingV ( const uint8_t setting )

static

Convert a native vertical swing postion to it's common equivalent.

Parameters

[in] setting A native position to convert.

Returns: The common vertical swing position.

◆ toString()

String IRDaikin312::toString ( void ) const

Convert the current internal state into a human readable string.

Returns: A human readable string.

◆ validChecksum()

bool IRDaikin312::validChecksum	(	uint8_t	state[],
		const uint16_t	length = `kDaikin312StateLength`
	)

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.

Member Data Documentation

◆ _

Daikin312Protocol IRDaikin312::_

private

◆ _irsend

IRsend IRDaikin312::_irsend

private

instance of the IR send class

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

include/ir_Daikin.h
src/ir_Daikin.cpp

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ IRDaikin312()

Member Function Documentation

◆ begin()

◆ calibrate()

◆ checksum()

◆ clearOnTimerFlag()

◆ clearSleepTimerFlag()

◆ convertFan()

◆ convertMode()

◆ convertSwingH()

◆ convertSwingV()

◆ disableOffTimer()

◆ disableOnTimer()

◆ disableSleepTimer()

◆ enableOffTimer()

◆ enableOnTimer()

◆ enableSleepTimer()

◆ getAnnounce()

◆ getBeep()

◆ getClean()

◆ getCurrentTime()

◆ getEcono()

◆ getEye()

◆ getEyeAuto()

◆ getEyeTimer()

◆ getFan()

◆ getFreshAir()

◆ getFreshAirHigh()

◆ getHumidity()

◆ getLight()

◆ getMode()

◆ getMold()

◆ getOffTime()

◆ getOffTimerEnabled()

◆ getOnTime()

◆ getOnTimerEnabled()

◆ getPower()

◆ getPowerful()

◆ getPurify()

◆ getQuiet()

◆ getRaw()

◆ getSleepTime()

◆ getSleepTimerEnabled()

◆ getSwingHorizontal()

◆ getSwingVertical()

◆ getTemp()

◆ off()

◆ on()

◆ send()

◆ setAnnounce()

◆ setBeep()

◆ setClean()

◆ setCurrentTime()

◆ setEcono()

◆ setEye()

◆ setEyeAuto()

◆ setEyeTimer()

◆ setFan()

◆ setFreshAir()

◆ setFreshAirHigh()

◆ setHumidity()

◆ setLight()

◆ setMode()

◆ setMold()

◆ setPower()

◆ setPowerful()

◆ setPurify()

◆ setQuiet()

◆ setRaw()

◆ setSwingHorizontal()

◆ setSwingVertical()

◆ setTemp()

◆ stateReset()

◆ toCommon()