hoffmation-base 3.0.0-alpha.20 → 3.0.0-alpha.22

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 +3 -3
  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
@@ -9,17 +9,23 @@ export declare class LedSetLightCommand extends DimmerSetLightCommand {
9
9
  colorTemp: number;
10
10
  _commandType: CommandType;
11
11
  /**
12
- *
13
- * @param {CommandSource | BaseCommand} source
14
- * @param {boolean} on
15
- * @param {string} reason
16
- * @param {number} timeout A chosen Timeout after which the light should be reset
17
- * @param {number} brightness The desired brightness
18
- * @param {number} transitionTime The transition time during turnOn/turnOff
19
- * @param {string} color The desired color in 6 digit hex Code
20
- * @param {number} colorTemp The desired color Temperature (0 = more White)
12
+ * Command to set the light-state of a Led-Device
13
+ * @param source - The source of the command
14
+ * @param on - The desired state-value
15
+ * @param reason - You can provide a reason for clarity
16
+ * @param timeout - A chosen Timeout after which the light should be reset
17
+ * @param brightness - The desired brightness
18
+ * @param transitionTime - The transition time during turnOn/turnOff
19
+ * @param color - The desired color in 6 digit hex Code
20
+ * @param colorTemp - The desired color Temperature (0 = more White)
21
21
  */
22
22
  constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number, brightness?: number, transitionTime?: number, color?: string, colorTemp?: number);
23
23
  get logMessage(): string;
24
+ /**
25
+ * Create a LedSetLightCommand based on a LampSetTimeBasedCommand and LedSettings by respecting the time of day
26
+ * @param settings - The settings for the Led
27
+ * @param c - The command to base the LedSetLightCommand on
28
+ * @returns The created LedSetLightCommand
29
+ */
24
30
  static byTimeBased(settings: LedSettings, c: LampSetTimeBasedCommand): LedSetLightCommand;
25
31
  }
@@ -6,15 +6,15 @@ const dimmerSetLightCommand_1 = require("./dimmerSetLightCommand");
6
6
  const timeCallback_1 = require("../timeCallback");
7
7
  class LedSetLightCommand extends dimmerSetLightCommand_1.DimmerSetLightCommand {
8
8
  /**
9
- *
10
- * @param {CommandSource | BaseCommand} source
11
- * @param {boolean} on
12
- * @param {string} reason
13
- * @param {number} timeout A chosen Timeout after which the light should be reset
14
- * @param {number} brightness The desired brightness
15
- * @param {number} transitionTime The transition time during turnOn/turnOff
16
- * @param {string} color The desired color in 6 digit hex Code
17
- * @param {number} colorTemp The desired color Temperature (0 = more White)
9
+ * Command to set the light-state of a Led-Device
10
+ * @param source - The source of the command
11
+ * @param on - The desired state-value
12
+ * @param reason - You can provide a reason for clarity
13
+ * @param timeout - A chosen Timeout after which the light should be reset
14
+ * @param brightness - The desired brightness
15
+ * @param transitionTime - The transition time during turnOn/turnOff
16
+ * @param color - The desired color in 6 digit hex Code
17
+ * @param colorTemp - The desired color Temperature (0 = more White)
18
18
  */
19
19
  constructor(source, on, reason = '', timeout = -1, brightness, transitionTime, color = '', colorTemp = -1) {
20
20
  super(source, on, reason, timeout, brightness, transitionTime);
@@ -25,7 +25,12 @@ class LedSetLightCommand extends dimmerSetLightCommand_1.DimmerSetLightCommand {
25
25
  get logMessage() {
26
26
  return `Led setLight to state: ${this.on}, timeout: ${this.timeout}, brightness: ${this.brightness}, color: ${this.color}, colorTemp: ${this.colorTemp} for reason: ${this.reasonTrace}`;
27
27
  }
28
- // TODO: Missing Comment
28
+ /**
29
+ * Create a LedSetLightCommand based on a LampSetTimeBasedCommand and LedSettings by respecting the time of day
30
+ * @param settings - The settings for the Led
31
+ * @param c - The command to base the LedSetLightCommand on
32
+ * @returns The created LedSetLightCommand
33
+ */
29
34
  static byTimeBased(settings, c) {
30
35
  switch (c.time) {
31
36
  case timeCallback_1.TimeOfDay.Daylight:
@@ -5,5 +5,11 @@ import { TimeOfDay } from '../timeCallback';
5
5
  export declare class LightGroupSwitchTimeConditionalCommand extends BaseCommand {
6
6
  readonly time: TimeOfDay;
7
7
  _commandType: CommandType;
8
+ /**
9
+ * Command to switch a light group in accordance to a specific time of the day
10
+ * @param source - The source of the command
11
+ * @param time - The time of the day to switch the light group
12
+ * @param reason - You can provide a reason for clarification
13
+ */
8
14
  constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string);
9
15
  }
@@ -4,7 +4,12 @@ exports.LightGroupSwitchTimeConditionalCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class LightGroupSwitchTimeConditionalCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to switch a light group in accordance to a specific time of the day
9
+ * @param source - The source of the command
10
+ * @param time - The time of the day to switch the light group
11
+ * @param reason - You can provide a reason for clarification
12
+ */
8
13
  constructor(source, time, reason = '') {
9
14
  super(source, reason);
10
15
  this.time = time;
@@ -3,6 +3,11 @@ import { CommandSource } from './commandSource';
3
3
  import { CommandType } from './commandType';
4
4
  export declare class RestoreTargetAutomaticValueCommand extends BaseCommand {
5
5
  _commandType: CommandType;
6
+ /**
7
+ * Command to restore the target automatic value of an actuator
8
+ * @param source - The source of the command
9
+ * @param reason - You can provide a reason for clarification
10
+ */
6
11
  constructor(source: CommandSource | BaseCommand, reason?: string);
7
12
  get logMessage(): string;
8
13
  }
@@ -4,7 +4,11 @@ exports.RestoreTargetAutomaticValueCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class RestoreTargetAutomaticValueCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to restore the target automatic value of an actuator
9
+ * @param source - The source of the command
10
+ * @param reason - You can provide a reason for clarification
11
+ */
8
12
  constructor(source, reason = '') {
9
13
  super(source, reason);
10
14
  this._commandType = commandType_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand;
@@ -3,5 +3,10 @@ import { CommandType } from './commandType';
3
3
  import { CommandSource } from './commandSource';
4
4
  export declare class RoomRestoreLightCommand extends BaseCommand {
5
5
  _commandType: CommandType;
6
+ /**
7
+ * Command to restore the normal automatic light-state of a room
8
+ * @param source - The source of the command
9
+ * @param reason - You can provide a reason for clarification
10
+ */
6
11
  constructor(source: CommandSource | BaseCommand, reason?: string);
7
12
  }
@@ -4,7 +4,11 @@ exports.RoomRestoreLightCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class RoomRestoreLightCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to restore the normal automatic light-state of a room
9
+ * @param source - The source of the command
10
+ * @param reason - You can provide a reason for clarification
11
+ */
8
12
  constructor(source, reason = '') {
9
13
  super(source, reason);
10
14
  this._commandType = commandType_1.CommandType.RoomRestoreLightCommand;
@@ -4,5 +4,11 @@ import { CommandType } from './commandType';
4
4
  export declare class RoomRestoreShutterPositionCommand extends BaseCommand {
5
5
  readonly recalc: boolean;
6
6
  _commandType: CommandType;
7
+ /**
8
+ * Command to restore the normal automatic shutter position of a room
9
+ * @param source - The source of the command
10
+ * @param recalc - Whether to recalculate the shutter position
11
+ * @param reason - You can provide a reason for clarification
12
+ */
7
13
  constructor(source: CommandSource | BaseCommand, recalc?: boolean, reason?: string);
8
14
  }
@@ -4,7 +4,12 @@ exports.RoomRestoreShutterPositionCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class RoomRestoreShutterPositionCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to restore the normal automatic shutter position of a room
9
+ * @param source - The source of the command
10
+ * @param recalc - Whether to recalculate the shutter position
11
+ * @param reason - You can provide a reason for clarification
12
+ */
8
13
  constructor(source, recalc = false, reason = '') {
9
14
  super(source, reason);
10
15
  this.recalc = recalc;
@@ -6,9 +6,9 @@ export declare class RoomSetLightTimeBasedCommand extends BaseCommand {
6
6
  _commandType: CommandType;
7
7
  /**
8
8
  * Sets the light based on the current time, rollo Position and room Settings
9
- * @param source
10
- * @param movementDependant Only turn light on if there was a movement in the same room
11
- * @param reason
9
+ * @param source - The source of the command
10
+ * @param movementDependant - Only turn light on if there was a movement in the same room
11
+ * @param reason - You can provide a reason for clarity
12
12
  */
13
13
  constructor(source: CommandSource | BaseCommand, movementDependant?: boolean, reason?: string);
14
14
  }
@@ -6,9 +6,9 @@ const commandType_1 = require("./commandType");
6
6
  class RoomSetLightTimeBasedCommand extends baseCommand_1.BaseCommand {
7
7
  /**
8
8
  * Sets the light based on the current time, rollo Position and room Settings
9
- * @param source
10
- * @param movementDependant Only turn light on if there was a movement in the same room
11
- * @param reason
9
+ * @param source - The source of the command
10
+ * @param movementDependant - Only turn light on if there was a movement in the same room
11
+ * @param reason - You can provide a reason for clarity
12
12
  */
13
13
  constructor(source, movementDependant = false, reason = '') {
14
14
  super(source, reason);
@@ -3,5 +3,10 @@ import { CommandSource } from './commandSource';
3
3
  import { CommandType } from './commandType';
4
4
  export declare class ShutterSunriseUpCommand extends BaseCommand {
5
5
  _commandType: CommandType;
6
+ /**
7
+ * Command to perform actions when the shutter should be opened due to sunrise
8
+ * @param source - The source of the command
9
+ * @param reason - You can provide a reason for clarification
10
+ */
6
11
  constructor(source: CommandSource | BaseCommand, reason?: string);
7
12
  }
@@ -4,7 +4,11 @@ exports.ShutterSunriseUpCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class ShutterSunriseUpCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to perform actions when the shutter should be opened due to sunrise
9
+ * @param source - The source of the command
10
+ * @param reason - You can provide a reason for clarification
11
+ */
8
12
  constructor(source, reason = '') {
9
13
  super(source, reason);
10
14
  this._commandType = commandType_1.CommandType.ShutterSunriseUpCommand;
@@ -3,5 +3,10 @@ import { CommandSource } from './commandSource';
3
3
  import { CommandType } from './commandType';
4
4
  export declare class ShutterSunsetDownCommand extends BaseCommand {
5
5
  _commandType: CommandType;
6
+ /**
7
+ * Command to perform actions when the shutter is closing due to sunset
8
+ * @param source - The source of the command
9
+ * @param reason - You can provide a reason for clarification
10
+ */
6
11
  constructor(source: CommandSource | BaseCommand, reason?: string);
7
12
  }
@@ -4,7 +4,11 @@ exports.ShutterSunsetDownCommand = void 0;
4
4
  const baseCommand_1 = require("./baseCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class ShutterSunsetDownCommand extends baseCommand_1.BaseCommand {
7
- // TODO: Missing Comment
7
+ /**
8
+ * Command to perform actions when the shutter is closing due to sunset
9
+ * @param source - The source of the command
10
+ * @param reason - You can provide a reason for clarification
11
+ */
8
12
  constructor(source, reason = '') {
9
13
  super(source, reason);
10
14
  this._commandType = commandType_1.CommandType.SunsetDownCommand;
@@ -7,6 +7,16 @@ import { LampSetTimeBasedCommand } from './lampSetTimeBasedCommand';
7
7
  export declare class WledSetLightCommand extends DimmerSetLightCommand {
8
8
  preset?: number | undefined;
9
9
  _commandType: CommandType;
10
+ /**
11
+ * Command to set the light state of a WLED device
12
+ * @param source - The source of the command
13
+ * @param on - The desired state of the light
14
+ * @param reason - You can provide a reason for clarification
15
+ * @param timeout - The duration in milliseconds this should block automatic changes --> Reverse to automatic after this time
16
+ * @param brightness - The brightness of the light
17
+ * @param transitionTime - The time in milliseconds the transition should take
18
+ * @param preset - The preset to use
19
+ */
10
20
  constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number, brightness?: number, transitionTime?: number, preset?: number | undefined);
11
21
  get logMessage(): string;
12
22
  static byTimeBased(settings: WledSettings, c: LampSetTimeBasedCommand): WledSetLightCommand;
@@ -5,7 +5,16 @@ const commandType_1 = require("./commandType");
5
5
  const dimmerSetLightCommand_1 = require("./dimmerSetLightCommand");
6
6
  const timeCallback_1 = require("../timeCallback");
7
7
  class WledSetLightCommand extends dimmerSetLightCommand_1.DimmerSetLightCommand {
8
- // TODO: Missing Comment
8
+ /**
9
+ * Command to set the light state of a WLED device
10
+ * @param source - The source of the command
11
+ * @param on - The desired state of the light
12
+ * @param reason - You can provide a reason for clarification
13
+ * @param timeout - The duration in milliseconds this should block automatic changes --> Reverse to automatic after this time
14
+ * @param brightness - The brightness of the light
15
+ * @param transitionTime - The time in milliseconds the transition should take
16
+ * @param preset - The preset to use
17
+ */
9
18
  constructor(source, on, reason = '', timeout = -1, brightness = -1, transitionTime = -1, preset) {
10
19
  super(source, on, reason, timeout, brightness, transitionTime);
11
20
  this.preset = preset;
@@ -1,9 +1,9 @@
1
1
  export declare class ConnectionCallbacks {
2
- onAuth?: any;
3
- onCommand?(pInstance: string, pCommand: string | number | boolean | any[] | Record<string, any> | null, pData: any): boolean;
2
+ onAuth?: unknown;
3
+ onCommand?(pInstance: string, pCommand: string | number | boolean | unknown[] | Record<string, unknown> | null, pData: unknown): boolean;
4
4
  onConnChange?(pState: boolean): void;
5
- onError?: any;
5
+ onError?(error: unknown): void;
6
6
  onObjectChange?(pId: string, pObj: ioBroker.Object): void;
7
- onRefresh?: any;
7
+ onRefresh?: unknown;
8
8
  onUpdate?(id: string, state: ioBroker.State): void;
9
9
  }
@@ -3,8 +3,8 @@ export interface deviceConfig {
3
3
  _id: string;
4
4
  ts?: number;
5
5
  from?: string;
6
- native?: any;
7
- common?: any & {
8
- name: string;
6
+ native?: unknown;
7
+ common?: {
8
+ name: string | object;
9
9
  };
10
10
  }
@@ -8,28 +8,23 @@ export declare class AcSettings extends DeviceSettings {
8
8
  maximumMinutes: number;
9
9
  /**
10
10
  * Heating can be forbidden completly e.g. for summer season
11
- * @type {boolean}
12
11
  */
13
12
  heatingAllowed: boolean;
14
13
  /**
15
14
  * Whether we should ignore the room temperature and let the AC decide on its own
16
- * @type {boolean}
17
15
  */
18
16
  useOwnTemperature: boolean;
19
17
  /**
20
18
  * Whether the AC should use automatic mode to decide on its own whether to heat or cool
21
19
  * !!Warning!! This can result in excessive energy consumption, as overshooting the temperature can result in the AC switching to the opposite mode
22
- * @type {boolean}
23
20
  */
24
21
  useAutomatic: boolean;
25
22
  /**
26
23
  * Whether we should turn off AC-Cooling when someone is in the room
27
- * @type {boolean}
28
24
  */
29
25
  noCoolingOnMovement: boolean;
30
26
  /**
31
27
  * Whether this AC should be turned off for some time manually
32
- * @type {boolean}
33
28
  */
34
29
  manualDisabled: boolean;
35
30
  fromPartialObject(data: Partial<AcSettings>): void;
@@ -14,28 +14,23 @@ class AcSettings extends deviceSettings_1.DeviceSettings {
14
14
  this.maximumMinutes = 0;
15
15
  /**
16
16
  * Heating can be forbidden completly e.g. for summer season
17
- * @type {boolean}
18
17
  */
19
18
  this.heatingAllowed = false;
20
19
  /**
21
20
  * Whether we should ignore the room temperature and let the AC decide on its own
22
- * @type {boolean}
23
21
  */
24
22
  this.useOwnTemperature = false;
25
23
  /**
26
24
  * Whether the AC should use automatic mode to decide on its own whether to heat or cool
27
25
  * !!Warning!! This can result in excessive energy consumption, as overshooting the temperature can result in the AC switching to the opposite mode
28
- * @type {boolean}
29
26
  */
30
27
  this.useAutomatic = false;
31
28
  /**
32
29
  * Whether we should turn off AC-Cooling when someone is in the room
33
- * @type {boolean}
34
30
  */
35
31
  this.noCoolingOnMovement = false;
36
32
  /**
37
33
  * Whether this AC should be turned off for some time manually
38
- * @type {boolean}
39
34
  */
40
35
  this.manualDisabled = false;
41
36
  }
@@ -2,44 +2,36 @@ import { DeviceSettings } from './deviceSettings';
2
2
  export declare class ActuatorSettings extends DeviceSettings {
3
3
  /**
4
4
  * Whether to turn on the device at dawn in time-based commands or automatic.
5
- * @type {boolean}
6
5
  */
7
6
  dawnOn: boolean;
8
7
  /**
9
8
  * Whether to turn on the device at dusk in time-based commands or automatic.
10
- * @type {boolean}
11
9
  */
12
10
  duskOn: boolean;
13
11
  /**
14
12
  * Whether to turn on the device at night in time-based commands or automatic.
15
- * @type {boolean}
16
13
  */
17
14
  nightOn: boolean;
18
15
  /**
19
16
  * Whether to turn on the device at day in time-based commands or automatic.
20
- * @type {boolean}
21
17
  */
22
18
  dayOn: boolean;
23
19
  /**
24
20
  * Indicates if this device controls e.g. an Eltako, which has it's own Turn Off Time logic.
25
- * @type {boolean}
26
21
  */
27
22
  isStromStoss: boolean;
28
23
  /**
29
24
  * Whether after manually turning off a previously manually turned on device, fall back to automatic mode.
30
25
  * Instead of switching to a forced off state.
31
- * @type {boolean}
32
26
  */
33
27
  resetToAutomaticOnForceOffAfterForceOn: boolean;
34
28
  /**
35
29
  * If this is an Actuator controling a time based relais,
36
30
  * this indicates the time after which we retrigger the relais.
37
- * @type {number}
38
31
  */
39
32
  stromStossResendTime: number;
40
33
  /**
41
34
  * Whether to include this device in the ambient light option.
42
- * @type {boolean}
43
35
  */
44
36
  includeInAmbientLight: boolean;
45
37
  fromPartialObject(data: Partial<ActuatorSettings>): void;
@@ -8,44 +8,36 @@ class ActuatorSettings extends deviceSettings_1.DeviceSettings {
8
8
  super(...arguments);
9
9
  /**
10
10
  * Whether to turn on the device at dawn in time-based commands or automatic.
11
- * @type {boolean}
12
11
  */
13
12
  this.dawnOn = true;
14
13
  /**
15
14
  * Whether to turn on the device at dusk in time-based commands or automatic.
16
- * @type {boolean}
17
15
  */
18
16
  this.duskOn = true;
19
17
  /**
20
18
  * Whether to turn on the device at night in time-based commands or automatic.
21
- * @type {boolean}
22
19
  */
23
20
  this.nightOn = true;
24
21
  /**
25
22
  * Whether to turn on the device at day in time-based commands or automatic.
26
- * @type {boolean}
27
23
  */
28
24
  this.dayOn = false;
29
25
  /**
30
26
  * Indicates if this device controls e.g. an Eltako, which has it's own Turn Off Time logic.
31
- * @type {boolean}
32
27
  */
33
28
  this.isStromStoss = false;
34
29
  /**
35
30
  * Whether after manually turning off a previously manually turned on device, fall back to automatic mode.
36
31
  * Instead of switching to a forced off state.
37
- * @type {boolean}
38
32
  */
39
33
  this.resetToAutomaticOnForceOffAfterForceOn = true;
40
34
  /**
41
35
  * If this is an Actuator controling a time based relais,
42
36
  * this indicates the time after which we retrigger the relais.
43
- * @type {number}
44
37
  */
45
38
  this.stromStossResendTime = 180;
46
39
  /**
47
40
  * Whether to include this device in the ambient light option.
48
- * @type {boolean}
49
41
  */
50
42
  this.includeInAmbientLight = false;
51
43
  }
@@ -2,7 +2,6 @@ import { DeviceSettings } from './deviceSettings';
2
2
  export declare class GarageDoorOpenerSettings extends DeviceSettings {
3
3
  /**
4
4
  * In case the sensor detects open door instead of closed
5
- * @type {boolean}
6
5
  */
7
6
  invertSensor: boolean;
8
7
  fromPartialObject(data: Partial<GarageDoorOpenerSettings>): void;
@@ -8,7 +8,6 @@ class GarageDoorOpenerSettings extends deviceSettings_1.DeviceSettings {
8
8
  super(...arguments);
9
9
  /**
10
10
  * In case the sensor detects open door instead of closed
11
- * @type {boolean}
12
11
  */
13
12
  this.invertSensor = false;
14
13
  }
@@ -5,34 +5,28 @@ export declare class HeaterSettings extends DeviceSettings {
5
5
  /**
6
6
  * Whether this device should be controlled using only valve position
7
7
  * !! Only certain devices allow direct controlling of valve Position !!
8
- * @type {boolean}
9
8
  */
10
9
  controlByPid: boolean;
11
10
  controlByTempDiff: boolean;
12
11
  /**
13
12
  * Whether this device should turn off at Start of summer season and only heat in winter
14
- * @type {boolean}
15
13
  */
16
14
  seasonalTurnOffActive: boolean;
17
15
  /**
18
16
  *
19
17
  * The day in a year after which SeasonalHeater should be turned off completly
20
- * @type {number}
21
18
  */
22
19
  seasonTurnOffDay: number;
23
20
  /**
24
21
  * The day in a year after which SeasonalHeater should be turned to automatic
25
- * @type {number}
26
22
  */
27
23
  seasonTurnOnDay: number;
28
24
  /**
29
25
  * In case of pid Control the forced minimum percentage for this heater valve
30
- * @type {number}
31
26
  */
32
27
  pidForcedMinimum: number;
33
28
  /**
34
29
  * Whether this AC should be turned off for some time manually
35
- * @type {boolean}
36
30
  */
37
31
  manualDisabled: boolean;
38
32
  fromPartialObject(data: Partial<HeaterSettings>): void;
@@ -11,34 +11,28 @@ class HeaterSettings extends deviceSettings_1.DeviceSettings {
11
11
  /**
12
12
  * Whether this device should be controlled using only valve position
13
13
  * !! Only certain devices allow direct controlling of valve Position !!
14
- * @type {boolean}
15
14
  */
16
15
  this.controlByPid = false;
17
16
  this.controlByTempDiff = false;
18
17
  /**
19
18
  * Whether this device should turn off at Start of summer season and only heat in winter
20
- * @type {boolean}
21
19
  */
22
20
  this.seasonalTurnOffActive = true;
23
21
  /**
24
22
  *
25
23
  * The day in a year after which SeasonalHeater should be turned off completly
26
- * @type {number}
27
24
  */
28
25
  this.seasonTurnOffDay = 99;
29
26
  /**
30
27
  * The day in a year after which SeasonalHeater should be turned to automatic
31
- * @type {number}
32
28
  */
33
29
  this.seasonTurnOnDay = 267;
34
30
  /**
35
31
  * In case of pid Control the forced minimum percentage for this heater valve
36
- * @type {number}
37
32
  */
38
33
  this.pidForcedMinimum = 1;
39
34
  /**
40
35
  * Whether this AC should be turned off for some time manually
41
- * @type {boolean}
42
36
  */
43
37
  this.manualDisabled = false;
44
38
  }
@@ -2,7 +2,6 @@ import { DeviceSettings } from './deviceSettings';
2
2
  export declare class MotionSensorSettings extends DeviceSettings {
3
3
  /**
4
4
  * If set to false, a detected movement on this sensor will block certain alarms on windows in this room
5
- * @type {boolean}
6
5
  */
7
6
  seesWindow: boolean;
8
7
  excludeFromNightAlarm: boolean;
@@ -8,7 +8,6 @@ class MotionSensorSettings extends deviceSettings_1.DeviceSettings {
8
8
  super(...arguments);
9
9
  /**
10
10
  * If set to false, a detected movement on this sensor will block certain alarms on windows in this room
11
- * @type {boolean}
12
11
  */
13
12
  this.seesWindow = true;
14
13
  this.excludeFromNightAlarm = false;
@@ -4,18 +4,15 @@ export declare class ShutterSettings extends DeviceSettings {
4
4
  msTilBot: number;
5
5
  /**
6
6
  * The direction this shutter is facing (0 = North, 180 = South)
7
- * @type {number}
8
7
  */
9
8
  direction: number;
10
9
  /**
11
10
  * The desired position, when the shutter should perform a heat reduction.
12
- * @type {number}
13
11
  */
14
12
  heatReductionPosition: number;
15
13
  /**
16
14
  * Some shutter give no position feedback on their own, so by knowing the durations in either direction,
17
15
  * we can programmatically trigger the callbacks.
18
- * @type {boolean}
19
16
  */
20
17
  triggerPositionUpdateByTime: boolean;
21
18
  fromPartialObject(data: Partial<ShutterSettings>): void;
@@ -10,18 +10,15 @@ class ShutterSettings extends deviceSettings_1.DeviceSettings {
10
10
  this.msTilBot = -1;
11
11
  /**
12
12
  * The direction this shutter is facing (0 = North, 180 = South)
13
- * @type {number}
14
13
  */
15
14
  this.direction = 180;
16
15
  /**
17
16
  * The desired position, when the shutter should perform a heat reduction.
18
- * @type {number}
19
17
  */
20
18
  this.heatReductionPosition = 40;
21
19
  /**
22
20
  * Some shutter give no position feedback on their own, so by knowing the durations in either direction,
23
21
  * we can programmatically trigger the callbacks.
24
- * @type {boolean}
25
22
  */
26
23
  this.triggerPositionUpdateByTime = false;
27
24
  }
@@ -5,13 +5,11 @@ export declare class HeatGroupSettings extends GroupSettings {
5
5
  automaticPoints: TemperatureSettings[];
6
6
  /**
7
7
  * Whether the temperature should be calculated automatically, or the manualTemperature should be used
8
- * @type {boolean}
9
8
  */
10
9
  automaticMode: boolean;
11
10
  automaticFallBackTemperatur: number;
12
11
  /**
13
12
  * Target temperature when automaticMode is disabled
14
- * @type {number}
15
13
  */
16
14
  manualTemperature: number;
17
15
  fromPartialObject(data: Partial<HeatGroupSettings>): void;