forked from radinsky/broadlink-http-rest
-
Notifications
You must be signed in to change notification settings - Fork 0
/
RestHome.lyx
executable file
·3814 lines (2905 loc) · 72.6 KB
/
RestHome.lyx
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
#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin unavailable
\textclass scrartcl
\use_default_options true
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding auto
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\use_dash_ligatures true
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref false
\papersize default
\use_geometry false
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date false
\justification true
\use_refstyle 1
\use_minted 0
\index Index
\shortcut idx
\color #008000
\end_index
\secnumdepth 3
\tocdepth 3
\paragraph_separation indent
\paragraph_indentation default
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header
\begin_body
\begin_layout Title
REST Home
\end_layout
\begin_layout Section
Introduction
\end_layout
\begin_layout Standard
RestHome is a python based home automation server.
Instead of a specific web gui, RestHome is entirely HTTP driven, using
a REST based API.
There is a web gui under development.
Interfaces can also be physical things such as buttons and LCDs that can
be interacted with.
RestHome provides logical control flow and state variables to home automation
rather than just static scenes or routines.
\end_layout
\begin_layout Standard
RestHome is smart enough to know how to handle being run behind ssl tunneling
software to read the actual connecting address.
You should only allow remote access via SSL and only on POST operations
that are password protected.
While more secure methods of connection might be better, IFTTT webhooks
won't handle much beyond a password shoved into a JSON payload.
I'll add OAuth style webhooks eventually.
\end_layout
\begin_layout Standard
RestHome spawns multiple threads to handle its built-in HTTP server and
passes events to those threads to handle concurrent actions and timing.
There is a plugin device that can handle specific scheduling as well.
\end_layout
\begin_layout Section
Initial Setup
\end_layout
\begin_layout Standard
This section is in need of work.
\end_layout
\begin_layout Standard
You'll need Python 3.6 or later, the pysocks module, and likely a few others.
I'll update this at a later date.
\end_layout
\begin_layout Standard
Execute ./server.py and if it does not find a settings.ini file, it will attempt
to create a bare one and auto-detect what it can.
During discovery, it may attempt to load additional device modules and
install them.
You will be prompted before installing anything.
\end_layout
\begin_layout Standard
Once it's up and running, use Control-C (^C) to stop the program.
Now you'll edit the settings.ini to configure the scenes and devices and
logic you want, then restart the server.
\end_layout
\begin_layout Section
Settings.ini
\end_layout
\begin_layout Standard
The settings file is a standard
\begin_inset Quotes eld
\end_inset
INI
\begin_inset Quotes erd
\end_inset
file using square brackets to label sections.
\end_layout
\begin_layout Itemize
The
\begin_inset Quotes eld
\end_inset
[General]
\begin_inset Quotes erd
\end_inset
section defines specific values related to the server itself including
binding to specific ports and security considerations.
\end_layout
\begin_layout Itemize
The
\begin_inset Quotes eld
\end_inset
[Status]
\begin_inset Quotes erd
\end_inset
section is a global variable space.
This may eventually go away in favor of using a catch-all device for the
entire household to allow device/variable syntax.
This forms a sort of namespace for variables by device.
\end_layout
\begin_layout Itemize
Device sections are just the device name.
They must contain details about the device.
At the very least, this section must contain a
\begin_inset Quotes eld
\end_inset
Type
\begin_inset Quotes erd
\end_inset
entry names the module to use for this device.
You will usually have a
\begin_inset Quotes eld
\end_inset
Comment
\begin_inset Quotes erd
\end_inset
field that describes the device in detail, a
\begin_inset Quotes eld
\end_inset
Room
\begin_inset Quotes erd
\end_inset
that names the room in the house where the device is located, and a
\begin_inset Quotes eld
\end_inset
Template
\begin_inset Quotes erd
\end_inset
that defines the types of commands and default Icon file (for the upcoming
GUI) for the device.
You may also specify a
\begin_inset Quotes eld
\end_inset
Timeout
\begin_inset Quotes erd
\end_inset
, a
\begin_inset Quotes eld
\end_inset
Delay
\begin_inset Quotes erd
\end_inset
between commands, and maybe an
\begin_inset Quotes eld
\end_inset
IPAddress
\begin_inset Quotes erd
\end_inset
,
\begin_inset Quotes eld
\end_inset
MACAddress
\begin_inset Quotes erd
\end_inset
, or
\begin_inset Quotes eld
\end_inset
Hostname
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Itemize
Each device section normally has it's own Status section.
For example, I have 3 multi-split air conditioners.
So for the
\begin_inset Quotes eld
\end_inset
[LivingRoom-HVAC]
\begin_inset Quotes erd
\end_inset
device section there is a
\begin_inset Quotes eld
\end_inset
[LivingRoom-HVAC Status]
\begin_inset Quotes erd
\end_inset
section with the status variables of the device.
\end_layout
\begin_layout Itemize
Devices that identify as a thermostat create a temperature zone list using
the names of the rooms they are in.
\end_layout
\begin_layout Itemize
Each device section may have a
\begin_inset Quotes eld
\end_inset
Commands
\begin_inset Quotes erd
\end_inset
section just like the
\begin_inset Quotes eld
\end_inset
Status
\begin_inset Quotes erd
\end_inset
section.
A device's
\begin_inset Quotes eld
\end_inset
Commands
\begin_inset Quotes erd
\end_inset
section lists command names followed by data.
The data defined for a command may be interpretted two ways.
If the data begins with a period, it is a macro, and each entry on that
line is a command to be sent to the device separated by that device's device-de
lay.
Otherwise, the data is interpretted by the device.
\end_layout
\begin_layout Itemize
\begin_inset Quotes eld
\end_inset
Outside
\begin_inset Quotes erd
\end_inset
is the recommended device name for whatever you have that gets the outside
temperature.
I normally scrape a website to get the information.
We'll see how to do this later.
\end_layout
\begin_layout Subsection
General
\end_layout
\begin_layout Description
ServerAddress IP to listen on, defaults to 0.0.0.0
\end_layout
\begin_layout Description
ServerPort Port to listen on, defaults to 8080
\end_layout
\begin_layout Description
Timeout Defaults timeout for network operations, in seconds.
Defaults to 8
\end_layout
\begin_layout Description
LearnFrom IP addresses that can use
\begin_inset Quotes eld
\end_inset
learnCommand
\begin_inset Quotes erd
\end_inset
.
Default is anyone if not set.
\end_layout
\begin_layout Description
BroadcastAddress Use a specific IP when broadcasting some device discovery
commands
\end_layout
\begin_layout Description
Autodetect Set to a list of module names (space separated) to attempt device
discovery with that module.
The list will be cleared after device discovery completes.
\end_layout
\begin_layout Description
AllowOverwrite If this is set, allow learned commands to overwrite existing
commands.
If not set, existing commands are protected from overwrite.
\end_layout
\begin_layout Description
RestrictAccess Restrict all operations to this list of IPs.
All other connections will be denied.
\end_layout
\begin_layout Description
Password Allow password protected POST operations from any IP.
GET operations (no password) will only be allowed from the list of addresses
in RestrictAccess.
\emph on
Warning:
\emph default
This is a plaintext password, so make sure this file is not readable by
anyone else!
\end_layout
\begin_layout Description
Hostname A hostname that will be used when generating URLs, mostly for Web
UI
\end_layout
\begin_layout Description
House The device name that represents the entire house, usually a virtual
\begin_inset Quotes eld
\end_inset
url
\begin_inset Quotes erd
\end_inset
device
\end_layout
\begin_layout Description
Debug Can increase the debug level up to 8 to get an exhaustive trace of
what's going on.
\end_layout
\begin_layout Description
Email May be used by the web UI
\end_layout
\begin_layout Description
Degrees Attempts to report all temperatures in 'F' or 'C'.
\end_layout
\begin_layout Description
DefaultUI Default name of the GUI you want to use.
The only one now is
\begin_inset Quotes eld
\end_inset
testing
\begin_inset Quotes erd
\end_inset
.
\end_layout
\begin_layout Description
CustomDash A custom 1-liner to throw at the top of the testing UI.
This will likely change.
\end_layout
\begin_layout Section
REST URLs
\end_layout
\begin_layout Itemize
IR learn/send commands
\end_layout
\begin_layout LyX-Code
# learn a command named
\begin_inset Quotes eld
\end_inset
mute
\begin_inset Quotes erd
\end_inset
from the
\begin_inset Quotes eld
\end_inset
deviceName
\begin_inset Quotes erd
\end_inset
device
\end_layout
\begin_layout LyX-Code
http://localhost:8080/deviceName/learnCommand/mute
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
# send
\begin_inset Quotes eld
\end_inset
lampon
\begin_inset Quotes erd
\end_inset
command to
\begin_inset Quotes eld
\end_inset
deviceName
\begin_inset Quotes erd
\end_inset
, set lamp variable to 1/set
\end_layout
\begin_layout LyX-Code
http://localhost:8080/deviceName/sendCommand/lampon
\end_layout
\begin_layout Itemize
Get/Set Status variables
\end_layout
\begin_layout LyX-Code
# return lamp status as 0 or 1
\end_layout
\begin_layout LyX-Code
http://localhost:8080/deviceName/getStatus/lamp
\end_layout
\begin_layout LyX-Code
\end_layout
\begin_layout LyX-Code
# set the status variable to 1
\end_layout
\begin_layout LyX-Code
http://localhost:8080/deviceName/setStatus/lamp/1
\end_layout
\begin_layout Itemize
List All Pending Events
\end_layout
\begin_layout LyX-Code
http://localhost:8080/listEvents
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{
\begin_inset Newline newline
\end_inset
"ok": "eventList",
\begin_inset Newline newline
\end_inset
"3": "ZoneTimer = .inc(Zone) Menu/Init ZoneTimer",
\begin_inset Newline newline
\end_inset
"25": "POLL_LivingRoom-HVAC_update = LivingRoom-HVAC",
\begin_inset Newline newline
\end_inset
"34": "POLL_BedRoom-HVAC_update = BedRoom-HVAC",
\begin_inset Newline newline
\end_inset
"42": "POLL_UtilityRoom-HVAC_update = UtilityRoom-HVAC",
\begin_inset Newline newline
\end_inset
"233": "ThermostatLoop = .ThermostatLogic ThermostatLoop",
\begin_inset Newline newline
\end_inset
"835": "fetchWeatherLoop = .Weather/updateWeather fetchWeatherLoop"
\begin_inset Newline newline
\end_inset
}
\end_layout
\begin_layout Itemize
List All Devices
\end_layout
\begin_layout LyX-Code
http://localhost:8080/listDevices
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{
\end_layout
\begin_layout LyX-Code
"ok": "deviceList",
\begin_inset Newline newline
\end_inset
"Fireplace": "Duraflame Heater",
\begin_inset Newline newline
\end_inset
"Alice": "Vizio SmartCast TV",
\begin_inset Newline newline
\end_inset
"LivingRoom-BlackBean": "LivingRoom-BlackBean",
\begin_inset Newline newline
\end_inset
"AV": "Sony DH770 AV Reciever",
\begin_inset Newline newline
\end_inset
"AC": "GREE Air Conditioner",
\begin_inset Newline newline
\end_inset
"IFTTT": "IFTTT",
\begin_inset Newline newline
\end_inset
"LG": "Ultra Blueray Player",
\begin_inset Newline newline
\end_inset
"BeagleBone": "On-board GPIO Pins",
\begin_inset Newline newline
\end_inset
"StrayScampsDen": "Entire House"
\begin_inset Newline newline
\end_inset
}
\end_layout
\begin_layout Itemize
List Status variables for a device, and current values
\end_layout
\begin_layout LyX-Code
http://thermostat:8080/LivingRoom-HVAC/listStatus
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{
\end_layout
\begin_layout LyX-Code
"ok": "LivingRoom-HVAC Status",
\end_layout
\begin_layout LyX-Code
"Mode": "heat",
\begin_inset Newline newline
\end_inset
"Standby": "False",
\end_layout
\begin_layout LyX-Code
\begin_inset Quotes qld
\end_inset
HeatSetpoint
\begin_inset Quotes qrd
\end_inset
: "72",
\begin_inset Newline newline
\end_inset
"CoolSetpoint
\begin_inset Quotes qrd
\end_inset
: "74",
\begin_inset Newline newline
\end_inset
"lastTemp": "75",
\begin_inset Newline newline
\end_inset
"CurrentTemp": "75",
\begin_inset Newline newline
\end_inset
"FanSpeed": "auto",
\begin_inset Newline newline
\end_inset
"CurrentHumidity": "None",
\begin_inset Newline newline
\end_inset
"CurrentSensorTemperature": "75",
\begin_inset Newline newline
\end_inset
"RunState": "normal",
\begin_inset Newline newline
\end_inset
"Defrost": "False"
\begin_inset Newline newline
\end_inset
}
\end_layout
\begin_layout Itemize
Lists all rooms and the devices in that room
\end_layout
\begin_layout LyX-Code
http://thermostat:8080/listRooms
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{
\end_layout
\begin_layout LyX-Code
"ok": "StrayScampsDen",
\begin_inset Newline newline
\end_inset
"BedRoom": "Bedroom-Blackbean BedRoom-HVAC",
\begin_inset Newline newline
\end_inset
"LivingRoom": "Livingroom-Blackbean LivingRoom-HVAC Thermostat",
\begin_inset Newline newline
\end_inset
"UtilityRoom": "UtilityRoom-HVAC"
\begin_inset Newline newline
\end_inset
}
\end_layout
\begin_layout Itemize
Similar to above, but lists thermal zones only (and current temp), including
Outside
\end_layout
\begin_layout LyX-Code
http://thermostat:8080/listThermalZones
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{
\begin_inset Newline newline
\end_inset
"ok": "thermalZones",
\begin_inset Newline newline
\end_inset
"LivingRoom": "75",
\begin_inset Newline newline
\end_inset
"BedRoom": "75",
\begin_inset Newline newline
\end_inset
"UtilityRoom": "77",
\begin_inset Newline newline
\end_inset
"Outside": "65"
\begin_inset Newline newline
\end_inset
}
\end_layout
\begin_layout Itemize
Get the type of a variable (currently always returns
\begin_inset Quotes eld
\end_inset
string
\begin_inset Quotes erd
\end_inset
)
\end_layout
\begin_layout LyX-Code
http://thermostat:8080/LivingRoom-HVAC/getType/Defrost
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{ "Defrost": "string" }
\end_layout
\begin_layout Itemize
Toggle a status variable (does not send on/off commands unless you have
a trigger set on the variable.
It just flips the internal status variable, changing 0 to 1 and anything
not 0 into 0.
\end_layout
\begin_layout LyX-Code
http://thermostat:8080/Thermostat/toggleStatus/Night
\end_layout
\begin_deeper
\begin_layout LyX-Code
returns
\end_layout
\end_deeper
\begin_layout LyX-Code
{ "Night": "1" }
\end_layout
\begin_layout Section
Special Sections
\end_layout
\begin_layout Subsection
TRIGGER device/status
\end_layout
\begin_layout Standard
You can use this two ways, either list the
\begin_inset Quotes eld
\end_inset
command
\begin_inset Quotes erd
\end_inset
to run when the variable changes or list
\begin_inset Quotes eld
\end_inset
on
\begin_inset Quotes erd
\end_inset
and
\begin_inset Quotes eld
\end_inset
off
\begin_inset Quotes erd
\end_inset
to first test the new value and run the given command.
Either way, if you want to run a command when a status variable changes,
this is it.
\end_layout
\begin_layout Subsection
ARRAY arrayname
\end_layout
\begin_layout Standard
You list
\begin_inset Quotes eld
\end_inset
Elements
\begin_inset Quotes erd
\end_inset
as a space separated list.
When you access the arrayname as a status variable it will return the first
item on this list.
If you increment the arrayname, an internal counter is moved to the next
element.
Likewise, you can decrement the arrayname to get to the previous element.
Access is circular.
The contents of
\begin_inset Quotes eld
\end_inset
elements
\begin_inset Quotes erd
\end_inset
can be another status variable.
The index of the ARRAY is stored in a status section named after the array.
\end_layout
\begin_layout Subsection
EVENT Eventname
\end_layout
\begin_layout Standard
You specify a command as well as when it should run, relative to now.
For example, if you wanted it to run in 2 minutes and 30 seconds, you set:
\end_layout
\begin_layout LyX-Code
minutes = 2
\begin_inset Newline newline
\end_inset
seconds = 30
\end_layout
\begin_layout Standard
You start the event by calling it as a command from a macro or startup.
If you want the event to repeat in a loop, then have it call itself as
part of its own command parameter.
\end_layout
\begin_layout Subsection
LOGIC node
\end_layout
\begin_layout Standard
Like an Event, you call the node like any other command.
You specify a
\begin_inset Quotes eld
\end_inset
test
\begin_inset Quotes erd
\end_inset
, optionally a
\begin_inset Quotes eld
\end_inset
compare
\begin_inset Quotes erd
\end_inset
, and one or more branches.
Here is an example that allows one person to set a
\begin_inset Quotes eld
\end_inset
target
\begin_inset Quotes erd
\end_inset
via the REST setStatus/target command and then another person puts in a
guess using setStatus/guess.
The higher/lower hints are printed on the server console output.
\end_layout
\begin_layout LyX-Code
[LOGIC GuessNumber]
\begin_inset Newline newline
\end_inset
test = guess
\begin_inset Newline newline
\end_inset