ESPHome  2024.6.1
mitsubishi.cpp
Go to the documentation of this file.
1 #include "mitsubishi.h"
2 #include "esphome/core/log.h"
3 
4 namespace esphome {
5 namespace mitsubishi {
6 
7 static const char *const TAG = "mitsubishi.climate";
8 
9 const uint8_t MITSUBISHI_OFF = 0x00;
10 
11 const uint8_t MITSUBISHI_MODE_AUTO = 0x20;
12 const uint8_t MITSUBISHI_MODE_COOL = 0x18;
13 const uint8_t MITSUBISHI_MODE_DRY = 0x10;
14 const uint8_t MITSUBISHI_MODE_FAN_ONLY = 0x38;
15 const uint8_t MITSUBISHI_MODE_HEAT = 0x08;
16 
17 const uint8_t MITSUBISHI_MODE_A_HEAT = 0x00;
18 const uint8_t MITSUBISHI_MODE_A_DRY = 0x02;
19 const uint8_t MITSUBISHI_MODE_A_COOL = 0x06;
20 const uint8_t MITSUBISHI_MODE_A_AUTO = 0x06;
21 
22 const uint8_t MITSUBISHI_WIDE_VANE_SWING = 0xC0;
23 
24 const uint8_t MITSUBISHI_FAN_AUTO = 0x00;
25 
26 const uint8_t MITSUBISHI_VERTICAL_VANE_SWING = 0x38;
27 
28 // const uint8_t MITSUBISHI_AUTO = 0X80;
29 const uint8_t MITSUBISHI_OTHERWISE = 0X40;
30 const uint8_t MITSUBISHI_POWERFUL = 0x08;
31 
32 // Optional presets used to enable some model features
33 const uint8_t MITSUBISHI_ECONOCOOL = 0x20;
34 const uint8_t MITSUBISHI_NIGHTMODE = 0xC1;
35 
36 // Pulse parameters in usec
37 const uint16_t MITSUBISHI_BIT_MARK = 430;
38 const uint16_t MITSUBISHI_ONE_SPACE = 1250;
39 const uint16_t MITSUBISHI_ZERO_SPACE = 390;
40 const uint16_t MITSUBISHI_HEADER_MARK = 3500;
41 const uint16_t MITSUBISHI_HEADER_SPACE = 1700;
42 const uint16_t MITSUBISHI_MIN_GAP = 17500;
43 
44 // Marker bytes
45 const uint8_t MITSUBISHI_BYTE00 = 0X23;
46 const uint8_t MITSUBISHI_BYTE01 = 0XCB;
47 const uint8_t MITSUBISHI_BYTE02 = 0X26;
48 const uint8_t MITSUBISHI_BYTE03 = 0X01;
49 const uint8_t MITSUBISHI_BYTE04 = 0X00;
50 const uint8_t MITSUBISHI_BYTE13 = 0X00;
51 const uint8_t MITSUBISHI_BYTE16 = 0X00;
52 
60 
61  if (this->supports_cool_)
63  if (this->supports_heat_)
65 
66  if (this->supports_cool_ && this->supports_heat_)
68 
69  if (this->supports_dry_)
71  if (this->supports_fan_only_)
73 
74  // Default to only 3 levels in ESPHome even if most unit supports 4. The 3rd level is not used.
77  if (this->fan_mode_ == MITSUBISHI_FAN_Q4L)
79  if (/*this->fan_mode_ == MITSUBISHI_FAN_5L ||*/ this->fan_mode_ >= MITSUBISHI_FAN_4L)
80  traits.add_supported_fan_mode(climate::CLIMATE_FAN_MIDDLE); // Shouldn't be used for this but it helps
81 
84 
87 
88  return traits;
89 }
90 
92  // Byte 0-4: Constant: 0x23, 0xCB, 0x26, 0x01, 0x00
93  // Byte 5: On=0x20, Off: 0x00
94  // Byte 6: MODE (See MODEs above (Heat/Dry/Cool/Auto/FanOnly)
95  // Byte 7: TEMP bits 0,1,2,3, added to MITSUBISHI_TEMP_MIN
96  // Example: 0x00 = 0°C+MITSUBISHI_TEMP_MIN = 16°C; 0x07 = 7°C+MITSUBISHI_TEMP_MIN = 23°C
97  // Byte 8: MODE_A & Wide Vane (if present)
98  // MODE_A bits 0,1,2 different than Byte 6 (See MODE_As above)
99  // Wide Vane bits 4,5,6,7 (Middle = 0x30)
100  // Byte 9: FAN/Vertical Vane/Switch To Auto
101  // FAN (Speed) bits 0,1,2
102  // Vertical Vane bits 3,4,5 (Auto = 0x00)
103  // Switch To Auto bits 6,7
104  // Byte 10: CLOCK Current time as configured on remote (0x00=Not used)
105  // Byte 11: END CLOCK Stop time of HVAC (0x00 for no setting)
106  // Byte 12: START CLOCK Start time of HVAC (0x00 for no setting)
107  // Byte 13: Constant 0x00
108  // Byte 14: HVAC specfic, i.e. ECONO COOL, CLEAN MODE, always 0x00
109  // Byte 15: HVAC specfic, i.e. POWERFUL, SMART SET, PLASMA, always 0x00
110  // Byte 16: Constant 0x00
111  // Byte 17: Checksum: SUM[Byte0...Byte16]
112  uint8_t remote_state[18] = {0x23, 0xCB, 0x26, 0x01, 0x00, 0x20, 0x08, 0x00, 0x00,
113  0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00};
114 
115  switch (this->mode) {
117  remote_state[6] = MITSUBISHI_MODE_HEAT;
118  remote_state[8] = MITSUBISHI_MODE_A_HEAT;
119  break;
121  remote_state[6] = MITSUBISHI_MODE_DRY;
122  remote_state[8] = MITSUBISHI_MODE_A_DRY;
123  break;
125  remote_state[6] = MITSUBISHI_MODE_COOL;
126  remote_state[8] = MITSUBISHI_MODE_A_COOL;
127  break;
129  remote_state[6] = MITSUBISHI_MODE_AUTO;
130  remote_state[8] = MITSUBISHI_MODE_A_AUTO;
131  break;
133  remote_state[6] = MITSUBISHI_MODE_FAN_ONLY;
134  remote_state[8] = MITSUBISHI_MODE_A_AUTO;
135  break;
137  default:
138  remote_state[5] = MITSUBISHI_OFF;
139  break;
140  }
141 
142  // Temperature
143  if (this->mode == climate::CLIMATE_MODE_DRY) {
144  remote_state[7] = 24 - MITSUBISHI_TEMP_MIN; // Remote sends always 24°C if "Dry" mode is selected
145  } else {
146  remote_state[7] = (uint8_t) roundf(
148  }
149 
150  // Wide Vane
151  switch (this->swing_mode) {
154  remote_state[8] = remote_state[8] | MITSUBISHI_WIDE_VANE_SWING; // Wide Vane Swing
155  break;
157  default:
158  remote_state[8] = remote_state[8] | this->default_horizontal_direction_; // Off--> horizontal default position
159  break;
160  }
161 
162  ESP_LOGD(TAG, "default_horizontal_direction_: %02X", this->default_horizontal_direction_);
163 
164  // Fan Speed & Vertical Vane
165  // Map of Climate fan mode to this device expected value
166  // For 3Level: Low = 1, Medium = 2, High = 3
167  // For 4Level: Low = 1, Middle = 2, Medium = 3, High = 4
168  // For 5Level: Low = 1, Middle = 2, Medium = 3, High = 4
169  // For 4Level + Quiet: Low = 1, Middle = 2, Medium = 3, High = 4, Quiet = 5
170 
171  switch (this->fan_mode.value()) {
173  remote_state[9] = 1;
174  break;
176  if (this->fan_mode_ == MITSUBISHI_FAN_3L) {
177  remote_state[9] = 2;
178  } else {
179  remote_state[9] = 3;
180  }
181  break;
183  if (this->fan_mode_ == MITSUBISHI_FAN_3L) {
184  remote_state[9] = 3;
185  } else {
186  remote_state[9] = 4;
187  }
188  break;
190  remote_state[9] = 2;
191  break;
193  remote_state[9] = 5;
194  break;
195  default:
196  remote_state[9] = MITSUBISHI_FAN_AUTO;
197  break;
198  }
199 
200  ESP_LOGD(TAG, "fan: %02x state: %02x", this->fan_mode.value(), remote_state[9]);
201 
202  // Vertical Vane
203  switch (this->swing_mode) {
206  remote_state[9] = remote_state[9] | MITSUBISHI_VERTICAL_VANE_SWING | MITSUBISHI_OTHERWISE; // Vane Swing
207  break;
209  default:
210  remote_state[9] = remote_state[9] | this->default_vertical_direction_ |
211  MITSUBISHI_OTHERWISE; // Off--> vertical default position
212  break;
213  }
214 
215  ESP_LOGD(TAG, "default_vertical_direction_: %02X", this->default_vertical_direction_);
216 
217  // Special modes
218  switch (this->preset.value()) {
220  remote_state[6] = MITSUBISHI_MODE_COOL | MITSUBISHI_OTHERWISE;
221  remote_state[8] = (remote_state[8] & ~7) | MITSUBISHI_MODE_A_COOL;
222  remote_state[14] = MITSUBISHI_ECONOCOOL;
223  break;
225  remote_state[9] = MITSUBISHI_FAN_AUTO;
226  remote_state[14] = MITSUBISHI_NIGHTMODE;
227  break;
229  remote_state[6] |= MITSUBISHI_OTHERWISE;
230  remote_state[15] = MITSUBISHI_POWERFUL;
231  break;
233  default:
234  break;
235  }
236 
237  // Checksum
238  for (int i = 0; i < 17; i++) {
239  remote_state[17] += remote_state[i];
240  }
241 
242  ESP_LOGD(TAG, "sending: %02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X,%02X",
243  remote_state[0], remote_state[1], remote_state[2], remote_state[3], remote_state[4], remote_state[5],
244  remote_state[6], remote_state[7], remote_state[8], remote_state[9], remote_state[10], remote_state[11],
245  remote_state[12], remote_state[13], remote_state[14], remote_state[15], remote_state[16], remote_state[17]);
246 
247  auto transmit = this->transmitter_->transmit();
248  auto *data = transmit.get_data();
249 
250  data->set_carrier_frequency(38000);
251  // repeat twice
252  for (uint8_t r = 0; r < 2; r++) {
253  // Header
254  data->mark(MITSUBISHI_HEADER_MARK);
255  data->space(MITSUBISHI_HEADER_SPACE);
256  // Data
257  for (uint8_t i : remote_state) {
258  for (uint8_t j = 0; j < 8; j++) {
259  data->mark(MITSUBISHI_BIT_MARK);
260  bool bit = i & (1 << j);
261  data->space(bit ? MITSUBISHI_ONE_SPACE : MITSUBISHI_ZERO_SPACE);
262  }
263  }
264  // Footer
265  if (r == 0) {
266  data->mark(MITSUBISHI_BIT_MARK);
267  data->space(MITSUBISHI_MIN_GAP); // Pause before repeating
268  }
269  }
270  data->mark(MITSUBISHI_BIT_MARK);
271 
272  transmit.perform();
273 }
274 
275 bool MitsubishiClimate::parse_state_frame_(const uint8_t frame[]) { return false; }
276 
278  uint8_t state_frame[18] = {};
279 
280  if (!data.expect_item(MITSUBISHI_HEADER_MARK, MITSUBISHI_HEADER_SPACE)) {
281  ESP_LOGV(TAG, "Header fail");
282  return false;
283  }
284 
285  for (uint8_t pos = 0; pos < 18; pos++) {
286  uint8_t byte = 0;
287  for (int8_t bit = 0; bit < 8; bit++) {
288  if (data.expect_item(MITSUBISHI_BIT_MARK, MITSUBISHI_ONE_SPACE)) {
289  byte |= 1 << bit;
290  } else if (!data.expect_item(MITSUBISHI_BIT_MARK, MITSUBISHI_ZERO_SPACE)) {
291  ESP_LOGV(TAG, "Byte %d bit %d fail", pos, bit);
292  return false;
293  }
294  }
295  state_frame[pos] = byte;
296 
297  // Check Header && Footer
298  if ((pos == 0 && byte != MITSUBISHI_BYTE00) || (pos == 1 && byte != MITSUBISHI_BYTE01) ||
299  (pos == 2 && byte != MITSUBISHI_BYTE02) || (pos == 3 && byte != MITSUBISHI_BYTE03) ||
300  (pos == 4 && byte != MITSUBISHI_BYTE04) || (pos == 13 && byte != MITSUBISHI_BYTE13) ||
301  (pos == 16 && byte != MITSUBISHI_BYTE16)) {
302  ESP_LOGV(TAG, "Bytes 0,1,2,3,4,13 or 16 fail - invalid value");
303  return false;
304  }
305  }
306 
307  // On/Off and Mode
308  if (state_frame[5] == MITSUBISHI_OFF) {
310  } else {
311  switch (state_frame[6]) {
314  break;
315  case MITSUBISHI_MODE_DRY:
317  break;
320  break;
323  break;
326  break;
327  }
328  }
329 
330  // Temp
331  this->target_temperature = state_frame[7] + MITSUBISHI_TEMP_MIN;
332 
333  // Fan
334  uint8_t fan = state_frame[9] & 0x07; //(Bit 0,1,2 = Speed)
335  // Map of Climate fan mode to this device expected value
336  // For 3Level: Low = 1, Medium = 2, High = 3
337  // For 4Level: Low = 1, Middle = 2, Medium = 3, High = 4
338  // For 5Level: Low = 1, Middle = 2, Medium = 3, High = 4
339  // For 4Level + Quiet: Low = 1, Middle = 2, Medium = 3, High = 4, Quiet = 5
340  climate::ClimateFanMode modes_mapping[8] = {
348  climate::CLIMATE_FAN_AUTO};
349  this->fan_mode = modes_mapping[fan];
350 
351  // Wide Vane
352  uint8_t wide_vane = state_frame[8] & 0xF0; // Bits 4,5,6,7
353  switch (wide_vane) {
356  break;
357  default:
359  break;
360  }
361 
362  // Vertical Vane
363  uint8_t vertical_vane = state_frame[9] & 0x38; // Bits 3,4,5
364  switch (vertical_vane) {
368  } else {
370  }
371  break;
372  }
373 
374  switch (state_frame[14]) {
377  break;
380  break;
381  }
382 
383  ESP_LOGV(TAG, "Receiving: %s", format_hex_pretty(state_frame, 18).c_str());
384 
385  this->publish_state();
386  return true;
387 }
388 
389 } // namespace mitsubishi
390 } // namespace esphome
The fan mode is set to Low.
Definition: climate_mode.h:54
const uint16_t MITSUBISHI_MIN_GAP
Definition: mitsubishi.cpp:42
value_type const & value() const
Definition: optional.h:89
const uint16_t MITSUBISHI_ONE_SPACE
Definition: mitsubishi.cpp:38
The fan mode is set to Quiet.
Definition: climate_mode.h:66
bool parse_state_frame_(const uint8_t frame[])
Definition: mitsubishi.cpp:275
const uint8_t MITSUBISHI_BYTE01
Definition: mitsubishi.cpp:46
ClimateSwingMode swing_mode
The active swing mode of the climate device.
Definition: climate.h:202
const uint8_t MITSUBISHI_BYTE13
Definition: mitsubishi.cpp:50
void set_visual_temperature_step(float temperature_step)
const uint8_t MITSUBISHI_MODE_COOL
Definition: mitsubishi.cpp:12
The fan mode is set to Both.
Definition: climate_mode.h:74
std::string format_hex_pretty(const uint8_t *data, size_t length)
Format the byte array data of length len in pretty-printed, human-readable hex.
Definition: helpers.cpp:361
const uint8_t MITSUBISHI_BYTE02
Definition: mitsubishi.cpp:47
const uint8_t MITSUBISHI_MODE_A_COOL
Definition: mitsubishi.cpp:19
const uint8_t MITSUBISHI_BYTE00
Definition: mitsubishi.cpp:45
float target_temperature
The target temperature of the climate device.
Definition: climate.h:186
void set_carrier_frequency(uint32_t carrier_frequency)
Definition: remote_base.h:34
The fan mode is set to Middle.
Definition: climate_mode.h:60
const uint8_t MITSUBISHI_MODE_A_AUTO
Definition: mitsubishi.cpp:20
This class contains all static data for climate devices.
void set_visual_min_temperature(float visual_min_temperature)
The climate device is set to heat to reach the target temperature.
Definition: climate_mode.h:18
const uint8_t MITSUBISHI_VERTICAL_VANE_SWING
Definition: mitsubishi.cpp:26
const uint8_t MITSUBISHI_POWERFUL
Definition: mitsubishi.cpp:30
ClimateMode mode
The active mode of the climate device.
Definition: climate.h:173
const uint8_t MITSUBISHI_ECONOCOOL
Definition: mitsubishi.cpp:33
const uint8_t MITSUBISHI_MODE_A_DRY
Definition: mitsubishi.cpp:18
const uint8_t MITSUBISHI_OTHERWISE
Definition: mitsubishi.cpp:29
const uint8_t MITSUBISHI_MODE_HEAT
Definition: mitsubishi.cpp:15
The climate device is set to dry/humidity mode.
Definition: climate_mode.h:22
const uint8_t MITSUBISHI_MODE_A_HEAT
Definition: mitsubishi.cpp:17
const uint8_t MITSUBISHI_BYTE04
Definition: mitsubishi.cpp:49
void set_supported_presets(std::set< ClimatePreset > presets)
climate::ClimateTraits traits() override
Definition: mitsubishi.cpp:53
const uint8_t MITSUBISHI_BYTE16
Definition: mitsubishi.cpp:51
const uint16_t MITSUBISHI_BIT_MARK
Definition: mitsubishi.cpp:37
const uint8_t MITSUBISHI_OFF
Definition: mitsubishi.cpp:9
Device is prepared for sleep.
Definition: climate_mode.h:96
const uint8_t MITSUBISHI_WIDE_VANE_SWING
Definition: mitsubishi.cpp:22
bool on_receive(remote_base::RemoteReceiveData data) override
Definition: mitsubishi.cpp:277
HorizontalDirection default_horizontal_direction_
Definition: mitsubishi.h:76
The fan mode is set to Horizontal.
Definition: climate_mode.h:78
The climate device is set to cool to reach the target temperature.
Definition: climate_mode.h:16
const uint8_t MITSUBISHI_FAN_AUTO
Definition: mitsubishi.cpp:24
void set_supported_fan_modes(std::set< ClimateFanMode > modes)
The fan mode is set to Auto.
Definition: climate_mode.h:52
optional< ClimatePreset > preset
The active preset of the climate device.
Definition: climate.h:208
const uint8_t MITSUBISHI_TEMP_MAX
Definition: mitsubishi.h:12
const uint16_t MITSUBISHI_HEADER_SPACE
Definition: mitsubishi.cpp:41
void set_supported_modes(std::set< ClimateMode > modes)
const uint16_t MITSUBISHI_HEADER_MARK
Definition: mitsubishi.cpp:40
RemoteTransmitterBase * transmitter_
Definition: remote_base.h:276
void set_visual_max_temperature(float visual_max_temperature)
The climate device is set to heat/cool to reach the target temperature.
Definition: climate_mode.h:14
The fan mode is set to Vertical.
Definition: climate_mode.h:76
void add_supported_fan_mode(ClimateFanMode mode)
void publish_state()
Publish the state of the climate device, to be called from integrations.
Definition: climate.cpp:395
The fan mode is set to High.
Definition: climate_mode.h:58
The swing mode is set to Off.
Definition: climate_mode.h:72
The climate device is off.
Definition: climate_mode.h:12
const uint8_t MITSUBISHI_NIGHTMODE
Definition: mitsubishi.cpp:34
void set_supports_action(bool supports_action)
optional< ClimateFanMode > fan_mode
The active fan mode of the climate device.
Definition: climate.h:199
const uint8_t MITSUBISHI_MODE_FAN_ONLY
Definition: mitsubishi.cpp:14
Device is in boost preset.
Definition: climate_mode.h:90
This is a workaround until we can figure out a way to get the tflite-micro idf component code availab...
Definition: a01nyub.cpp:7
void set_supported_swing_modes(std::set< ClimateSwingMode > modes)
Device is running an energy-saving preset.
Definition: climate_mode.h:94
const uint8_t MITSUBISHI_BYTE03
Definition: mitsubishi.cpp:48
const uint8_t MITSUBISHI_TEMP_MIN
Definition: mitsubishi.h:11
The fan mode is set to Medium.
Definition: climate_mode.h:56
const uint8_t MITSUBISHI_MODE_DRY
Definition: mitsubishi.cpp:13
bool expect_item(uint32_t mark, uint32_t space)
Definition: remote_base.cpp:74
const uint16_t MITSUBISHI_ZERO_SPACE
Definition: mitsubishi.cpp:39
The climate device only has the fan enabled, no heating or cooling is taking place.
Definition: climate_mode.h:20
VerticalDirection default_vertical_direction_
Definition: mitsubishi.h:77
void add_supported_mode(ClimateMode mode)
const uint8_t MITSUBISHI_MODE_AUTO
Definition: mitsubishi.cpp:11