hoffmation-base 3.0.0-alpha.20 → 3.0.0-alpha.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 (159) hide show
  1. package/lib/liquid-pid.d.ts +2 -5
  2. package/lib/liquid-pid.js +2 -5
  3. package/lib/models/command/ShutterSetLevelCommand.d.ts +7 -0
  4. package/lib/models/command/ShutterSetLevelCommand.js +7 -1
  5. package/lib/models/command/WindowRestoreDesiredPositionCommand.d.ts +5 -0
  6. package/lib/models/command/WindowRestoreDesiredPositionCommand.js +5 -1
  7. package/lib/models/command/WindowSetDesiredPositionCommand.d.ts +6 -0
  8. package/lib/models/command/WindowSetDesiredPositionCommand.js +6 -1
  9. package/lib/models/command/WindowSetRolloByWeatherStatusCommand.d.ts +5 -0
  10. package/lib/models/command/WindowSetRolloByWeatherStatusCommand.js +5 -1
  11. package/lib/models/command/actuatorSetStateCommand.d.ts +7 -0
  12. package/lib/models/command/actuatorSetStateCommand.js +7 -1
  13. package/lib/models/command/actuatorToggleCommand.d.ts +5 -0
  14. package/lib/models/command/actuatorToggleCommand.js +5 -1
  15. package/lib/models/command/actuatorWriteStateToDeviceCommand.d.ts +6 -0
  16. package/lib/models/command/actuatorWriteStateToDeviceCommand.js +6 -1
  17. package/lib/models/command/baseCommand.d.ts +10 -0
  18. package/lib/models/command/baseCommand.js +16 -1
  19. package/lib/models/command/blockAutomaticCommand.d.ts +4 -4
  20. package/lib/models/command/blockAutomaticCommand.js +4 -4
  21. package/lib/models/command/blockAutomaticLiftBlockCommand.d.ts +2 -2
  22. package/lib/models/command/blockAutomaticLiftBlockCommand.js +2 -2
  23. package/lib/models/command/blockAutomaticUntilCommand.d.ts +4 -4
  24. package/lib/models/command/blockAutomaticUntilCommand.js +4 -4
  25. package/lib/models/command/commandSource.d.ts +19 -0
  26. package/lib/models/command/commandSource.js +20 -1
  27. package/lib/models/command/dimmerSetLightCommand.d.ts +7 -6
  28. package/lib/models/command/dimmerSetLightCommand.js +7 -6
  29. package/lib/models/command/floorSetAllShuttersCommand.d.ts +4 -4
  30. package/lib/models/command/floorSetAllShuttersCommand.js +4 -4
  31. package/lib/models/command/lampSetLightCommand.d.ts +7 -0
  32. package/lib/models/command/lampSetLightCommand.js +7 -1
  33. package/lib/models/command/lampSetTimeBasedCommand.d.ts +4 -4
  34. package/lib/models/command/lampSetTimeBasedCommand.js +4 -4
  35. package/lib/models/command/lampToggleLightCommand.d.ts +5 -5
  36. package/lib/models/command/lampToggleLightCommand.js +5 -5
  37. package/lib/models/command/ledSetLightCommand.d.ts +15 -9
  38. package/lib/models/command/ledSetLightCommand.js +15 -10
  39. package/lib/models/command/lightGroupSwitchTimeConditionalCommand.d.ts +6 -0
  40. package/lib/models/command/lightGroupSwitchTimeConditionalCommand.js +6 -1
  41. package/lib/models/command/restoreTargetAutomaticValueCommand.d.ts +5 -0
  42. package/lib/models/command/restoreTargetAutomaticValueCommand.js +5 -1
  43. package/lib/models/command/roomRestoreLightCommand.d.ts +5 -0
  44. package/lib/models/command/roomRestoreLightCommand.js +5 -1
  45. package/lib/models/command/roomRestoreShutterPositionCommand.d.ts +6 -0
  46. package/lib/models/command/roomRestoreShutterPositionCommand.js +6 -1
  47. package/lib/models/command/roomSetLightTimeBasedCommand.d.ts +3 -3
  48. package/lib/models/command/roomSetLightTimeBasedCommand.js +3 -3
  49. package/lib/models/command/shutterSunriseUpCommand.d.ts +5 -0
  50. package/lib/models/command/shutterSunriseUpCommand.js +5 -1
  51. package/lib/models/command/shutterSunsetDownCommand.d.ts +5 -0
  52. package/lib/models/command/shutterSunsetDownCommand.js +5 -1
  53. package/lib/models/command/wledSetLightCommand.d.ts +10 -0
  54. package/lib/models/command/wledSetLightCommand.js +10 -1
  55. package/lib/models/connectionCallbacks.d.ts +4 -4
  56. package/lib/models/deviceConfig.d.ts +2 -2
  57. package/lib/models/deviceSettings/acSettings.d.ts +0 -5
  58. package/lib/models/deviceSettings/acSettings.js +0 -5
  59. package/lib/models/deviceSettings/actuatorSettings.d.ts +0 -8
  60. package/lib/models/deviceSettings/actuatorSettings.js +0 -8
  61. package/lib/models/deviceSettings/garageDoorOpenerSettings.d.ts +0 -1
  62. package/lib/models/deviceSettings/garageDoorOpenerSettings.js +0 -1
  63. package/lib/models/deviceSettings/heaterSettings.d.ts +0 -6
  64. package/lib/models/deviceSettings/heaterSettings.js +0 -6
  65. package/lib/models/deviceSettings/motionSensorSettings.d.ts +0 -1
  66. package/lib/models/deviceSettings/motionSensorSettings.js +0 -1
  67. package/lib/models/deviceSettings/shutterSettings.d.ts +0 -3
  68. package/lib/models/deviceSettings/shutterSettings.js +0 -3
  69. package/lib/models/groupSettings/heatGroupSettings.d.ts +0 -2
  70. package/lib/models/groupSettings/heatGroupSettings.js +0 -2
  71. package/lib/models/iIdHolder.d.ts +6 -0
  72. package/lib/models/objectSettings.d.ts +2 -2
  73. package/lib/models/objectSettings.js +2 -2
  74. package/lib/models/rooms/RoomBase.d.ts +2 -1
  75. package/lib/models/rooms/RoomBase.js +2 -1
  76. package/lib/models/rooms/iRoomBase.d.ts +17 -0
  77. package/lib/models/rooms/iRoomImportEnforcer.d.ts +4 -0
  78. package/lib/server/devices/Griffe.js +0 -1
  79. package/lib/server/devices/IoBrokerBaseDevice.d.ts +9 -16
  80. package/lib/server/devices/IoBrokerBaseDevice.js +9 -16
  81. package/lib/server/devices/IoBrokerDeviceInfo.d.ts +2 -2
  82. package/lib/server/devices/IoBrokerDeviceInfo.js +6 -4
  83. package/lib/server/devices/baseDeviceInterfaces/iAcDevice.d.ts +32 -0
  84. package/lib/server/devices/baseDeviceInterfaces/iActuator.d.ts +16 -0
  85. package/lib/server/devices/baseDeviceInterfaces/iBaseDevice.d.ts +25 -0
  86. package/lib/server/devices/baseDeviceInterfaces/iBatteryDevice.d.ts +10 -1
  87. package/lib/server/devices/baseDeviceInterfaces/iBluetoothDetector.d.ts +5 -5
  88. package/lib/server/devices/baseDeviceInterfaces/iButtonSwitch.d.ts +13 -0
  89. package/lib/server/devices/baseDeviceInterfaces/iCameraDevice.d.ts +10 -0
  90. package/lib/server/devices/baseDeviceInterfaces/iDimmableLamp.d.ts +9 -2
  91. package/lib/server/devices/baseDeviceInterfaces/iEnergyManager.d.ts +13 -2
  92. package/lib/server/devices/baseDeviceInterfaces/iExcessEnergyConsumer.d.ts +16 -2
  93. package/lib/server/devices/baseDeviceInterfaces/iGarageDoorOpener.d.ts +10 -0
  94. package/lib/server/devices/baseDeviceInterfaces/iHandleSensor.d.ts +12 -0
  95. package/lib/server/devices/baseDeviceInterfaces/iHeater.d.ts +12 -2
  96. package/lib/server/devices/baseDeviceInterfaces/iHumiditySensor.d.ts +7 -0
  97. package/lib/server/devices/baseDeviceInterfaces/iLamp.d.ts +4 -0
  98. package/lib/server/devices/baseDeviceInterfaces/iLedRgbCct.d.ts +5 -0
  99. package/lib/server/devices/baseDeviceInterfaces/iMotionSensor.d.ts +7 -1
  100. package/lib/server/devices/baseDeviceInterfaces/iScene.d.ts +7 -0
  101. package/lib/server/devices/baseDeviceInterfaces/iShutter.d.ts +7 -0
  102. package/lib/server/devices/baseDeviceInterfaces/iSmokeDetectorDevice.d.ts +7 -0
  103. package/lib/server/devices/baseDeviceInterfaces/iSpeaker.d.ts +25 -0
  104. package/lib/server/devices/baseDeviceInterfaces/iTemperatureSensor.d.ts +11 -0
  105. package/lib/server/devices/baseDeviceInterfaces/iTemporaryDisableAutomatic.d.ts +7 -0
  106. package/lib/server/devices/baseDeviceInterfaces/iTvDevice.d.ts +12 -0
  107. package/lib/server/devices/baseDeviceInterfaces/iVibrationSensor.d.ts +0 -1
  108. package/lib/server/devices/blueIris/cameraDevice.d.ts +2 -3
  109. package/lib/server/devices/blueIris/cameraDevice.js +2 -3
  110. package/lib/server/devices/dachs/interfaces/KeyListEntity.d.ts +0 -8
  111. package/lib/server/devices/dachs/interfaces/KeyListEntity.js +0 -8
  112. package/lib/server/devices/dachs/lib/dachsHttpClient.d.ts +1 -1
  113. package/lib/server/devices/groups/Window.d.ts +1 -0
  114. package/lib/server/devices/groups/Window.js +1 -0
  115. package/lib/server/devices/groups/heatGroup.d.ts +6 -6
  116. package/lib/server/devices/groups/heatGroup.js +6 -6
  117. package/lib/server/devices/groups/presenceGroup.d.ts +0 -1
  118. package/lib/server/devices/groups/presenceGroup.js +0 -1
  119. package/lib/server/devices/hmIPDevices/hmIpHeizgruppe.d.ts +0 -1
  120. package/lib/server/devices/hmIPDevices/hmIpHeizgruppe.js +0 -6
  121. package/lib/server/devices/iDeviceUpdater.d.ts +11 -0
  122. package/lib/server/devices/jsObject/jsObjectEnergyManager.d.ts +1 -1
  123. package/lib/server/devices/jsObject/jsObjectEnergyManager.js +1 -1
  124. package/lib/server/devices/sharedFunctions/lampUtils.js +3 -1
  125. package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.d.ts +1 -1
  126. package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.js +1 -1
  127. package/lib/server/devices/zigbee/BaseDevices/zigbeeSwitch.d.ts +1 -1
  128. package/lib/server/devices/zigbee/zigbeeAquaraVibra.d.ts +1 -1
  129. package/lib/server/devices/zigbee/zigbeeEuroHeater.d.ts +2 -3
  130. package/lib/server/devices/zigbee/zigbeeEuroHeater.js +2 -3
  131. package/lib/server/ioBroker/connection.d.ts +20 -20
  132. package/lib/server/ioBroker/connection.js +29 -21
  133. package/lib/server/ioBroker/socketIOConnectOptions.d.ts +2 -2
  134. package/lib/server/ioBroker/socketIOVisCommand.d.ts +5 -1
  135. package/lib/server/services/Sonos/polly-service.js +1 -2
  136. package/lib/server/services/Translation/res.d.ts +34 -19
  137. package/lib/server/services/Translation/res.js +34 -19
  138. package/lib/server/services/api/api-service.d.ts +72 -70
  139. package/lib/server/services/api/api-service.js +72 -70
  140. package/lib/server/services/blockAutomaticHandler.js +5 -0
  141. package/lib/server/services/dbo/iPersist.d.ts +96 -0
  142. package/lib/server/services/https-service.d.ts +3 -2
  143. package/lib/server/services/https-service.js +3 -2
  144. package/lib/server/services/log-service/log-service.d.ts +2 -2
  145. package/lib/server/services/log-service/log-service.js +2 -2
  146. package/lib/server/services/news-service.d.ts +5 -6
  147. package/lib/server/services/news-service.js +5 -6
  148. package/lib/server/services/room-service/room-service.d.ts +3 -2
  149. package/lib/server/services/room-service/room-service.js +4 -3
  150. package/lib/server/services/settings-service.d.ts +3 -2
  151. package/lib/server/services/settings-service.js +3 -2
  152. package/lib/server/services/utils/iDisposeable.d.ts +3 -0
  153. package/lib/server/services/victron/victron-device.d.ts +2 -2
  154. package/lib/server/services/victron/victron-device.js +2 -2
  155. package/lib/server/services/weather/weather-current.d.ts +0 -2
  156. package/lib/server/services/weather/weather-service.d.ts +4 -1
  157. package/lib/server/services/weather/weather-service.js +4 -0
  158. package/lib/tsconfig.tsbuildinfo +1 -1
  159. package/package.json +6 -5
@@ -26,6 +26,7 @@ var ConnectionState;
26
26
  })(ConnectionState || (ConnectionState = {}));
27
27
  class IOBrokerConnection {
28
28
  constructor(connOptions = {}, connCallbacks = new models_1.ConnectionCallbacks(), objectsRequired = false) {
29
+ var _a;
29
30
  this._authInfo = new ioBrokerAuthInfo_1.IoBrokerAuthInfo();
30
31
  this._authRunning = false;
31
32
  this._cmdQueue = new Array();
@@ -78,7 +79,7 @@ class IOBrokerConnection {
78
79
  this._connCallbacks = connCallbacks;
79
80
  let connLink = connOptions.connLink;
80
81
  if (!connOptions.connLink && this._isExecutedInBrowser) {
81
- connLink = window.localStorage.getItem('connLink');
82
+ connLink = (_a = window.localStorage.getItem('connLink')) !== null && _a !== void 0 ? _a : undefined;
82
83
  }
83
84
  // Connection data from "/_socket/info.js"
84
85
  if (!connLink && typeof socketUrl !== 'undefined')
@@ -290,6 +291,7 @@ class IOBrokerConnection {
290
291
  }
291
292
  const err = reason;
292
293
  iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Error, `Recieved socket error: ${err.message}\nStack:${err.stack}`);
294
+ // @ts-ignore
293
295
  const innerErr = reason.description;
294
296
  if (innerErr) {
295
297
  iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Error, `Inner socket error: ${innerErr.message}\nStack:${innerErr.stack}`);
@@ -298,91 +300,91 @@ class IOBrokerConnection {
298
300
  }
299
301
  /**
300
302
  * Getter isExecutedInBrowser
301
- * @return {boolean }
303
+ * @returns
302
304
  */
303
305
  get isExecutedInBrowser() {
304
306
  return this._isExecutedInBrowser;
305
307
  }
306
308
  /**
307
309
  * Getter enums
308
- * @return {unknown}
310
+ * @returns
309
311
  */
310
312
  get enums() {
311
313
  return this._enums;
312
314
  }
313
315
  /**
314
316
  * Setter enums
315
- * @param {unknown} value
317
+ * @param value
316
318
  */
317
319
  set enums(value) {
318
320
  this._enums = value;
319
321
  }
320
322
  /**
321
323
  * Getter isAuthDone
322
- * @return {boolean }
324
+ * @returns
323
325
  */
324
326
  get isAuthDone() {
325
327
  return this._isAuthDone;
326
328
  }
327
329
  /**
328
330
  * Getter namespace
329
- * @return {string }
331
+ * @returns
330
332
  */
331
333
  get namespace() {
332
334
  return this._namespace;
333
335
  }
334
336
  /**
335
337
  * Setter namespace
336
- * @param {string } value
338
+ * @param value
337
339
  */
338
340
  set namespace(value) {
339
341
  this._namespace = value;
340
342
  }
341
343
  /**
342
344
  * Getter objects
343
- * @return {unknown}
345
+ * @returns
344
346
  */
345
347
  get objects() {
346
348
  return this._objects;
347
349
  }
348
350
  /**
349
351
  * Setter objects
350
- * @param {unknown} value
352
+ * @param value
351
353
  */
352
354
  set objects(value) {
353
355
  this._objects = value;
354
356
  }
355
357
  /**
356
358
  * Getter type
357
- * @return {string }
359
+ * @returns
358
360
  */
359
361
  get type() {
360
362
  return this._type;
361
363
  }
362
364
  /**
363
365
  * Setter type
364
- * @param {string } value
366
+ * @param value
365
367
  */
366
368
  set type(value) {
367
369
  this._type = value;
368
370
  }
369
371
  /**
370
372
  * Getter timeout
371
- * @return {number }
373
+ * @returns
372
374
  */
373
375
  get timeout() {
374
376
  return this._timeout;
375
377
  }
376
378
  /**
377
379
  * Setter timeout
378
- * @param {number } value
380
+ * @param value
379
381
  */
380
382
  set timeout(value) {
381
383
  this._timeout = value;
382
384
  }
383
385
  /**
384
386
  * Getter user
385
- * @return {unknown}
387
+ * @returns
386
388
  */
387
389
  get user() {
388
390
  return this._user;
@@ -390,7 +392,7 @@ class IOBrokerConnection {
390
392
  //#endregion
391
393
  /**
392
394
  * Setter user
393
- * @param {unknown} value
395
+ * @param value
394
396
  */
395
397
  set user(value) {
396
398
  this._user = value;
@@ -478,7 +480,7 @@ class IOBrokerConnection {
478
480
  const regMatch = ext.toLowerCase().match(/\.[^.]+$/);
479
481
  ext = regMatch !== null && regMatch.length > 0 ? regMatch[0] : '';
480
482
  }
481
- let _mimeType = '';
483
+ let _mimeType;
482
484
  if (ext === '.css') {
483
485
  _mimeType = 'text/css';
484
486
  }
@@ -588,7 +590,7 @@ class IOBrokerConnection {
588
590
  // @ts-ignore
589
591
  writeFile(filename, data, mode, callback,
590
592
  // @ts-ignore
591
- ...args) {
593
+ ..._args) {
592
594
  if (this._type === 'local') {
593
595
  // @ts-ignore
594
596
  storage.set(filename, JSON.stringify(data));
@@ -764,6 +766,7 @@ class IOBrokerConnection {
764
766
  }
765
767
  for (const row of res.rows) {
766
768
  if (row.value !== null) {
769
+ // @ts-ignore
767
770
  data[row.id] = row.value;
768
771
  }
769
772
  }
@@ -781,6 +784,7 @@ class IOBrokerConnection {
781
784
  }
782
785
  for (const row of res.rows) {
783
786
  if (row.value !== null) {
787
+ // @ts-ignore
784
788
  data[row.id] = row.value;
785
789
  }
786
790
  }
@@ -792,6 +796,7 @@ class IOBrokerConnection {
792
796
  }
793
797
  for (const row of res.rows) {
794
798
  if (row.value !== null) {
799
+ // @ts-ignore
795
800
  data[row.id] = row.value;
796
801
  }
797
802
  }
@@ -819,7 +824,7 @@ class IOBrokerConnection {
819
824
  // @ts-ignore
820
825
  getChildren(id, useCache, callback,
821
826
  // @ts-ignore
822
- ...args) {
827
+ ..._args) {
823
828
  if (this._checkConnection('getChildren', arguments) != ConnectionState.connected)
824
829
  return;
825
830
  if (!id)
@@ -849,6 +854,7 @@ class IOBrokerConnection {
849
854
  }
850
855
  for (const row of res.rows) {
851
856
  if (row.value !== null) {
857
+ // @ts-ignore
852
858
  data[row.id] = row.value;
853
859
  }
854
860
  }
@@ -859,6 +865,7 @@ class IOBrokerConnection {
859
865
  }
860
866
  for (const row of res.rows) {
861
867
  if (row.value !== null) {
868
+ // @ts-ignore
862
869
  data[row.id] = row.value;
863
870
  }
864
871
  }
@@ -870,6 +877,7 @@ class IOBrokerConnection {
870
877
  }
871
878
  for (const row of res.rows) {
872
879
  if (row.value !== null) {
880
+ // @ts-ignore
873
881
  data[row.id] = row.value;
874
882
  }
875
883
  }
@@ -960,7 +968,7 @@ class IOBrokerConnection {
960
968
  return new Date(0);
961
969
  }
962
970
  // @ts-ignore
963
- addObject(objId, obj, callback) {
971
+ addObject(_objId, _obj, _callback) {
964
972
  if (!this._isConnected) {
965
973
  iobrokerConnectionLogging_1.iobrokerConnectionLogging.writeLog(iobrokerConnectionLogging_1.iobrokerConnectionLogLevel.Debug, 'No connection!');
966
974
  return;
@@ -1024,7 +1032,7 @@ class IOBrokerConnection {
1024
1032
  // FIXME finish implementation of this file
1025
1033
  getConfig(useCache, callback,
1026
1034
  // @ts-ignore
1027
- ...args) {
1035
+ ..._args) {
1028
1036
  if (this._checkConnection('getConfig', arguments) != ConnectionState.connected)
1029
1037
  return;
1030
1038
  if (typeof useCache === 'function') {
@@ -1112,7 +1120,7 @@ class IOBrokerConnection {
1112
1120
  }
1113
1121
  getHistory(id, options, callback,
1114
1122
  // @ts-ignore
1115
- ...args) {
1123
+ ..._args) {
1116
1124
  if (this._checkConnection('getHistory', arguments) != ConnectionState.connected)
1117
1125
  return;
1118
1126
  if (!options)
@@ -1,6 +1,6 @@
1
1
  export declare class SocketIOConnectOpts {
2
2
  name?: string;
3
- connLink?: any;
4
- socketSession?: any;
3
+ connLink?: string;
4
+ socketSession?: unknown;
5
5
  socketForceWebSockets?: boolean;
6
6
  }
@@ -2,5 +2,9 @@ export declare class SocketIOVisCommand {
2
2
  command: string;
3
3
  data: string;
4
4
  instance: string;
5
- constructor(pObject: any);
5
+ constructor(pObject: {
6
+ command: string;
7
+ data: string;
8
+ instance: string;
9
+ });
6
10
  }
@@ -54,8 +54,7 @@ class PollyService {
54
54
  const fPath = path_1.default.join(this._mp3Path, filename);
55
55
  try {
56
56
  if (fs.existsSync(fPath)) {
57
- const duration = (0, get_mp3_duration_1.default)(fs.readFileSync(fPath));
58
- return duration;
57
+ return (0, get_mp3_duration_1.default)(fs.readFileSync(fPath));
59
58
  }
60
59
  }
61
60
  catch (err) {
@@ -4,79 +4,94 @@ export declare class Res {
4
4
  private static selectedLanguage;
5
5
  static initialize(config: iTranslationSettings): void;
6
6
  /**
7
- * Retrieves a string like `Alarm system arming."`
7
+ * @returns Retrieves a string like `Alarm system arming."`
8
8
  */
9
9
  static alarmArmed(): string;
10
10
  /**
11
- * Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
11
+ * @returns Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
12
12
  */
13
13
  static alarmNightModeArmed(): string;
14
14
  /**
15
- * Retrieves a string like `"@P0" closed after @P1 minutes`
15
+ * @param deviceCustomName - The custom name of the device
16
+ * @param minutes - The minutes the device was closed after
17
+ * @returns Retrieves a string like `"@P0" closed after @P1 minutes`
16
18
  */
17
19
  static closedAfterMinutes(deviceCustomName: string, minutes: string): string;
18
20
  /**
19
- * Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
21
+ * @param roomName - The name of the room
22
+ * @returns Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
20
23
  */
21
24
  static fireAlarmEnd(roomName: string): string;
22
25
  /**
23
- * Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
26
+ * @param roomName - The name of the room
27
+ * @param deviceCustomName - The custom name of the device
28
+ * @returns Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
24
29
  */
25
30
  static fireAlarmRepeat(roomName: string, deviceCustomName: string): string;
26
31
  /**
27
- * Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
32
+ * @param roomName - The name of the room
33
+ * @param deviceCustomName - The custom name of the device
34
+ * @returns Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
28
35
  */
29
36
  static fireAlarmStart(roomName: string, deviceCustomName: string): string;
30
37
  /**
31
- * Retrieves a string like `Good Morning`
38
+ * @returns Retrieves a string like `Good Morning`
32
39
  */
33
40
  static goodMorning(): string;
34
41
  /**
35
- * Retrieves a string like "Alarm. Intruder detected"
42
+ * @returns Retrieves a string like "Alarm. Intruder detected"
36
43
  */
37
44
  static intruderAlarm(): string;
38
45
  /**
39
- * Retrieves a string like "Additional defense protocol initiated."
46
+ * @returns Retrieves a string like "Additional defense protocol initiated."
40
47
  */
41
48
  static intruderAdditionalDefenseWarning(): string;
42
49
  /**
43
- * Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
50
+ * @returns Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
44
51
  */
45
52
  static intruderGreeting(): string;
46
53
  /**
47
- * Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
54
+ * @returns Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
48
55
  */
49
56
  static intruderLeaveAndOwnerInformed(): string;
50
57
  /**
51
- * Retrieves a string like "All shutter are opening, please leave immediatly."
58
+ * @returns Retrieves a string like "All shutter are opening, please leave immediatly."
52
59
  */
53
60
  static intruderShutterUpPleaseLeave(): string;
54
61
  /**
55
- * Retrieves a string like `"@P0" just closed`
62
+ * @param deviceCustomName - The custom name of the device
63
+ * @returns Retrieves a string like `"@P0" just closed`
56
64
  */
57
65
  static justClosed(deviceCustomName: string): string;
58
66
  /**
59
- * Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
67
+ * @param deviceCustomName - The custom name of the device
68
+ * @returns Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
60
69
  */
61
70
  static vibrationAlarm(deviceCustomName: string): string;
62
71
  /**
63
- * Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
72
+ * @param roomName - The name of the room
73
+ * @returns Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
64
74
  */
65
75
  static waterAlarmEnd(roomName: string): string;
66
76
  /**
67
- * Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
77
+ * @param deviceCustomName - The custom name of the device
78
+ * @param roomName - The name of the room
79
+ * @returns Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
68
80
  */
69
81
  static waterAlarmRepeat(deviceCustomName: string, roomName: string): string;
70
82
  /**
71
- * Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
83
+ * @param deviceCustomName - The custom name of the device
84
+ * @param roomName - The name of the room
85
+ * @returns Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
72
86
  */
73
87
  static waterAlarmStart(deviceCustomName: string, roomName: string): string;
74
88
  /**
75
- * Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
89
+ * @returns Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
76
90
  */
77
91
  static welcomeHome(): string;
78
92
  /**
79
- * Retrieves a string like `"@P0" was opened`
93
+ * @param deviceCustomName - The custom name of the device
94
+ * @returns Retrieves a string like `"@P0" was opened`
80
95
  */
81
96
  static wasOpened(deviceCustomName: string): string;
82
97
  private static fill;
@@ -11,115 +11,130 @@ class Res {
11
11
  this.translations = resources_json_1.default;
12
12
  }
13
13
  /**
14
- * Retrieves a string like `Alarm system arming."`
14
+ * @returns Retrieves a string like `Alarm system arming."`
15
15
  */
16
16
  static alarmArmed() {
17
17
  return this.fill(this.translations.alarmArmed);
18
18
  }
19
19
  /**
20
- * Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
20
+ * @returns Retrieves a string like `Alarm system will be armed in night mode. Sweet Dreams!"`
21
21
  */
22
22
  static alarmNightModeArmed() {
23
23
  return this.fill(this.translations.alarmNightModeArmed);
24
24
  }
25
25
  /**
26
- * Retrieves a string like `"@P0" closed after @P1 minutes`
26
+ * @param deviceCustomName - The custom name of the device
27
+ * @param minutes - The minutes the device was closed after
28
+ * @returns Retrieves a string like `"@P0" closed after @P1 minutes`
27
29
  */
28
30
  static closedAfterMinutes(deviceCustomName, minutes) {
29
31
  return this.fill(this.translations.closedAfterMinutes, [deviceCustomName, minutes]);
30
32
  }
31
33
  /**
32
- * Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
34
+ * @param roomName - The name of the room
35
+ * @returns Retrieves a string like `No more smoke: Danger in "@P0" resolved.`
33
36
  */
34
37
  static fireAlarmEnd(roomName) {
35
38
  return this.fill(this.translations.fireAlarmEnd, [roomName]);
36
39
  }
37
40
  /**
38
- * Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
41
+ * @param roomName - The name of the room
42
+ * @param deviceCustomName - The custom name of the device
43
+ * @returns Retrieves a string like `Smoke detector "@P0" active. Possible fire in "@P1".`
39
44
  */
40
45
  static fireAlarmRepeat(roomName, deviceCustomName) {
41
46
  return this.fill(this.translations.fireAlarmRepeat, [roomName, deviceCustomName]);
42
47
  }
43
48
  /**
44
- * Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
49
+ * @param roomName - The name of the room
50
+ * @param deviceCustomName - The custom name of the device
51
+ * @returns Retrieves a string like `Smoke detector "@P0" triggered. Possible fire in "@P1".`
45
52
  */
46
53
  static fireAlarmStart(roomName, deviceCustomName) {
47
54
  return this.fill(this.translations.fireAlarmStart, [roomName, deviceCustomName]);
48
55
  }
49
56
  /**
50
- * Retrieves a string like `Good Morning`
57
+ * @returns Retrieves a string like `Good Morning`
51
58
  */
52
59
  static goodMorning() {
53
60
  return this.fill(this.translations.goodMorning);
54
61
  }
55
62
  /**
56
- * Retrieves a string like "Alarm. Intruder detected"
63
+ * @returns Retrieves a string like "Alarm. Intruder detected"
57
64
  */
58
65
  static intruderAlarm() {
59
66
  return this.fill(this.translations.intruderAlarm);
60
67
  }
61
68
  /**
62
- * Retrieves a string like "Additional defense protocol initiated."
69
+ * @returns Retrieves a string like "Additional defense protocol initiated."
63
70
  */
64
71
  static intruderAdditionalDefenseWarning() {
65
72
  return this.fill(this.translations.intruderAdditionalDefenseWarning);
66
73
  }
67
74
  /**
68
- * Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
75
+ * @returns Retrieves a string like "Hello potential intruder! You're beeing recorded and the alarm protocol is initiated please leave the building immediately!"
69
76
  */
70
77
  static intruderGreeting() {
71
78
  return this.fill(this.translations.intruderGreeting);
72
79
  }
73
80
  /**
74
- * Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
81
+ * @returns Retrieves a string like "Leave now! The owners and additional emergency contacts are informed!"
75
82
  */
76
83
  static intruderLeaveAndOwnerInformed() {
77
84
  return this.fill(this.translations.intruderLeaveAndOwnerInformed);
78
85
  }
79
86
  /**
80
- * Retrieves a string like "All shutter are opening, please leave immediatly."
87
+ * @returns Retrieves a string like "All shutter are opening, please leave immediatly."
81
88
  */
82
89
  static intruderShutterUpPleaseLeave() {
83
90
  return this.fill(this.translations.intruderShutterUpPleaseLeave);
84
91
  }
85
92
  /**
86
- * Retrieves a string like `"@P0" just closed`
93
+ * @param deviceCustomName - The custom name of the device
94
+ * @returns Retrieves a string like `"@P0" just closed`
87
95
  */
88
96
  static justClosed(deviceCustomName) {
89
97
  return this.fill(this.translations.justClosed, [deviceCustomName]);
90
98
  }
91
99
  /**
92
- * Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
100
+ * @param deviceCustomName - The custom name of the device
101
+ * @returns Retrieves a string like `Vibration Alert from "@P0". I repeat: Alarm at "@P0"`
93
102
  */
94
103
  static vibrationAlarm(deviceCustomName) {
95
104
  return this.fill(this.translations.vibrationAlarm, [deviceCustomName]);
96
105
  }
97
106
  /**
98
- * Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
107
+ * @param roomName - The name of the room
108
+ * @returns Retrieves a string like `Water alarm end: Flooding in "@P0" over.`
99
109
  */
100
110
  static waterAlarmEnd(roomName) {
101
111
  return this.fill(this.translations.waterAlarmEnd, [roomName]);
102
112
  }
103
113
  /**
104
- * Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
114
+ * @param deviceCustomName - The custom name of the device
115
+ * @param roomName - The name of the room
116
+ * @returns Retrieves a string like `"@P0" has triggered. Pool party in "@P1".`
105
117
  */
106
118
  static waterAlarmRepeat(deviceCustomName, roomName) {
107
119
  return this.fill(this.translations.waterAlarmRepeat, [deviceCustomName, roomName]);
108
120
  }
109
121
  /**
110
- * Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
122
+ * @param deviceCustomName - The custom name of the device
123
+ * @param roomName - The name of the room
124
+ * @returns Retrieves a string like `"@P0" detects water. Possible pipe burst in "@P1".`
111
125
  */
112
126
  static waterAlarmStart(deviceCustomName, roomName) {
113
127
  return this.fill(this.translations.waterAlarmStart, [deviceCustomName, roomName]);
114
128
  }
115
129
  /**
116
- * Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
130
+ * @returns Retrieves a string like "Vibration Alert from "@P0". I repeat: Alarm at "@P0""
117
131
  */
118
132
  static welcomeHome() {
119
133
  return this.fill(this.translations.welcomeHome);
120
134
  }
121
135
  /**
122
- * Retrieves a string like `"@P0" was opened`
136
+ * @param deviceCustomName - The custom name of the device
137
+ * @returns Retrieves a string like `"@P0" was opened`
123
138
  */
124
139
  static wasOpened(deviceCustomName) {
125
140
  return this.fill(this.translations.wasOpened, [deviceCustomName]);