homey-api 3.0.0-rc.2 → 3.0.0-rc.21

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/assets/specifications/AthomCloudAPI.json +16 -0
  2. package/assets/specifications/HomeyAPIV3Local.json +365 -7
  3. package/assets/types/homey-api.d.ts +382 -59
  4. package/assets/types/homey-api.private.d.ts +428 -59
  5. package/index.browser.js +1 -0
  6. package/index.js +19 -20
  7. package/lib/HomeyAPI/HomeyAPI.js +58 -5
  8. package/lib/HomeyAPI/HomeyAPIV2/ManagerDevices/Capability.js +2 -2
  9. package/lib/HomeyAPI/HomeyAPIV2/ManagerDevices/Device.js +4 -3
  10. package/lib/HomeyAPI/HomeyAPIV2/ManagerDevices.js +0 -14
  11. package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers/Driver.js +2 -2
  12. package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers/PairSession.js +20 -0
  13. package/lib/HomeyAPI/HomeyAPIV2/ManagerDrivers.js +17 -0
  14. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/AdvancedFlow.js +19 -4
  15. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/Flow.js +27 -2
  16. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardAction.js +2 -2
  17. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardCondition.js +2 -2
  18. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow/FlowCardTrigger.js +2 -2
  19. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlow.js +37 -14
  20. package/lib/HomeyAPI/HomeyAPIV2/ManagerFlowToken/FlowToken.js +3 -3
  21. package/lib/HomeyAPI/HomeyAPIV2/ManagerInsights/Log.js +2 -3
  22. package/lib/HomeyAPI/HomeyAPIV2/ManagerInsights.js +17 -0
  23. package/lib/HomeyAPI/HomeyAPIV3/Item.js +14 -1
  24. package/lib/HomeyAPI/HomeyAPIV3/Manager.js +34 -46
  25. package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices/Device.js +14 -12
  26. package/lib/HomeyAPI/HomeyAPIV3/ManagerDevices/DeviceCapability.js +1 -1
  27. package/lib/HomeyAPI/HomeyAPIV3/ManagerDrivers/PairSession.js +9 -0
  28. package/lib/HomeyAPI/HomeyAPIV3/ManagerDrivers.js +2 -0
  29. package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/AdvancedFlow.js +119 -0
  30. package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/Flow.js +103 -0
  31. package/lib/HomeyAPI/HomeyAPIV3/ManagerFlow/FlowCard.js +8 -0
  32. package/lib/HomeyAPI/HomeyAPIV3/ManagerFlowToken/FlowToken.js +12 -4
  33. package/lib/HomeyAPI/HomeyAPIV3/ManagerInsights/Log.js +14 -0
  34. package/lib/HomeyAPI/HomeyAPIV3.js +8 -8
  35. package/lib/HomeyAPI/HomeyAPIV3Local/ManagerDevkit.js +32 -0
  36. package/lib/HomeyAPI/HomeyAPIV3Local.js +6 -0
  37. package/package.json +2 -1
@@ -2628,6 +2628,29 @@
2628
2628
 
2629
2629
 
2630
2630
 
2631
+ ):
2632
+ Promise<any>;
2633
+
2634
+ activateHomey(
2635
+
2636
+
2637
+
2638
+
2639
+ opts: {
2640
+
2641
+
2642
+ id: string,
2643
+
2644
+
2645
+
2646
+ userId: string,
2647
+
2648
+
2649
+ },
2650
+
2651
+
2652
+
2653
+
2631
2654
  ):
2632
2655
  Promise<any>;
2633
2656
 
@@ -5371,7 +5394,34 @@
5371
5394
 
5372
5395
 
5373
5396
 
5374
- debug: function,
5397
+ debug: function | null,
5398
+
5399
+
5400
+ },
5401
+
5402
+
5403
+
5404
+
5405
+ ):
5406
+ Promise<any>;
5407
+
5408
+ createLocalAPI(
5409
+
5410
+
5411
+
5412
+
5413
+ opts: {
5414
+
5415
+
5416
+ address: String,
5417
+
5418
+
5419
+
5420
+ token: String,
5421
+
5422
+
5423
+
5424
+ debug: function | null,
5375
5425
 
5376
5426
 
5377
5427
  },
@@ -6411,62 +6461,6 @@
6411
6461
 
6412
6462
 
6413
6463
 
6414
- makeCapabilityInstance(
6415
-
6416
-
6417
-
6418
-
6419
- capabilityId: string,
6420
-
6421
-
6422
-
6423
- listener: {
6424
-
6425
-
6426
- value: number | boolean | string,
6427
-
6428
-
6429
- },
6430
-
6431
-
6432
-
6433
-
6434
- ):
6435
- HomeyAPIV2.ManagerDevices.Device.DeviceCapability;
6436
-
6437
- setCapabilityValue(
6438
-
6439
-
6440
-
6441
-
6442
- opts: {
6443
-
6444
-
6445
- capabilityId: string,
6446
-
6447
-
6448
-
6449
- value: number | boolean | string,
6450
-
6451
-
6452
-
6453
- opts: {
6454
-
6455
-
6456
- duration: number,
6457
-
6458
-
6459
- },
6460
-
6461
-
6462
- },
6463
-
6464
-
6465
-
6466
-
6467
- ):
6468
- Promise<void>;
6469
-
6470
6464
  }
6471
6465
 
6472
6466
  }
@@ -7670,6 +7664,24 @@
7670
7664
 
7671
7665
 
7672
7666
 
7667
+
7668
+
7669
+
7670
+
7671
+
7672
+
7673
+
7674
+ export namespace HomeyAPIV3Local.ManagerAlarms {
7675
+
7676
+ export class Alarm {
7677
+
7678
+
7679
+
7680
+
7681
+
7682
+ }
7683
+
7684
+ }
7673
7685
 
7674
7686
 
7675
7687
 
@@ -7867,6 +7879,16 @@
7867
7879
 
7868
7880
  export namespace HomeyAPIV3Local.ManagerExperiments {
7869
7881
 
7882
+ export class ExperimentHomeKit {
7883
+
7884
+
7885
+
7886
+ id: string;
7887
+
7888
+
7889
+
7890
+ }
7891
+
7870
7892
  export class ExperimentPowerUser {
7871
7893
 
7872
7894
 
@@ -16234,6 +16256,150 @@
16234
16256
 
16235
16257
 
16236
16258
 
16259
+ isConnected(
16260
+
16261
+ ):
16262
+ Boolean;
16263
+
16264
+ connect(
16265
+
16266
+ ):
16267
+ Promise<void>;
16268
+
16269
+ disconnect(
16270
+
16271
+ ):
16272
+ Promise<void>;
16273
+
16274
+ }
16275
+
16276
+ export class ManagerAlarms extends HomeyAPIV3Local.Manager {
16277
+
16278
+
16279
+
16280
+
16281
+
16282
+ getAlarms(
16283
+
16284
+ ):
16285
+ Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
16286
+
16287
+ getAlarm(
16288
+
16289
+
16290
+
16291
+
16292
+ opts: {
16293
+
16294
+
16295
+ id: string,
16296
+
16297
+
16298
+ },
16299
+
16300
+
16301
+
16302
+
16303
+ ):
16304
+ Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
16305
+
16306
+ createAlarm(
16307
+
16308
+
16309
+
16310
+
16311
+ opts: {
16312
+
16313
+
16314
+ alarm: {
16315
+
16316
+
16317
+ name: string,
16318
+
16319
+
16320
+
16321
+ time: string,
16322
+
16323
+
16324
+
16325
+ enabled: boolean,
16326
+
16327
+
16328
+
16329
+ repetition: object,
16330
+
16331
+
16332
+ },
16333
+
16334
+
16335
+ },
16336
+
16337
+
16338
+
16339
+
16340
+ ):
16341
+ Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
16342
+
16343
+ updateAlarm(
16344
+
16345
+
16346
+
16347
+
16348
+ opts: {
16349
+
16350
+
16351
+ id: string,
16352
+
16353
+
16354
+
16355
+ alarm: {
16356
+
16357
+
16358
+ name: string,
16359
+
16360
+
16361
+
16362
+ time: string,
16363
+
16364
+
16365
+
16366
+ enabled: boolean,
16367
+
16368
+
16369
+
16370
+ repetition: object,
16371
+
16372
+
16373
+ },
16374
+
16375
+
16376
+ },
16377
+
16378
+
16379
+
16380
+
16381
+ ):
16382
+ Promise<HomeyAPIV3Local.ManagerAlarms.Alarm>;
16383
+
16384
+ deleteAlarm(
16385
+
16386
+
16387
+
16388
+
16389
+ opts: {
16390
+
16391
+
16392
+ id: string,
16393
+
16394
+
16395
+ },
16396
+
16397
+
16398
+
16399
+
16400
+ ):
16401
+ Promise<any>;
16402
+
16237
16403
  isConnected(
16238
16404
 
16239
16405
  ):
@@ -16562,6 +16728,25 @@
16562
16728
 
16563
16729
 
16564
16730
 
16731
+ opts: {
16732
+
16733
+
16734
+ id: string,
16735
+
16736
+
16737
+ },
16738
+
16739
+
16740
+
16741
+
16742
+ ):
16743
+ Promise<any>;
16744
+
16745
+ getAppUsage(
16746
+
16747
+
16748
+
16749
+
16565
16750
  opts: {
16566
16751
 
16567
16752
 
@@ -16851,6 +17036,29 @@
16851
17036
 
16852
17037
 
16853
17038
 
17039
+ ):
17040
+ Promise<any>;
17041
+
17042
+ setDebugLogging(
17043
+
17044
+
17045
+
17046
+
17047
+ opts: {
17048
+
17049
+
17050
+ peripheral: string,
17051
+
17052
+
17053
+
17054
+ enabled: boolean,
17055
+
17056
+
17057
+ },
17058
+
17059
+
17060
+
17061
+
16854
17062
  ):
16855
17063
  Promise<any>;
16856
17064
 
@@ -17577,7 +17785,7 @@
17577
17785
 
17578
17786
 
17579
17787
 
17580
- data: object,
17788
+ data: *,
17581
17789
 
17582
17790
 
17583
17791
  },
@@ -17604,7 +17812,7 @@
17604
17812
 
17605
17813
 
17606
17814
 
17607
- data: object,
17815
+ data: *,
17608
17816
 
17609
17817
 
17610
17818
  },
@@ -18512,6 +18720,44 @@
18512
18720
  ):
18513
18721
  Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
18514
18722
 
18723
+ getFlowToken(
18724
+
18725
+
18726
+
18727
+
18728
+ opts: {
18729
+
18730
+
18731
+ id: string,
18732
+
18733
+
18734
+ },
18735
+
18736
+
18737
+
18738
+
18739
+ ):
18740
+ Promise<HomeyAPIV3Local.ManagerFlowToken.FlowToken>;
18741
+
18742
+ getFlowTokenValue(
18743
+
18744
+
18745
+
18746
+
18747
+ opts: {
18748
+
18749
+
18750
+ id: string,
18751
+
18752
+
18753
+ },
18754
+
18755
+
18756
+
18757
+
18758
+ ):
18759
+ Promise<any>;
18760
+
18515
18761
  isConnected(
18516
18762
 
18517
18763
  ):
@@ -19022,6 +19268,25 @@
19022
19268
  ):
19023
19269
  Promise<any>;
19024
19270
 
19271
+ getVariable(
19272
+
19273
+
19274
+
19275
+
19276
+ opts: {
19277
+
19278
+
19279
+ id: string,
19280
+
19281
+
19282
+ },
19283
+
19284
+
19285
+
19286
+
19287
+ ):
19288
+ Promise<HomeyAPIV3Local.ManagerLogic.Variable>;
19289
+
19025
19290
  getVariables(
19026
19291
 
19027
19292
  ):
@@ -19367,6 +19632,25 @@
19367
19632
 
19368
19633
 
19369
19634
 
19635
+ ):
19636
+ Promise<any>;
19637
+
19638
+ getPresent(
19639
+
19640
+
19641
+
19642
+
19643
+ opts: {
19644
+
19645
+
19646
+ id: string,
19647
+
19648
+
19649
+ },
19650
+
19651
+
19652
+
19653
+
19370
19654
  ):
19371
19655
  Promise<any>;
19372
19656
 
@@ -19419,6 +19703,25 @@
19419
19703
 
19420
19704
 
19421
19705
 
19706
+ ):
19707
+ Promise<any>;
19708
+
19709
+ getAsleep(
19710
+
19711
+
19712
+
19713
+
19714
+ opts: {
19715
+
19716
+
19717
+ id: string,
19718
+
19719
+
19720
+ },
19721
+
19722
+
19723
+
19724
+
19422
19725
  ):
19423
19726
  Promise<any>;
19424
19727
 
@@ -19829,6 +20132,25 @@
19829
20132
 
19830
20133
  rebootOTA(
19831
20134
 
20135
+ ):
20136
+ Promise<any>;
20137
+
20138
+ setDebug(
20139
+
20140
+
20141
+
20142
+
20143
+ opts: {
20144
+
20145
+
20146
+ namespace: string,
20147
+
20148
+
20149
+ },
20150
+
20151
+
20152
+
20153
+
19832
20154
  ):
19833
20155
  Promise<any>;
19834
20156
 
@@ -20439,6 +20761,25 @@
20439
20761
 
20440
20762
  getZones(
20441
20763
 
20764
+ ):
20765
+ Promise<HomeyAPIV3Local.ManagerZones.Zone>;
20766
+
20767
+ getZone(
20768
+
20769
+
20770
+
20771
+
20772
+ opts: {
20773
+
20774
+
20775
+ id: string,
20776
+
20777
+
20778
+ },
20779
+
20780
+
20781
+
20782
+
20442
20783
  ):
20443
20784
  Promise<HomeyAPIV3Local.ManagerZones.Zone>;
20444
20785
 
@@ -20584,6 +20925,30 @@
20584
20925
 
20585
20926
  flashFirmware(
20586
20927
 
20928
+ ):
20929
+ Promise<any>;
20930
+
20931
+ getLog(
20932
+
20933
+ ):
20934
+ Promise<any>;
20935
+
20936
+ setLogEnabled(
20937
+
20938
+
20939
+
20940
+
20941
+ opts: {
20942
+
20943
+
20944
+ enabled: boolean,
20945
+
20946
+
20947
+ },
20948
+
20949
+
20950
+
20951
+
20587
20952
  ):
20588
20953
  Promise<any>;
20589
20954
 
@@ -20621,6 +20986,10 @@
20621
20986
 
20622
20987
 
20623
20988
 
20989
+
20990
+
20991
+
20992
+
20624
20993
 
20625
20994
 
20626
20995
 
package/index.browser.js CHANGED
@@ -11,3 +11,4 @@ global.HomeyCloudAPI = require('./lib/HomeyCloudAPI');
11
11
  global.HomeyAPIV2 = require('./lib/HomeyAPI/HomeyAPIV2');
12
12
  global.HomeyAPIV3Local = require('./lib/HomeyAPI/HomeyAPIV3Local');
13
13
  global.HomeyAPIV3Cloud = require('./lib/HomeyAPI/HomeyAPIV3Cloud');
14
+ global.HomeyAPI = require('./lib/HomeyAPI/HomeyAPI');
package/index.js CHANGED
@@ -2,23 +2,22 @@
2
2
 
3
3
  'use strict';
4
4
 
5
- module.exports = {
6
- AthomAppsAPI: require('./lib/AthomAppsAPI'),
7
- AthomBackupAPI: require('./lib/AthomBackupAPI'),
8
- AthomCallbackAPI: require('./lib/AthomCallbackAPI'),
9
- AthomCloudAPI: require('./lib/AthomCloudAPI'),
10
- AthomConnectAPI: require('./lib/AthomConnectAPI'),
11
- AthomDNSAPI: require('./lib/AthomDNSAPI'),
12
- AthomFirmwareAPI: require('./lib/AthomFirmwareAPI'),
13
- AthomFlowAPI: require('./lib/AthomFlowAPI'),
14
- AthomGeolocateAPI: require('./lib/AthomGeolocateAPI'),
15
- AthomIconsAPI: require('./lib/AthomIconsAPI'),
16
- AthomInfraredAPI: require('./lib/AthomInfraredAPI'),
17
- AthomNotificationsAPI: require('./lib/AthomNotificationsAPI'),
18
- AthomSetupAPI: require('./lib/AthomSetupAPI'),
19
- AthomStoreAPI: require('./lib/AthomStoreAPI'),
20
- AthomWeatherAPI: require('./lib/AthomWeatherAPI'),
21
- AthomWebhooksAPI: require('./lib/AthomWebhooksAPI'),
22
- HomeyCloudAPI: require('./lib/HomeyCloudAPI'),
23
- HomeyAPI: require('./lib/HomeyAPI/HomeyAPI'),
24
- };
5
+ module.exports = {};
6
+ module.exports.AthomAppsAPI = require('./lib/AthomAppsAPI');
7
+ module.exports.AthomBackupAPI = require('./lib/AthomBackupAPI');
8
+ module.exports.AthomCallbackAPI = require('./lib/AthomCallbackAPI');
9
+ module.exports.AthomCloudAPI = require('./lib/AthomCloudAPI');
10
+ module.exports.AthomConnectAPI = require('./lib/AthomConnectAPI');
11
+ module.exports.AthomDNSAPI = require('./lib/AthomDNSAPI');
12
+ module.exports.AthomFirmwareAPI = require('./lib/AthomFirmwareAPI');
13
+ module.exports.AthomFlowAPI = require('./lib/AthomFlowAPI');
14
+ module.exports.AthomGeolocateAPI = require('./lib/AthomGeolocateAPI');
15
+ module.exports.AthomIconsAPI = require('./lib/AthomIconsAPI');
16
+ module.exports.AthomInfraredAPI = require('./lib/AthomInfraredAPI');
17
+ module.exports.AthomNotificationsAPI = require('./lib/AthomNotificationsAPI');
18
+ module.exports.AthomSetupAPI = require('./lib/AthomSetupAPI');
19
+ module.exports.AthomStoreAPI = require('./lib/AthomStoreAPI');
20
+ module.exports.AthomWeatherAPI = require('./lib/AthomWeatherAPI');
21
+ module.exports.AthomWebhooksAPI = require('./lib/AthomWebhooksAPI');
22
+ module.exports.HomeyCloudAPI = require('./lib/HomeyCloudAPI');
23
+ module.exports.HomeyAPI = require('./lib/HomeyAPI/HomeyAPI');