doxygen/html/ir__Sharp_8h_source.html

// 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: CRMC-A950 JBEZ (A907)

//   Brand: Sharp,  Model: AH-PR13-GL A/C (A903)

//   Brand: Sharp,  Model: CRMC-A903JBEZ remote (A903)

//   Brand: Sharp,  Model: AH-XP10NRY A/C (A903)

//   Brand: Sharp,  Model: CRMC-820 JBEZ remote (A903)

//   Brand: Sharp,  Model: CRMC-A705 JBEZ remote (A705)

//   Brand: Sharp,  Model: AH-A12REVP-1 A/C (A903)

//   Brand: Sharp,  Model: CRMC-A863 JBEZ remote (A903)


#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 Model2 :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 (A903 too)

const uint8_t kSharpAcFanHigh =                     0b101;  // 5 (FAN3)

const uint8_t kSharpAcFanA705Med =                  0b101;  // 5 (A903 too)

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;


// Ref: https://github.com/crankyoldgit/IRremoteESP8266/discussions/1590#discussioncomment-1260213

const uint8_t kSharpAcSwingVIgnore = 0b000;  // Don't change the swing setting.

const uint8_t kSharpAcSwingVHigh =   0b001;  // 0° down. Similar to Cool Coanda.

const uint8_t kSharpAcSwingVOff =    0b010;  // Stop & Go to last fixed pos.

const uint8_t kSharpAcSwingVMid =    0b011;  // 30° down

const uint8_t kSharpAcSwingVLow =    0b100;  // 45° down

const uint8_t kSharpAcSwingVLast =   0b101;  // Same as kSharpAcSwingVOff.

// Toggles between last fixed pos & either 75° down (Heat) or 0° down (Cool)

// i.e. alternate between last pos <-> 75° down if in Heat mode, AND

//      alternate between last pos <-> 0° down if in Cool mode.

// Note: `setSwingV(kSharpAcSwingVLowest)` will only allow the Lowest setting in

//       Heat mode, it will default to `kSharpAcSwingVLow` otherwise.

//       If you want to set this value in other modes e.g. Cool, you must

//       use `setSwingV`s optional `force` parameter.

const uint8_t kSharpAcSwingVLowest = 0b110;

const uint8_t kSharpAcSwingVCoanda = kSharpAcSwingVLowest;

const uint8_t kSharpAcSwingVToggle = 0b111;  // Toggle Constant swinging on/off.


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

  uint8_t getSwingV(void) const;

  void setSwingV(const uint8_t position, const bool force = false);

  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,

                            const sharp_ac_remote_model_t model =

                                sharp_ac_remote_model_t::A907);

  static uint8_t convertSwingV(const stdAc::swingv_t position);

  stdAc::opmode_t toCommonMode(const uint8_t mode) const;

  stdAc::fanspeed_t toCommonFanSpeed(const uint8_t speed) const;

  stdAc::swingv_t toCommonSwingV(

      const uint8_t pos,

      const stdAc::opmode_t mode = stdAc::opmode_t::kHeat) const;

  stdAc::state_t toCommon(const stdAc::state_t *prev = NULL) 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_