mirrors
/
Tasmota
mirror of https://github.com/arendst/Tasmota.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Tasmota/lib/lib_basic/IRremoteESP8266/src/ir_Hitachi.h

479 lines
17 KiB
C++
Raw Blame History

// Copyright 2018-2020 David Conran
/// @file
/// @brief Support for Hitachi A/C protocols.
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/417
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/453
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/973
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/1056
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/1060
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/1134
// Supports:
// Brand: Hitachi, Model: RAS-35THA6 remote
// Brand: Hitachi, Model: LT0541-HTA remote (HITACHI_AC1)
// Brand: Hitachi, Model: Series VI A/C (Circa 2007) (HITACHI_AC1)
// Brand: Hitachi, Model: RAR-8P2 remote (HITACHI_AC424)
// Brand: Hitachi, Model: RAS-AJ25H A/C (HITACHI_AC424)
// Brand: Hitachi, Model: PC-LH3B (HITACHI_AC3)
// Brand: Hitachi, Model: KAZE-312KSDP A/C (HITACHI_AC1)
// Brand: Hitachi, Model: R-LT0541-HTA/Y.K.1.1-1 V2.3 remote (HITACHI_AC1)
// Brand: Hitachi, Model: RAS-22NK A/C (HITACHI_AC344)
// Brand: Hitachi, Model: RF11T1 remote (HITACHI_AC344)
#ifndef IR_HITACHI_H_
#define IR_HITACHI_H_
#define __STDC_LIMIT_MACROS
#include <stdint.h>
#ifndef UNIT_TEST
#include <Arduino.h>
#endif
#include "IRremoteESP8266.h"
#include "IRsend.h"
#ifdef UNIT_TEST
#include "IRsend_test.h"
#endif
/// Native representation of a Hitachi 224-bit A/C message.
union HitachiProtocol{
uint8_t raw[kHitachiAcStateLength]; ///< The state in native code.
struct {
// Byte 0~9
uint8_t pad0[10];
// Byte 10
uint8_t Mode :8;
// Byte 11
uint8_t Temp :8;
// Byte 12
uint8_t :8;
// Byte 13
uint8_t Fan :8;
// Byte 14
uint8_t :7;
uint8_t SwingV :1;
// Byte 15
uint8_t :7;
uint8_t SwingH :1;
// Byte 16
uint8_t :8;
// Byte 17
uint8_t Power :1;
uint8_t :7;
// Byte 18~26
uint8_t pad1[9];
// Byte 27
uint8_t Sum :8;
};
};
// Constants
const uint16_t kHitachiAcFreq = 38000; // Hz.
const uint8_t kHitachiAcAuto = 2;
const uint8_t kHitachiAcHeat = 3;
const uint8_t kHitachiAcCool = 4;
const uint8_t kHitachiAcDry = 5;
const uint8_t kHitachiAcFan = 0xC;
const uint8_t kHitachiAcFanAuto = 1;
const uint8_t kHitachiAcFanLow = 2;
const uint8_t kHitachiAcFanMed = 3;
const uint8_t kHitachiAcFanHigh = 5;
const uint8_t kHitachiAcMinTemp = 16; // 16C
const uint8_t kHitachiAcMaxTemp = 32; // 32C
const uint8_t kHitachiAcAutoTemp = 23; // 23C
/// Native representation of a Hitachi 53-byte/424-bit A/C message.
union Hitachi424Protocol{
uint8_t raw[kHitachiAc424StateLength]; ///< The state in native code
struct {
// Byte 0~10
uint8_t pad0[11];
// Byte 11
uint8_t Button :8;
// Byte 12
uint8_t :8;
// Byte 13
uint8_t :2;
uint8_t Temp :6;
// Byte 14~24
uint8_t pad1[11];
// Byte 25
uint8_t Mode :4;
uint8_t Fan :4;
// Byte 26
uint8_t :8;
// Byte 27
uint8_t Power :8;
// Byte 28~34
uint8_t pad2[7];
// Byte 35
uint8_t SwingH :3;
uint8_t :5;
// Byte 36
uint8_t :8;
// Byte 37
uint8_t :5;
uint8_t SwingV :1;
uint8_t :2;
};
};
// HitachiAc424 & HitachiAc344
const uint8_t kHitachiAc424ButtonPowerMode = 0x13;
const uint8_t kHitachiAc424ButtonFan = 0x42;
const uint8_t kHitachiAc424ButtonTempDown = 0x43;
const uint8_t kHitachiAc424ButtonTempUp = 0x44;
const uint8_t kHitachiAc424ButtonSwingV = 0x81;
const uint8_t kHitachiAc424ButtonSwingH = 0x8C;
const uint8_t kHitachiAc344ButtonPowerMode = kHitachiAc424ButtonPowerMode;
const uint8_t kHitachiAc344ButtonFan = kHitachiAc424ButtonFan;
const uint8_t kHitachiAc344ButtonTempDown = kHitachiAc424ButtonTempDown;
const uint8_t kHitachiAc344ButtonTempUp = kHitachiAc424ButtonTempUp;
const uint8_t kHitachiAc344ButtonSwingV = kHitachiAc424ButtonSwingV;
const uint8_t kHitachiAc344ButtonSwingH = kHitachiAc424ButtonSwingH;
const uint8_t kHitachiAc424MinTemp = 16; // 16C
const uint8_t kHitachiAc424MaxTemp = 32; // 32C
const uint8_t kHitachiAc344MinTemp = kHitachiAc424MinTemp;
const uint8_t kHitachiAc344MaxTemp = kHitachiAc424MaxTemp;
const uint8_t kHitachiAc424FanTemp = 27; // 27C
const uint8_t kHitachiAc424Fan = 1;
const uint8_t kHitachiAc424Cool = 3;
const uint8_t kHitachiAc424Dry = 5;
const uint8_t kHitachiAc424Heat = 6;
const uint8_t kHitachiAc344Fan = kHitachiAc424Fan;
const uint8_t kHitachiAc344Cool = kHitachiAc424Cool;
const uint8_t kHitachiAc344Dry = kHitachiAc424Dry;
const uint8_t kHitachiAc344Heat = kHitachiAc424Heat;
const uint8_t kHitachiAc424FanMin = 1;
const uint8_t kHitachiAc424FanLow = 2;
const uint8_t kHitachiAc424FanMedium = 3;
const uint8_t kHitachiAc424FanHigh = 4;
const uint8_t kHitachiAc424FanAuto = 5;
const uint8_t kHitachiAc424FanMax = 6;
const uint8_t kHitachiAc424FanMaxDry = 2;
const uint8_t kHitachiAc344FanMin = kHitachiAc424FanMin;
const uint8_t kHitachiAc344FanLow = kHitachiAc424FanLow;
const uint8_t kHitachiAc344FanMedium = kHitachiAc424FanMedium;
const uint8_t kHitachiAc344FanHigh = kHitachiAc424FanHigh;
const uint8_t kHitachiAc344FanAuto = kHitachiAc424FanAuto;
const uint8_t kHitachiAc344FanMax = kHitachiAc424FanMax;
const uint8_t kHitachiAc424PowerOn = 0xF1;
const uint8_t kHitachiAc424PowerOff = 0xE1;
const uint8_t kHitachiAc344SwingHAuto = 0; // 0b000
const uint8_t kHitachiAc344SwingHRightMax = 1; // 0b001
const uint8_t kHitachiAc344SwingHRight = 2; // 0b010
const uint8_t kHitachiAc344SwingHMiddle = 3; // 0b011
const uint8_t kHitachiAc344SwingHLeft = 4; // 0b100
const uint8_t kHitachiAc344SwingHLeftMax = 5; // 0b101
/// Native representation of a Hitachi 104-bit A/C message.
union Hitachi1Protocol{
uint8_t raw[kHitachiAc1StateLength]; ///< The state in native code.
struct {
// Byte 0~2
uint8_t pad[3];
// Byte 3
uint8_t :6;
uint8_t Model :2;
// Byte 4
uint8_t :8;
// Byte 5
uint8_t Fan :4;
uint8_t Mode :4;
// Byte 6
uint8_t :2;
uint8_t Temp :5; // stored in LSB order.
uint8_t :1;
// Byte 7
uint8_t OffTimerLow :8; // nr. of minutes
// Byte 8
uint8_t OffTimerHigh :8; // & in LSB order.
// Byte 9
uint8_t OnTimerLow :8; // nr. of minutes
// Byte 10
uint8_t OnTimerHigh :8; // & in LSB order.
// Byte 11
uint8_t SwingToggle :1;
uint8_t Sleep :3;
uint8_t PowerToggle :1;
uint8_t Power :1;
uint8_t SwingV :1;
uint8_t SwingH :1;
// Byte 12
uint8_t Sum :8;
};
};
// HitachiAc1
// Model
const uint8_t kHitachiAc1Model_A = 0b10;
const uint8_t kHitachiAc1Model_B = 0b01;
// Mode & Fan
const uint8_t kHitachiAc1Dry = 0b0010; // 2
const uint8_t kHitachiAc1Fan = 0b0100; // 4
const uint8_t kHitachiAc1Cool = 0b0110; // 6
const uint8_t kHitachiAc1Heat = 0b1001; // 9
const uint8_t kHitachiAc1Auto = 0b1110; // 14
const uint8_t kHitachiAc1FanAuto = 1; // 0b0001
const uint8_t kHitachiAc1FanHigh = 2; // 0b0010
const uint8_t kHitachiAc1FanMed = 4; // 0b0100
const uint8_t kHitachiAc1FanLow = 8; // 0b1000
// Temp
const uint8_t kHitachiAc1TempSize = 5; // Mask 0b01111100
const uint8_t kHitachiAc1TempDelta = 7;
const uint8_t kHitachiAc1TempAuto = 25; // Celsius
// Timer
const uint8_t kHitachiAc1TimerSize = 16; // Mask 0b1111111111111111
// Sleep
const uint8_t kHitachiAc1SleepOff = 0b000;
const uint8_t kHitachiAc1Sleep1 = 0b001;
const uint8_t kHitachiAc1Sleep2 = 0b010;
const uint8_t kHitachiAc1Sleep3 = 0b011;
const uint8_t kHitachiAc1Sleep4 = 0b100;
// Checksum
const uint8_t kHitachiAc1ChecksumStartByte = 5;
// Classes
/// Class for handling detailed Hitachi 224-bit A/C messages.
/// @see https://github.com/ToniA/arduino-heatpumpir/blob/master/HitachiHeatpumpIR.cpp
class IRHitachiAc {
public:
explicit IRHitachiAc(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_HITACHI_AC
void send(const uint16_t repeat = kHitachiAcDefaultRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return 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.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_HITACHI_AC
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void) const;
void setTemp(const uint8_t temp);
uint8_t getTemp(void) const;
void setFan(const uint8_t speed);
uint8_t getFan(void) const;
void setMode(const uint8_t mode);
uint8_t getMode(void) const;
void setSwingVertical(const bool on);
bool getSwingVertical(void) const;
void setSwingHorizontal(const bool on);
bool getSwingHorizontal(void) const;
uint8_t* getRaw(void);
void setRaw(const uint8_t new_code[],
const uint16_t length = kHitachiAcStateLength);
static bool validChecksum(const uint8_t state[],
const uint16_t length = kHitachiAcStateLength);
static uint8_t calcChecksum(const uint8_t state[],
const uint16_t length = kHitachiAcStateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
stdAc::state_t toCommon(void) const;
String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
HitachiProtocol _;
void checksum(const uint16_t length = kHitachiAcStateLength);
uint8_t _previoustemp;
};
/// Class for handling detailed Hitachi 104-bit A/C messages.
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/1056
class IRHitachiAc1 {
public:
explicit IRHitachiAc1(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_HITACHI_AC1
void send(const uint16_t repeat = kHitachiAcDefaultRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return 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.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_HITACHI_AC1
void begin(void);
void on(void);
void off(void);
void setModel(const hitachi_ac1_remote_model_t model);
hitachi_ac1_remote_model_t getModel(void) const;
void setPower(const bool on);
bool getPower(void) const;
void setPowerToggle(const bool on);
bool getPowerToggle(void) const;
void setTemp(const uint8_t temp);
uint8_t getTemp(void) const;
void setFan(const uint8_t speed, const bool force = false);
uint8_t getFan(void) const;
void setMode(const uint8_t mode);
uint8_t getMode(void) const;
void setSwingToggle(const bool toggle);
bool getSwingToggle(void) const;
void setSwingV(const bool on);
bool getSwingV(void) const;
void setSwingH(const bool on);
bool getSwingH(void) const;
void setSleep(const uint8_t mode);
uint8_t getSleep(void) const;
void setOnTimer(const uint16_t mins);
uint16_t getOnTimer(void) const;
void setOffTimer(const uint16_t mins);
uint16_t getOffTimer(void) const;
uint8_t* getRaw(void);
void setRaw(const uint8_t new_code[],
const uint16_t length = kHitachiAc1StateLength);
static bool validChecksum(const uint8_t state[],
const uint16_t length = kHitachiAc1StateLength);
static uint8_t calcChecksum(const uint8_t state[],
const uint16_t length = kHitachiAc1StateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
stdAc::state_t toCommon(void) const;
String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
Hitachi1Protocol _;
void checksum(const uint16_t length = kHitachiAc1StateLength);
};
/// Class for handling detailed Hitachi 53-byte/424-bit A/C messages.
class IRHitachiAc424 {
friend class IRHitachiAc344;
public:
explicit IRHitachiAc424(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
virtual void stateReset(void);
#if SEND_HITACHI_AC424
virtual void send(const uint16_t repeat = kHitachiAcDefaultRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return 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.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_HITACHI_AC424
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void) const;
void setTemp(const uint8_t temp, bool setPrevious = true);
uint8_t getTemp(void) const;
void setFan(const uint8_t speed);
uint8_t getFan(void) const;
uint8_t getButton(void) const;
void setButton(const uint8_t button);
void setSwingVToggle(const bool on);
bool getSwingVToggle(void) const;
void setMode(const uint8_t mode);
uint8_t getMode(void) const;
uint8_t* getRaw(void);
virtual void setRaw(const uint8_t new_code[],
const uint16_t length = kHitachiAc424StateLength);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
virtual stdAc::state_t toCommon(void) const;
virtual String toString(void) const;
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
Hitachi424Protocol _;
void setInvertedStates(void);
String _toString(void) const;
uint8_t _previoustemp;
};
/// Class for handling detailed Hitachi 15to27-byte/120to216-bit A/C messages.
class IRHitachiAc3 {
public:
explicit IRHitachiAc3(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_HITACHI_AC3
void send(const uint16_t repeat = kHitachiAcDefaultRepeat);
/// Run the calibration to calculate uSec timing offsets for this platform.
/// @return 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.
int8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_HITACHI_AC3
void begin(void);
uint8_t getMode(void);
uint8_t* getRaw(void);
void setRaw(const uint8_t new_code[],
const uint16_t length = kHitachiAc3StateLength);
static bool hasInvertedStates(const uint8_t state[], const uint16_t length);
#ifndef UNIT_TEST
private:
IRsend _irsend; ///< Instance of the IR send class
#else // UNIT_TEST
/// @cond IGNORE
IRsendTest _irsend; ///< Instance of the testing IR send class
/// @endcond
#endif // UNIT_TEST
uint8_t remote_state[kHitachiAc3StateLength]; ///< The state in native code.
void setInvertedStates(const uint16_t length = kHitachiAc3StateLength);
};
/// Class for handling detailed Hitachi 344-bit A/C messages.
class IRHitachiAc344: public IRHitachiAc424 {
public:
explicit IRHitachiAc344(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void) override;
void setRaw(const uint8_t new_code[],
const uint16_t length = kHitachiAc344StateLength) override;
stdAc::state_t toCommon(void) const override;
#if SEND_HITACHI_AC344
void send(const uint16_t repeat = kHitachiAcDefaultRepeat) override;
#endif // SEND_HITACHI_AC344
void setSwingV(const bool on);
bool getSwingV(void) const;
void setSwingH(const uint8_t position);
uint8_t getSwingH(void) const;
static uint8_t convertSwingH(const stdAc::swingh_t position);
static stdAc::swingh_t toCommonSwingH(const uint8_t pos);
String toString(void) const override;
};
#endif // IR_HITACHI_H_
Reference in New Issue View Git Blame Copy Permalink