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
@@ -5,6 +5,10 @@ export interface iLamp extends iActuator {
5
5
  * The state value of the device
6
6
  */
7
7
  readonly lightOn: boolean;
8
+ /**
9
+ * Changes the state of the lamp based on the time
10
+ * @param {LampSetTimeBasedCommand} command - The command to execute
11
+ */
8
12
  setTimeBased(command: LampSetTimeBasedCommand): void;
9
13
  /**
10
14
  * Toggles the state of the lamp
@@ -4,5 +4,10 @@ export interface iLedRgbCct extends iDimmableLamp {
4
4
  settings: LedSettings;
5
5
  readonly color: string;
6
6
  readonly colortemp: number;
7
+ /**
8
+ * This function sets the light to a specific value
9
+ * Accessible in API
10
+ * @param {LedSetLightCommand} c - The command to execute
11
+ */
7
12
  setLight(c: LedSetLightCommand): void;
8
13
  }
@@ -3,12 +3,18 @@ import { iRoomDevice } from './iRoomDevice';
3
3
  export interface iMotionSensor extends iRoomDevice {
4
4
  settings: MotionSensorSettings;
5
5
  readonly movementDetected: boolean;
6
+ /**
7
+ * Time since the last motion was detected in seconds
8
+ */
6
9
  readonly timeSinceLastMotion: number;
7
10
  detectionsToday: number;
8
11
  /**
9
12
  * Adds a callback for when a motion state has changed.
10
- * @param pCallback Function that accepts the new state as parameter
13
+ * @param pCallback - Function that accepts the new state as parameter
11
14
  */
12
15
  addMovementCallback(pCallback: (newState: boolean) => void): void;
16
+ /**
17
+ * Persists the current motion information to the database
18
+ */
13
19
  persistMotionSensor(): void;
14
20
  }
@@ -8,6 +8,13 @@ export interface iScene extends iRoomDevice {
8
8
  readonly on: boolean;
9
9
  readonly automaticEndTimeout: NodeJS.Timeout | null;
10
10
  settings: SceneSettings;
11
+ /**
12
+ * Starts the scene for the given duration
13
+ * @param {number} timeout - If set, the scene will end after the given time in ms
14
+ */
11
15
  startScene(timeout?: number): void;
16
+ /**
17
+ * Ends the scene --> This also stops the automatic end timeout.
18
+ */
12
19
  endScene(): void;
13
20
  }
@@ -6,6 +6,13 @@ export interface iShutter extends iRoomDevice {
6
6
  currentLevel: number;
7
7
  desiredWindowShutterLevel: number;
8
8
  window: Window | undefined;
9
+ /**
10
+ * Persists the current information of the shutter to the database
11
+ */
9
12
  persist(): void;
13
+ /**
14
+ * Sets the level of the shutter
15
+ * @param {ShutterSetLevelCommand} command - The command to execute
16
+ */
10
17
  setLevel(command: ShutterSetLevelCommand): void;
11
18
  }
@@ -1,5 +1,12 @@
1
1
  import { iRoomDevice } from './iRoomDevice';
2
2
  export interface iSmokeDetectorDevice extends iRoomDevice {
3
+ /**
4
+ * Indicates if the smoke detector is currently detecting smoke
5
+ */
3
6
  readonly smoke: boolean;
7
+ /**
8
+ * Stops the alarm of the smoke detector
9
+ * @param {boolean} quiet - If true, the alarm will be stopped without announcing alarm end.
10
+ */
4
11
  stopAlarm(quiet: boolean): void;
5
12
  }
@@ -1,8 +1,33 @@
1
1
  import { iRoomDevice } from './iRoomDevice';
2
2
  export interface iSpeaker extends iRoomDevice {
3
+ /**
4
+ * Plays an mp3 file on the device
5
+ * @param {string} mp3Name - The name of the mp3 file to play
6
+ * @param {number} duration - The duration of the mp3 file in seconds
7
+ * @param {number} [volume] - The volume to play the mp3 file with
8
+ * @param {boolean} [onlyWhenPlaying] - If true, the mp3 file will only be played when the device is already playing something
9
+ * @param {boolean} [resolveAfterRevert] - If true, the promise will be resolved after the device has reverted to the previous state
10
+ */
3
11
  playOnDevice(mp3Name: string, duration: number, volume?: number, onlyWhenPlaying?: boolean, resolveAfterRevert?: boolean): void;
12
+ /**
13
+ * Plays a test message on the device
14
+ */
4
15
  playTestMessage(): void;
16
+ /**
17
+ * Plays a file from an url on the device
18
+ * @param {string} url - The url to play
19
+ */
5
20
  playUrl(url: string): void;
21
+ /**
22
+ * Stops the current playback on the device
23
+ */
6
24
  stop(): void;
25
+ /**
26
+ * Speaks a message on the device using the text-to-speech engine
27
+ * @param {string} pMessage - The message to speak
28
+ * @param {number} [volume] - The volume to speak the message with
29
+ * @param {boolean} [onlyWhenPlaying] - If true, the message will only be spoken when the device is already playing something
30
+ * @param {boolean} [resolveAfterRevert] - If true, the promise will be resolved after the device has reverted to the previous state
31
+ */
7
32
  speakOnDevice(pMessage: string, volume?: number, onlyWhenPlaying?: boolean, resolveAfterRevert?: boolean): void;
8
33
  }
@@ -6,7 +6,18 @@ export interface iTemperatureSensor extends iRoomDevice {
6
6
  roomTemperature: number;
7
7
  iTemperature: number;
8
8
  sTemperature: string;
9
+ /**
10
+ * Adds a callback to be called when the temperature changes
11
+ * @param {(pValue: number) => void} pCallback - The callback to be called
12
+ */
9
13
  addTempChangeCallback(pCallback: (pValue: number) => void): void;
14
+ /**
15
+ * Inform the temperature sensor that the temperature in the room has changed
16
+ * @param {number} newTemperatur - The new temperature in the room in Celsius
17
+ */
10
18
  onTemperaturChange(newTemperatur: number): void;
19
+ /**
20
+ * Persists the current temperature sensor information to the database
21
+ */
11
22
  persistTemperaturSensor(): void;
12
23
  }
@@ -2,6 +2,13 @@ import { BlockAutomaticHandler } from '../../services/blockAutomaticHandler';
2
2
  import { iBaseDevice } from './iBaseDevice';
3
3
  import { RestoreTargetAutomaticValueCommand } from '../../../models';
4
4
  export interface iTemporaryDisableAutomatic extends iBaseDevice {
5
+ /**
6
+ * The block automation handler containing the current block state/time, etc.
7
+ */
5
8
  readonly blockAutomationHandler: BlockAutomaticHandler;
9
+ /**
10
+ * Restores the automatic value/state of the device
11
+ * @param {RestoreTargetAutomaticValueCommand} command - The command to restore the automatic value/state
12
+ */
6
13
  restoreTargetAutomaticValue(command: RestoreTargetAutomaticValueCommand): void;
7
14
  }
@@ -1,8 +1,20 @@
1
1
  import { iRoomDevice } from './iRoomDevice';
2
2
  export interface iTvDevice extends iRoomDevice {
3
3
  readonly on: boolean;
4
+ /**
5
+ * Turns the TV on
6
+ */
4
7
  turnOn(): void;
8
+ /**
9
+ * Turns the TV off
10
+ */
5
11
  turnOff(): void;
12
+ /**
13
+ * Increases the volume of the TV
14
+ */
6
15
  volumeUp(): void;
16
+ /**
17
+ * Decreases the volume of the TV
18
+ */
7
19
  volumeDown(): void;
8
20
  }
@@ -5,5 +5,4 @@ export interface iVibrationSensor extends iRoomDevice {
5
5
  vibrationBlockedByMotion: boolean;
6
6
  vibrationBlockedByMotionTimeStamp: number;
7
7
  vibration: boolean;
8
- alarmCheck(): void;
9
8
  }
@@ -43,8 +43,7 @@ export declare class CameraDevice implements iCameraDevice {
43
43
  get info(): DeviceInfo;
44
44
  set info(info: DeviceInfo);
45
45
  /**
46
- * Time since Last Motion in seconds
47
- * @returns {number}
46
+ * @inheritDoc
48
47
  */
49
48
  get timeSinceLastMotion(): number;
50
49
  get customName(): string;
@@ -52,7 +51,7 @@ export declare class CameraDevice implements iCameraDevice {
52
51
  get room(): RoomBase | undefined;
53
52
  /**
54
53
  * Adds a callback for when a motion state has changed.
55
- * @param pCallback Function that accepts the new state as parameter
54
+ * @param pCallback - Function that accepts the new state as parameter
56
55
  */
57
56
  addMovementCallback(pCallback: (newState: boolean) => void): void;
58
57
  onGriffUpdate(open: boolean): void;
@@ -103,8 +103,7 @@ class CameraDevice {
103
103
  this._info = info;
104
104
  }
105
105
  /**
106
- * Time since Last Motion in seconds
107
- * @returns {number}
106
+ * @inheritDoc
108
107
  */
109
108
  get timeSinceLastMotion() {
110
109
  return Math.round((services_1.Utils.nowMS() - this._lastMotion) / 1000);
@@ -121,7 +120,7 @@ class CameraDevice {
121
120
  }
122
121
  /**
123
122
  * Adds a callback for when a motion state has changed.
124
- * @param pCallback Function that accepts the new state as parameter
123
+ * @param pCallback - Function that accepts the new state as parameter
125
124
  */
126
125
  addMovementCallback(pCallback) {
127
126
  this._movementDetectedCallback.push(pCallback);
@@ -8,11 +8,3 @@ export interface KeyListEntityResponse<V> {
8
8
  rawValue?: string;
9
9
  value: V;
10
10
  }
11
- /**
12
-
13
- "key": "",
14
- "doc": "",
15
- "unit": Number
16
-
17
-
18
- */
@@ -1,10 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
-
5
- "key": "",
6
- "doc": "",
7
- "unit": Number
8
-
9
-
10
- */
@@ -9,7 +9,7 @@ import { DachsClientOptions, iFlattenedCompleteResponse, KeyListEntityResponse }
9
9
  */
10
10
  export declare class DachsHttpClient {
11
11
  private options;
12
- private url;
12
+ private readonly url;
13
13
  private axiosInstance;
14
14
  constructor(options: DachsClientOptions);
15
15
  /**
@@ -13,6 +13,7 @@ export declare class Window extends BaseGroup {
13
13
  constructor(roomName: string, handleIds?: string[], vibrationIds?: string[], shutterIds?: string[], magnetIds?: string[]);
14
14
  /**
15
15
  * sets the desired Pos and moves rollo to this level
16
+ * @param c - The command to execute
16
17
  */
17
18
  setDesiredPosition(c: WindowSetDesiredPositionCommand): void;
18
19
  getHandle(): HmIpGriff[];
@@ -23,6 +23,7 @@ class Window extends base_group_1.BaseGroup {
23
23
  }
24
24
  /**
25
25
  * sets the desired Pos and moves rollo to this level
26
+ * @param c - The command to execute
26
27
  */
27
28
  setDesiredPosition(c) {
28
29
  this.desiredPosition = c.position;
@@ -7,13 +7,13 @@ export declare class HeatGroup extends BaseGroup {
7
7
  settings: HeatGroupSettings;
8
8
  constructor(roomName: string, heaterIds: string[], tempSensorIds: string[], humiditySensorIds: string[], acIds: string[]);
9
9
  /**
10
- * The current measured temperature of the room in Celsius
11
- * @returns {number}
10
+ * Calculates the combined humidity Level in this room
11
+ * @returns The humidity in percent
12
12
  */
13
13
  get humidity(): number;
14
14
  /**
15
- * The current measured temperature of the room in Celsius
16
- * @returns {number}
15
+ * Calculates the temperature based on all available sensors.
16
+ * @returns The temperature in °C
17
17
  */
18
18
  get temperature(): number;
19
19
  get desiredTemp(): number;
@@ -26,8 +26,8 @@ export declare class HeatGroup extends BaseGroup {
26
26
  /**
27
27
  * Sets all ACs to new desired Value
28
28
  * TODO: Migrate to new Command System
29
- * @param {boolean} newDesiredState
30
- * @param {boolean} force Whether this was a manual trigger, thus blocking automatic changes for 1 hour
29
+ * @param newDesiredState - The new desired (on/off) state
30
+ * @param force - Whether this was a manual trigger, thus blocking automatic changes for 1 hour
31
31
  */
32
32
  setAc(newDesiredState: boolean, force?: boolean): void;
33
33
  deleteAutomaticPoint(name: string): void;
@@ -19,8 +19,8 @@ class HeatGroup extends base_group_1.BaseGroup {
19
19
  this.deviceCluster.deviceMap.set(device_cluster_type_1.DeviceClusterType.Ac, new device_list_1.DeviceList(acIds));
20
20
  }
21
21
  /**
22
- * The current measured temperature of the room in Celsius
23
- * @returns {number}
22
+ * Calculates the combined humidity Level in this room
23
+ * @returns The humidity in percent
24
24
  */
25
25
  get humidity() {
26
26
  let humidity = baseDeviceInterfaces_1.UNDEFINED_HUMIDITY_VALUE;
@@ -40,8 +40,8 @@ class HeatGroup extends base_group_1.BaseGroup {
40
40
  return humidity;
41
41
  }
42
42
  /**
43
- * The current measured temperature of the room in Celsius
44
- * @returns {number}
43
+ * Calculates the temperature based on all available sensors.
44
+ * @returns The temperature in °C
45
45
  */
46
46
  get temperature() {
47
47
  let temp = baseDeviceInterfaces_1.UNDEFINED_TEMP_VALUE;
@@ -128,8 +128,8 @@ class HeatGroup extends base_group_1.BaseGroup {
128
128
  /**
129
129
  * Sets all ACs to new desired Value
130
130
  * TODO: Migrate to new Command System
131
- * @param {boolean} newDesiredState
132
- * @param {boolean} force Whether this was a manual trigger, thus blocking automatic changes for 1 hour
131
+ * @param newDesiredState - The new desired (on/off) state
132
+ * @param force - Whether this was a manual trigger, thus blocking automatic changes for 1 hour
133
133
  */
134
134
  setAc(newDesiredState, force = false) {
135
135
  const devs = this.getOwnAcDevices();
@@ -15,7 +15,6 @@ export declare class PresenceGroup extends BaseGroup {
15
15
  private motionSensorOnLastLeft;
16
16
  /**
17
17
  * In case of an existing delayed last left callback timeout, this removes it.
18
- * @private
19
18
  */
20
19
  private resetLastLeftTimeout;
21
20
  private motionSensorOnFirstEnter;
@@ -106,7 +106,6 @@ class PresenceGroup extends base_group_1.BaseGroup {
106
106
  }
107
107
  /**
108
108
  * In case of an existing delayed last left callback timeout, this removes it.
109
- * @private
110
109
  */
111
110
  resetLastLeftTimeout() {
112
111
  if (this._lastLeftTimeout !== null) {
@@ -38,7 +38,6 @@ export declare class HmIpHeizgruppe extends HmIPDevice implements iTemperatureSe
38
38
  addHumidityCallback(pCallback: (pValue: number) => void): void;
39
39
  getBelongingHeizungen(): iHeater[];
40
40
  update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
41
- stopAutomaticCheck(): void;
42
41
  checkAutomaticChange(): void;
43
42
  addTempChangeCallback(pCallback: (pValue: number) => void): void;
44
43
  onTemperaturChange(newTemperatur: number): void;
@@ -119,12 +119,6 @@ class HmIpHeizgruppe extends hmIpDevice_1.HmIPDevice {
119
119
  break;
120
120
  }
121
121
  }
122
- stopAutomaticCheck() {
123
- if (this._iAutomaticInterval !== undefined) {
124
- clearInterval(this._iAutomaticInterval);
125
- this._iAutomaticInterval = undefined;
126
- }
127
- }
128
122
  checkAutomaticChange() {
129
123
  var _a, _b, _c, _d;
130
124
  if (!this._initialSeasonCheckDone) {
@@ -1,4 +1,15 @@
1
1
  export interface IDeviceUpdater {
2
+ /**
3
+ * Updates the state of a device
4
+ * @param id - The id of the device
5
+ * @param state - The new state
6
+ * @param initial - Whether this is an initial state update
7
+ */
2
8
  updateState(id: string, state: ioBroker.State, initial?: boolean): void;
9
+ /**
10
+ * Updates the given object
11
+ * @param pId - The id of the object
12
+ * @param pObj - The new object
13
+ */
3
14
  updateObject(pId: string, pObj: ioBroker.Object): void;
4
15
  }
@@ -38,7 +38,7 @@ export declare class JsObjectEnergyManager extends IoBrokerBaseDevice implements
38
38
  * | drawing | 0W | 100W | 1000W |
39
39
  * | selfConsume | 900W | 1000W | 0W |
40
40
  * ________________________________________
41
- **/
41
+ */
42
42
  get excessEnergyConsumerConsumption(): number;
43
43
  private _phaseAState;
44
44
  get phaseAState(): PhaseState;
@@ -72,7 +72,7 @@ class JsObjectEnergyManager extends IoBrokerBaseDevice_1.IoBrokerBaseDevice {
72
72
  * | drawing | 0W | 100W | 1000W |
73
73
  * | selfConsume | 900W | 1000W | 0W |
74
74
  * ________________________________________
75
- **/
75
+ */
76
76
  get excessEnergyConsumerConsumption() {
77
77
  return this._excessEnergyConsumerConsumption;
78
78
  }
@@ -34,7 +34,9 @@ class LampUtils {
34
34
  !command.on &&
35
35
  device.blockAutomationHandler.automaticBlockActive) {
36
36
  dontBlock = true;
37
- device.blockAutomationHandler.liftAutomaticBlock(new models_1.BlockAutomaticLiftBlockCommand(command, 'Reset Automatic Block as we are turning off manually after a force on'));
37
+ const liftCommand = new models_1.BlockAutomaticLiftBlockCommand(command, 'Reset Automatic Block as we are turning off manually after a force on');
38
+ liftCommand.overrideCommandSource = models_1.CommandSource.Automatic;
39
+ device.blockAutomationHandler.liftAutomaticBlock(liftCommand);
38
40
  }
39
41
  return dontBlock;
40
42
  }
@@ -24,7 +24,7 @@ export declare class ZigbeeMotionSensor extends ZigbeeDevice implements iMotionS
24
24
  set detectionsToday(pVal: number);
25
25
  /**
26
26
  * Adds a callback for when a motion state has changed.
27
- * @param pCallback Function that accepts the new state as parameter
27
+ * @param pCallback - Function that accepts the new state as parameter
28
28
  */
29
29
  addMovementCallback(pCallback: (newState: boolean) => void): void;
30
30
  persistMotionSensor(): void;
@@ -64,7 +64,7 @@ class ZigbeeMotionSensor extends index_1.ZigbeeDevice {
64
64
  }
65
65
  /**
66
66
  * Adds a callback for when a motion state has changed.
67
- * @param pCallback Function that accepts the new state as parameter
67
+ * @param pCallback - Function that accepts the new state as parameter
68
68
  */
69
69
  addMovementCallback(pCallback) {
70
70
  this._movementDetectedCallback.push(pCallback);
@@ -13,7 +13,7 @@ export declare abstract class ZigbeeSwitch extends ZigbeeDevice implements iButt
13
13
  abstract buttonTop: Button | undefined;
14
14
  abstract buttonTopLeft: Button | undefined;
15
15
  abstract buttonTopRight: Button | undefined;
16
- constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
16
+ protected constructor(pInfo: IoBrokerDeviceInfo, deviceType: DeviceType);
17
17
  persist(buttonName: string, pressType: ButtonPressType): void;
18
18
  update(idSplit: string[], state: ioBroker.State, initial?: boolean, pOverrride?: boolean): void;
19
19
  abstract getButtonAssignment(): string;
@@ -28,6 +28,6 @@ export declare class ZigbeeAquaraVibra extends ZigbeeDevice implements iVibratio
28
28
  set vibrationBlockedByMotion(pVal: boolean);
29
29
  update(idSplit: string[], state: ioBroker.State, initial?: boolean): void;
30
30
  setSensitivity(pVal: number): void;
31
- alarmCheck(): void;
31
+ private alarmCheck;
32
32
  persistBatteryDevice(): void;
33
33
  }
@@ -27,9 +27,8 @@ export declare class ZigbeeEuroHeater extends ZigbeeHeater implements iDisposabl
27
27
  dispose(): void;
28
28
  private setValve;
29
29
  /**
30
- * Sets the mode (1 = manual valve, 2 = automatic temp based)
31
- * @param {1 | 2} targetMode
32
- * @private
30
+ * Sets the mode
31
+ * @param targetMode - (1 = manual valve, 2 = automatic temp based)
33
32
  */
34
33
  private setMode;
35
34
  }
@@ -169,9 +169,8 @@ class ZigbeeEuroHeater extends BaseDevices_1.ZigbeeHeater {
169
169
  }, 10000, this);
170
170
  }
171
171
  /**
172
- * Sets the mode (1 = manual valve, 2 = automatic temp based)
173
- * @param {1 | 2} targetMode
174
- * @private
172
+ * Sets the mode
173
+ * @param targetMode - (1 = manual valve, 2 = automatic temp based)
175
174
  */
176
175
  setMode(targetMode) {
177
176
  this.setState(this._setModeId, targetMode);
@@ -32,79 +32,79 @@ export declare class IOBrokerConnection implements iDisposable {
32
32
  private _isExecutedInBrowser;
33
33
  /**
34
34
  * Getter isExecutedInBrowser
35
- * @return {boolean }
35
+ * @returns
36
36
  */
37
37
  get isExecutedInBrowser(): boolean;
38
38
  private _enums?;
39
39
  /**
40
40
  * Getter enums
41
- * @return {unknown}
41
+ * @returns
42
42
  */
43
43
  get enums(): Record<string, ioBroker.EnumObject> | undefined;
44
44
  /**
45
45
  * Setter enums
46
- * @param {unknown} value
46
+ * @param value
47
47
  */
48
48
  set enums(value: Record<string, ioBroker.EnumObject> | undefined);
49
49
  private _isAuthDone;
50
50
  /**
51
51
  * Getter isAuthDone
52
- * @return {boolean }
52
+ * @returns
53
53
  */
54
54
  get isAuthDone(): boolean;
55
55
  private _namespace;
56
56
  /**
57
57
  * Getter namespace
58
- * @return {string }
58
+ * @returns
59
59
  */
60
60
  get namespace(): string;
61
61
  /**
62
62
  * Setter namespace
63
- * @param {string } value
63
+ * @param value
64
64
  */
65
65
  set namespace(value: string);
66
66
  private _objects?;
67
67
  /**
68
68
  * Getter objects
69
- * @return {unknown}
69
+ * @returns
70
70
  */
71
71
  get objects(): Record<string, ioBroker.Object> | undefined;
72
72
  /**
73
73
  * Setter objects
74
- * @param {unknown} value
74
+ * @param value
75
75
  */
76
76
  set objects(value: Record<string, ioBroker.Object> | undefined);
77
77
  private _type;
78
78
  /**
79
79
  * Getter type
80
- * @return {string }
80
+ * @returns
81
81
  */
82
82
  get type(): string;
83
83
  /**
84
84
  * Setter type
85
- * @param {string } value
85
+ * @param value
86
86
  */
87
87
  set type(value: string);
88
88
  private _timeout;
89
89
  /**
90
90
  * Getter timeout
91
- * @return {number }
91
+ * @returns
92
92
  */
93
93
  get timeout(): number;
94
94
  /**
95
95
  * Setter timeout
96
- * @param {number } value
96
+ * @param value
97
97
  */
98
98
  set timeout(value: number);
99
99
  private _user;
100
100
  /**
101
101
  * Getter user
102
- * @return {unknown}
102
+ * @returns
103
103
  */
104
104
  get user(): string;
105
105
  /**
106
106
  * Setter user
107
- * @param {unknown} value
107
+ * @param value
108
108
  */
109
109
  set user(value: string);
110
110
  reconnect(pConnOptions: unknown): void;
@@ -113,7 +113,7 @@ export declare class IOBrokerConnection implements iDisposable {
113
113
  readFile(filename: string, callback: ioBroker.ReadFileCallback, isRemote: boolean): void;
114
114
  getMimeType(ext: string): string;
115
115
  readFile64(filename: string, callback: unknown, isRemote: boolean): void;
116
- writeFile(filename: string, data: unknown | string, mode: number, callback: ioBroker.ErrnoCallback, ...args: unknown[]): void;
116
+ writeFile(filename: string, data: unknown | string, mode: number, callback: ioBroker.ErrnoCallback, ..._args: unknown[]): void;
117
117
  writeFile64(filename: string, data: string, callback: ioBroker.ErrnoCallback): void;
118
118
  readDir(dirname: string, callback: ioBroker.ReadDirCallback): void;
119
119
  mkdir(dirname: string, callback: ioBroker.ErrnoCallback): void;
@@ -123,16 +123,16 @@ export declare class IOBrokerConnection implements iDisposable {
123
123
  sendTo(instance: string, command: string, payload: ioBroker.MessagePayload, callback: ioBroker.MessageCallback | ioBroker.MessageCallbackInfo): void;
124
124
  getStates(idPattern: string | undefined, callback: ioBroker.GetStatesCallback): void;
125
125
  getObjects(useCache: boolean, callback: ioBroker.GetObjectsCallback): void;
126
- getChildren(id: string, useCache: boolean, callback: (err?: Error | null, children?: string[]) => void, ...args: unknown[]): void;
126
+ getChildren(id: string, useCache: boolean, callback: (err?: Error | null, children?: string[]) => void, ..._args: unknown[]): void;
127
127
  getObject(id: string, useCache: boolean, callback: ioBroker.GetObjectCallback): void;
128
128
  getSyncTime(): Date;
129
- addObject(objId: unknown, obj: unknown, callback: unknown): void;
129
+ addObject(_objId: unknown, _obj: unknown, _callback: unknown): void;
130
130
  delObject(objId: string): void;
131
131
  httpGet(url: string, callback: (res: IncomingMessage | Error) => void): void;
132
132
  logError(errorText: string): void;
133
133
  authenticate(user: string, password: string, salt: string): void;
134
- getConfig(useCache: boolean, callback: (error: Error | null, conf?: Record<string, any>) => void, ...args: unknown[]): void;
135
- sendCommand(instance: string, command: string, data: string | number | boolean | unknown[] | Record<string, any> | null, ack?: boolean): void;
134
+ getConfig(useCache: boolean, callback: (error: Error | null, conf?: Record<string, unknown>) => void, ..._args: unknown[]): void;
135
+ sendCommand(instance: string, command: string, data: string | number | boolean | unknown[] | Record<string, unknown> | null, ack?: boolean): void;
136
136
  readProjects(callback: (err?: NodeJS.ErrnoException | null, objects?: Array<{
137
137
  name: string;
138
138
  readOnly: undefined | boolean;
@@ -142,7 +142,7 @@ export declare class IOBrokerConnection implements iDisposable {
142
142
  clearCache(): void;
143
143
  getHistory(id: string, options: ioBroker.GetHistoryOptions & {
144
144
  timeout?: number;
145
- }, callback: ioBroker.GetHistoryCallback, ...args: unknown[]): void;
145
+ }, callback: ioBroker.GetHistoryCallback, ..._args: unknown[]): void;
146
146
  private _checkConnection;
147
147
  private _monitor;
148
148
  private _onAuth;