-
Notifications
You must be signed in to change notification settings - Fork 839
/
Copy pathir_Fujitsu.cpp
1043 lines (966 loc) · 35.7 KB
/
ir_Fujitsu.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2017 Jonny Graham
// Copyright 2017-2021 David Conran
// Copyright 2021 siriuslzx
/// @file
/// @brief Support for Fujitsu A/C protocols.
/// Fujitsu A/C support added by Jonny Graham & David Conran
/// @warning Use of incorrect model may cause the A/C unit to lock up.
/// e.g. An A/C that uses an AR-RAH1U remote may lock up requiring a physical
/// power rest, if incorrect model (ARRAH2E) is used with a Swing command.
/// The correct model for it is ARREB1E.
/// @see https://github.com/crankyoldgit/IRremoteESP8266/issues/1376
#include "ir_Fujitsu.h"
#include <algorithm>
#ifndef ARDUINO
#include <string>
#endif
#include "IRsend.h"
#include "IRtext.h"
#include "IRutils.h"
// Ref:
// These values are based on averages of measurements
const uint16_t kFujitsuAcHdrMark = 3324;
const uint16_t kFujitsuAcHdrSpace = 1574;
const uint16_t kFujitsuAcBitMark = 448;
const uint16_t kFujitsuAcOneSpace = 1182;
const uint16_t kFujitsuAcZeroSpace = 390;
const uint16_t kFujitsuAcMinGap = 8100;
const uint8_t kFujitsuAcExtraTolerance = 5; // Extra tolerance percentage.
using irutils::addBoolToString;
using irutils::addIntToString;
using irutils::addLabeledString;
using irutils::addModeToString;
using irutils::addModelToString;
using irutils::addFanToString;
using irutils::addTempFloatToString;
using irutils::minsToString;
#if SEND_FUJITSU_AC
/// Send a Fujitsu A/C formatted message.
/// Status: STABLE / Known Good.
/// @param[in] data The message to be sent.
/// @param[in] nbytes The number of bytes of message to be sent.
/// Typically one of:
/// kFujitsuAcStateLength,
/// kFujitsuAcStateLength - 1,
/// kFujitsuAcStateLengthShort,
/// kFujitsuAcStateLengthShort - 1
/// @param[in] repeat The number of times the command is to be repeated.
void IRsend::sendFujitsuAC(const unsigned char data[], const uint16_t nbytes,
const uint16_t repeat) {
sendGeneric(kFujitsuAcHdrMark, kFujitsuAcHdrSpace, kFujitsuAcBitMark,
kFujitsuAcOneSpace, kFujitsuAcBitMark, kFujitsuAcZeroSpace,
kFujitsuAcBitMark, kFujitsuAcMinGap, data, nbytes, 38, false,
repeat, 50);
}
#endif // SEND_FUJITSU_AC
// Code to emulate Fujitsu A/C IR remote control unit.
/// Class Constructor
/// @param[in] pin GPIO to be used when sending.
/// @param[in] model The enum for the model of A/C to be emulated.
/// @param[in] inverted Is the output signal to be inverted?
/// @param[in] use_modulation Is frequency modulation to be used?
IRFujitsuAC::IRFujitsuAC(const uint16_t pin,
const fujitsu_ac_remote_model_t model,
const bool inverted, const bool use_modulation)
: _irsend(pin, inverted, use_modulation) {
setModel(model);
stateReset();
}
/// Set the currently emulated model of the A/C.
/// @param[in] model An enum representing the model to support/emulate.
void IRFujitsuAC::setModel(const fujitsu_ac_remote_model_t model) {
_model = model;
switch (model) {
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARJW2:
_state_length = kFujitsuAcStateLength - 1;
_state_length_short = kFujitsuAcStateLengthShort - 1;
break;
case fujitsu_ac_remote_model_t::ARRY4:
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARREB1E:
default:
_state_length = kFujitsuAcStateLength;
_state_length_short = kFujitsuAcStateLengthShort;
}
}
/// Get the currently emulated/detected model of the A/C.
/// @return The enum representing the model of A/C.
fujitsu_ac_remote_model_t IRFujitsuAC::getModel(void) const { return _model; }
/// Reset the state of the remote to a known good state/sequence.
void IRFujitsuAC::stateReset(void) {
for (size_t i = 0; i < kFujitsuAcStateLength; i++) {
_.longcode[i] = 0;
}
setTemp(24);
_.Fan = kFujitsuAcFanHigh;
_.Mode = kFujitsuAcModeCool;
_.Swing = kFujitsuAcSwingBoth;
_cmd = kFujitsuAcCmdTurnOn;
_.Filter = false;
_.Clean = false;
_.TimerType = kFujitsuAcStopTimers;
_.OnTimer = 0;
_.OffTimer = 0;
_.longcode[0] = 0x14;
_.longcode[1] = 0x63;
_.longcode[3] = 0x10;
_.longcode[4] = 0x10;
}
/// Set up hardware to be able to send a message.
void IRFujitsuAC::begin(void) { _irsend.begin(); }
#if SEND_FUJITSU_AC
/// Send the current internal state as an IR message.
/// @param[in] repeat Nr. of times the message will be repeated.
void IRFujitsuAC::send(const uint16_t repeat) {
_irsend.sendFujitsuAC(getRaw(), getStateLength(), repeat);
}
#endif // SEND_FUJITSU_AC
/// Update the length (size) of the state code for the current configuration.
/// @return true, if use long codes; false, use short codes.
bool IRFujitsuAC::updateUseLongOrShort(void) {
bool fullCmd = false;
switch (_cmd) {
case kFujitsuAcCmdTurnOff: // 0x02
case kFujitsuAcCmdEcono: // 0x09
case kFujitsuAcCmdPowerful: // 0x39
case kFujitsuAcCmdStepVert: // 0x6C
case kFujitsuAcCmdToggleSwingVert: // 0x6D
case kFujitsuAcCmdStepHoriz: // 0x79
case kFujitsuAcCmdToggleSwingHoriz: // 0x7A
_.Cmd = _cmd;
break;
default:
switch (_model) {
case fujitsu_ac_remote_model_t::ARRY4:
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARREW4E:
_.Cmd = 0xFE;
break;
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARJW2:
_.Cmd = 0xFC;
break;
}
fullCmd = true;
break;
}
return fullCmd;
}
/// Calculate and set the checksum values for the internal state.
void IRFujitsuAC::checkSum(void) {
if (updateUseLongOrShort()) { // Is it a long code?
// Nr. of bytes in the message after this byte.
_.RestLength = _state_length - 7;
_.Protocol = (_model == fujitsu_ac_remote_model_t::ARREW4E) ? 0x31 : 0x30;
_.Power = (_cmd == kFujitsuAcCmdTurnOn) || get10CHeat();
// These values depend on model
if (_model != fujitsu_ac_remote_model_t::ARREB1E &&
_model != fujitsu_ac_remote_model_t::ARREW4E) {
_.OutsideQuiet = 0;
if (_model != fujitsu_ac_remote_model_t::ARRAH2E) {
_.TimerType = kFujitsuAcStopTimers;
}
}
if (_model != fujitsu_ac_remote_model_t::ARRY4) {
if (_model != fujitsu_ac_remote_model_t::ARREW4E) _.Clean = false;
_.Filter = false;
}
// Set the On/Off/Sleep timer Nr of mins.
_.OffTimer = getOffSleepTimer();
_.OnTimer = getOnTimer();
// Enable bit for the Off/Sleep timer
_.OffTimerEnable = _.OffTimer > 0;
// Enable bit for the On timer
_.OnTimerEnable = _.OnTimer > 0;
uint8_t checksum = 0;
uint8_t checksum_complement = 0;
switch (_model) {
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARJW2:
_.Swing = kFujitsuAcSwingOff;
checksum = sumBytes(_.longcode, _state_length - 1);
checksum_complement = 0x9B;
break;
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARRY4:
_.unknown = 1;
// FALL THRU
default:
checksum = sumBytes(_.longcode + _state_length_short,
_state_length - _state_length_short - 1);
}
// and negate the checksum and store it in the last byte.
_.longcode[_state_length - 1] = checksum_complement - checksum;
} else { // short codes
for (size_t i = 0; i < _state_length_short; i++) {
_.shortcode[i] = _.longcode[i];
}
switch (_model) {
case fujitsu_ac_remote_model_t::ARRY4:
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARREW4E:
// The last byte is the inverse of penultimate byte
_.shortcode[_state_length_short - 1] =
~_.shortcode[_state_length_short - 2];
break;
default:
{}; // We don't need to do anything for the others.
}
}
}
/// Get the length (size) of the state code for the current configuration.
/// @return The length of the state array required for this config.
uint8_t IRFujitsuAC::getStateLength(void) {
return updateUseLongOrShort() ? _state_length : _state_length_short;
}
/// Get a PTR to the internal state/code for this protocol.
/// @return PTR to a code for this protocol based on the current internal state.
uint8_t* IRFujitsuAC::getRaw(void) {
checkSum();
if (_.Cmd == 0xFE || _.Cmd == 0xFC)
return _.longcode;
return _.shortcode;
}
/// Build the internal state/config from the current (raw) A/C message.
/// @param[in] length Size of the current/used (raw) A/C message array.
void IRFujitsuAC::buildFromState(const uint16_t length) {
switch (length) {
case kFujitsuAcStateLength - 1:
case kFujitsuAcStateLengthShort - 1:
setModel(fujitsu_ac_remote_model_t::ARDB1);
// ARJW2 has horizontal swing.
if (_.Swing > kFujitsuAcSwingVert)
setModel(fujitsu_ac_remote_model_t::ARJW2);
break;
default:
switch (_.Cmd) {
case kFujitsuAcCmdEcono:
case kFujitsuAcCmdPowerful:
setModel(fujitsu_ac_remote_model_t::ARREB1E);
break;
default:
setModel(fujitsu_ac_remote_model_t::ARRAH2E);
}
}
switch (_.RestLength) {
case 8:
if (_model != fujitsu_ac_remote_model_t::ARJW2)
setModel(fujitsu_ac_remote_model_t::ARDB1);
break;
case 9:
if (_model != fujitsu_ac_remote_model_t::ARREB1E)
setModel(fujitsu_ac_remote_model_t::ARRAH2E);
break;
}
if (_.Power)
setCmd(kFujitsuAcCmdTurnOn);
else
setCmd(kFujitsuAcCmdStayOn);
// Currently the only way we know how to tell ARRAH2E & ARRY4 apart is if
// either the raw Filter or Clean setting is on.
if (_model == fujitsu_ac_remote_model_t::ARRAH2E && (_.Filter || _.Clean))
setModel(fujitsu_ac_remote_model_t::ARRY4);
if (_state_length == kFujitsuAcStateLength && _.OutsideQuiet)
setModel(fujitsu_ac_remote_model_t::ARREB1E);
switch (_.Cmd) {
case kFujitsuAcCmdTurnOff:
case kFujitsuAcCmdStepHoriz:
case kFujitsuAcCmdToggleSwingHoriz:
case kFujitsuAcCmdStepVert:
case kFujitsuAcCmdToggleSwingVert:
case kFujitsuAcCmdEcono:
case kFujitsuAcCmdPowerful:
setCmd(_.Cmd);
break;
}
if (_.Protocol == 0x31) setModel(fujitsu_ac_remote_model_t::ARREW4E);
}
/// Set the internal state from a valid code for this protocol.
/// @param[in] newState A valid code for this protocol.
/// @param[in] length Size of the newState array.
/// @return true, if successful; Otherwise false. (i.e. size check)
bool IRFujitsuAC::setRaw(const uint8_t newState[], const uint16_t length) {
if (length > kFujitsuAcStateLength) return false;
for (uint16_t i = 0; i < kFujitsuAcStateLength; i++) {
if (i < length)
_.longcode[i] = newState[i];
else
_.longcode[i] = 0;
}
buildFromState(length);
return true;
}
/// Request the A/C to step the Horizontal Swing.
void IRFujitsuAC::stepHoriz(void) { setCmd(kFujitsuAcCmdStepHoriz); }
/// Request the A/C to toggle the Horizontal Swing mode.
/// @param[in] update Do we need to update the general swing config?
void IRFujitsuAC::toggleSwingHoriz(const bool update) {
// Toggle the current setting.
if (update) setSwing(getSwing() ^ kFujitsuAcSwingHoriz);
// and set the appropriate special command.
setCmd(kFujitsuAcCmdToggleSwingHoriz);
}
/// Request the A/C to step the Vertical Swing.
void IRFujitsuAC::stepVert(void) { setCmd(kFujitsuAcCmdStepVert); }
/// Request the A/C to toggle the Vertical Swing mode.
/// @param[in] update Do we need to update the general swing config?
void IRFujitsuAC::toggleSwingVert(const bool update) {
// Toggle the current setting.
if (update) setSwing(getSwing() ^ kFujitsuAcSwingVert);
// and set the appropriate special command.
setCmd(kFujitsuAcCmdToggleSwingVert);
}
/// Set the requested (special) command part for the A/C message.
/// @param[in] cmd The special command code.
void IRFujitsuAC::setCmd(const uint8_t cmd) {
switch (cmd) {
case kFujitsuAcCmdTurnOff:
case kFujitsuAcCmdTurnOn:
case kFujitsuAcCmdStayOn:
case kFujitsuAcCmdStepVert:
case kFujitsuAcCmdToggleSwingVert:
_cmd = cmd;
break;
case kFujitsuAcCmdStepHoriz:
case kFujitsuAcCmdToggleSwingHoriz:
switch (_model) {
// Only these remotes have horizontal.
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARJW2:
_cmd = cmd;
break;
default:
_cmd = kFujitsuAcCmdStayOn;
}
break;
case kFujitsuAcCmdEcono:
case kFujitsuAcCmdPowerful:
switch (_model) {
// Only these remotes have these commands.
case ARREB1E:
case ARREW4E:
_cmd = cmd;
break;
default:
_cmd = kFujitsuAcCmdStayOn;
}
break;
default:
_cmd = kFujitsuAcCmdStayOn;
}
}
/// Set the requested (special) command part for the A/C message.
/// @return The special command code.
uint8_t IRFujitsuAC::getCmd(void) const {
return _cmd;
}
/// Change the power setting.
/// @param[in] on true, the setting is on. false, the setting is off.
void IRFujitsuAC::setPower(const bool on) {
setCmd(on ? kFujitsuAcCmdTurnOn : kFujitsuAcCmdTurnOff);
}
/// Set the requested power state of the A/C to off.
void IRFujitsuAC::off(void) { setPower(false); }
/// Set the requested power state of the A/C to on.
void IRFujitsuAC::on(void) { setPower(true); }
/// Get the value of the current power setting.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::getPower(void) const { return _cmd != kFujitsuAcCmdTurnOff; }
/// Set the Outside Quiet mode of the A/C.
/// @param[in] on true, the setting is on. false, the setting is off.
void IRFujitsuAC::setOutsideQuiet(const bool on) {
_.OutsideQuiet = on;
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the Outside Quiet mode status of the A/C.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::getOutsideQuiet(void) const {
switch (_model) {
// Only ARREB1E & ARREW4E seems to have this mode.
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARREW4E:
return _.OutsideQuiet;
default: return false;
}
}
/// Set the temperature.
/// @param[in] temp The temperature in degrees.
/// @param[in] useCelsius Use Celsius or Fahrenheit?
void IRFujitsuAC::setTemp(const float temp, const bool useCelsius) {
float mintemp;
float maxtemp;
uint8_t offset;
bool _useCelsius;
float _temp;
switch (_model) {
// These models have native Fahrenheit & Celsius upport.
case fujitsu_ac_remote_model_t::ARREW4E:
_useCelsius = useCelsius;
_temp = temp;
break;
// Make sure everything else uses Celsius.
default:
_useCelsius = true;
_temp = useCelsius ? temp : fahrenheitToCelsius(temp);
}
setCelsius(_useCelsius);
if (_useCelsius) {
mintemp = kFujitsuAcMinTemp;
maxtemp = kFujitsuAcMaxTemp;
offset = kFujitsuAcTempOffsetC;
} else {
mintemp = kFujitsuAcMinTempF;
maxtemp = kFujitsuAcMaxTempF;
offset = kFujitsuAcTempOffsetF;
}
_temp = std::max(mintemp, _temp);
_temp = std::min(maxtemp, _temp);
if (_useCelsius) {
if (_model == fujitsu_ac_remote_model_t::ARREW4E)
_.Temp = (_temp - (offset / 2)) * 2;
else
_.Temp = (_temp - offset) * 4;
} else {
_.Temp = _temp - offset;
}
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the current temperature setting.
/// @return The current setting for temp. in degrees of the currently set units.
float IRFujitsuAC::getTemp(void) const {
if (_model == fujitsu_ac_remote_model_t::ARREW4E) {
if (_.Fahrenheit) // Currently only ARREW4E supports native Fahrenheit.
return _.Temp + kFujitsuAcTempOffsetF;
else
return (_.Temp / 2.0) + (kFujitsuAcMinTemp / 2);
} else {
return _.Temp / 4 + kFujitsuAcMinTemp;
}
}
/// Set the speed of the fan.
/// @param[in] fanSpeed The desired setting.
void IRFujitsuAC::setFanSpeed(const uint8_t fanSpeed) {
if (fanSpeed > kFujitsuAcFanQuiet)
_.Fan = kFujitsuAcFanHigh; // Set the fan to maximum if out of range.
else
_.Fan = fanSpeed;
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the current fan speed setting.
/// @return The current fan speed.
uint8_t IRFujitsuAC::getFanSpeed(void) const { return _.Fan; }
/// Set the operating mode of the A/C.
/// @param[in] mode The desired operating mode.
void IRFujitsuAC::setMode(const uint8_t mode) {
if (mode > kFujitsuAcModeHeat)
_.Mode = kFujitsuAcModeHeat; // Set the mode to maximum if out of range.
else
_.Mode = mode;
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the operating mode setting of the A/C.
/// @return The current operating mode setting.
uint8_t IRFujitsuAC::getMode(void) const { return _.Mode; }
/// Set the requested swing operation mode of the A/C unit.
/// @param[in] swingMode The swingMode code for the A/C.
/// Vertical, Horizon, or Both. See constants for details.
/// @note Not all models support all possible swing modes.
void IRFujitsuAC::setSwing(const uint8_t swingMode) {
_.Swing = swingMode;
switch (_model) {
// No Horizontal support.
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARRY4:
// Set the mode to max if out of range
if (swingMode > kFujitsuAcSwingVert) _.Swing = kFujitsuAcSwingVert;
break;
// Has Horizontal support.
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARJW2:
default:
// Set the mode to max if out of range
if (swingMode > kFujitsuAcSwingBoth) _.Swing = kFujitsuAcSwingBoth;
}
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the requested swing operation mode of the A/C unit.
/// @return The contents of the swing state/mode.
uint8_t IRFujitsuAC::getSwing(void) const {
return _.Swing;
}
/// Set the Clean mode of the A/C.
/// @param[in] on true, the setting is on. false, the setting is off.
void IRFujitsuAC::setClean(const bool on) {
_.Clean = on;
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the Clean mode status of the A/C.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::getClean(void) const {
switch (_model) {
case fujitsu_ac_remote_model_t::ARRY4: return _.Clean;
default: return false;
}
}
/// Set the Filter mode status of the A/C.
/// @param[in] on true, the setting is on. false, the setting is off.
void IRFujitsuAC::setFilter(const bool on) {
_.Filter = on;
setCmd(kFujitsuAcCmdStayOn); // No special command involved.
}
/// Get the Filter mode status of the A/C.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::getFilter(void) const {
switch (_model) {
case fujitsu_ac_remote_model_t::ARRY4: return _.Filter;
default: return false;
}
}
/// Set the 10C heat status of the A/C.
/// @param[in] on true, the setting is on. false, the setting is off.
void IRFujitsuAC::set10CHeat(const bool on) {
switch (_model) {
// Only selected models support this.
case fujitsu_ac_remote_model_t::ARREW4E:
setClean(on); // 10C Heat uses the same bit as Clean
if (on) {
_.Mode = kFujitsuAcModeFan;
_.Power = true;
_.Fan = kFujitsuAcFanAuto;
_.Swing = kFujitsuAcSwingOff;
}
default:
break;
}
}
/// Get the 10C heat status of the A/C.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::get10CHeat(void) const {
switch (_model) {
case fujitsu_ac_remote_model_t::ARREW4E:
return (_.Clean && _.Power && _.Mode == kFujitsuAcModeFan &&
_.Fan == kFujitsuAcFanAuto && _.Swing == kFujitsuAcSwingOff);
default: return false;
}
}
/// Get the Timer type of the A/C message.
/// @return The current timer type in numeric form.
uint8_t IRFujitsuAC::getTimerType(void) const {
switch (_model) {
// These models seem to have timer support.
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARREB1E:
return _.TimerType;
default: return kFujitsuAcStopTimers;
}
}
/// Set the Timer type of the A/C message.
/// @param[in] timertype The kind of timer to use for the message.
void IRFujitsuAC::setTimerType(const uint8_t timertype) {
switch (timertype) {
case kFujitsuAcSleepTimer:
case kFujitsuAcOnTimer:
case kFujitsuAcOffTimer:
case kFujitsuAcStopTimers:
_.TimerType = timertype;
break;
default: _.TimerType = kFujitsuAcStopTimers;
}
}
/// Get the On Timer setting of the A/C.
/// @return nr of minutes left on the timer. 0 means disabled/not supported.
uint16_t IRFujitsuAC::getOnTimer(void) const {
if (getTimerType() == kFujitsuAcOnTimer)
return _.OnTimer;
return 0;
}
/// Set the On Timer setting of the A/C.
/// @param[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
void IRFujitsuAC::setOnTimer(const uint16_t nr_mins) {
_.OnTimer = std::min(kFujitsuAcTimerMax, nr_mins); // Bounds check.
if (_.OnTimer) {
_.TimerType = kFujitsuAcOnTimer;
} else if (getTimerType() == kFujitsuAcOnTimer) {
_.TimerType = kFujitsuAcStopTimers;
}
}
/// Get the Off/Sleep Timer setting of the A/C.
/// @return nr of minutes left on the timer. 0 means disabled/not supported.
uint16_t IRFujitsuAC::getOffSleepTimer(void) const {
switch (getTimerType()) {
case kFujitsuAcOffTimer:
case kFujitsuAcSleepTimer:
return _.OffTimer;
default:
return 0;
}
}
/// Set the Off/Sleep Timer time for the A/C.
/// @param[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
inline void IRFujitsuAC::setOffSleepTimer(const uint16_t nr_mins) {
_.OffTimer = std::min(kFujitsuAcTimerMax, nr_mins); // Bounds check.
}
/// Set the Off Timer time for the A/C.
/// @param[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
void IRFujitsuAC::setOffTimer(const uint16_t nr_mins) {
setOffSleepTimer(nr_mins);
if (nr_mins)
_.TimerType = kFujitsuAcOffTimer;
else if (getTimerType() != kFujitsuAcOnTimer)
_.TimerType = kFujitsuAcStopTimers;
}
/// Set the Sleep Timer time for the A/C.
/// @param[in] nr_mins Nr. of minutes to set the timer to. 0 means disabled.
void IRFujitsuAC::setSleepTimer(const uint16_t nr_mins) {
setOffSleepTimer(nr_mins);
if (nr_mins)
_.TimerType = kFujitsuAcSleepTimer;
else if (getTimerType() != kFujitsuAcOnTimer)
_.TimerType = kFujitsuAcStopTimers;
}
/// Verify the checksum is valid for a given state.
/// @param[in] state The array to verify the checksum of.
/// @param[in] length The length of the state array.
/// @return true, if the state has a valid checksum. Otherwise, false.
bool IRFujitsuAC::validChecksum(uint8_t state[], const uint16_t length) {
uint8_t sum = 0;
uint8_t sum_complement = 0;
uint8_t checksum = state[length - 1];
switch (length) {
case kFujitsuAcStateLengthShort: // ARRAH2E, ARREB1E, & ARRY4
return state[length - 1] == (uint8_t)~state[length - 2];
case kFujitsuAcStateLength - 1: // ARDB1 & ARJW2
sum = sumBytes(state, length - 1);
sum_complement = 0x9B;
break;
case kFujitsuAcStateLength: // ARRAH2E, ARRY4, & ARREB1E
sum = sumBytes(state + kFujitsuAcStateLengthShort,
length - 1 - kFujitsuAcStateLengthShort);
break;
default: // Includes ARDB1 & ARJW2 short.
return true; // Assume the checksum is valid for other lengths.
}
return checksum == (uint8_t)(sum_complement - sum); // Does it match?
}
/// Set the device's remote ID number.
/// @param[in] num The ID for the remote. Valid number range is 0 to 3.
void IRFujitsuAC::setId(const uint8_t num) { _.Id = num; }
/// Get the current device's remote ID number.
/// @return The current device's remote ID number.
uint8_t IRFujitsuAC::getId(void) const { return _.Id; }
/// Set the Temperature units for the A/C.
/// @param[in] on true, use Celsius. false, use Fahrenheit.
void IRFujitsuAC::setCelsius(const bool on) { _.Fahrenheit = !on; }
/// Get the Clean mode status of the A/C.
/// @return true, the setting is on. false, the setting is off.
bool IRFujitsuAC::getCelsius(void) const { return !_.Fahrenheit; }
/// Convert a stdAc::opmode_t enum into its native mode.
/// @param[in] mode The enum to be converted.
/// @return The native equivalent of the enum.
uint8_t IRFujitsuAC::convertMode(const stdAc::opmode_t mode) {
switch (mode) {
case stdAc::opmode_t::kCool: return kFujitsuAcModeCool;
case stdAc::opmode_t::kHeat: return kFujitsuAcModeHeat;
case stdAc::opmode_t::kDry: return kFujitsuAcModeDry;
case stdAc::opmode_t::kFan: return kFujitsuAcModeFan;
default: return kFujitsuAcModeAuto;
}
}
/// Convert a stdAc::fanspeed_t enum into it's native speed.
/// @param[in] speed The enum to be converted.
/// @return The native equivalent of the enum.
uint8_t IRFujitsuAC::convertFan(stdAc::fanspeed_t speed) {
switch (speed) {
case stdAc::fanspeed_t::kMin: return kFujitsuAcFanQuiet;
case stdAc::fanspeed_t::kLow: return kFujitsuAcFanLow;
case stdAc::fanspeed_t::kMedium: return kFujitsuAcFanMed;
case stdAc::fanspeed_t::kHigh:
case stdAc::fanspeed_t::kMax: return kFujitsuAcFanHigh;
default: return kFujitsuAcFanAuto;
}
}
/// Convert a native mode into its stdAc equivalent.
/// @param[in] mode The native setting to be converted.
/// @return The stdAc equivalent of the native setting.
stdAc::opmode_t IRFujitsuAC::toCommonMode(const uint8_t mode) {
switch (mode) {
case kFujitsuAcModeCool: return stdAc::opmode_t::kCool;
case kFujitsuAcModeHeat: return stdAc::opmode_t::kHeat;
case kFujitsuAcModeDry: return stdAc::opmode_t::kDry;
case kFujitsuAcModeFan: return stdAc::opmode_t::kFan;
default: return stdAc::opmode_t::kAuto;
}
}
/// Convert a native fan speed into its stdAc equivalent.
/// @param[in] speed The native setting to be converted.
/// @return The stdAc equivalent of the native setting.
stdAc::fanspeed_t IRFujitsuAC::toCommonFanSpeed(const uint8_t speed) {
switch (speed) {
case kFujitsuAcFanHigh: return stdAc::fanspeed_t::kMax;
case kFujitsuAcFanMed: return stdAc::fanspeed_t::kMedium;
case kFujitsuAcFanLow: return stdAc::fanspeed_t::kLow;
case kFujitsuAcFanQuiet: return stdAc::fanspeed_t::kMin;
default: return stdAc::fanspeed_t::kAuto;
}
}
/// Convert the current internal state into its stdAc::state_t equivalent.
/// @return The stdAc equivalent of the native settings.
stdAc::state_t IRFujitsuAC::toCommon(void) const {
stdAc::state_t result;
result.protocol = decode_type_t::FUJITSU_AC;
result.model = _model;
result.power = getPower();
result.mode = toCommonMode(_.Mode);
result.celsius = getCelsius();
result.degrees = getTemp();
result.fanspeed = toCommonFanSpeed(_.Fan);
uint8_t swing = _.Swing;
switch (result.model) {
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARRY4:
result.clean = _.Clean;
result.filter = _.Filter;
result.swingv = (swing & kFujitsuAcSwingVert) ? stdAc::swingv_t::kAuto
: stdAc::swingv_t::kOff;
result.swingh = (swing & kFujitsuAcSwingHoriz) ? stdAc::swingh_t::kAuto
: stdAc::swingh_t::kOff;
break;
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARJW2:
default:
result.swingv = stdAc::swingv_t::kOff;
result.swingh = stdAc::swingh_t::kOff;
}
result.quiet = _.Fan == kFujitsuAcFanQuiet;
result.turbo = _cmd == kFujitsuAcCmdPowerful;
result.econo = _cmd == kFujitsuAcCmdEcono;
// Not supported.
result.light = false;
result.filter = false;
result.clean = false;
result.beep = false;
result.sleep = -1;
result.clock = -1;
return result;
}
/// Convert the current internal state into a human readable string.
/// @return A human readable string.
String IRFujitsuAC::toString(void) const {
String result = "";
result.reserve(100); // Reserve some heap for the string to reduce fragging.
fujitsu_ac_remote_model_t model = _model;
result += addModelToString(decode_type_t::FUJITSU_AC, model, false);
result += addIntToString(_.Id, kIdStr);
result += addBoolToString(getPower(), kPowerStr);
result += addModeToString(_.Mode, kFujitsuAcModeAuto, kFujitsuAcModeCool,
kFujitsuAcModeHeat, kFujitsuAcModeDry,
kFujitsuAcModeFan);
result += addTempFloatToString(getTemp(), getCelsius());
result += addFanToString(_.Fan, kFujitsuAcFanHigh, kFujitsuAcFanLow,
kFujitsuAcFanAuto, kFujitsuAcFanQuiet,
kFujitsuAcFanMed);
switch (model) {
// These models have no internal swing, clean. or filter state.
case fujitsu_ac_remote_model_t::ARDB1:
case fujitsu_ac_remote_model_t::ARJW2:
break;
// These models have Clean & Filter, plus Swing (via fall thru)
case fujitsu_ac_remote_model_t::ARRAH2E:
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARRY4:
result += addBoolToString(getClean(), kCleanStr);
result += addBoolToString(getFilter(), kFilterStr);
// FALL THRU
default: // e.g. ARREW4E
if (model == fujitsu_ac_remote_model_t::ARREW4E)
result += addBoolToString(get10CHeat(), k10CHeatStr);
result += addIntToString(_.Swing, kSwingStr);
result += kSpaceLBraceStr;
switch (_.Swing) {
case kFujitsuAcSwingOff:
result += kOffStr;
break;
case kFujitsuAcSwingVert:
result += kSwingVStr;
break;
case kFujitsuAcSwingHoriz:
result += kSwingHStr;
break;
case kFujitsuAcSwingBoth:
result += kSwingVStr;
result += '+';
result += kSwingHStr;
break;
default:
result += kUnknownStr;
}
result += ')';
}
result += kCommaSpaceStr;
result += kCommandStr;
result += kColonSpaceStr;
switch (_cmd) {
case kFujitsuAcCmdStepHoriz:
result += kStepStr;
result += ' ';
result += kSwingHStr;
break;
case kFujitsuAcCmdStepVert:
result += kStepStr;
result += ' ';
result += kSwingVStr;
break;
case kFujitsuAcCmdToggleSwingHoriz:
result += kToggleStr;
result += ' ';
result += kSwingHStr;
break;
case kFujitsuAcCmdToggleSwingVert:
result += kToggleStr;
result += ' ';
result += kSwingVStr;
break;
case kFujitsuAcCmdEcono:
result += kEconoStr;
break;
case kFujitsuAcCmdPowerful:
result += kPowerfulStr;
break;
default:
result += kNAStr;
}
uint16_t mins = 0;
String type_str = kTimerStr;
switch (model) {
case fujitsu_ac_remote_model_t::ARREB1E:
case fujitsu_ac_remote_model_t::ARREW4E:
result += addBoolToString(getOutsideQuiet(), kOutsideQuietStr);
// FALL THRU
// These models seem to have timer support.
case fujitsu_ac_remote_model_t::ARRAH2E:
switch (getTimerType()) {
case kFujitsuAcOnTimer:
type_str = kOnTimerStr;
mins = getOnTimer();
break;
case kFujitsuAcOffTimer:
type_str = kOffTimerStr;
mins = getOffSleepTimer();
break;
case kFujitsuAcSleepTimer:
type_str = kSleepTimerStr;
mins = getOffSleepTimer();
break;
}
result += addLabeledString(mins ? minsToString(mins) : kOffStr, type_str);
break;
default:
break;
}
return result;
}
#if DECODE_FUJITSU_AC
/// Decode the supplied Fujitsu AC IR message if possible.
/// Status: STABLE / Working.
/// @param[in,out] results Ptr to the data to decode & where to store the decode
/// result.
/// @param[in] offset The starting index to use when attempting to decode the
/// raw data. Typically/Defaults to kStartOffset.
/// @param[in] nbits The number of data bits to expect.
/// @param[in] strict Flag indicating if we should perform strict matching.
/// @return A boolean. True if it can decode it, false if it can't.
bool IRrecv::decodeFujitsuAC(decode_results* results, uint16_t offset,
const uint16_t nbits,
const bool strict) {
uint16_t dataBitsSoFar = 0;
// Have we got enough data to successfully decode?
if (results->rawlen < (2 * kFujitsuAcMinBits) + kHeader + kFooter - 1 +
offset)
return false; // Can't possibly be a valid message.
// Compliance
if (strict) {
switch (nbits) {
case kFujitsuAcBits:
case kFujitsuAcBits - 8:
case kFujitsuAcMinBits:
case kFujitsuAcMinBits + 8: break;
default: return false; // Must be called with the correct nr. of bits.
}
}
// Header / Some of the Data
uint16_t used = matchGeneric(results->rawbuf + offset, results->state,
results->rawlen - offset, kFujitsuAcMinBits - 8,
kFujitsuAcHdrMark, kFujitsuAcHdrSpace, // Header
kFujitsuAcBitMark, kFujitsuAcOneSpace, // Data
kFujitsuAcBitMark, kFujitsuAcZeroSpace,
0, 0, // No Footer (yet)
false, _tolerance + kFujitsuAcExtraTolerance, 0,
false); // LSBF
if (!used) return false;
offset += used;
// Check we have the typical data header.
if (results->state[0] != 0x14 || results->state[1] != 0x63) return false;
dataBitsSoFar += kFujitsuAcMinBits - 8;
// Keep reading bytes until we either run out of message or state to fill.
match_result_t data_result;
for (uint16_t i = 5;
offset <= results->rawlen - 16 && i < kFujitsuAcStateLength;
i++, dataBitsSoFar += 8, offset += data_result.used) {
data_result = matchData(
&(results->rawbuf[offset]), 8, kFujitsuAcBitMark, kFujitsuAcOneSpace,
kFujitsuAcBitMark, kFujitsuAcZeroSpace,
_tolerance + kFujitsuAcExtraTolerance, 0, false);
if (data_result.success == false) break; // Fail
results->state[i] = data_result.data;
}
// Footer
if (offset > results->rawlen ||
!matchMark(results->rawbuf[offset++], kFujitsuAcBitMark))
return false;
// The space is optional if we are out of capture.
if (offset < results->rawlen &&