Tasmota/lib/IRremoteESP8266-2.7.5/src/ir_Mitsubishi.h

313 lines
12 KiB
C
Raw Normal View History

2019-11-02 11:21:18 +00:00
// Copyright 2009 Ken Shirriff
// Copyright 2017-2019 David Conran
// Copyright 2019 Mark Kuchel
// Mitsubishi
// Supports:
// Brand: Mitsubishi, Model: TV
// Brand: Mitsubishi, Model: HC3000 Projector
// Brand: Mitsubishi, Model: MS-GK24VA A/C
// Brand: Mitsubishi, Model: KM14A 0179213 remote
// Brand: Mitsubishi Electric, Model: PEAD-RP71JAA Ducted A/C
// Brand: Mitsubishi Electric, Model: 001CP T7WE10714 remote
// Brand: Mitsubishi Electric, Model: MSH-A24WV / MUH-A24WV A/C
// Brand: Mitsubishi Electric, Model: KPOA remote
#ifndef IR_MITSUBISHI_H_
#define IR_MITSUBISHI_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
// Mitsubishi (TV) decoding added from https://github.com/z3t0/Arduino-IRremote
// Mitsubishi (TV) sending & Mitsubishi A/C support added by David Conran
// Constants
const uint8_t kMitsubishiAcModeOffset = 3;
const uint8_t kMitsubishiAcAuto = 0b100;
const uint8_t kMitsubishiAcCool = 0b011;
const uint8_t kMitsubishiAcDry = 0b010;
const uint8_t kMitsubishiAcHeat = 0b001;
const uint8_t kMitsubishiAcPowerOffset = 5;
const uint8_t kMitsubishiAcPower = 1 << kMitsubishiAcPowerOffset; // 0x20
const uint8_t kMitsubishiAcFanOffset = 0;
const uint8_t kMitsubishiAcFanSize = 3; // Mask 0b111
const uint8_t kMitsubishiAcFanAuto = 0;
const uint8_t kMitsubishiAcFanAutoOffset = 7;
const uint8_t kMitsubishiAcFanMax = 5;
const uint8_t kMitsubishiAcFanRealMax = 4;
const uint8_t kMitsubishiAcFanSilent = 6;
const uint8_t kMitsubishiAcFanQuiet = kMitsubishiAcFanSilent;
const uint8_t kMitsubishiAcMinTemp = 16; // 16C
const uint8_t kMitsubishiAcMaxTemp = 31; // 31C
const uint8_t kMitsubishiAcVaneBitOffset = 6;
const uint8_t kMitsubishiAcVaneOffset = 3;
const uint8_t kMitsubishiAcVaneSize = 3;
const uint8_t kMitsubishiAcVaneAuto = 0;
const uint8_t kMitsubishiAcVaneAutoMove = 7;
const uint8_t kMitsubishiAcNoTimer = 0;
const uint8_t kMitsubishiAcStartTimer = 5;
const uint8_t kMitsubishiAcStopTimer = 3;
const uint8_t kMitsubishiAcStartStopTimer = 7;
const uint8_t kMitsubishiAcWideVaneAuto = 8;
const uint8_t kMitsubishi136PowerByte = 5;
const uint8_t kMitsubishi136PowerOffset = 6;
const uint8_t kMitsubishi136PowerBit = 1 << kMitsubishi136PowerOffset;
const uint8_t kMitsubishi136TempByte = 6;
const uint8_t kMitsubishi136MinTemp = 17; // 17C
const uint8_t kMitsubishi136MaxTemp = 30; // 30C
const uint8_t kMitsubishi136ModeByte = kMitsubishi136TempByte;
const uint8_t kMitsubishi136ModeOffset = 0;
const uint8_t kMitsubishi136Fan = 0b000;
const uint8_t kMitsubishi136Cool = 0b001;
const uint8_t kMitsubishi136Heat = 0b010;
const uint8_t kMitsubishi136Auto = 0b011;
const uint8_t kMitsubishi136Dry = 0b101;
const uint8_t kMitsubishi136SwingVByte = 7;
const uint8_t kMitsubishi136SwingVLowest = 0b0000;
const uint8_t kMitsubishi136SwingVLow = 0b0001;
const uint8_t kMitsubishi136SwingVHigh = 0b0010;
const uint8_t kMitsubishi136SwingVHighest = 0b0011;
const uint8_t kMitsubishi136SwingVAuto = 0b1100;
const uint8_t kMitsubishi136FanByte = kMitsubishi136SwingVByte;
// FanMask = 0b00000110;
const uint8_t kMitsubishi136FanOffset = 1;
const uint8_t kMitsubishi136FanSize = 2; // Bits
const uint8_t kMitsubishi136FanMin = 0b00;
const uint8_t kMitsubishi136FanLow = 0b01;
const uint8_t kMitsubishi136FanMed = 0b10;
const uint8_t kMitsubishi136FanMax = 0b11;
const uint8_t kMitsubishi136FanQuiet = kMitsubishi136FanMin;
// Mitsubishi112
// remote_state[5]
const uint8_t kMitsubishi112PowerByte = 5;
const uint8_t kMitsubishi112PowerOffset = 2; // 0b00000100
// remote_state[6]
const uint8_t kMitsubishi112ModeByte = 6;
const uint8_t kMitsubishi112ModeOffset = 0; // Mask 0b00000111
const uint8_t kMitsubishi112Cool = 0b011;
const uint8_t kMitsubishi112Heat = 0b001;
const uint8_t kMitsubishi112Auto = 0b111;
const uint8_t kMitsubishi112Dry = 0b010;
// remote_state[7]
const uint8_t kMitsubishi112TempByte = 7;
const uint8_t kMitsubishi112TempSize = 4; // Mask 0b00001111
const uint8_t kMitsubishi112MinTemp = 16; // 16C
const uint8_t kMitsubishi112MaxTemp = 31; // 31C
// remote_state[8]
const uint8_t kMitsubishi112FanByte = 8;
const uint8_t kMitsubishi112FanOffset = 0; // Mask 0b00000111;
const uint8_t kMitsubishi112FanSize = 3;
const uint8_t kMitsubishi112FanMin = 0b010;
const uint8_t kMitsubishi112FanLow = 0b011;
const uint8_t kMitsubishi112FanMed = 0b101;
const uint8_t kMitsubishi112FanMax = 0b000;
const uint8_t kMitsubishi112FanQuiet = kMitsubishi112FanMin;
const uint8_t kMitsubishi112SwingVByte = kMitsubishi112FanByte;
const uint8_t kMitsubishi112SwingVOffset = 3; // Mask 0b00111000
const uint8_t kMitsubishi112SwingVSize = 3; // Mask 0b00111000
const uint8_t kMitsubishi112SwingVLowest = 0b101;
const uint8_t kMitsubishi112SwingVLow = 0b100;
const uint8_t kMitsubishi112SwingVMiddle = 0b011;
const uint8_t kMitsubishi112SwingVHigh = 0b010;
const uint8_t kMitsubishi112SwingVHighest = 0b001;
const uint8_t kMitsubishi112SwingVAuto = 0b111;
// remote_state[12]
const uint8_t kMitsubishi112SwingHByte = 12;
const uint8_t kMitsubishi112SwingHSize = 4;
const uint8_t kMitsubishi112SwingHOffset = 2; // Mask 0b00111100
const uint8_t kMitsubishi112SwingHLeftMax = 0b0001;
const uint8_t kMitsubishi112SwingHLeft = 0b0010;
const uint8_t kMitsubishi112SwingHMiddle = 0b0011;
const uint8_t kMitsubishi112SwingHRight = 0b0100;
const uint8_t kMitsubishi112SwingHRightMax = 0b0101;
const uint8_t kMitsubishi112SwingHWide = 0b1000;
const uint8_t kMitsubishi112SwingHAuto = 0b1100;
// Legacy defines (Deprecated)
#define MITSUBISHI_AC_VANE_AUTO_MOVE kMitsubishiAcVaneAutoMove
#define MITSUBISHI_AC_VANE_AUTO kMitsubishiAcVaneAuto
#define MITSUBISHI_AC_POWER kMitsubishiAcPower
#define MITSUBISHI_AC_MIN_TEMP kMitsubishiAcMinTemp
#define MITSUBISHI_AC_MAX_TEMP kMitsubishiAcMaxTemp
#define MITSUBISHI_AC_HEAT kMitsubishiAcHeat
#define MITSUBISHI_AC_FAN_SILENT kMitsubishiAcFanSilent
#define MITSUBISHI_AC_FAN_REAL_MAX kMitsubishiAcFanRealMax
#define MITSUBISHI_AC_FAN_MAX kMitsubishiAcFanMax
#define MITSUBISHI_AC_FAN_AUTO kMitsubishiAcFanAuto
#define MITSUBISHI_AC_DRY kMitsubishiAcDry
#define MITSUBISHI_AC_COOL kMitsubishiAcCool
#define MITSUBISHI_AC_AUTO kMitsubishiAcAuto
class IRMitsubishiAC {
public:
explicit IRMitsubishiAC(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
static bool validChecksum(const uint8_t* data);
#if SEND_MITSUBISHI_AC
void send(const uint16_t repeat = kMitsubishiACMinRepeat);
uint8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_MITSUBISHI_AC
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void);
void setTemp(const uint8_t degrees);
uint8_t getTemp(void);
void setFan(const uint8_t speed);
uint8_t getFan(void);
void setMode(const uint8_t mode);
uint8_t getMode(void);
void setVane(const uint8_t position);
void setWideVane(const uint8_t position);
uint8_t getVane(void);
uint8_t getWideVane(void);
uint8_t* getRaw(void);
void setRaw(const uint8_t* data);
uint8_t getClock(void);
void setClock(const uint8_t clock);
uint8_t getStartClock(void);
void setStartClock(const uint8_t clock);
uint8_t getStopClock(void);
void setStopClock(const uint8_t clock);
uint8_t getTimer(void);
void setTimer(const uint8_t timer);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static uint8_t convertSwingV(const stdAc::swingv_t position);
static uint8_t convertSwingH(const stdAc::swingh_t position);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
static stdAc::swingh_t toCommonSwingH(const uint8_t pos);
stdAc::state_t toCommon(void);
String toString(void);
#ifndef UNIT_TEST
private:
IRsend _irsend;
#else
IRsendTest _irsend;
#endif
uint8_t remote_state[kMitsubishiACStateLength];
void checksum(void);
static uint8_t calculateChecksum(const uint8_t* data);
};
class IRMitsubishi136 {
public:
explicit IRMitsubishi136(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_MITSUBISHI136
void send(const uint16_t repeat = kMitsubishi136MinRepeat);
uint8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_MITSUBISHI136
void begin(void);
static bool validChecksum(const uint8_t* data,
const uint16_t len = kMitsubishi136StateLength);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void);
void setTemp(const uint8_t degrees);
uint8_t getTemp(void);
void setFan(const uint8_t speed);
uint8_t getFan(void);
void setMode(const uint8_t mode);
uint8_t getMode(void);
void setSwingV(const uint8_t position);
uint8_t getSwingV(void);
void setQuiet(const bool on);
bool getQuiet(void);
uint8_t* getRaw(void);
void setRaw(const uint8_t* data);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static uint8_t convertSwingV(const stdAc::swingv_t position);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
stdAc::state_t toCommon(void);
String toString(void);
#ifndef UNIT_TEST
private:
IRsend _irsend;
#else
IRsendTest _irsend;
#endif
uint8_t remote_state[kMitsubishi136StateLength];
void checksum(void);
};
class IRMitsubishi112 {
public:
explicit IRMitsubishi112(const uint16_t pin, const bool inverted = false,
const bool use_modulation = true);
void stateReset(void);
#if SEND_MITSUBISHI112
void send(const uint16_t repeat = kMitsubishi112MinRepeat);
uint8_t calibrate(void) { return _irsend.calibrate(); }
#endif // SEND_MITSUBISHI112
void begin(void);
void on(void);
void off(void);
void setPower(const bool on);
bool getPower(void);
void setTemp(const uint8_t degrees);
uint8_t getTemp(void);
void setFan(const uint8_t speed);
uint8_t getFan(void);
void setMode(const uint8_t mode);
uint8_t getMode(void);
void setSwingV(const uint8_t position);
uint8_t getSwingV(void);
void setSwingH(const uint8_t position);
uint8_t getSwingH(void);
void setQuiet(const bool on);
bool getQuiet(void);
uint8_t* getRaw(void);
void setRaw(const uint8_t* data);
static uint8_t convertMode(const stdAc::opmode_t mode);
static uint8_t convertFan(const stdAc::fanspeed_t speed);
static uint8_t convertSwingV(const stdAc::swingv_t position);
static uint8_t convertSwingH(const stdAc::swingh_t position);
static stdAc::opmode_t toCommonMode(const uint8_t mode);
static stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed);
static stdAc::swingv_t toCommonSwingV(const uint8_t pos);
static stdAc::swingh_t toCommonSwingH(const uint8_t pos);
stdAc::state_t toCommon(void);
String toString(void);
#ifndef UNIT_TEST
private:
IRsend _irsend;
#else
IRsendTest _irsend;
#endif
uint8_t remote_state[kMitsubishi112StateLength];
void checksum(void);
};
#endif // IR_MITSUBISHI_H_