hoffmation-base 3.0.0-alpha.2 → 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 (185) 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 +8 -1
  5. package/lib/models/command/WindowRestoreDesiredPositionCommand.d.ts +5 -0
  6. package/lib/models/command/WindowRestoreDesiredPositionCommand.js +5 -0
  7. package/lib/models/command/WindowSetDesiredPositionCommand.d.ts +6 -0
  8. package/lib/models/command/WindowSetDesiredPositionCommand.js +6 -0
  9. package/lib/models/command/WindowSetRolloByWeatherStatusCommand.d.ts +5 -0
  10. package/lib/models/command/WindowSetRolloByWeatherStatusCommand.js +5 -0
  11. package/lib/models/command/actuatorSetStateCommand.d.ts +7 -0
  12. package/lib/models/command/actuatorSetStateCommand.js +9 -2
  13. package/lib/models/command/actuatorToggleCommand.d.ts +5 -0
  14. package/lib/models/command/actuatorToggleCommand.js +6 -1
  15. package/lib/models/command/actuatorWriteStateToDeviceCommand.d.ts +7 -1
  16. package/lib/models/command/actuatorWriteStateToDeviceCommand.js +12 -2
  17. package/lib/models/command/baseCommand.d.ts +14 -1
  18. package/lib/models/command/baseCommand.js +40 -6
  19. package/lib/models/command/blockAutomaticCommand.d.ts +17 -0
  20. package/lib/models/command/blockAutomaticCommand.js +22 -0
  21. package/lib/models/command/blockAutomaticLiftBlockCommand.d.ts +12 -0
  22. package/lib/models/command/blockAutomaticLiftBlockCommand.js +17 -0
  23. package/lib/models/command/blockAutomaticUntilCommand.d.ts +17 -0
  24. package/lib/models/command/blockAutomaticUntilCommand.js +22 -0
  25. package/lib/models/command/commandSource.d.ts +19 -0
  26. package/lib/models/command/commandSource.js +20 -0
  27. package/lib/models/command/commandType.d.ts +3 -0
  28. package/lib/models/command/commandType.js +3 -0
  29. package/lib/models/command/dimmerSetLightCommand.d.ts +7 -6
  30. package/lib/models/command/dimmerSetLightCommand.js +13 -11
  31. package/lib/models/command/floorSetAllShuttersCommand.d.ts +4 -4
  32. package/lib/models/command/floorSetAllShuttersCommand.js +4 -4
  33. package/lib/models/command/index.d.ts +3 -0
  34. package/lib/models/command/index.js +7 -1
  35. package/lib/models/command/lampSetLightCommand.d.ts +7 -0
  36. package/lib/models/command/lampSetLightCommand.js +8 -1
  37. package/lib/models/command/lampSetTimeBasedCommand.d.ts +4 -4
  38. package/lib/models/command/lampSetTimeBasedCommand.js +5 -5
  39. package/lib/models/command/lampToggleLightCommand.d.ts +5 -5
  40. package/lib/models/command/lampToggleLightCommand.js +6 -6
  41. package/lib/models/command/ledSetLightCommand.d.ts +15 -9
  42. package/lib/models/command/ledSetLightCommand.js +16 -10
  43. package/lib/models/command/lightGroupSwitchTimeConditionalCommand.d.ts +6 -0
  44. package/lib/models/command/lightGroupSwitchTimeConditionalCommand.js +6 -0
  45. package/lib/models/command/restoreTargetAutomaticValueCommand.d.ts +5 -0
  46. package/lib/models/command/restoreTargetAutomaticValueCommand.js +6 -1
  47. package/lib/models/command/roomRestoreLightCommand.d.ts +5 -0
  48. package/lib/models/command/roomRestoreLightCommand.js +5 -0
  49. package/lib/models/command/roomRestoreShutterPositionCommand.d.ts +6 -0
  50. package/lib/models/command/roomRestoreShutterPositionCommand.js +6 -0
  51. package/lib/models/command/roomSetLightTimeBasedCommand.d.ts +3 -3
  52. package/lib/models/command/roomSetLightTimeBasedCommand.js +3 -3
  53. package/lib/models/command/shutterSunriseUpCommand.d.ts +5 -0
  54. package/lib/models/command/shutterSunriseUpCommand.js +5 -0
  55. package/lib/models/command/shutterSunsetDownCommand.d.ts +5 -0
  56. package/lib/models/command/shutterSunsetDownCommand.js +5 -0
  57. package/lib/models/command/wledSetLightCommand.d.ts +11 -0
  58. package/lib/models/command/wledSetLightCommand.js +13 -0
  59. package/lib/models/connectionCallbacks.d.ts +4 -4
  60. package/lib/models/deviceConfig.d.ts +2 -2
  61. package/lib/models/deviceSettings/acSettings.d.ts +6 -5
  62. package/lib/models/deviceSettings/acSettings.js +10 -8
  63. package/lib/models/deviceSettings/actuatorSettings.d.ts +13 -4
  64. package/lib/models/deviceSettings/actuatorSettings.js +19 -9
  65. package/lib/models/deviceSettings/garageDoorOpenerSettings.d.ts +0 -1
  66. package/lib/models/deviceSettings/garageDoorOpenerSettings.js +0 -1
  67. package/lib/models/deviceSettings/heaterSettings.d.ts +0 -6
  68. package/lib/models/deviceSettings/heaterSettings.js +0 -6
  69. package/lib/models/deviceSettings/ledSettings.js +10 -18
  70. package/lib/models/deviceSettings/motionSensorSettings.d.ts +0 -1
  71. package/lib/models/deviceSettings/motionSensorSettings.js +0 -1
  72. package/lib/models/deviceSettings/shutterSettings.d.ts +0 -3
  73. package/lib/models/deviceSettings/shutterSettings.js +0 -3
  74. package/lib/models/deviceSettings/wledSettings.js +5 -13
  75. package/lib/models/groupSettings/heatGroupSettings.d.ts +3 -1
  76. package/lib/models/groupSettings/heatGroupSettings.js +3 -1
  77. package/lib/models/iIdHolder.d.ts +6 -0
  78. package/lib/models/objectSettings.d.ts +2 -2
  79. package/lib/models/objectSettings.js +2 -2
  80. package/lib/models/rooms/RoomBase.d.ts +2 -1
  81. package/lib/models/rooms/RoomBase.js +4 -3
  82. package/lib/models/rooms/iRoomBase.d.ts +17 -0
  83. package/lib/models/rooms/iRoomImportEnforcer.d.ts +4 -0
  84. package/lib/server/devices/Griffe.js +0 -1
  85. package/lib/server/devices/IoBrokerBaseDevice.d.ts +11 -16
  86. package/lib/server/devices/IoBrokerBaseDevice.js +21 -17
  87. package/lib/server/devices/IoBrokerDeviceInfo.d.ts +2 -2
  88. package/lib/server/devices/IoBrokerDeviceInfo.js +6 -4
  89. package/lib/server/devices/baseDeviceInterfaces/iAcDevice.d.ts +30 -3
  90. package/lib/server/devices/baseDeviceInterfaces/iActuator.d.ts +16 -0
  91. package/lib/server/devices/baseDeviceInterfaces/iBaseDevice.d.ts +25 -0
  92. package/lib/server/devices/baseDeviceInterfaces/iBatteryDevice.d.ts +10 -1
  93. package/lib/server/devices/baseDeviceInterfaces/iBluetoothDetector.d.ts +5 -5
  94. package/lib/server/devices/baseDeviceInterfaces/iButtonSwitch.d.ts +13 -0
  95. package/lib/server/devices/baseDeviceInterfaces/iCameraDevice.d.ts +10 -0
  96. package/lib/server/devices/baseDeviceInterfaces/iDimmableLamp.d.ts +9 -2
  97. package/lib/server/devices/baseDeviceInterfaces/iEnergyManager.d.ts +13 -2
  98. package/lib/server/devices/baseDeviceInterfaces/iExcessEnergyConsumer.d.ts +16 -2
  99. package/lib/server/devices/baseDeviceInterfaces/iGarageDoorOpener.d.ts +10 -0
  100. package/lib/server/devices/baseDeviceInterfaces/iHandleSensor.d.ts +12 -0
  101. package/lib/server/devices/baseDeviceInterfaces/iHeater.d.ts +12 -2
  102. package/lib/server/devices/baseDeviceInterfaces/iHumiditySensor.d.ts +7 -0
  103. package/lib/server/devices/baseDeviceInterfaces/iLamp.d.ts +4 -0
  104. package/lib/server/devices/baseDeviceInterfaces/iLedRgbCct.d.ts +5 -0
  105. package/lib/server/devices/baseDeviceInterfaces/iMotionSensor.d.ts +7 -1
  106. package/lib/server/devices/baseDeviceInterfaces/iScene.d.ts +7 -0
  107. package/lib/server/devices/baseDeviceInterfaces/iShutter.d.ts +7 -0
  108. package/lib/server/devices/baseDeviceInterfaces/iSmokeDetectorDevice.d.ts +7 -0
  109. package/lib/server/devices/baseDeviceInterfaces/iSpeaker.d.ts +25 -0
  110. package/lib/server/devices/baseDeviceInterfaces/iTemperatureSensor.d.ts +11 -0
  111. package/lib/server/devices/baseDeviceInterfaces/iTemporaryDisableAutomatic.d.ts +7 -0
  112. package/lib/server/devices/baseDeviceInterfaces/iTvDevice.d.ts +12 -0
  113. package/lib/server/devices/baseDeviceInterfaces/iVibrationSensor.d.ts +0 -1
  114. package/lib/server/devices/blueIris/cameraDevice.d.ts +2 -3
  115. package/lib/server/devices/blueIris/cameraDevice.js +2 -3
  116. package/lib/server/devices/dachs/interfaces/KeyListEntity.d.ts +0 -8
  117. package/lib/server/devices/dachs/interfaces/KeyListEntity.js +0 -8
  118. package/lib/server/devices/dachs/lib/dachsHttpClient.d.ts +1 -1
  119. package/lib/server/devices/groups/Window.d.ts +1 -0
  120. package/lib/server/devices/groups/Window.js +1 -0
  121. package/lib/server/devices/groups/heatGroup.d.ts +7 -6
  122. package/lib/server/devices/groups/heatGroup.js +8 -9
  123. package/lib/server/devices/groups/lightGroup.d.ts +2 -2
  124. package/lib/server/devices/groups/lightGroup.js +11 -10
  125. package/lib/server/devices/groups/presenceGroup.d.ts +0 -1
  126. package/lib/server/devices/groups/presenceGroup.js +0 -1
  127. package/lib/server/devices/hmIPDevices/hmIpHeizgruppe.d.ts +0 -1
  128. package/lib/server/devices/hmIPDevices/hmIpHeizgruppe.js +0 -6
  129. package/lib/server/devices/hmIPDevices/hmIpLampe.js +1 -2
  130. package/lib/server/devices/hmIPDevices/hmIpRoll.js +2 -2
  131. package/lib/server/devices/iDeviceUpdater.d.ts +11 -0
  132. package/lib/server/devices/jsObject/jsObjectEnergyManager.d.ts +1 -1
  133. package/lib/server/devices/jsObject/jsObjectEnergyManager.js +1 -1
  134. package/lib/server/devices/sharedFunctions/lampUtils.d.ts +1 -0
  135. package/lib/server/devices/sharedFunctions/lampUtils.js +32 -15
  136. package/lib/server/devices/wledDevice.d.ts +1 -0
  137. package/lib/server/devices/wledDevice.js +13 -8
  138. package/lib/server/devices/zigbee/BaseDevices/ZigbeeActuator.js +1 -2
  139. package/lib/server/devices/zigbee/BaseDevices/zigbeeDevice.d.ts +0 -2
  140. package/lib/server/devices/zigbee/BaseDevices/zigbeeDevice.js +9 -18
  141. package/lib/server/devices/zigbee/BaseDevices/zigbeeDimmer.js +8 -8
  142. package/lib/server/devices/zigbee/BaseDevices/zigbeeLedRGBCCT.d.ts +2 -1
  143. package/lib/server/devices/zigbee/BaseDevices/zigbeeLedRGBCCT.js +6 -4
  144. package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.d.ts +1 -1
  145. package/lib/server/devices/zigbee/BaseDevices/zigbeeMotionSensor.js +1 -1
  146. package/lib/server/devices/zigbee/BaseDevices/zigbeeShutter.js +3 -3
  147. package/lib/server/devices/zigbee/BaseDevices/zigbeeSwitch.d.ts +1 -1
  148. package/lib/server/devices/zigbee/zigbeeAquaraVibra.d.ts +1 -1
  149. package/lib/server/devices/zigbee/zigbeeEuroHeater.d.ts +2 -3
  150. package/lib/server/devices/zigbee/zigbeeEuroHeater.js +2 -3
  151. package/lib/server/ioBroker/connection.d.ts +20 -20
  152. package/lib/server/ioBroker/connection.js +29 -21
  153. package/lib/server/ioBroker/socketIOConnectOptions.d.ts +2 -2
  154. package/lib/server/ioBroker/socketIOVisCommand.d.ts +5 -1
  155. package/lib/server/services/Sonos/polly-service.js +1 -2
  156. package/lib/server/services/Translation/res.d.ts +34 -19
  157. package/lib/server/services/Translation/res.js +34 -19
  158. package/lib/server/services/ac/ac-device.d.ts +0 -5
  159. package/lib/server/services/ac/ac-device.js +17 -18
  160. package/lib/server/services/ac/daikin-service.js +2 -1
  161. package/lib/server/services/ac/own-daikin-device.js +12 -4
  162. package/lib/server/services/api/api-service.d.ts +117 -52
  163. package/lib/server/services/api/api-service.js +160 -68
  164. package/lib/server/services/blockAutomaticHandler.d.ts +6 -8
  165. package/lib/server/services/blockAutomaticHandler.js +15 -13
  166. package/lib/server/services/dbo/iPersist.d.ts +96 -0
  167. package/lib/server/services/govee/own-govee-device.js +4 -7
  168. package/lib/server/services/https-service.d.ts +3 -2
  169. package/lib/server/services/https-service.js +3 -2
  170. package/lib/server/services/log-service/log-service.d.ts +2 -2
  171. package/lib/server/services/log-service/log-service.js +2 -2
  172. package/lib/server/services/news-service.d.ts +5 -6
  173. package/lib/server/services/news-service.js +5 -6
  174. package/lib/server/services/room-service/room-service.d.ts +3 -2
  175. package/lib/server/services/room-service/room-service.js +4 -3
  176. package/lib/server/services/settings-service.d.ts +3 -2
  177. package/lib/server/services/settings-service.js +3 -2
  178. package/lib/server/services/utils/iDisposeable.d.ts +3 -0
  179. package/lib/server/services/victron/victron-device.d.ts +2 -2
  180. package/lib/server/services/victron/victron-device.js +2 -2
  181. package/lib/server/services/weather/weather-current.d.ts +0 -2
  182. package/lib/server/services/weather/weather-service.d.ts +4 -1
  183. package/lib/server/services/weather/weather-service.js +4 -0
  184. package/lib/tsconfig.tsbuildinfo +1 -1
  185. package/package.json +6 -5
@@ -7,10 +7,10 @@ export declare class FloorSetAllShuttersCommand extends BaseCommand {
7
7
  _commandType: CommandType;
8
8
  /**
9
9
  * Creates an instance of FloorSetAllShuttersCommand.
10
- * @param {CommandSource | BaseCommand} source
11
- * @param {number} position (0 closed, 100 open)
12
- * @param {number | undefined} specificFloor undefined = all floors
13
- * @param {string} reason
10
+ * @param source - The source of the command
11
+ * @param position - (0 closed, 100 open)
12
+ * @param specificFloor - undefined = all floors
13
+ * @param reason - You can provide a reason for clarity
14
14
  */
15
15
  constructor(source: CommandSource | BaseCommand, position: number, specificFloor?: number | undefined, reason?: string);
16
16
  }
@@ -6,10 +6,10 @@ const commandType_1 = require("./commandType");
6
6
  class FloorSetAllShuttersCommand extends baseCommand_1.BaseCommand {
7
7
  /**
8
8
  * Creates an instance of FloorSetAllShuttersCommand.
9
- * @param {CommandSource | BaseCommand} source
10
- * @param {number} position (0 closed, 100 open)
11
- * @param {number | undefined} specificFloor undefined = all floors
12
- * @param {string} reason
9
+ * @param source - The source of the command
10
+ * @param position - (0 closed, 100 open)
11
+ * @param specificFloor - undefined = all floors
12
+ * @param reason - You can provide a reason for clarity
13
13
  */
14
14
  constructor(source, position, specificFloor = undefined, reason = '') {
15
15
  super(source, reason);
@@ -1,3 +1,6 @@
1
+ export { BlockAutomaticCommand } from './blockAutomaticCommand';
2
+ export { BlockAutomaticUntilCommand } from './blockAutomaticUntilCommand';
3
+ export { BlockAutomaticLiftBlockCommand } from './blockAutomaticLiftBlockCommand';
1
4
  export { RestoreTargetAutomaticValueCommand } from './restoreTargetAutomaticValueCommand';
2
5
  export { ActuatorSetStateCommand } from './actuatorSetStateCommand';
3
6
  export { ActuatorToggleCommand } from './actuatorToggleCommand';
@@ -1,6 +1,12 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.WledSetLightCommand = exports.WindowSetRolloByWeatherStatusCommand = exports.WindowSetDesiredPositionCommand = exports.WindowRestoreDesiredPositionCommand = exports.ShutterSunsetDownCommand = exports.ShutterSunriseUpCommand = exports.ShutterSetLevelCommand = exports.RoomSetLightTimeBasedCommand = exports.RoomRestoreShutterPositionCommand = exports.RoomRestoreLightCommand = exports.LightGroupSwitchTimeConditionalCommand = exports.LedSetLightCommand = exports.LampToggleLightCommand = exports.LampSetTimeBasedCommand = exports.LampSetLightCommand = exports.FloorSetAllShuttersCommand = exports.DimmerSetLightCommand = exports.CommandType = exports.CommandSource = exports.BaseCommand = exports.ActuatorWriteStateToDeviceCommand = exports.ActuatorToggleCommand = exports.ActuatorSetStateCommand = exports.RestoreTargetAutomaticValueCommand = void 0;
3
+ exports.WledSetLightCommand = exports.WindowSetRolloByWeatherStatusCommand = exports.WindowSetDesiredPositionCommand = exports.WindowRestoreDesiredPositionCommand = exports.ShutterSunsetDownCommand = exports.ShutterSunriseUpCommand = exports.ShutterSetLevelCommand = exports.RoomSetLightTimeBasedCommand = exports.RoomRestoreShutterPositionCommand = exports.RoomRestoreLightCommand = exports.LightGroupSwitchTimeConditionalCommand = exports.LedSetLightCommand = exports.LampToggleLightCommand = exports.LampSetTimeBasedCommand = exports.LampSetLightCommand = exports.FloorSetAllShuttersCommand = exports.DimmerSetLightCommand = exports.CommandType = exports.CommandSource = exports.BaseCommand = exports.ActuatorWriteStateToDeviceCommand = exports.ActuatorToggleCommand = exports.ActuatorSetStateCommand = exports.RestoreTargetAutomaticValueCommand = exports.BlockAutomaticLiftBlockCommand = exports.BlockAutomaticUntilCommand = exports.BlockAutomaticCommand = void 0;
4
+ var blockAutomaticCommand_1 = require("./blockAutomaticCommand");
5
+ Object.defineProperty(exports, "BlockAutomaticCommand", { enumerable: true, get: function () { return blockAutomaticCommand_1.BlockAutomaticCommand; } });
6
+ var blockAutomaticUntilCommand_1 = require("./blockAutomaticUntilCommand");
7
+ Object.defineProperty(exports, "BlockAutomaticUntilCommand", { enumerable: true, get: function () { return blockAutomaticUntilCommand_1.BlockAutomaticUntilCommand; } });
8
+ var blockAutomaticLiftBlockCommand_1 = require("./blockAutomaticLiftBlockCommand");
9
+ Object.defineProperty(exports, "BlockAutomaticLiftBlockCommand", { enumerable: true, get: function () { return blockAutomaticLiftBlockCommand_1.BlockAutomaticLiftBlockCommand; } });
4
10
  var restoreTargetAutomaticValueCommand_1 = require("./restoreTargetAutomaticValueCommand");
5
11
  Object.defineProperty(exports, "RestoreTargetAutomaticValueCommand", { enumerable: true, get: function () { return restoreTargetAutomaticValueCommand_1.RestoreTargetAutomaticValueCommand; } });
6
12
  var actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");
@@ -4,6 +4,13 @@ import { BaseCommand } from './baseCommand';
4
4
  import { ActuatorSetStateCommand } from './actuatorSetStateCommand';
5
5
  export declare class LampSetLightCommand extends ActuatorSetStateCommand {
6
6
  _commandType: CommandType;
7
+ /**
8
+ * Command to set the light of a lamp
9
+ * @param source - The source of the command
10
+ * @param on - The new state of the light
11
+ * @param reason - You can provide a reason for clarification
12
+ * @param timeout - If provided, the device automatic will be turned off for the given time in ms --> Reverts to automatic after the timeout.
13
+ */
7
14
  constructor(source: CommandSource | BaseCommand, on: boolean, reason?: string, timeout?: number);
8
15
  get logMessage(): string;
9
16
  }
@@ -4,12 +4,19 @@ exports.LampSetLightCommand = void 0;
4
4
  const commandType_1 = require("./commandType");
5
5
  const actuatorSetStateCommand_1 = require("./actuatorSetStateCommand");
6
6
  class LampSetLightCommand extends actuatorSetStateCommand_1.ActuatorSetStateCommand {
7
+ /**
8
+ * Command to set the light of a lamp
9
+ * @param source - The source of the command
10
+ * @param on - The new state of the light
11
+ * @param reason - You can provide a reason for clarification
12
+ * @param timeout - If provided, the device automatic will be turned off for the given time in ms --> Reverts to automatic after the timeout.
13
+ */
7
14
  constructor(source, on, reason = '', timeout = -1) {
8
15
  super(source, on, reason, timeout);
9
16
  this._commandType = commandType_1.CommandType.LampSetLightCommand;
10
17
  }
11
18
  get logMessage() {
12
- return `Lamp setLight to ${this.on} from ${this.source} for reason: ${this.reasonTrace}`;
19
+ return `Lamp setLight to ${this.on} with timeout ${this.timeout} for reason: ${this.reasonTrace}`;
13
20
  }
14
21
  }
15
22
  exports.LampSetLightCommand = LampSetLightCommand;
@@ -8,10 +8,10 @@ export declare class LampSetTimeBasedCommand extends BaseCommand {
8
8
  _commandType: CommandType;
9
9
  /**
10
10
  * Set's the lamp based on lamp settings for the current time
11
- * @param {CommandSource | BaseCommand} source
12
- * @param {TimeOfDay} time The time to use for calculation of desired state
13
- * @param reason
14
- * @param {number} timeout If > 0 this is the time after which the lamp reverts to its original state
11
+ * @param source - The source of the command
12
+ * @param time - The time to use for calculation of desired state
13
+ * @param reason - You can provide a reason for clarity
14
+ * @param timeout - If > 0 this is the time after which the lamp reverts to its original state
15
15
  */
16
16
  constructor(source: CommandSource | BaseCommand, time: TimeOfDay, reason?: string, timeout?: number);
17
17
  get logMessage(): string;
@@ -7,10 +7,10 @@ const timeCallback_1 = require("../timeCallback");
7
7
  class LampSetTimeBasedCommand extends baseCommand_1.BaseCommand {
8
8
  /**
9
9
  * Set's the lamp based on lamp settings for the current time
10
- * @param {CommandSource | BaseCommand} source
11
- * @param {TimeOfDay} time The time to use for calculation of desired state
12
- * @param reason
13
- * @param {number} timeout If > 0 this is the time after which the lamp reverts to its original state
10
+ * @param source - The source of the command
11
+ * @param time - The time to use for calculation of desired state
12
+ * @param reason - You can provide a reason for clarity
13
+ * @param timeout - If > 0 this is the time after which the lamp reverts to its original state
14
14
  */
15
15
  constructor(source, time, reason = '', timeout = -1) {
16
16
  super(source, reason);
@@ -19,7 +19,7 @@ class LampSetTimeBasedCommand extends baseCommand_1.BaseCommand {
19
19
  this._commandType = commandType_1.CommandType.LampSetTimeBasedCommand;
20
20
  }
21
21
  get logMessage() {
22
- return `Lamp setTimeBased to ${timeCallback_1.TimeOfDay[this.time]} from ${this.source}`;
22
+ return `Lamp setTimeBased to ${timeCallback_1.TimeOfDay[this.time]} for reason: ${this.reasonTrace}`;
23
23
  }
24
24
  }
25
25
  exports.LampSetTimeBasedCommand = LampSetTimeBasedCommand;
@@ -8,11 +8,11 @@ export declare class LampToggleLightCommand extends ActuatorToggleCommand {
8
8
  readonly calculateTime: boolean;
9
9
  _commandType: CommandType;
10
10
  /**
11
- *
12
- * @param {CommandSource | BaseCommand} source
13
- * @param {string} reason
14
- * @param {TimeOfDay} time The time to use for calculation of desired state
15
- * @param {boolean} calculateTime Alternative to "time", if set the time will be calculated by the lamps room and its settings
11
+ * Command to toggle the light-state of a lamp
12
+ * @param source - The source of the command
13
+ * @param reason - You can provide a reason for clarity
14
+ * @param time - The time to use for calculation of desired state
15
+ * @param calculateTime - Alternative to "time", if set the time will be calculated by the lamps room and its settings
16
16
  */
17
17
  constructor(source: CommandSource | BaseCommand, reason?: string, time?: TimeOfDay | undefined, calculateTime?: boolean);
18
18
  get logMessage(): string;
@@ -5,11 +5,11 @@ const actuatorToggleCommand_1 = require("./actuatorToggleCommand");
5
5
  const commandType_1 = require("./commandType");
6
6
  class LampToggleLightCommand extends actuatorToggleCommand_1.ActuatorToggleCommand {
7
7
  /**
8
- *
9
- * @param {CommandSource | BaseCommand} source
10
- * @param {string} reason
11
- * @param {TimeOfDay} time The time to use for calculation of desired state
12
- * @param {boolean} calculateTime Alternative to "time", if set the time will be calculated by the lamps room and its settings
8
+ * Command to toggle the light-state of a lamp
9
+ * @param source - The source of the command
10
+ * @param reason - You can provide a reason for clarity
11
+ * @param time - The time to use for calculation of desired state
12
+ * @param calculateTime - Alternative to "time", if set the time will be calculated by the lamps room and its settings
13
13
  */
14
14
  constructor(source, reason = '', time, calculateTime = false) {
15
15
  super(source, reason);
@@ -18,7 +18,7 @@ class LampToggleLightCommand extends actuatorToggleCommand_1.ActuatorToggleComma
18
18
  this._commandType = commandType_1.CommandType.LampToggleLightCommand;
19
19
  }
20
20
  get logMessage() {
21
- return `Lamp toggleLight from ${this.source} for reason: ${this.reasonTrace}`;
21
+ return `Lamp toggleLight for reason: ${this.reasonTrace}`;
22
22
  }
23
23
  }
24
24
  exports.LampToggleLightCommand = LampToggleLightCommand;
@@ -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);
@@ -23,8 +23,14 @@ class LedSetLightCommand extends dimmerSetLightCommand_1.DimmerSetLightCommand {
23
23
  this._commandType = commandType_1.CommandType.LedSetLightCommand;
24
24
  }
25
25
  get logMessage() {
26
- return `Led setLight to ${this.on} from ${this.source} for reason: ${this.reasonTrace}`;
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
+ /**
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
+ */
28
34
  static byTimeBased(settings, c) {
29
35
  switch (c.time) {
30
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,6 +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
+ /**
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
+ */
7
13
  constructor(source, time, reason = '') {
8
14
  super(source, reason);
9
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,12 +4,17 @@ 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
+ /**
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
+ */
7
12
  constructor(source, reason = '') {
8
13
  super(source, reason);
9
14
  this._commandType = commandType_1.CommandType.ActuatorRestoreTargetAutomaticValueCommand;
10
15
  }
11
16
  get logMessage() {
12
- return `Actuator restore target automatic value from ${this.source} for reason: ${this.reasonTrace}`;
17
+ return `Actuator restore target automatic value due to reason: ${this.reasonTrace}`;
13
18
  }
14
19
  }
15
20
  exports.RestoreTargetAutomaticValueCommand = RestoreTargetAutomaticValueCommand;
@@ -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,6 +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
+ /**
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
+ */
7
12
  constructor(source, reason = '') {
8
13
  super(source, reason);
9
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,6 +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
+ /**
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, recalc = false, reason = '') {
8
14
  super(source, reason);
9
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,6 +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
+ /**
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
+ */
7
12
  constructor(source, reason = '') {
8
13
  super(source, reason);
9
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,6 +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
+ /**
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
+ */
7
12
  constructor(source, reason = '') {
8
13
  super(source, reason);
9
14
  this._commandType = commandType_1.CommandType.SunsetDownCommand;
@@ -7,6 +7,17 @@ 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);
21
+ get logMessage(): string;
11
22
  static byTimeBased(settings: WledSettings, c: LampSetTimeBasedCommand): WledSetLightCommand;
12
23
  }
@@ -5,11 +5,24 @@ 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
+ /**
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
+ */
8
18
  constructor(source, on, reason = '', timeout = -1, brightness = -1, transitionTime = -1, preset) {
9
19
  super(source, on, reason, timeout, brightness, transitionTime);
10
20
  this.preset = preset;
11
21
  this._commandType = commandType_1.CommandType.WledSetLightCommand;
12
22
  }
23
+ get logMessage() {
24
+ return `Dimmer setLight to ${this.on} with Brightness ${this.brightness}, timeout ${this.timeout} and preset ${this.preset} for reason: ${this.reasonTrace}`;
25
+ }
13
26
  static byTimeBased(settings, c) {
14
27
  switch (c.time) {
15
28
  case timeCallback_1.TimeOfDay.Daylight:
@@ -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 & {
6
+ native?: unknown;
7
+ common?: unknown & {
8
8
  name: string;
9
9
  };
10
10
  }
@@ -8,22 +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
- useOwnTemperatureAndAutomatic: boolean;
16
+ useOwnTemperature: boolean;
17
+ /**
18
+ * Whether the AC should use automatic mode to decide on its own whether to heat or cool
19
+ * !!Warning!! This can result in excessive energy consumption, as overshooting the temperature can result in the AC switching to the opposite mode
20
+ */
21
+ useAutomatic: boolean;
19
22
  /**
20
23
  * Whether we should turn off AC-Cooling when someone is in the room
21
- * @type {boolean}
22
24
  */
23
25
  noCoolingOnMovement: boolean;
24
26
  /**
25
27
  * Whether this AC should be turned off for some time manually
26
- * @type {boolean}
27
28
  */
28
29
  manualDisabled: boolean;
29
30
  fromPartialObject(data: Partial<AcSettings>): void;
@@ -14,35 +14,37 @@ 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
- this.useOwnTemperatureAndAutomatic = false;
22
+ this.useOwnTemperature = false;
23
+ /**
24
+ * Whether the AC should use automatic mode to decide on its own whether to heat or cool
25
+ * !!Warning!! This can result in excessive energy consumption, as overshooting the temperature can result in the AC switching to the opposite mode
26
+ */
27
+ this.useAutomatic = false;
25
28
  /**
26
29
  * Whether we should turn off AC-Cooling when someone is in the room
27
- * @type {boolean}
28
30
  */
29
31
  this.noCoolingOnMovement = false;
30
32
  /**
31
33
  * Whether this AC should be turned off for some time manually
32
- * @type {boolean}
33
34
  */
34
35
  this.manualDisabled = false;
35
36
  }
36
37
  fromPartialObject(data) {
37
- var _a, _b, _c, _d, _e, _f, _g, _h;
38
+ var _a, _b, _c, _d, _e, _f, _g, _h, _j;
38
39
  this.minimumHours = (_a = data.minimumHours) !== null && _a !== void 0 ? _a : this.minimumHours;
39
40
  this.minimumMinutes = (_b = data.minimumMinutes) !== null && _b !== void 0 ? _b : this.minimumMinutes;
40
41
  this.maximumHours = (_c = data.maximumHours) !== null && _c !== void 0 ? _c : this.maximumHours;
41
42
  this.maximumMinutes = (_d = data.maximumMinutes) !== null && _d !== void 0 ? _d : this.maximumMinutes;
42
43
  this.heatingAllowed = (_e = data.heatingAllowed) !== null && _e !== void 0 ? _e : this.heatingAllowed;
43
44
  this.noCoolingOnMovement = (_f = data.noCoolingOnMovement) !== null && _f !== void 0 ? _f : this.noCoolingOnMovement;
44
- this.useOwnTemperatureAndAutomatic = (_g = data.useOwnTemperatureAndAutomatic) !== null && _g !== void 0 ? _g : this.useOwnTemperatureAndAutomatic;
45
- this.manualDisabled = (_h = data.manualDisabled) !== null && _h !== void 0 ? _h : this.manualDisabled;
45
+ this.useOwnTemperature = (_g = data.useOwnTemperature) !== null && _g !== void 0 ? _g : this.useOwnTemperature;
46
+ this.useAutomatic = (_h = data.useAutomatic) !== null && _h !== void 0 ? _h : this.useAutomatic;
47
+ this.manualDisabled = (_j = data.manualDisabled) !== null && _j !== void 0 ? _j : this.manualDisabled;
46
48
  super.fromPartialObject(data);
47
49
  }
48
50
  toJSON() {