# IRremoteESP8266: src/ir_Sharp.h Source File

ir_Sharp.h
Go to the documentation of this file.
// Copyright 2019 crankyoldgit
// Supports:
// Brand: Sharp, Model: LC-52D62U TV
// Brand: Sharp, Model: AY-ZP40KR A/C (A907)
// Brand: Sharp, Model: AH-AxSAY A/C (A907)
// Brand: Sharp, Model: CRMC-A907 JBEZ remote (A907)
// Brand: Sharp, Model: AH-XP10NRY A/C (A907)
// Brand: Sharp, Model: CRMC-820 JBEZ remote (A907)
// Brand: Sharp, Model: CRMC-A705 JBEZ remote (A705)
#ifndef IR_SHARP_H_
#define IR_SHARP_H_
#ifndef UNIT_TEST
#include <Arduino.h>
#endif
#include "IRrecv.h"
#include "IRremoteESP8266.h"
#include "IRsend.h"
#ifdef UNIT_TEST
#include "IRsend_test.h"
#endif
#include "IRutils.h"
union SharpProtocol{
uint8_t raw[kSharpAcStateLength];
struct {
// Byte 0~3
uint8_t pad[4];
// Byte 4
uint8_t Temp :4;
uint8_t Model :1;
uint8_t :3;
// Byte 5
uint8_t :4;
uint8_t PowerSpecial :4;
// Byte 6
uint8_t Mode :2;
uint8_t :1;
uint8_t Clean :1;
uint8_t Fan :3;
uint8_t :1;
// Byte 7
uint8_t TimerHours :4;
uint8_t :2;
uint8_t TimerType :1;
uint8_t TimerEnabled:1;
// Byte 8
uint8_t Swing :3;
uint8_t :5;
// Byte 9
uint8_t :8;
// Byte 10
uint8_t Special :8;
// Byte 11
uint8_t :2;
uint8_t Ion :1;
uint8_t :1;
uint8_t A705:1;
uint8_t :3;
// Byte 12
uint8_t :4;
uint8_t Sum :4;
};
};
// Constants
const uint16_t kSharpAcHdrMark = 3800;
const uint16_t kSharpAcHdrSpace = 1900;
const uint16_t kSharpAcBitMark = 470;
const uint16_t kSharpAcZeroSpace = 500;
const uint16_t kSharpAcOneSpace = 1400;
const uint32_t kSharpAcGap = kDefaultMessageGap;
const uint8_t kSharpAcByteTemp = 4;
const uint8_t kSharpAcMinTemp = 15; // Celsius
const uint8_t kSharpAcMaxTemp = 30; // Celsius
const uint8_t kSharpAcPowerUnknown = 0; // 0b0000
const uint8_t kSharpAcPowerOnFromOff = 1; // 0b0001
const uint8_t kSharpAcPowerOff = 2; // 0b0010
const uint8_t kSharpAcPowerOn = 3; // 0b0011 (Normal)
const uint8_t kSharpAcPowerSetSpecialOn = 6; // 0b0110
const uint8_t kSharpAcPowerSetSpecialOff = 7; // 0b0111
const uint8_t kSharpAcPowerTimerSetting = 8; // 0b1000
const uint8_t kSharpAcAuto = 0b00; // A907 only
const uint8_t kSharpAcFan = 0b00; // A705 only
const uint8_t kSharpAcDry = 0b11;
const uint8_t kSharpAcCool = 0b10;
const uint8_t kSharpAcHeat = 0b01; // A907 only
const uint8_t kSharpAcFanAuto = 0b010; // 2
const uint8_t kSharpAcFanMin = 0b100; // 4 (FAN1)
const uint8_t kSharpAcFanMed = 0b011; // 3 (FAN2)
const uint8_t kSharpAcFanA705Low = 0b011; // 3
const uint8_t kSharpAcFanHigh = 0b101; // 5 (FAN3)
const uint8_t kSharpAcFanA705Med = 0b101; // 5
const uint8_t kSharpAcFanMax = 0b111; // 7 (FAN4)
const uint8_t kSharpAcTimerIncrement = 30; // Mins
const uint8_t kSharpAcTimerHoursOff = 0b0000;
const uint8_t kSharpAcTimerHoursMax = 0b1100; // 12
const uint8_t kSharpAcOffTimerType = 0b0;
const uint8_t kSharpAcOnTimerType = 0b1;
const uint8_t kSharpAcSwingToggle = 0b111;
const uint8_t kSharpAcSwingNoToggle = 0b000;
const uint8_t kSharpAcSpecialPower = 0x00;
const uint8_t kSharpAcSpecialTurbo = 0x01;
const uint8_t kSharpAcSpecialTempEcono = 0x04;
const uint8_t kSharpAcSpecialFan = 0x05;
const uint8_t kSharpAcSpecialSwing = 0x06;
const uint8_t kSharpAcSpecialTimer = 0xC0;
const uint8_t kSharpAcSpecialTimerHalfHour = 0xDE;
// Classes
class IRSharpAc {
public:
explicit IRSharpAc(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
#if SEND_SHARP_AC
void send(const uint16_t repeat = kSharpAcDefaultRepeat);
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_SHARP_AC
void begin(void);
void setModel(const sharp_ac_remote_model_t model);
sharp_ac_remote_model_t getModel(const bool raw = false) const;
void on(void);
void off(void);
void setPower(const bool on, const bool prev_on = true);
bool getPower(void) const;
bool isPowerSpecial(void) const;
void setTemp(const uint8_t temp, const bool save = true);
uint8_t getTemp(void) const;
void setFan(const uint8_t fan, const bool save = true);
uint8_t getFan(void) const;
void setMode(const uint8_t mode, const bool save = true);
uint8_t getMode(void) const;
void setSpecial(const uint8_t mode);
uint8_t getSpecial(void) const;
bool getTurbo(void) const;
void setTurbo(const bool on);
bool getSwingToggle(void) const;
void setSwingToggle(const bool on);
bool getIon(void) const;
void setIon(const bool on);
bool getEconoToggle(void) const;
void setEconoToggle(const bool on);
bool getLightToggle(void) const;
void setLightToggle(const bool on);
uint16_t getTimerTime(void) const;
bool getTimerEnabled(void) const;
bool getTimerType(void) const;
void setTimer(bool enable, bool timer_type, uint16_t mins);
bool getClean(void) const;
void setClean(const bool on);
uint8_t* getRaw(void);
void setRaw(const uint8_t new_code[],
const uint16_t length = kSharpAcStateLength);
static bool validChecksum(uint8_t state[],
const uint16_t length = kSharpAcStateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
stdAc::opmode_t toCommonMode(const uint8_t mode) const;
stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed) const;
stdAc::state_t toCommon(void) const;
String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend;
#else // UNIT_TEST
IRsendTest _irsend;
#endif // UNIT_TEST
SharpProtocol _;
uint8_t _temp;
uint8_t _mode;
uint8_t _fan;
sharp_ac_remote_model_t _model;
void stateReset(void);
void checksum(void);
static uint8_t calcChecksum(uint8_t state[],
const uint16_t length = kSharpAcStateLength);
void setPowerSpecial(const uint8_t value);
uint8_t getPowerSpecial(void) const;
void clearPowerSpecial(void);
bool _getEconoToggle(void) const;
void _setEconoToggle(const bool on);
};
#endif // IR_SHARP_H_
IRSharpAc::getEconoToggle
bool getEconoToggle(void) const
Get the Economical mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:585
kSharpAcHeat
const uint8_t kSharpAcHeat
Definition: ir_Sharp.h:103
kSharpAcSpecialTempEcono
const uint8_t kSharpAcSpecialTempEcono
Definition: ir_Sharp.h:123
IRSharpAc::calibrate
int8_t calibrate(void)
Run the calibration to calculate uSec timing offsets for this platform.
Definition: ir_Sharp.h:141
IRSharpAc::getLightToggle
bool getLightToggle(void) const
Get the Light toggle setting of the A/C.
Definition: ir_Sharp.cpp:600
IRSharpAc::setTimer
void setTimer(bool enable, bool timer_type, uint16_t mins)
Set or cancel the timer function.
Definition: ir_Sharp.cpp:629
IRSharpAc::setTemp
void setTemp(const uint8_t temp, const bool save=true)
Set the temperature.
Definition: ir_Sharp.cpp:416
kSharpAcPowerOnFromOff
const uint8_t kSharpAcPowerOnFromOff
Definition: ir_Sharp.h:92
IRSharpAc::off
void off(void)
Set the requested power state of the A/C to off.
Definition: ir_Sharp.cpp:368
kSharpAcOneSpace
const uint16_t kSharpAcOneSpace
Definition: ir_Sharp.h:84
stdAc::fanspeed_t
fanspeed_t
Common A/C settings for Fan Speeds.
Definition: IRsend.h:58
IRSharpAc::_temp
uint8_t _temp
Saved copy of the desired temp.
Definition: ir_Sharp.h:196
kDefaultMessageGap
const uint32_t kDefaultMessageGap
Definition: IRsend.h:41
IRSharpAc::calcChecksum
static uint8_t calcChecksum(uint8_t state[], const uint16_t length=kSharpAcStateLength)
Calculate the checksum for a given state.
Definition: ir_Sharp.cpp:262
kSharpAcFanA705Low
const uint8_t kSharpAcFanA705Low
Definition: ir_Sharp.h:107
IRSharpAc::toCommonFanSpeed
stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed) const
Convert a native fan speed into its stdAc equivalent.
Definition: ir_Sharp.cpp:717
kSharpAcSpecialTimer
const uint8_t kSharpAcSpecialTimer
Definition: ir_Sharp.h:126
kSharpAcOnTimerType
const uint8_t kSharpAcOnTimerType
Definition: ir_Sharp.h:116
kSharpAcCool
const uint8_t kSharpAcCool
Definition: ir_Sharp.h:102
IRsend.h
kSharpAcSpecialFan
const uint8_t kSharpAcSpecialFan
Definition: ir_Sharp.h:124
kSharpAcSpecialSwing
const uint8_t kSharpAcSpecialSwing
Definition: ir_Sharp.h:125
IRSharpAc::getIon
bool getIon(void) const
Get the Ion (Filter) setting of the A/C.
Definition: ir_Sharp.cpp:545
kSharpAcOffTimerType
const uint8_t kSharpAcOffTimerType
Definition: ir_Sharp.h:115
IRsend
Class for sending all basic IR protocols.
Definition: IRsend.h:182
kSharpAcMaxTemp
const uint8_t kSharpAcMaxTemp
Definition: ir_Sharp.h:89
IRSharpAc::setFan
void setFan(const uint8_t fan, const bool save=true)
Set the speed of the fan.
Definition: ir_Sharp.cpp:488
IRsend::calibrate
int8_t calibrate(uint16_t hz=38000U)
Calculate & set any offsets to account for execution times during sending.
Definition: IRsend.cpp:207
IRSharpAc::_model
sharp_ac_remote_model_t _model
Saved copy of the model.
Definition: ir_Sharp.h:199
IRSharpAc::IRSharpAc
IRSharpAc(const uint16_t pin, const bool inverted=false, const bool use_modulation=true)
Class constructor.
Definition: ir_Sharp.cpp:243
kSharpAcZeroSpace
const uint16_t kSharpAcZeroSpace
Definition: ir_Sharp.h:83
IRSharpAc::setPower
void setPower(const bool on, const bool prev_on=true)
Change the power setting, including the previous power state.
Definition: ir_Sharp.cpp:373
kSharpAcDry
const uint8_t kSharpAcDry
Definition: ir_Sharp.h:101
String
std::string String
Definition: IRremoteESP8266.h:1178
kSharpAcTimerHoursMax
const uint8_t kSharpAcTimerHoursMax
Definition: ir_Sharp.h:114
kSharpAcPowerOff
const uint8_t kSharpAcPowerOff
Definition: ir_Sharp.h:93
IRSharpAc::getFan
uint8_t getFan(void) const
Get the current fan speed setting.
Definition: ir_Sharp.cpp:508
SharpProtocol
Native representation of a Sharp A/C message.
Definition: ir_Sharp.h:37
kSharpAcSwingNoToggle
const uint8_t kSharpAcSwingNoToggle
Definition: ir_Sharp.h:119
kSharpAcTimerIncrement
const uint8_t kSharpAcTimerIncrement
Definition: ir_Sharp.h:112
IRremoteESP8266.h
kSharpAcPowerSetSpecialOn
const uint8_t kSharpAcPowerSetSpecialOn
Definition: ir_Sharp.h:95
SharpProtocol::A705
uint8_t A705
Definition: ir_Sharp.h:71
IRSharpAc::convertMode
static uint8_t convertMode(const stdAc::opmode_t mode)
Convert a stdAc::opmode_t enum into its native mode.
Definition: ir_Sharp.cpp:672
IRSharpAc::setTurbo
void setTurbo(const bool on)
Set the Turbo setting of the A/C.
Definition: ir_Sharp.cpp:524
IRSharpAc::setModel
void setModel(const sharp_ac_remote_model_t model)
Set the model of the A/C to emulate.
Definition: ir_Sharp.cpp:312
IRSharpAc::validChecksum
static bool validChecksum(uint8_t state[], const uint16_t length=kSharpAcStateLength)
Verify the checksum is valid for a given state.
Definition: ir_Sharp.cpp:273
kSharpAcSpecialTimerHalfHour
const uint8_t kSharpAcSpecialTimerHalfHour
Definition: ir_Sharp.h:127
kSharpAcTimerHoursOff
const uint8_t kSharpAcTimerHoursOff
Definition: ir_Sharp.h:113
IRSharpAc::getTurbo
bool getTurbo(void) const
Get the Turbo setting of the A/C.
Definition: ir_Sharp.cpp:514
SharpProtocol::Model
uint8_t Model
Definition: ir_Sharp.h:44
SharpProtocol::Clean
uint8_t Clean
Definition: ir_Sharp.h:52
SharpProtocol::TimerType
uint8_t TimerType
Definition: ir_Sharp.h:58
kSharpAcSwingToggle
const uint8_t kSharpAcSwingToggle
Definition: ir_Sharp.h:118
IRSharpAc::setPowerSpecial
void setPowerSpecial(const uint8_t value)
Set the value of the Power Special setting without any checks.
Definition: ir_Sharp.cpp:337
kSharpAcFanAuto
const uint8_t kSharpAcFanAuto
Definition: ir_Sharp.h:104
SharpProtocol::Ion
uint8_t Ion
Definition: ir_Sharp.h:69
IRSharpAc::send
void send(const uint16_t repeat=kSharpAcDefaultRepeat)
Send the current internal state as an IR message.
Definition: ir_Sharp.cpp:253
IRSharpAc::_irsend
IRsend _irsend
Instance of the IR send class.
Definition: ir_Sharp.h:189
IRSharpAc::checksum
void checksum(void)
Calculate and set the checksum values for the internal state.
Definition: ir_Sharp.cpp:279
kSharpAcGap
const uint32_t kSharpAcGap
Definition: ir_Sharp.h:85
IRSharpAc::isPowerSpecial
bool isPowerSpecial(void) const
Is one of the special power states in use?
Definition: ir_Sharp.cpp:355
IRSharpAc::getRaw
uint8_t * getRaw(void)
Get a PTR to the internal state/code for this protocol.
Definition: ir_Sharp.cpp:297
IRSharpAc::_getEconoToggle
bool _getEconoToggle(void) const
Get the Economical mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:560
IRSharpAc::getTemp
uint8_t getTemp(void) const
Get the current temperature setting.
Definition: ir_Sharp.cpp:442
kSharpAcPowerUnknown
const uint8_t kSharpAcPowerUnknown
Definition: ir_Sharp.h:91
IRrecv.h
kSharpAcPowerOn
const uint8_t kSharpAcPowerOn
Definition: ir_Sharp.h:94
IRSharpAc::getPowerSpecial
uint8_t getPowerSpecial(void) const
Get the value of the Power Special setting.
Definition: ir_Sharp.cpp:343
IRSharpAc::_setEconoToggle
void _setEconoToggle(const bool on)
Set the Economical mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:569
IRSharpAc::setSpecial
void setSpecial(const uint8_t mode)
Set the value of the Special (button/command?) setting.
Definition: ir_Sharp.cpp:393
IRSharpAc::begin
void begin(void)
Set up hardware to be able to send a message.
Definition: ir_Sharp.cpp:248
kSharpAcStateLength
const uint16_t kSharpAcStateLength
Definition: IRremoteESP8266.h:1059
kSharpAcFanMax
const uint8_t kSharpAcFanMax
Definition: ir_Sharp.h:110
IRutils.h
IRSharpAc::_mode
uint8_t _mode
Saved copy of the desired mode.
Definition: ir_Sharp.h:197
SharpProtocol::PowerSpecial
uint8_t PowerSpecial
Definition: ir_Sharp.h:48
IRSharpAc
Class for handling detailed Sharp A/C messages.
Definition: ir_Sharp.h:131
SharpProtocol::Sum
uint8_t Sum
Definition: ir_Sharp.h:75
IRSharpAc::getClean
bool getClean(void) const
Get the Clean setting of the A/C.
Definition: ir_Sharp.cpp:648
SharpProtocol::TimerEnabled
uint8_t TimerEnabled
Definition: ir_Sharp.h:59
SharpProtocol::Swing
uint8_t Swing
Definition: ir_Sharp.h:61
SharpProtocol::Special
uint8_t Special
Definition: ir_Sharp.h:66
kSharpAcPowerTimerSetting
const uint8_t kSharpAcPowerTimerSetting
Definition: ir_Sharp.h:97
kSharpAcFanHigh
const uint8_t kSharpAcFanHigh
Definition: ir_Sharp.h:108
kSharpAcFanMin
const uint8_t kSharpAcFanMin
Definition: ir_Sharp.h:105
IRSharpAc::setClean
void setClean(const bool on)
Set the Economical mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:655
IRSharpAc::toCommonMode
stdAc::opmode_t toCommonMode(const uint8_t mode) const
Convert a native mode into its stdAc equivalent.
Definition: ir_Sharp.cpp:699
IRSharpAc::getMode
uint8_t getMode(void) const
Get the operating mode setting of the A/C.
Definition: ir_Sharp.cpp:448
kSharpAcFan
const uint8_t kSharpAcFan
Definition: ir_Sharp.h:100
kSharpAcFanMed
const uint8_t kSharpAcFanMed
Definition: ir_Sharp.h:106
kSharpAcDefaultRepeat
const uint16_t kSharpAcDefaultRepeat
Definition: IRremoteESP8266.h:1061
IRSharpAc::getModel
sharp_ac_remote_model_t getModel(const bool raw=false) const
Get/Detect the model of the A/C.
Definition: ir_Sharp.cpp:328
IRSharpAc::getSpecial
uint8_t getSpecial(void) const
Get the value of the Special (button/command?) setting.
Definition: ir_Sharp.cpp:411
IRSharpAc::getTimerEnabled
bool getTimerEnabled(void) const
Is the Timer enabled?
Definition: ir_Sharp.cpp:614
IRSharpAc::getTimerType
bool getTimerType(void) const
Get the current timer type.
Definition: ir_Sharp.cpp:620
kSharpAcFanA705Med
const uint8_t kSharpAcFanA705Med
Definition: ir_Sharp.h:109
IRSharpAc::_fan
uint8_t _fan
Saved copy of the desired fan speed.
Definition: ir_Sharp.h:198
IRSharpAc::setEconoToggle
void setEconoToggle(const bool on)
Set the Economical mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:578
SharpProtocol::Mode
uint8_t Mode
Definition: ir_Sharp.h:50
IRSharpAc::toCommon
stdAc::state_t toCommon(void) const
Convert the current internal state into its stdAc::state_t equivalent.
Definition: ir_Sharp.cpp:738
SharpProtocol::TimerHours
uint8_t TimerHours
Definition: ir_Sharp.h:56
IRSharpAc::getTimerTime
uint16_t getTimerTime(void) const
Get how long the timer is set for, in minutes.
Definition: ir_Sharp.cpp:606
kSharpAcHdrSpace
const uint16_t kSharpAcHdrSpace
Definition: ir_Sharp.h:81
kSharpAcAuto
const uint8_t kSharpAcAuto
Definition: ir_Sharp.h:99
IRSharpAc::_
SharpProtocol _
Definition: ir_Sharp.h:195
IRSharpAc::setLightToggle
void setLightToggle(const bool on)
Set the Light mode toggle setting of the A/C.
Definition: ir_Sharp.cpp:593
IRSharpAc::setSwingToggle
void setSwingToggle(const bool on)
Set the (vertical) Swing Toggle setting of the A/C.
Definition: ir_Sharp.cpp:538
SharpProtocol::Fan
uint8_t Fan
Definition: ir_Sharp.h:53
kSharpAcPowerSetSpecialOff
const uint8_t kSharpAcPowerSetSpecialOff
Definition: ir_Sharp.h:96
IRSharpAc::on
void on(void)
Set the requested power state of the A/C to on.
Definition: ir_Sharp.cpp:365
IRSharpAc::getSwingToggle
bool getSwingToggle(void) const
Get the (vertical) Swing Toggle setting of the A/C.
Definition: ir_Sharp.cpp:532
IRSharpAc::setMode
void setMode(const uint8_t mode, const bool save=true)
Set the operating mode of the A/C.
Definition: ir_Sharp.cpp:455
IRSharpAc::getPower
bool getPower(void) const
Get the value of the current power setting.
Definition: ir_Sharp.cpp:383
kSharpAcBitMark
const uint16_t kSharpAcBitMark
Definition: ir_Sharp.h:82
SharpProtocol::raw
uint8_t raw[kSharpAcStateLength]
State of the remote in IR code form.
Definition: ir_Sharp.h:38
kSharpAcMinTemp
const uint8_t kSharpAcMinTemp
Definition: ir_Sharp.h:88
SharpProtocol::Temp
uint8_t Temp
Definition: ir_Sharp.h:43
kSharpAcSpecialTurbo
const uint8_t kSharpAcSpecialTurbo
Definition: ir_Sharp.h:122
IRSharpAc::stateReset
void stateReset(void)
Reset the state of the remote to a known good state/sequence.
Definition: ir_Sharp.cpp:284
kSharpAcByteTemp
const uint8_t kSharpAcByteTemp
Definition: ir_Sharp.h:87
IRSharpAc::setIon
void setIon(const bool on)
Set the Ion (Filter) setting of the A/C.
Definition: ir_Sharp.cpp:551
stdAc::state_t
Structure to hold a common A/C state.
Definition: IRsend.h:97
IRSharpAc::clearPowerSpecial
void clearPowerSpecial(void)
Clear the "special"/non-normal bits in the power section. e.g. for normal/common command modes.
Definition: ir_Sharp.cpp:349
kSharpAcHdrMark
const uint16_t kSharpAcHdrMark
Definition: ir_Sharp.h:80
IRSharpAc::setRaw
void setRaw(const uint8_t new_code[], const uint16_t length=kSharpAcStateLength)
Set the internal state from a valid code for this protocol.
Definition: ir_Sharp.cpp:305
kSharpAcSpecialPower
const uint8_t kSharpAcSpecialPower
Definition: ir_Sharp.h:121
SharpProtocol::pad
uint8_t pad[4]
Definition: ir_Sharp.h:41
sharp_ac_remote_model_t
sharp_ac_remote_model_t
Sharp A/C model numbers.
Definition: IRsend.h:152
IRSharpAc::toString
String toString(void) const
Convert the current internal state into a human readable string.
Definition: ir_Sharp.cpp:765
stdAc::opmode_t
opmode_t
Common A/C settings for A/C operating modes.
Definition: IRsend.h:46
IRSharpAc::convertFan
static uint8_t convertFan(const stdAc::fanspeed_t speed)
Convert a stdAc::fanspeed_t enum into it's native speed.
Definition: ir_Sharp.cpp:685