-
Notifications
You must be signed in to change notification settings - Fork 4
/
AdvAir.sh
executable file
·1961 lines (1841 loc) · 72.2 KB
/
AdvAir.sh
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
#!/bin/bash
################################################################################
#
# A massive thank you to John Talbot of homebridge-cmd4 for all his work on
# improving this shell script and the improvements to homebridge-cmd4 to cater
# further to the Advantage Air controller and all of it's Homebridge users!
#
# A massive thanks also to @uswong for his ideas and contributions to adding
# 'rotationSpeed' to the Fan accessory and a "linkedType" 'Fan Speed' to the
# Thermostat # accessory for speed control (low/medium/high/auto). I am very
# pleased with the work and I think a lot of users will be too!
#
###############################################################################
# Lets be explicit
typeset -i a argSTART argEND
#
# Passed in required Args
#
argEND=$#
IP=""
PORT=""
device=""
io=""
characteristic=""
value="1"
#
# Global returned data
#
myAirData=""
jqResult=""
fanState=0
coolState=0
heatState=0
rc=1
declare -a idArray_g
#
# For optional args and arg parsing
#
# Default values
zone=""
zoneSpecified=false
myZoneSpecified=false
fanSpecified=false
fanTimerSpecified=false
coolTimerSpecified=false
heatTimerSpecified=false
argSTART=4
logErrors=true
debugSpecified=false
fanSpeed=false
sameAsCached=false
myZoneAssigned=false
fspeed="low"
lightID=""
thingID=""
# By default selfTest is off
selfTest="TEST_OFF"
# Define the aircon system "ac1", "ac2", etc, default to "ac1" if not explicitly specified
ac="ac1"
# Define some variables for zone open checking
zoneOpen=0
# For timer capability
timerEnabled=false
# For flip capability for things' open/close, up/down mode
flipEnabled=false
# For lights and things (like garage, etc) controls
lightSpecified=false
thingSpecified=false
#Temporary files - the subdirectory full path will be defined later
if [ -z "${TMPDIR}" ]; then TMPDIR="/tmp"; fi
tmpSubDir="${TMPDIR}"
QUERY_AIRCON_LOG_FILE="queryCachedAirCon_calls.log"
QUERY_IDBYNAME_LOG_FILE="queryIdByName.log"
MY_AIRDATA_FILE="myAirData.txt"
FANTIMER_STATE_FILE="fanTimer.txt"
COOLTIMER_STATE_FILE="coolTimer.txt"
HEATTIMER_STATE_FILE="heatTimer.txt"
ZONEOPEN_FILE="zoneOpen.txt"
function showHelp()
{
local rc="$1"
cat <<' HELP_EOF'
Usage:
AdvAir.sh Get < AccessoryName > < characteristic > [ Options ]
or
AdvAir.sh Set < AccessoryName > < characteristic > < value > [ Options ]
Where Options maybe any of the following in any order:
z01, z02, z03 ... The zone to Set or Query
XXX.XXX.XXX.XXX The IP address of the AirCon to talk to
fanSpeed If the accessory is used to control the fan speed
timer To use a Lightbulb accessory as a timer
Additional test options to the above are:
TEST_OFF The default
TEST_ON For npm run test
HELP_EOF
exit "$rc"
}
function logError()
{
if [ "$logErrors" != true ]; then
return
fi
local comment="$1"
local result="$2"
local data1="$3"
local data2="$4"
local sfx
local file
local count
sfx="$rc-$io-$device-$characteristic"
sfx=${sfx// /_}
local fileName="${tmpSubDir}/AAerror-${sfx}.txt"
file=$(find "${fileName}"* 2>&1|grep -v find)
#
# append a counter to the file so that the number of same error is logged
if [ -f "${file}" ]; then
count=$(echo "${file}" | cut -d'#' -f2)
count=$((count + 1))
else
count=1
fi
rm -f "${file}"
#
fileName="${fileName}#${count}"
{ echo "$io $device $characteristic"
echo "${comment}"
echo "return code: $rc"
echo "result: $result"
echo "data1: $data1"
echo "data2: $data2"
} > "$fileName"
if [ "${io}" = "Set" ]; then
logQueryAirConDiagnostic "Unhandled $io $device $characteristic $value rc=$rc - this accessory is most likely offline"
elif [ "${io}" = "Get" ]; then
logQueryAirConDiagnostic "Unhandled $io $device $characteristic rc=$rc - this accessory is most likely offline!"
fi
}
function logQueryAirConDiagnostic()
{
if [ "$debugSpecified" != true ]; then
return
fi
local str="$1"
echo "$str" >> "$QUERY_AIRCON_LOG_FILE"
# Delete the log if it is > 15 MB
fSize=$(find "$QUERY_AIRCON_LOG_FILE" -ls | awk '{print $7}')
if [ "$fSize" -gt 15728640 ];then
rm "$QUERY_AIRCON_LOG_FILE"
fi
}
function logQueryIdByNameDiagnostic()
{
if [ "$debugSpecified" != true ]; then
return
fi
local str="$1"
echo "$str" >> "$QUERY_IDBYNAME_LOG_FILE"
# Delete the log if it is > 15 MB
fSize=$(find "$QUERY_IDBYNAME_LOG_FILE" -ls | awk '{print $7}')
if [ "$fSize" -gt 15728640 ];then
rm "$QUERY_IDBYNAME_LOG_FILE"
fi
}
function getFileStatDt()
{
local fileName="$1"
# This script is to determine the time of a file using 'stat'
# command and calculate the age of the file in seconds
# The return variables of this script:
# tf = last changed time of the file since Epoch
# t0 = current time since Epoch
# dt = the age of the file in seconds since last changed
case "$OSTYPE" in
darwin*)
tf=$( stat -r "$fileName" | awk '{print $11}' ) # for Mac users
;;
*)
tf=$( stat -c %Z "$fileName" )
;;
esac
t0=$(date '+%s')
dt=$((t0 - tf))
}
# NOTE: ONLY queryAirConWithIterations CALLS THIS !!!
function queryCachedAirCon()
{
local url="$1"
local exitOnFail="$2"
local forceFetch="$3"
local iteration="$4"
local queryType
local myAirData_cached="{}"
local lockFile="${MY_AIRDATA_FILE}.lock"
local dateFile="${MY_AIRDATA_FILE}.date"
t0=$(date '+%s')
# The dateFile is only valid if there is an MY_AIRDATA_FILE
local useFileCache=false
local doFetch=false
local dt=-1
# The dateFile and MY_AIRDATA_FILE must exist together to check
# for a valid date stamp
if [[ -f "$dateFile" && -f "$MY_AIRDATA_FILE" ]]; then
tf=$(cat "$dateFile")
dt=$(( t0 - tf ))
if [ "$dt" -le 120 ]; then
useFileCache=true
elif [[ "$dt" -gt 180 && -f "$lockFile" ]]; then # an earlier curl may have timed out
tlf=$(cat "$lockFile")
dtlf=$(( t0 - tlf ))
if [ "$dtlf" -ge 60 ]; then # earlier curl has timed out, recover and try again
rm "$lockFile"
rc=99
logQueryAirConDiagnostic "queryCachedAirCon_calls_earlier_CMD4_timed_out $tf $t0 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
return
fi
fi
fi
logQueryAirConDiagnostic "queryCachedAirCon_calls $tf $t0 $dt $useFileCache itr=$iteration $io $device $characteristic $url"
if [ "$forceFetch" = true ] || [ "$useFileCache" = false ]; then
doFetch=true
fi
# If $lockFile is detected, iterate until it is deleted or 60s whichever is earlier
# The $lockfile can be there for 1s to 60s (even beyond occasionally) for a big system, with an average of ~6s
#
if [ -f "$lockFile" ]; then
queryType="copy"
tlf=$(cat "$lockFile")
while [ -f "$lockFile" ]; do
sleep 1.0
t2=$(date '+%s')
dt=$(( t2 - t0 ))
dtlf=$(( t2 - tlf ))
if [ "$dtlf" -ge 60 ]; then
# earlier CMD4 has timed out (CMD4 timeout:60000) - this rarely happen (<0.1% of the time)
# flag it and copy the existing cached file and move on. May not have enough time to retry
rc=98
logQueryAirConDiagnostic "queryCachedAirCon_copy_earlier_CMD4_timed_out $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
# To test the logic, issue this comment
if [ "$selfTest" = "TEST_ON" ]; then
echo "Earlier \"curl\" to getSystemData has timed out"
fi
break
fi
done
myAirData=$( cat "$MY_AIRDATA_FILE" )
rc=$?
logQueryAirConDiagnostic "queryCachedAirCon_copy $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
# To test the logic, issue this comment
if [ "$selfTest" = "TEST_ON" ]; then
echo "Fetching myAirData from cached file"
fi
elif [ "$doFetch" = true ]; then
echo "$t0" > "$lockFile"
queryType="curl"
myAirData=$( curl --fail -s -g "$url")
rc=$?
if [ "$rc" = "0" ]; then
#Need to parse to ensure the json file is not empty
parseMyAirDataWithJq ".aircons.$ac.info" "${exitOnFail}"
if [ "$rc" = "0" ]; then
t2=$(date '+%s')
echo "$t2" > "$dateFile" # overwrite $dateFile
#if $myAirData is not the same as the cached file, overwrite it with the new $myAirData
if [ -f "$MY_AIRDATA_FILE" ]; then isMyAirDataSameAsCached; fi
if [ $sameAsCached = false ]; then echo "$myAirData" > "$MY_AIRDATA_FILE"; fi
dt=$((t2 - t0)) # time-taken for curl command to complete
logQueryAirConDiagnostic "queryCachedAirCon_curl $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
else
echo "{}" > "$MY_AIRDATA_FILE"
echo "$t2" > "$dateFile"
logQueryAirConDiagnostic "queryCachedAirCon_curl_invalid $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
# just in case
unset myAirData
fi
else
echo "{}" > "$MY_AIRDATA_FILE"
echo "$t2" > "$dateFile"
logQueryAirConDiagnostic "queryCachedAirCon_curl_failed $t0 $t2 $dt $useFileCache rc=$rc itr=$iteration $io $device $characteristic $url"
unset myAirData
fi
rm "$lockFile"
elif [ "$doFetch" = false ]; then
queryType="cache"
myAirData=$( cat "$MY_AIRDATA_FILE" )
rc=$?
fi
if [ "$rc" != "0" ]; then
if [ "$exitOnFail" = "1" ]; then
logError "getValue_${queryType} failed" "" "" "$url"
exit $rc
fi
fi
}
function isMyAirDataSameAsCached()
{
local aircons
local lights
local things
local myAirData_cached
local aircons_cached
local lights_cached
local things_cached
myAirData_cached=$(cat "$MY_AIRDATA_FILE")
if [ "$myAirData_cached" = "$myAirData" ]; then
sameAsCached=true
return
elif [ "$myAirData_cached" = "{}" ]; then
return
fi
# For aircon system with temperature sensors, "rssi" and "measuredTemp" are changing all the time
# do not need to compare "rssi" but if "measuredTemp" is changed, cached file will be updated
# compare only the aircons, lights and things - all the rest does not matter
aircons=$(echo "$myAirData"|jq -ec ".aircons[]"|sed s/rssi\":[0-9]*/rssi\":0/g)
lights=$(echo "$myAirData"|jq -ec ".myLights.lights[]")
things=$(echo "$myAirData"|jq -ec ".myThings.things[]")
aircons_cached=$(echo "$myAirData_cached"|jq -ec ".aircons[]"|sed s/rssi\":[0-9]*/rssi\":0/g)
lights_cached=$(echo "$myAirData_cached"|jq -ec ".myLights.lights[]")
things_cached=$(echo "$myAirData_cached"|jq -ec ".myThings.things[]")
if [[ "$aircons" = "$aircons_cached" && "$lights" = "$lights_cached" && "$things" = "$things_cached" ]]; then sameAsCached=true; fi
}
function setAirConUsingIteration()
{
local url="$1"
local dateFile="${MY_AIRDATA_FILE}.date"
# This script is purely used to 'Set' the AA system and to update the MY_AIRDATA_FILE cached file
if [ "$selfTest" = "TEST_ON" ]; then
# For Testing, you can compare whats sent
echo "Setting url: $url";
fi
# Try 5 times, the last returning the error found.
for i in 0 1 2 3 4
do
if [ "$selfTest" = "TEST_ON" ]; then
echo "Try $i"
fi
local exitOnFail="0"
if [ "$i" = "4" ]; then
exitOnFail="1"
fi
t3=$(date '+%s')
curlResult=$(curl --fail -s -g "$url")
rc=$?
curlResult=$(echo "${curlResult}" | grep false)
if [[ "$rc" = "0" && -n "${curlResult}" ]]; then rc=5; fi
logQueryAirConDiagnostic "setAirCon_curl $t3 rc=$rc itr=$i $io $device $characteristic $value $url"
if [ "$rc" = "0" ]; then
# update $MY_AIRDATA_FILE directly instead of fetching a new copy from AdvantageAir controller after a set command
updateMyAirDataCachedFile "$url"
myAirData=$( cat "$MY_AIRDATA_FILE" )
echo "$t3" > "$dateFile"
return
fi
if [ "$exitOnFail" = "1" ]; then
logQueryAirConDiagnostic "setAirCon_curl_failed $t3 rc=$rc $io $device $characteristic $value $url"
logError "SetAirCon_curl failed" "" "$io" "$url"
exit $rc
fi
sleep 1.0
done
}
function updateMyAirDataCachedFile()
{
local url="$1"
# This script to parse the curl $url: input - 'http://192.168.0.31:2025/setAircon?json={ac1:{zones:{z04:{state:open}}}}'
# into jq set path: output - '.aircons.ac1.zones.z04.state="open"'
# input - 'http://192.168.0.31:2025/setAircon?json={ac1:{zones:{z04:{value:90}}}}'
# output - '.aircons.ac1.zones.z04.value=90'
# input - 'http://192.168.0.31:2025/setAircon?json={ac1:{info:{state:on,mode:vent}}}'
# output1 - '.aircons.ac1.info.state="on"
# output2 - '.aircons.ac1.info.mode="vent"
local setNumber
local setMode
local jqPathToSetJson
local jqPathToSetJsonState
local JqHeader=${url:$((${#IP}+13)):8}
local setJqPath=${url:$((${#IP}+13)):100}
setNumber=$(echo "$setJqPath"|grep 'value\|setTemp\|countDownTo\|myZone')
setMode=$(echo "$setJqPath"|grep mode)
# Strip down $jqPath by removing `"`, `{`, `}` and replace the last `:` with `=`
# then replace the rest of `:` with `.`
setJqPath=$(echo "$setJqPath"|sed s/[\"\{\}]//g|sed -E 's/(.*)\:/\1=/'|sed s/:/./g)
#
case $JqHeader in
setAirco)
setJqPath=${setJqPath//setAircon?json=/.aircons.}
if [ -n "$setNumber" ]; then
jqPathToSetJson=$setJqPath
elif [ -n "$setMode" ]; then
jqPathToSetJson=$(echo "$setJqPath"|sed s/state.on,//|sed 's/\(=\)\(.*\)/\1"\2"/g')
jqPathToSetJsonState=$(echo "$jqPathToSetJson"|cut -d"=" -f1|sed s/mode/state=\"on\"/)
updateMyAirDataCachedFileWithJq "$url" "$jqPathToSetJsonState"
else # value is a string
setJqPath=${setJqPath//=/=\"}
jqPathToSetJson=$setJqPath\"
fi
updateMyAirDataCachedFileWithJq "$url" "$jqPathToSetJson"
;;
setLight)
setJqPath=$(echo "$setJqPath"|sed s/setLight?json=id./.myLights.lights.\"/|sed s/,/\"./)
if [ -n "$setNumber" ]; then
jqPathToSetJson=$setJqPath
else # value is a string
setJqPath=${setJqPath//=/=\"}
jqPathToSetJson=$setJqPath\"
fi
updateMyAirDataCachedFileWithJq "$url" "$jqPathToSetJson"
;;
setThing) # value for things is always a number
jqPathToSetJson=$(echo "$setJqPath"|sed s/setThing?json=id./.myThings.things.\"/|sed s/,/\"./)
updateMyAirDataCachedFileWithJq "$url" "$jqPathToSetJson"
;;
esac
}
function updateMyAirDataCachedFileWithJq()
{
# this script to use jq to update the $MY_AIRDATA_FILE
local url="$1"
local jqPath="$2"
local updatedMyAirData
#
updatedMyAirData=$(jq -ec "$jqPath" "$MY_AIRDATA_FILE")
rc=$?
if [ "$rc" = "0" ]; then
echo "$updatedMyAirData" > "$MY_AIRDATA_FILE"
logQueryAirConDiagnostic "setAirCon_setJson $t3 rc=$rc $io $device $characteristic $jqPath"
if [ "$selfTest" = "TEST_ON" ]; then
# For Testing, you can compare whats sent
echo "Setting json: $jqPath"
fi
else
logQueryAirConDiagnostic "setAirCon_setJson_failed $t3 rc=$rc $io $device $characteristic $jqPath"
logError "setAirCon_setJson jq failed" "$jqPath" "" "$url"
exit $rc
fi
}
function parseMyAirDataWithJq()
{
local jqPath="$1"
local exitOnFail="$2"
# Understanding jq options
# -e (Upon bad data, exit with return code )
# Updates global variable jqResult
jqResult=$( echo "$myAirData" | jq -e "$jqPath" )
rc=$?
if [ "$rc" = "1" ] && [ "$jqResult" = false ]; then # "false" is an acceptable answer
rc=0
fi
if [ "$rc" != "0" ]; then
if [ "$selfTest" = "TEST_ON" ]; then
# For Testing, you can compare whats sent
echo "Parsing for jqPath failed: $jqPath";
fi
if [ "$exitOnFail" = "1" ]; then
logQueryAirConDiagnostic "parseMyAirDataWithJq_failed rc=$rc jqResult=$jqResult $io $device $characteristic $jqPath"
logError "jq failed" "$rc" "$jqResult" "" "$jqPath"
exit $rc
fi
else
if [ "$selfTest" = "TEST_ON" ]; then
# For Testing, you can compare whats sent
echo "Parsing for jqPath: $jqPath";
fi
fi
}
function queryAirConWithIterations()
{
local url="$1"
local forceFetch="$2"
# Try 5 times, the last returning the error found.
for i in 0 1 2 3 4
do
if [ "$selfTest" = "TEST_ON" ]; then
echo "Try $i"
fi
local exitOnFail="0"
if [ "$i" = "4" ]; then
exitOnFail="1"
fi
# Updates global variable myAirData
queryCachedAirCon "$url" "$exitOnFail" "$forceFetch" "$i"
if [ "$rc" = "0" ]; then
break
else
sleep 1.2
fi
done
}
function getMyAirDataFromCachedFile()
{
# get myAirData from $MY_AIRDATA_FILE cached file
if [ -f "$MY_AIRDATA_FILE" ]; then
myAirData=$(cat "$MY_AIRDATA_FILE")
if [ "$selfTest" = "TEST_ON" ]; then
echo "Getting myAirData.txt from cached file"
fi
else
queryAirConWithIterations "http://$IP:$PORT/getSystemData" false
fi
}
function queryIdByName()
{
local path="$1"
local name="$2"
# This script is to extract the ID(s) of a light by its name or a thing
# (garage, blinds, etc) by its name
# A name may be associated with more than 1 physcial light/thing
local name1 name2 name3 name4
local ids=""
name1=$(echo "$name"|cut -d" " -f1)
name2=$(echo "$name"|cut -d" " -f2)
name3=$(echo "$name"|cut -d" " -f3)
name4=$(echo "$name"|cut -d" " -f4)
# Obtain the unique ID by its name from a MY_AIRDATA_FILE, Which is updated
# every "Set" command or after 2 minutes of every "Get"
# Scan for the unique IDs of lights or things by their names using jq command.
# Each name might be associated with more than 1 light/thing hence can have
# more than 1 ID. As such the ID(s) is/are output to an array "$idArray_g"
if [ "$path" = "light" ]; then
ids=$( echo "${myAirData}" | jq -e ".myLights.lights[]|select(.name|test(\"$name1\"))|select(.name|test(\"$name2\"))|select(.name|test(\"$name3\"))|select(.name|test(\"$name4\"))|.id" )
rc=$?
elif [ "$path" = "thing" ]; then
ids=$( echo "${myAirData}" | jq -e ".myThings.things[]|select(.name|test(\"$name1\"))|select(.name|test(\"$name2\"))|select(.name|test(\"$name3\"))|select(.name|test(\"$name4\"))|.id" )
rc=$?
else
rc=5
fi
if [ "$ids" != "" ];then
eval "idArray_g=($ids)"
fi
# for diagnostic purpuses
t4=$(date '+%s')
logQueryIdByNameDiagnostic "queryIdByName_jq $t4 rc=$rc $io path=$path $characteristic id=${ids} name=$name"
if [ "$rc" != "0" ]; then
logQueryIdByNameDiagnostic "queryIdByName_jq_failed $t4 rc=$rc $io path=$path $characteristic id=${ids} name=$name"
logError "queryIdByName_jq failed" "${ids}" "${path}" "$name"
if [ "$selfTest" = "TEST_ON" ]; then
echo "Parsing id for \"$path:$name\" failed"
fi
exit $rc
fi
# This is good to test for
if [ "$selfTest" = "TEST_ON" ]; then
echo "path: $path name: $name ids=${ids[0]}"
fi
}
function openZoneInFullWithZoneOpenCounter()
{
Zone="$1"
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{zones:{$Zone:{state:open}}}}"
# update the number of zoneOpen in a temporary file to be used up to 10 seconds
zoneOpen=$((zoneOpen + 1))
echo "$zoneOpen" > "$ZONEOPEN_FILE"
parseMyAirDataWithJq ".aircons.$ac.zones.${Zone}.rssi" "1"
if [ "${jqResult}" = "0" ]; then
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{zones:{$Zone:{value:100}}}}"
fi
}
function closeZoneWithZoneOpenCounter()
{
Zone="$1"
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{zones:{$Zone:{state:close}}}}"
# update the number of zoneOpen in a temporary file to be used up to 10 seconds
zoneOpen=$((zoneOpen - 1))
echo "$zoneOpen" > "$ZONEOPEN_FILE"
}
function setMyZoneToAnOpenedZoneWithTempSensorWithPriorityToCzones()
{
# set myZone to an open zone with priority to an open cZone.
# Note: this routine is only called for the case where zoneOpen > noOfConstants.
for cZone in $cZone1 $cZone2 $cZone3; do
if [[ "${cZone}" != "z00" && "${cZone}" != "${zone}" ]]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state" "1"
if [ "${jqResult}" = '"open"' ]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.rssi" "1"
if [ "${jqResult}" != "0" ]; then
myZone="${cZone}"
myZoneValue=$((10#$( echo "${myZone}" | cut -d"z" -f2 )))
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{myZone:$myZoneValue}}}"
myZoneAssigned=true
return
fi
fi
fi
done
# if all cZones are closed then assign myZone to a next open zone
for ((Zone=1; Zone<=nZones; Zone++)); do
ZoneStr=$( printf "z%02d" "${Zone}" )
if [[ "${ZoneStr}" != "${zone}" && "${ZoneStr}" != "${cZone1}" && "${ZoneStr}" != "${cZone2}" && "${ZoneStr}" != "${cZone3}" ]]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.state" "1"
if [ "${jqResult}" = '"open"' ]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.rssi" "1"
if [ "${jqResult}" != "0" ]; then
myZone="${ZoneStr}"
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{myZone:$Zone}}}"
myZoneAssigned=true
return
fi
fi
fi
done
}
function openAclosedCzone()
{
# Open up a closed cZone
# Note: this routine is only called for the case where zoneOpen = noOfConstants.
for cZone in $cZone1 $cZone2 $cZone3; do
if [ "${cZone}" != "z00" ]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state" "1"
if [ "${jqResult}" = '"close"' ]; then
openZoneInFullWithZoneOpenCounter "${cZone}"
return
fi
fi
done
}
function openAclosedZoneWithTempSensorWithPriorityToCzones()
{
# Open up a closed zone with temperature sensor
for cZone in $cZone1 $cZone2 $cZone3; do
if [[ "${cZone}" != "z00" && "${cZone}" != "${zone}" ]]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.state" "1"
if [ "${jqResult}" = '"close"' ]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${cZone}.rssi" "1"
if [ "${jqResult}" != "0" ]; then
openZoneInFullWithZoneOpenCounter "${cZone}"
return
fi
fi
fi
done
for ((Zone=1; Zone<=nZones; Zone++)); do
ZoneStr=$( printf "z%02d" "${Zone}" )
if [[ "${ZoneStr}" != "${zone}" && "${ZoneStr}" != "${cZone1}" && "${ZoneStr}" != "${cZone2}" && "${ZoneStr}" != "${cZone3}" ]]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.state" "1"
if [ "${jqResult}" = '"close"' ]; then
parseMyAirDataWithJq ".aircons.$ac.zones.${ZoneStr}.rssi" "1"
if [ "${jqResult}" != "0" ]; then
openZoneInFullWithZoneOpenCounter "${ZoneStr}"
return
fi
fi
fi
done
}
function queryTimerStateFile()
{
TIMER_STATE_FILE="$1"
if [ -f "${TIMER_STATE_FILE}" ]; then
state=$(cat "${TIMER_STATE_FILE}")
rc=$?
else
state="{\"timeToOn\":0,\"timeToOff\":0,\"setTime\":0}"
rc=$?
echo "$state" > "$TIMER_STATE_FILE"
fi
if [ "$selfTest" = "TEST_ON" ]; then
echo "Query the state file: ${TIMER_STATE_FILE}"
fi
timeToOn=$(echo "$state" | jq -e ".timeToOn")
timeToOff=$(echo "$state" | jq -e ".timeToOff")
setTime=$(echo "$state" | jq -e ".setTime")
# Get the current state of the fan
parseMyAirDataWithJq ".aircons.$ac.info.state" "1"
acState="${jqResult}"
parseMyAirDataWithJq ".aircons.$ac.info.mode" "1"
acMode="${jqResult}"
if [ $fanTimerSpecified = true ]; then
if [[ "${acState}" = '"on"' && "${acMode}" = '"vent"' ]]; then
fanState=1
else
fanState=0
fi
logQueryAirConDiagnostic "queryFanTimer ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $coolTimerSpecified = true ]; then
if [[ "${acState}" = '"on"' && "${acMode}" = '"cool"' ]]; then
coolState=1
else
coolState=0
fi
logQueryAirConDiagnostic "queryCoolTimer ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $heatTimerSpecified = true ]; then
if [[ "${acState}" = '"on"' && "${acMode}" = '"heat"' ]]; then
heatState=1
else
heatState=0
fi
logQueryAirConDiagnostic "queryHeatTimer ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
fi
}
function updateTimer()
{
State="$1"
Mode="$2"
TIMER_STATE_FILE="$3"
if [ "$selfTest" = "TEST_ON" ]; then
t0=$((setTime + 2))
fi
# Update fan timer
if [[ "$timeToOn" = "0" && "$timeToOff" = "0" ]]; then # no update required
echo ""
return
elif [[ "${State}" = "1" && "${timeToOn}" != "0" ]]; then # reset timer
timeToOn=0
setTime=${t0}
elif [[ "${State}" = "1" && "$timeToOff" != "0" ]]; then # update timer
timeToOff=$((timeToOff - t0 + setTime))
timeToOff=$((timeToOff > 30? timeToOff : 0))
setTime=${t0}
if [ "$timeToOff" = "0" ]; then # turn off the fan
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{state:off}}}"
fi
elif [[ "${State}" = "0" && "$timeToOff" != "0" ]]; then # reset timer
timeToOff=0
setTime=${t0}
elif [[ "${State}" = "0" && "$timeToOn" != "0" ]]; then # update timer
timeToOn=$((timeToOn - t0 + setTime))
timeToOn=$((timeToOn > 30? timeToOn : 0))
setTime=${t0}
if [ "$timeToOn" = "0" ]; then # turn on the fan, cool or heat
setAirConUsingIteration "http://$IP:$PORT/setAircon?json={$ac:{info:{state:on,mode:$Mode}}}"
fi
fi
if [ "$selfTest" = "TEST_ON" ]; then
echo "Update the timer for ${Mode} with timeToOn: ${timeToOn} and timeToOff: ${timeToOff}"
fi
# Diagnostic logging
if [ $fanTimerSpecified = true ]; then
logQueryAirConDiagnostic "updateFanTimer ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $coolTimerSpecified = true ]; then
logQueryAirConDiagnostic "updateCoolTimer ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $heatTimerSpecified = true ]; then
logQueryAirConDiagnostic "updateHeatTimer ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
fi
updateTimerStateFile "${TIMER_STATE_FILE}"
}
function updateTimerStateFile()
{
TIMER_STATE_FILE="$1"
updatedState=$(jq -ec ".timeToOn=$timeToOn" "$TIMER_STATE_FILE" | jq -ec ".timeToOff=$timeToOff" | jq -ec ".setTime=$setTime")
rc=$?
echo "$updatedState" > "$TIMER_STATE_FILE"
# Diagnostic logging
if [ "${io}" = "Get" ]; then
prefix="update"
space=""
else
prefix="set"
space="e "
fi
if [ "$selfTest" = "TEST_ON" ]; then
echo "Update the timer state file: ${TIMER_STATE_FILE} with timeToOn: ${timeToOn} and timeToOff: ${timeToOff}"
fi
if [ $fanTimerSpecified = true ]; then
logQueryAirConDiagnostic "${prefix}FanTimerStateFil${space} ${t0} ${t0} fanState=${fanState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $coolTimerSpecified = true ]; then
logQueryAirConDiagnostic "${prefix}CoolTimerStateFil${space} ${t0} ${t0} coolState=${coolState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
elif [ $heatTimerSpecified = true ]; then
logQueryAirConDiagnostic "${prefix}HeatTimerStateFil${space} ${t0} ${t0} heatState=${heatState} ${timeToOn} ${timeToOff} ${setTime} $io $device $characteristic"
fi
}
# main starts here
if [ $argEND -le 1 ]; then
showHelp 199
fi
if [ $argEND -ge 1 ]; then
io=$1
if [ $argEND -ge 2 ]; then
device=$2
else
echo "Error - No device given for io: ${io}"
exit 1
fi
if [ $argEND -ge 3 ]; then
characteristic=$3
else
echo "Error - No Characteristic given for io: ${io} ${device}"
exit 1
fi
if [ "$io" = "Get" ]; then
argSTART=4
elif [[ "$io" = "Set" ]]; then
argSTART=5
if [ $argEND -ge 4 ]; then
value=$4
else
echo "Error - No value given to Set: ${io}"
exit 1
fi
else
echo "Error - Invalid io: ${io}"
exit 1
fi
fi
# For any unprocessed arguments
if [ $argEND -ge $argSTART ]; then
# Scan the remaining options
for (( a=argSTART;a<=argEND;a++ ))
do
# convert argument number to its value
v=${!a}
optionUnderstood=false
# Check the actual option against patterns
case ${v} in
TEST_OFF)
# Standard production usage
selfTest="${v}"
;;
TEST_ON)
# For npm run test
selfTest="${v}"
PORT="2025"
;;
fanSpeed)
# If the accessory is used to control the fan speed
fanSpeed=true
;;
timer)
# For timer capability
timerEnabled=true
;;
fanTimer )
fanTimerSpecified=true
;;
coolTimer )
coolTimerSpecified=true
;;
heatTimer )
heatTimerSpecified=true
;;
flip)
# To flip open/close, up/down mode for garage or gate
flipEnabled=true
;;
myZone=*)
# For myZone setting
myZoneSpecified=true
myZoneValue=$(echo "$v" | cut -d"=" -f2)
;;
ac*)
# Specify the aircon system 1, if not defined, ac="ac1"
ac="${v}"
;;
z*)
#
# if the option starts with a 'z' for zone
#
zone="${v}"
zoneSpecified=true
;;
light*)
#
# if the option starts with a "light" for lightings
#
lightSpecified=true
;;
ligID*)
#
# if the option starts with a "ligID" for lightings
#
lightID="${v:6:7}"
lightSpecified=true
;;
thing*)
#
# if the option starts with a "thing" for garage, blinds, etc
#
thingSpecified=true
;;
thiID*)
#
# if the option starts with a "thiID" for garage, blinds, etc
#
thingID="${v:6:7}"
thingSpecified=true
;;
*)
#
# See if the option is in the format of an IP
#
if expr "$v" : '[0-9]*\.[0-9]*\.[0-9]*\.[0-9]*[:0-9]*[-a-z]*$' >/dev/null; then
IP=$(echo "$v"|cut -d":" -f1|cut -d"-" -f1)
PORT=$(echo "$v"|cut -d":" -f2)
if ! expr "$PORT" : '[0-9]*$' > /dev/null; then
PORT=2025
fi
debug=$(echo "$v"|cut -d"-" -f2)
if [ "$debug" = "debug" ]; then debugSpecified=true; fi
if [ "$selfTest" = "TEST_ON" ]; then
echo "Using IP: $IP"
if [ "$debugSpecified" = true ]; then
echo "Diagnostic log is turned on"
fi
fi
optionUnderstood=true
fi
if [ "$optionUnderstood" = false ]; then
echo "Unknown Option: ${v}"
showHelp 1
fi
esac
done