forked from rithvikvibhu/GHLocalApi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathall.apib
1695 lines (957 loc) · 60.3 KB
/
all.apib
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
FORMAT: 1A
HOST: http://192.168.1.15:8008
# Google Home
This is an unofficial documentation of the local API used by the Home app to communicate with the device.
## Getting Started
The port for the http server is `8008` so the base url for these endpoints is:
`http://<google-home-ip>:8008`
Get the IP of Google Home from the Google Home app (Device Settings -> End of list) or from your router.
There is no auth mechanism in place as of now.
GET requests are simple, in the browser kind.
POST requests need to set the header: `content-type: application/json`
# Group Device Info
## Eureka Info [/setup/eureka_info]
### Eureka Info [GET]
This gives most of the device info. The GET parameter `params` is a comma separated list of json keys to fetch. Currently, these params are known: `version,audio,name,build_info,detail,device_info,net,wifi,setup,settings,opt_in,opencast,multizone,proxy,night_mode_params,user_eq,room_equalizer`
Nested items can also be filtered using the dot notation. Example: `audio.digital`
The `options` GET parameter is always set to `detail`. No other value is known.
+ Attributes
+ params (string, required)
+ Sample: version,audio,name,build_info,detail,device_info,net,wifi,setup,settings,opt_in,opencast,multizone,proxy,night_mode_params,user_eq,room_equalizer
+ options (string, required)
+ Sample: detail
+ Response 200 (application/json)
+ Attributes (Default)
+ Body
{"audio":{"digital":false},"build_info":{"build_type":2,"cast_build_revision":"1.32.118652","cast_control_version":1,"preview_channel_state":4,"release_track":"preview-joining-stable-channel","system_build_number":"118652"},"detail":{"icon_list":[{"depth":32,"height":55,"mimetype":"image/png","url":"/setup/icon.png","width":98}],"locale":{"display_string":"English (United States)"},"timezone":{"display_string":"India Standard Time (Kolkata)","offset":330}},"device_info":{"4k_blocked":0,"capabilities":{"assistant_supported":true,"audio_hdr_supported":false,"audio_surround_mode_supported":false,"ble_supported":true,"bluetooth_audio_sink_supported":true,"bluetooth_audio_source_supported":true,"bluetooth_supported":true,"cloudcast_supported":true,"display_supported":false,"fdr_supported":false,"hdmi_prefer_50hz_supported":false,"hdmi_prefer_high_fps_supported":false,"hi_res_audio_supported":false,"hotspot_supported":true,"input_management_supported":true,"multi_user_supported":true,"multichannel_group_supported":false,"multizone_supported":true,"night_mode_supported":true,"night_mode_supported_v2":true,"opencast_supported":true,"preview_channel_supported":true,"proxy_server_supported":false,"reboot_supported":true,"remote_ducking_supported":true,"setup_supported":true,"show_debug_overlay_supported":false,"stats_supported":true,"system_sound_effects_supported":false,"ui_flipping_supported":false,"user_eq_supported":true,"wifi_regulatory_domain_locked":true,"wifi_supported":true},"cloud_device_id":"XXXXX","factory_country_code":"US","hotspot_bssid":"XX:XX:XX:XX:XX:XX","mac_address":"XX:XX:XX:XX:XX:XX","manufacturer":"Google Inc.","model_name":"Google Home","product_name":"pineapple","public_key":"XXXXX","ssdp_udn":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","uma_client_id":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","uptime":4332.29},"multizone":{"audio_output_delay":0,"audio_output_delay_oem":0,"aux_in_group":"","groups":[],"multichannel_status":0},"name":"Living Room","net":{"ethernet_connected":false,"ip_address":"192.168.X.X","online":true},"night_mode_params":{"do_not_disturb":true,"enabled":false,"led_brightness":0.44999998807907104,"volume":0.46000000834465027,"windows":[{"days":[0,1,2,3,4,5,6],"length_hours":8,"start_hour":22}]},"opencast":{"pin_code":"4602"},"opt_in":{"audio_hdr":false,"audio_surround_mode":0,"autoplay_on_signal":true,"cloud_ipc":true,"hdmi_prefer_50hz":false,"hdmi_prefer_high_fps":true,"opencast":true,"preview_channel":true,"remote_ducking":true,"stats":true,"ui_flipped":false},"proxy":{"mode":"system"},"settings":{"closed_caption":{},"control_notifications":2,"country_code":"IN","locale":"en-US","network_standby":0,"system_sound_effects":true,"time_format":1,"timezone":"Asia/Kolkata","wake_on_cast":1},"setup":{"setup_state":60,"ssid_suffix":"k","stats":{"num_check_connectivity":0,"num_connect_wifi":0,"num_connected_wifi_not_saved":0,"num_initial_eureka_info":0,"num_obtain_ip":0},"tos_accepted":true},"user_eq":{"high_shelf":{"frequency":4500,"gain_db":0,"quality":0.707},"low_shelf":{"frequency":150,"gain_db":0,"quality":0.707},"max_peaking_eqs":0,"peaking_eqs":[]},"version":9,"wifi":{"bssid":"XX:XX:XX:XX:XX:XX","has_changes":false,"noise_level":-92,"signal_level":-52,"ssid":"XXXXX","wpa_configured":true,"wpa_id":1,"wpa_state":10}}
## Get App Device Id [/setup/get_app_device_id]
### App Device ID [POST]
This gives "app device id", "certificate" and "signed data".
The `app_id` in the request is mandatory and refers to Chromecast backdrop/screensaver app. It has to be set to `E8C28D3C`.
The certificate is valid and issued by `Chromecast ICA 6 (Audio Assist), Google Inc`.
Not sure what the other two are.
+ Request (application/json)
+ Attributes (App Device IDRequest)
+ Body
{
"app_id": "E8C28D3C"
}
+ Response 200 (application/json)
+ Attributes (Default24)
+ Body
{"app_device_id":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX","certificate":"-----BEGIN CERTIFICATE-----\nMIIDyzCCArOgAwIBAgIEWAVEujANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC\nVVMxEzARBgNVBAgMCkNhbGlmb3JuaWExFjAUBgNVBAcMDU1vdW50YWluIFZpZXcx\nEzARBgNVBAoMCkdvb2dsZSBJbmMxDTALBgNVBAsMBENhc3QxKDAmBgNVBAMMH0No\ncm9tZWNhc3QgSUNBIDYgKEF1ZGlvIEFzc2lzdCkwHhcNMTYxMDE3MjEzODAyWhcN\nMzYxMDEyMjEzODAyWjB8MRMwEQYDVQQIDApDYWxpZm9ybmlhMQswCQYDVQQGEwJV\nUzEWMBQGA1UEBwwNTW91bnRhaW4gVmlldzENMAsGA1UECwwEQ2FzdDETMBEGA1UE\nCgwKR29vZ2xlIEluYzEcMBoGA1UEAwwTQVkwTTdOIEZBOEZDQTMwNDE3MTCCASIw\nDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJrs4oARV4dn68gam78NWTscGx+x\np6hm23DQWdazzkoRdUdmb/BnCNPWCM1sw6eVKoc+wfiNtE2RSXO72+WBS11LAf3u\n/7SIpuTs63oQCZoijAbJ58sF6VLgItt1NrtLOGyE2zyCowWnVXgS0KJbZn6Gy3fn\nc6qWNW7RVl99vuUctjKVep0iRpXk2f/7gNjZZVSssg/BfN55NFaYvArmppJJu4RZ\nR7sEu+Jd+zO9a93Re8wDGEHnLAvw5TuVwkRrm2+rLWOzej+6TBuF8pXKfttwGb47\n/6JDD28rwEH1aT263BZolPTf6GqPyjKqiK42pOE6GU4iwKllC+y2irHhwLkCAwEA\nAaNIMEYwCQYDVR0TBAIwADALBgNVHQ8EBAMCB4AwEwYDVR0lBAwwCgYIKwYBBQUH\nAwIwFwYDVR0gBBAwDjAMBgorBgEEAdZ5AgUCMA0GCSqGSIb3DQEBBQUAA4IBAQCu\nOkrf/PVBaDPWR+YeiE/3UauwMXCN4VakJ7OYG3hy1r6AhA62H3ITdM2cXCV7T9NL\nDSL02DphIsbU1Us9uUU3v7tiWy5A1VT23EPqsJYFk146VySDvqg7xx6xkpHs7r59\ntn2tffpxUjSeUep1VQpcQpgcVT2JZHt4LwNtbbXyu3U98bz/dT78QIFYtu5WTqRA\nyOaw+0nAI6hrEbPnoJ/8rtb1WCmB4zmvoLiamwajwMaEzQrF9oc04LCHSHgRmFqy\nGopFA2pW8eHR8RYzds3HRExxx4E8HozV8V2EoQC9hmfE48Teky4SXzCWf9arFNXq\nqwp7/thZVuJIg+BZOeb0\n-----END CERTIFICATE-----\n","signed_data":"HAjp4Jqm6vKiIsQxAIF6jHmVSomqW4gC5W67OY1NzhPnmCQW2pjF2hWnaeTXwkd3DlI4tu+VsLR8q9pfEAV1KAJseku43f3iT6mg7etJ5HMym6y97ri4LB2tva1dxfK3YhIPVyGdEc4s2O+eTrI6kmY1nXxXLKuTeF8Hg+Akp2eOREljj+KNwVa+LA5EWtcA3Lq09qAfBcWj0fu+A1Gxi1YZNvDfjcrz3SF32hzXHl24xADxvbnlJ6O0atQNqvybB5ENaaqOoSoRct9JhuVRT8EkJd3MWm3gwADEA3hP11Oo8m3GIuBhcF3VBt946035kg9rf+9GLF+fme2sJQBGuA=="}
+ Response 404
Not Found
## Offer [/setup/offer]
### Offer [GET]
This gives a token which is used by the Home app to get offers. The offers themselves are not stored on the device.
A new token is generated for every request.
+ Response 200 (application/json)
+ Attributes (Default25)
+ Body
{"token":"ADtqmfShz74YuyEyF8hNAP8uLTEKGZjp-qnKOAzuXYcYWw5H9dqtUBOYxN_gOyvR9ibEefxiM0EZaiBWhwvPkBg1jnLNdCycWuCv9bKdn-6zUa06a6sah55gvtA8VkiDObuc8RKmvB2tq3UCAM9u_7xnZNHFswfbW99Lh1-qAp-NB0xZIu-un3JKZ0EfMQywHMs9fNY_QjcDgaLyqaqAsAE1GwZZ_IEtmw=="}
## Assistant Check Ready Status [/setup/assistant/check_ready_status]
### Check Ready Status [POST]
**Update:** This seems to have changed now and is no longer possible. The error is also new.
Setting `play_ready_message` to true plays a welcome message on the device saying "Hi, I'm your Google Assistant. I'm here to help. To learn a few things you can do, continue in the Google Home app."
+ Request (application/json)
+ Attributes (Check Ready StatusRequest)
+ Body
{
"play_ready_message": true,
"user_id": "xxxxx"
}
+ Response 200 (application/json)
+ Attributes (Default27)
+ Body
{"can_enroll":false,"enrollment_state":8,"error":"NEED_RELINK","error_code":7,"ready":false,"retryable":false}
## Supported Timezones [/setup/supported_timezones]
### Timezones [GET]
Simply returns a list of all supported timezones.
+ Response 200 (application/json)
+ Attributes (array[Default28])
+ Body
[{"display_string":"Samoa Standard Time (Midway)","offset":-660,"timezone":"Pacific/Midway"},{"display_string":"Hawaii-Aleutian Standard Time (Honolulu)","offset":-600,"timezone":"Pacific/Honolulu"},{"display_string":"Alaska Daylight Time (Anchorage)","offset":-480,"timezone":"America/Anchorage"},{"display_string":"Pacific Daylight Time (Los Angeles)","offset":-420,"timezone":"America/Los_Angeles"},{"display_string":"Pacific Daylight Time (Vancouver)","offset":-420,"timezone":"America/Vancouver"},{"display_string":"Pacific Daylight Time (Tijuana)","offset":-420,"timezone":"America/Tijuana"},{"display_string":"Mountain Standard Time (Phoenix)","offset":-420,"timezone":"America/Phoenix"},{"display_string":"Mountain Daylight Time (Denver)","offset":-360,"timezone":"America/Denver"},{"display_string":"Mountain Daylight Time (Edmonton)","offset":-360,"timezone":"America/Edmonton"},{"display_string":"Mexican Pacific Daylight Time (Chihuahua)","offset":-360,"timezone":"America/Chihuahua"},{"display_string":"Central Standard Time (Regina)","offset":-360,"timezone":"America/Regina"},{"display_string":"Central Standard Time (Costa Rica)","offset":-360,"timezone":"America/Costa_Rica"},{"display_string":"Central Daylight Time (Chicago)","offset":-300,"timezone":"America/Chicago"},{"display_string":"Central Daylight Time (Mexico City)","offset":-300,"timezone":"America/Mexico_City"},{"display_string":"Central Daylight Time (Winnipeg)","offset":-300,"timezone":"America/Winnipeg"},{"display_string":"Colombia Standard Time (Bogota)","offset":-300,"timezone":"America/Bogota"},{"display_string":"Eastern Daylight Time (New York)","offset":-240,"timezone":"America/New_York"},{"display_string":"Eastern Daylight Time (Toronto)","offset":-240,"timezone":"America/Toronto"},{"display_string":"Venezuela Time (Caracas)","offset":-240,"timezone":"America/Caracas"},{"display_string":"Atlantic Standard Time (Barbados)","offset":-240,"timezone":"America/Barbados"},{"display_string":"Atlantic Daylight Time (Halifax)","offset":-180,"timezone":"America/Halifax"},{"display_string":"Amazon Standard Time (Manaus)","offset":-240,"timezone":"America/Manaus"},{"display_string":"Chile Standard Time (Santiago)","offset":-240,"timezone":"America/Santiago"},{"display_string":"Newfoundland Daylight Time (St Johns)","offset":-150,"timezone":"America/St_Johns"},{"display_string":"Brasilia Standard Time (Sao Paulo)","offset":-180,"timezone":"America/Sao_Paulo"},{"display_string":"Brasilia Standard Time (Araguaina)","offset":-180,"timezone":"America/Araguaina"},{"display_string":"Argentina Standard Time (Buenos Aires)","offset":-180,"timezone":"America/Argentina/Buenos_Aires"},{"display_string":"Western Argentina Standard Time (San Luis)","offset":-180,"timezone":"America/Argentina/San_Luis"},{"display_string":"Uruguay Standard Time (Montevideo)","offset":-180,"timezone":"America/Montevideo"},{"display_string":"West Greenland Summer Time (Godthab)","offset":-120,"timezone":"America/Godthab"},{"display_string":"South Georgia Time (South Georgia)","offset":-120,"timezone":"Atlantic/South_Georgia"},{"display_string":"Cape Verde Standard Time (Cape Verde)","offset":-60,"timezone":"Atlantic/Cape_Verde"},{"display_string":"Azores Summer Time (Azores)","offset":0,"timezone":"Atlantic/Azores"},{"display_string":"Western European Standard Time (Casablanca)","offset":0,"timezone":"Africa/Casablanca"},{"display_string":"British Summer Time (London)","offset":60,"timezone":"Europe/London"},{"display_string":"Irish Standard Time (Dublin)","offset":60,"timezone":"Europe/Dublin"},{"display_string":"Central European Summer Time (Amsterdam)","offset":120,"timezone":"Europe/Amsterdam"},{"display_string":"Central European Summer Time (Belgrade)","offset":120,"timezone":"Europe/Belgrade"},{"display_string":"Central European Summer Time (Berlin)","offset":120,"timezone":"Europe/Berlin"},{"display_string":"Central European Summer Time (Brussels)","offset":120,"timezone":"Europe/Brussels"},{"display_string":"Central European Summer Time (Copenhagen)","offset":120,"timezone":"Europe/Copenhagen"},{"display_string":"Western European Summer Time (Lisbon)","offset":60,"timezone":"Europe/Lisbon"},{"display_string":"Central European Summer Time (Madrid)","offset":120,"timezone":"Europe/Madrid"},{"display_string":"Central European Summer Time (Oslo)","offset":120,"timezone":"Europe/Oslo"},{"display_string":"Central European Summer Time (Paris)","offset":120,"timezone":"Europe/Paris"},{"display_string":"Central European Summer Time (Rome)","offset":120,"timezone":"Europe/Rome"},{"display_string":"Central European Summer Time (Stockholm)","offset":120,"timezone":"Europe/Stockholm"},{"display_string":"Central European Summer Time (Sarajevo)","offset":120,"timezone":"Europe/Sarajevo"},{"display_string":"Central European Summer Time (Vienna)","offset":120,"timezone":"Europe/Vienna"},{"display_string":"Central European Summer Time (Warsaw)","offset":120,"timezone":"Europe/Warsaw"},{"display_string":"Central European Summer Time (Zurich)","offset":120,"timezone":"Europe/Zurich"},{"display_string":"Central Africa Time (Windhoek)","offset":120,"timezone":"Africa/Windhoek"},{"display_string":"West Africa Standard Time (Lagos)","offset":60,"timezone":"Africa/Lagos"},{"display_string":"West Africa Standard Time (Brazzaville)","offset":60,"timezone":"Africa/Brazzaville"},{"display_string":"Eastern European Standard Time (Cairo)","offset":120,"timezone":"Africa/Cairo"},{"display_string":"Central Africa Time (Harare)","offset":120,"timezone":"Africa/Harare"},{"display_string":"Central Africa Time (Maputo)","offset":120,"timezone":"Africa/Maputo"},{"display_string":"South Africa Standard Time (Johannesburg)","offset":120,"timezone":"Africa/Johannesburg"},{"display_string":"Eastern European Summer Time (Helsinki)","offset":180,"timezone":"Europe/Helsinki"},{"display_string":"Eastern European Summer Time (Athens)","offset":180,"timezone":"Europe/Athens"},{"display_string":"Eastern European Summer Time (Amman)","offset":180,"timezone":"Asia/Amman"},{"display_string":"Eastern European Summer Time (Beirut)","offset":180,"timezone":"Asia/Beirut"},{"display_string":"Israel Daylight Time (Jerusalem)","offset":180,"timezone":"Asia/Jerusalem"},{"display_string":"Moscow Standard Time (Minsk)","offset":180,"timezone":"Europe/Minsk"},{"display_string":"Arabian Standard Time (Baghdad)","offset":180,"timezone":"Asia/Baghdad"},{"display_string":"Arabian Standard Time (Riyadh)","offset":180,"timezone":"Asia/Riyadh"},{"display_string":"Arabian Standard Time (Kuwait)","offset":180,"timezone":"Asia/Kuwait"},{"display_string":"East Africa Time (Nairobi)","offset":180,"timezone":"Africa/Nairobi"},{"display_string":"Iran Daylight Time (Tehran)","offset":270,"timezone":"Asia/Tehran"},{"display_string":"Moscow Standard Time (Moscow)","offset":180,"timezone":"Europe/Moscow"},{"display_string":"Gulf Standard Time (Dubai)","offset":240,"timezone":"Asia/Dubai"},{"display_string":"Georgia Standard Time (Tbilisi)","offset":240,"timezone":"Asia/Tbilisi"},{"display_string":"Mauritius Standard Time (Mauritius)","offset":240,"timezone":"Indian/Mauritius"},{"display_string":"Azerbaijan Standard Time (Baku)","offset":240,"timezone":"Asia/Baku"},{"display_string":"Armenia Standard Time (Yerevan)","offset":240,"timezone":"Asia/Yerevan"},{"display_string":"Afghanistan Time (Kabul)","offset":270,"timezone":"Asia/Kabul"},{"display_string":"Pakistan Standard Time (Karachi)","offset":300,"timezone":"Asia/Karachi"},{"display_string":"Turkmenistan Standard Time (Ashgabat)","offset":300,"timezone":"Asia/Ashgabat"},{"display_string":"West Kazakhstan Time (Oral)","offset":300,"timezone":"Asia/Oral"},{"display_string":"India Standard Time (Kolkata)","offset":330,"timezone":"Asia/Kolkata"},{"display_string":"India Standard Time (Colombo)","offset":330,"timezone":"Asia/Colombo"},{"display_string":"Nepal Time (Kathmandu)","offset":345,"timezone":"Asia/Kathmandu"},{"display_string":"Yekaterinburg Standard Time (Yekaterinburg)","offset":300,"timezone":"Asia/Yekaterinburg"},{"display_string":"East Kazakhstan Time (Almaty)","offset":360,"timezone":"Asia/Almaty"},{"display_string":"Bangladesh Standard Time (Dhaka)","offset":360,"timezone":"Asia/Dhaka"},{"display_string":"Myanmar Time (Rangoon)","offset":390,"timezone":"Asia/Rangoon"},{"display_string":"Indochina Time (Bangkok)","offset":420,"timezone":"Asia/Bangkok"},{"display_string":"Western Indonesia Time (Jakarta)","offset":420,"timezone":"Asia/Jakarta"},{"display_string":"Omsk Standard Time (Omsk)","offset":360,"timezone":"Asia/Omsk"},{"display_string":"Novosibirsk Standard Time (Novosibirsk)","offset":420,"timezone":"Asia/Novosibirsk"},{"display_string":"China Standard Time (Shanghai)","offset":480,"timezone":"Asia/Shanghai"},{"display_string":"Hong Kong Standard Time (Hong Kong)","offset":480,"timezone":"Asia/Hong_Kong"},{"display_string":"Malaysia Time (Kuala Lumpur)","offset":480,"timezone":"Asia/Kuala_Lumpur"},{"display_string":"Singapore Standard Time (Singapore)","offset":480,"timezone":"Asia/Singapore"},{"display_string":"Philippine Standard Time (Manila)","offset":480,"timezone":"Asia/Manila"},{"display_string":"Taipei Standard Time (Taipei)","offset":480,"timezone":"Asia/Taipei"},{"display_string":"Central Indonesia Time (Makassar)","offset":480,"timezone":"Asia/Makassar"},{"display_string":"Krasnoyarsk Standard Time (Krasnoyarsk)","offset":420,"timezone":"Asia/Krasnoyarsk"},{"display_string":"Australian Western Standard Time (Perth)","offset":480,"timezone":"Australia/Perth"},{"display_string":"Australian Central Western Standard Time (Eucla)","offset":525,"timezone":"Australia/Eucla"},{"display_string":"Irkutsk Standard Time (Irkutsk)","offset":480,"timezone":"Asia/Irkutsk"},{"display_string":"Korean Standard Time (Seoul)","offset":540,"timezone":"Asia/Seoul"},{"display_string":"Japan Standard Time (Tokyo)","offset":540,"timezone":"Asia/Tokyo"},{"display_string":"Eastern Indonesia Time (Jayapura)","offset":540,"timezone":"Asia/Jayapura"},{"display_string":"Australian Central Standard Time (Adelaide)","offset":570,"timezone":"Australia/Adelaide"},{"display_string":"Australian Central Standard Time (Darwin)","offset":570,"timezone":"Australia/Darwin"},{"display_string":"Australian Eastern Standard Time (Brisbane)","offset":600,"timezone":"Australia/Brisbane"},{"display_string":"Australian Eastern Standard Time (Hobart)","offset":600,"timezone":"Australia/Hobart"},{"display_string":"Australian Eastern Standard Time (Sydney)","offset":600,"timezone":"Australia/Sydney"},{"display_string":"Yakutsk Standard Time (Yakutsk)","offset":540,"timezone":"Asia/Yakutsk"},{"display_string":"Chamorro Standard Time (Guam)","offset":600,"timezone":"Pacific/Guam"},{"display_string":"Papua New Guinea Time (Port Moresby)","offset":600,"timezone":"Pacific/Port_Moresby"},{"display_string":"Vladivostok Standard Time (Vladivostok)","offset":600,"timezone":"Asia/Vladivostok"},{"display_string":"Sakhalin Standard Time (Sakhalin)","offset":660,"timezone":"Asia/Sakhalin"},{"display_string":"Magadan Standard Time (Magadan)","offset":660,"timezone":"Asia/Magadan"},{"display_string":"New Zealand Standard Time (Auckland)","offset":720,"timezone":"Pacific/Auckland"},{"display_string":"Fiji Standard Time (Fiji)","offset":720,"timezone":"Pacific/Fiji"},{"display_string":"Marshall Islands Time (Majuro)","offset":720,"timezone":"Pacific/Majuro"},{"display_string":"Tonga Standard Time (Tongatapu)","offset":780,"timezone":"Pacific/Tongatapu"},{"display_string":"Apia Standard Time (Apia)","offset":780,"timezone":"Pacific/Apia"},{"display_string":"Line Islands Time (Kiritimati)","offset":840,"timezone":"Pacific/Kiritimati"}]
## Supported Locales [/setup/supported_locales]
### Locales [GET]
Simply returns a list of all supported locales.
+ Response 200 (application/json)
+ Attributes (array[Default29])
+ Body
[{"display_string":"Amharic - አማርኛ","locale":"am"},{"display_string":"Arabic - العربية","locale":"ar"},{"display_string":"Bulgarian - български","locale":"bg"},{"display_string":"Bangla - বাংলা","locale":"bn"},{"display_string":"Catalan - català","locale":"ca"},{"display_string":"Czech - čeština","locale":"cs"},{"display_string":"Danish - dansk","locale":"da"},{"display_string":"German - Deutsch","locale":"de"},{"display_string":"Greek - Ελληνικά","locale":"el"},{"display_string":"English (United Kingdom)","locale":"en-GB"},{"display_string":"English (United States)","locale":"en-US"},{"display_string":"Spanish - español","locale":"es"},{"display_string":"Estonian - eesti","locale":"et"},{"display_string":"Persian - فارسی","locale":"fa"},{"display_string":"Finnish - suomi","locale":"fi"},{"display_string":"Filipino","locale":"fil"},{"display_string":"French - français","locale":"fr"},{"display_string":"Gujarati - ગુજરાતી","locale":"gu"},{"display_string":"Hebrew - עברית","locale":"he"},{"display_string":"Hindi - हिन्दी","locale":"hi"},{"display_string":"Croatian - hrvatski","locale":"hr"},{"display_string":"Hungarian - magyar","locale":"hu"},{"display_string":"Indonesian - Indonesia","locale":"id"},{"display_string":"Italian - italiano","locale":"it"},{"display_string":"Japanese - 日本語","locale":"ja"},{"display_string":"Kannada - ಕನ್ನಡ","locale":"kn"},{"display_string":"Korean - 한국어","locale":"ko"},{"display_string":"Lithuanian - lietuvių","locale":"lt"},{"display_string":"Latvian - latviešu","locale":"lv"},{"display_string":"Malayalam - മലയാളം","locale":"ml"},{"display_string":"Marathi - मराठी","locale":"mr"},{"display_string":"Malay - Melayu","locale":"ms"},{"display_string":"Norwegian Bokmål - norsk bokmål","locale":"nb"},{"display_string":"Dutch - Nederlands","locale":"nl"},{"display_string":"Polish - polski","locale":"pl"},{"display_string":"Portuguese (Portugal) - português (Portugal)","locale":"pt-PT"},{"display_string":"Romanian - română","locale":"ro"},{"display_string":"Russian - русский","locale":"ru"},{"display_string":"Slovak - slovenčina","locale":"sk"},{"display_string":"Slovenian - slovenščina","locale":"sl"},{"display_string":"Serbian - српски","locale":"sr"},{"display_string":"Swedish - svenska","locale":"sv"},{"display_string":"Swahili - Kiswahili","locale":"sw"},{"display_string":"Tamil - தமிழ்","locale":"ta"},{"display_string":"Telugu - తెలుగు","locale":"te"},{"display_string":"Thai - ไทย","locale":"th"},{"display_string":"Turkish - Türkçe","locale":"tr"},{"display_string":"Ukrainian - українська","locale":"uk"},{"display_string":"Vietnamese - Tiếng Việt","locale":"vi"},{"display_string":"Chinese (Simplified) - 中文（简体）","locale":"zh-CN"},{"display_string":"Chinese (Traditional) - 中文（繁體）","locale":"zh-TW"},{"display_string":"Spanish (Latin America) - español (Latinoamérica)","locale":"es-419"},{"display_string":"Portuguese (Brazil) - português (Brasil)","locale":"pt-BR"},{"display_string":"English (Australia)","locale":"en-AU"},{"display_string":"English (Canada)","locale":"en-CA"},{"display_string":"English (India)","locale":"en-IN"},{"display_string":"English (Singapore)","locale":"en-SG"},{"display_string":"Spanish (United States) - español (Estados Unidos)","locale":"es-US"},{"display_string":"French (Canada) - français (Canada)","locale":"fr-CA"}]
## Test Internet Download Speed [/setup/test_internet_download_speed]
### Test Internet Download Speed [POST]
This endpoint tests internet download speed. Any sample file URL can be provided.
+ Request (application/json)
+ Attributes (Test Internet Download SpeedRequest)
+ Body
{
"url": "https://storage.googleapis.com/reliability-speedtest/random.txt"
}
+ Response 200 (application/json)
+ Attributes (Default31)
+ Body
{"bytes_received":31457280,"response_code":200,"time_for_data_fetch":4722,"time_for_http_response":316}
# Group Device Settings
## Set Eureka Info [/setup/set_eureka_info]
### Set Eureka Info [POST]
This can set custom values to some options.
Only fields to be modified need to be sent, not all. The example has all modifiable fields (#TODO).
Sending non-existant fields will still return a 200 OK, but they are not saved.
+ Request (application/json)
+ Attributes (Set Eureka InfoRequest)
+ Body
{
"name": "Living Room",
"settings": {
"control_notifications": 2
},
"opt_in": {
"opencast": true,
"preview_channel": true,
"remote_ducking": true,
"stats": true
}
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
## Assistant Set Night Mode Params [/setup/assistant/set_night_mode_params]
### Night Mode settings [POST]
This sets night mode options.
To view currently set values, use /setup/eureka_info.
If `enabled` is set to false, night mode is disabled and the other values do not matter.
`led_brightness` and `volume` refer to the maximum LED Brightness and Volume that is set during night mode.
`demo_to_user` is always set to `true` so change in values will be visible in realtime (like brightness).
`windows`: A combination of `length_hours` and `start_hour` is used to define start and end times for night mode. In this example, night mode starts at 10 PM (22) and ends at 6 AM (8 hours later). `windows.days` is an array of days of week when night mode will be enabled. Example: 0->Sunday, 1-> Monday, ..., 6->Saturday.
+ Request (application/json)
+ Attributes (Night Mode settingsRequest)
+ Body
{
"enabled": false,
"do_not_disturb": true,
"led_brightness": 0.44999998807907104,
"volume": 0.46000000834465027,
"demo_to_user": true,
"windows": [
{
"length_hours": 8,
"days": [
0,
1,
2,
3,
4,
5,
6
],
"start_hour": 22
}
]
}
+ Response 200 (application/json)
+ Attributes (Default37)
+ Body
{"do_not_disturb":true,"enabled":false,"led_brightness":0.44999998807907104,"volume":0.46000000834465027,"windows":[{"days":[0,1,2,3,4,5,6],"length_hours":8.0,"start_hour":22.0}]}
## Reboot [/setup/reboot]
### Reboot and Factory Reset [POST]
This can simply reboot the device (`params: "now"`) or factory reset the device (`params: "fdr"`).
+ Request (application/json)
+ Attributes (Reboot and Factory ResetRequest)
+ Body
{
"params": "now"
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
+ Request Factory Reset (application/json)
+ Attributes (Reboot and Factory ResetRequest)
+ Body
{
"params": "fdr"
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
# Group Assistant
## Assistant Notifications [/setup/assistant/notifications]
### Do Not Disturb [POST]
This is for the Do Not Disturb option. Sending an empty-body POST returns the current value. Sending a new value changes it.
+ Request Get current state (application/json)
+ Response 200 (application/json)
+ Attributes (Get current state)
+ Body
{"notifications_enabled":true}
+ Request Set new state (application/json)
+ Attributes (Get current state)
+ Body
{"notifications_enabled":true}
+ Response 200 (application/json)
+ Attributes (Get current state)
+ Body
{"notifications_enabled":true}
## Assistant A11y Mode [/setup/assistant/a11y_mode]
### Accessibility [POST]
This controls Accessibility sounds. `hotword_enabled` is for 'Play start sound' and `endpoint_enabled` is for 'Play end sound'.
Sending an empty-body POST request returns the current values.
Either of the fields or both can be sent and new values will be saved.
+ Request Get current values (application/json)
+ Attributes (AccessibilityRequest)
+ Response 200 (application/json)
+ Attributes (AccessibilityRequest)
+ Body
{"endpoint_enabled":false,"hotword_enabled":false}
+ Request Set new values (application/json)
+ Attributes (AccessibilityRequest)
+ Body
{
"hotword_enabled": false,
"endpoint_enabled": false
}
+ Response 200 (application/json)
+ Attributes (AccessibilityRequest)
+ Body
{"endpoint_enabled":false,"hotword_enabled":false}
## Assistant Alarms [/setup/assistant/alarms]
### Get Alarms and Timers [GET]
This gives a list of all active alarms and timers.
Both alarms and timers have `id`s which can be used to delete them. (There is no known way of creating them yet). The value of `status` have different meanings for alarms and timers (given below).
Alarms have `date_pattern` and `time_pattern` with day, month, year, hour, minute, second. `fire_time` is the same in unix time (milliseconds, not seconds).
`status` is 1 for set up and 2 for ringing.
Timers have `original_duration` is the original duration.
`status` is 1 for set up and 3 for ringing.
+ Response 200 (application/json)
+ Attributes (Default43)
+ Body
{"alarm":[{"date_pattern":{"day":15,"month":1,"year":2018},"time_pattern":{"hour":6,"minute":50,"second":0},"fire_time":1515995400000.0,"id":"alarm/xxx","status":1}],"timer":[{"fire_time":1516176765589,"id":"timer/xxx","original_duration":20000,"status":1}]}
## Assistant Alarms Delete [/setup/assistant/alarms/delete]
### Delete Alarms and Timers [POST]
This deletes alarms and timers by their id.
`ids` is a list of ids to be deleted. Sending invalid id still returns a 200 OK. The `/` in the ids have to be escaped like `\/`.
+ Request (application/json)
+ Attributes (Delete Alarms and TimersRequest)
+ Body
{
"ids": [
"timer/xxx",
"alarm/xxx"
]
}
+ Response 200 (application/json)
+ Attributes (Default49)
+ Body
{"success":true}
## Assistant Alarms Volume [/setup/assistant/alarms/volume]
### Alarm Volume [POST]
This gets and sets alarms and timers volume.
**Note:** This is not the same as normal volume.
Volume is a float number in [0, 1] where 0 is minimum and 1 is maximum.
Sending an empty body gets the volume. Sending `volume` sets the volume.
+ Request Get volume (application/json)
+ Attributes (Alarm VolumeRequest)
+ Response 200 (application/json)
+ Attributes (Alarm VolumeRequest)
+ Body
{"volume":1.0}
+ Request Set volume (application/json)
+ Attributes (Alarm VolumeRequest)
+ Body
{
"volume": 1
}
+ Response 200 (application/json)
+ Attributes (Alarm VolumeRequest)
+ Body
{"volume":1.0}
## User Eq Set Equalizer [/setup/user_eq/set_equalizer]
### Set Equalizer Values [POST]
This can only set new equalizer values. To get already set values, use /setup/eureka_info.
The body is mandatory. It can either contain `low_shelf` or `high_shelf` or both.
`low_shelf.gain_db` and `high_shelf.gain_db` refer to **bass** and **treble** respectively.
Default values are 0 for both.
While the slider in the Home app only ranges from -6 to +6, they can be set to any integer like 50 or -100. These changes persist.
+ Request (application/json)
+ Attributes (Set Equalizer ValuesRequest)
+ Body
{
"low_shelf": {
"gain_db": 0
},
"high_shelf": {
"gain_db": 0
}
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
# Group Bluetooth
## Bluetooth Status [/setup/bluetooth/status]
### Status [GET]
> **There are 2 parts of Bluetooth.**
>
> *Part 1*: Devices like phones connect to Home and play audio through Home.
> For this, /setup/bluetooth/discovery is used to make Home discoverable. Then devices can connect to it as if Home is just another bluetooth speaker.
>
> *Part 2*: Bluetooth speakers connect to Home and Home plays audio through the speakers.
> For this, /setup/bluetooth/scan and /setup/bluetooth/scan_results are used to connect to other speakers.
>
> The other endpoints are common for both parts.
**For both parts**
This gives the status of all bluetooth things.
Not sure what `audio_mode` is.
`discovery_enabled` states whether Home is discoverable. (**Part 1**)
`connecting_devices` is a list of all media sources (like phones) connected to Home. (**Part 1**)
`scanning_enabled` states whether Home scanning for other bluetooth speakers/devices. (**Part 2**)
`connected_devices` is a list of all speakers connected to Home. (**Part 2**)
+ Response 200 (application/json)
+ Attributes (Default55)
+ Body
{"audio_mode":0,"connecting_devices":[],"connected_devices":[{"device":{"bond_date":1529248165656.613,"device_class":2491396,"device_type":1,"last_connect_date":0,"mac_address":"xx:xx:xx:xx:xx:xx","name":"PHILIPS BT64","rssi":-255,"service_uuids":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]},"enabled_profiles":2}],"remote_sink":{"bond_date":1529248165656.613,"device_class":2491396,"device_type":1,"last_connect_date":0,"mac_address":"xx:xx:xx:xx:xx:xx","name":"PHILIPS BT64","rssi":-255,"service_uuids":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]},"discovery_enabled":false,"scanning_enabled":false}
## Bluetooth Get Bonded [/setup/bluetooth/get_bonded]
### Get Paired Devices [GET]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For both parts**
This gives a list of all paired or 'bonded' devices. The response field names are self-descriptive.
+ Response 200 (application/json)
+ Attributes (array[Default59])
+ Body
[{"bond_date":1503212407260.55,"device_class":5898764,"device_type":1,"last_connect_date":1514807829482.1111,"mac_address":"xx:xx:xx:xx:xx:xx","name":"Device Name","rssi":-255,"service_uuids":["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx","xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"]}]
## Bluetooth Bond [/setup/bluetooth/bond]
### Forget paired device [POST]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For both parts**
This is to forget paired devices by mac address. Works for both kinds of devices (Part 1 and Part 2).
+ Request (application/json)
+ Attributes (Forget paired deviceRequest)
+ Body
{
"mac_address": "xx:xx:xx:xx:xx:xx",
"bond": false
}
+ Response 200
+ Attributes (object)
## Bluetooth Discovery [/setup/bluetooth/discovery]
### Change Discoverability [POST]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For Part 1 only**
This enables/disables Home's bluetooth discovery and other devices can pair with Home (where Home acts as a speaker).
+ Request Set discoverable (application/json)
+ Attributes (Change DiscoverabilityRequest)
+ Body
{
"enable_discovery": true
}
+ Response 200
+ Attributes (object)
+ Request Set non-discoverable (application/json)
+ Attributes (Change DiscoverabilityRequest)
+ Body
{
"enable_discovery": false
}
+ Response 200
+ Attributes (object)
## Bluetooth Scan [/setup/bluetooth/scan]
### Scan for devices [POST]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For Part 2 only**
This initiates scan for other bluetooth speakers/devices. Scan results will be updated continuously for `timeout` seconds.
To get the scan results, see /setup/bluetooth/scan_results.
+ Request (application/json)
+ Attributes (Scan for devicesRequest)
+ Body
{
"enable": true,
"clear_results": true,
"timeout": 60
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
## Bluetooth Scan Results [/setup/bluetooth/scan_results]
### Get Scan Results [GET]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For Part 2 only**
This returns a list of all nearby bluetooth devices. While the Home app only shows speakers, this list contains all devices including TVs, mobiles, etc.
`rssi` is signal strength, `name` is name, `mac_address` is mac address.
`device_class` and `device_type` are bluetooth codes.
The Home app only lists those devices with `expected_profiles` > 0. Basically, the device should function speaker.
+ Response 200 (application/json)
+ Attributes (array[Default63])
+ Body
[{"device_class":525372,"device_type":3,"expected_profiles":0,"mac_address":"xx:xx:xx:xx:xx:xx","name":"KD-49X8200E","rssi":-90},{"device_class":5898764,"device_type":1,"expected_profiles":0,"mac_address":"xx:xx:xx:xx:xx:xx","name":"vivo 1714","rssi":-96},{"device_class":2491396,"device_type":1,"expected_profiles":1,"mac_address":"xx:xx:xx:xx:xx:xx","name":"Bluetooth Speaker","rssi":-93}]
## Bluetooth Connect [/setup/bluetooth/connect]
### Pair with Speaker [POST]
*See note for Bluetooth under `/setup/bluetooth/status`*
**For Part 2 only**
This pairs with other bluetooth speakers by mac address.
+ Request (application/json)
+ Attributes (Pair with SpeakerRequest)
+ Body
{
"mac_address": "54:13:79:49:19:22",
"connect": true,
"profile": 2
}
+ Response 200
+ Headers
Access-Control-Allow-Headers:Content-Type
Cache-Control:no-cache
Content-Length:0
+ Attributes (object)
# Group Wifi
## Configured Networks [/setup/configured_networks]
### Get Saved Networks [GET]
This gets a list of all saved Wi-Fi networks.
Each network has `ssid`, `wpa_auth`, `wpa_cipher` and `wpa_id`.
`wpa_id` is an incrementing number used to identify a saved network.
#TODO: Add values for `wpa_auth` and `wpa_cipher`.
+ Response 200 (application/json)
+ Attributes (array[Default65])
+ Body
[{"ssid":"Wifi name","wpa_auth":7,"wpa_cipher":4,"wpa_id":0}]
## Scan Wifi [/setup/scan_wifi]
### Scan for Networks [POST]
This initiates scanning for Wi-Fi networks.
For Chromecasts, this is required to populate results. For Google Home, this is not required. /setup/scan_results is always updated. (Related to [GitHub #22](https://github.com/rithvikvibhu/GHLocalApi/issues/22)).
+ Response 200
+ Attributes (object)
## Scan Results [/setup/scan_results]
### Get WiFi Scan Results [GET]
This gets a list of all nearby Wi-Fi access points.
+ Response 200 (application/json)
+ Attributes (array[Default66])
+ Body
[{"bssid":"APBSSID1","signal_level":-20,"ssid":"APSSID1","wpa_auth":7,"wpa_cipher":4,"wpa_id":0}]
## Connect Wifi [/setup/connect_wifi]
### Connect to WiFi Network [POST]
**Note:** Not sure how the password is encrypted. Might be using the public certificate from /setup/eureka_info. So this cannot be used as of now. If someone figures it out, [create a new issue here](https://github.com/rithvikvibhu/GHLocalApi/issues/new).
+ Request (application/json)
+ Attributes (Connect to WiFi NetworkRequest)
+ Body
{
"bssid": "5c:0a:xx:xx:xx:xx",
"signal_level": -42,
"ssid": "myotherssid",
"wpa_auth": 7,
"wpa_cipher": 4,
"enc_passwd": "xxxxxfPY="
}
+ Response 200
## Forget Wifi [/setup/forget_wifi]
### Forget WiFi Network [POST]
This is to forget a saved network by `wpa_id`. Get the `wpa_id` from /setup/configured_networks
+ Request (application/json)
+ Attributes (Forget WiFi NetworkRequest)
+ Body
{
"wpa_id": 0
}
+ Response 200
+ Attributes (object)
# Group Static Files
## NOTICEHtmlGz [/setup/NOTICE.html.gz]
### Legal Notice [GET]
All licenses of programs used by Home.
+ Response 200
+ Attributes (object)
## IconPng [/setup/icon.png]
### Chromecast Icon [GET]
A redirect to `http://www.gstatic.com/eureka/images/eureka_device.png`
+ Response 200
# Data Structures
## Default (object)
### Properties
+ `audio` (Audio, required)
+ `build_info` (BuildInfo, required)
+ `detail` (Detail, required)
+ `device_info` (DeviceInfo, required)
+ `multizone` (Multizone, required)
+ `name`: `Living Room` (string, required)
+ `net`: `Living Room` (Net, required)
+ `night_mode_params`: `Living Room` (NightModeParams, required)
+ `opencast`: `Living Room` (Opencast, required)
+ `opt_in`: `Living Room` (OptIn, required)
+ `proxy`: `Living Room` (Proxy, required)
+ `settings`: `Living Room` (Settings, required)
+ `setup`: `Living Room` (Setup, required)
+ `user_eq`: `Living Room` (UserEq, required)
+ `version`: `9` (number, required)
+ `wifi`: `9` (Wifi, required)
## Audio (object)
### Properties
+ `digital`: `false` (boolean, required)
## BuildInfo (object)
### Properties
+ `build_type`: `2` (number, required)
+ `cast_build_revision`: `1.32.118652` (string, required)
+ `cast_control_version`: `1` (number, required)
+ `preview_channel_state`: `4` (number, required)
+ `release_track`: `preview-joining-stable-channel` (string, required)
+ `system_build_number`: `118652` (string, required)
## Detail (object)
### Properties
+ `icon_list` (array[IconList], required)
+ `locale` (Locale, required)
+ `timezone` (Timezone, required)
## IconList (object)
### Properties