homebridge-melcloud-control 2.5.0-beta.97 → 3.0.0-beta.0

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 (3) hide show
  1. package/CHANGELOG.md +14 -11
  2. package/README.md +64 -57
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -5,21 +5,24 @@ All notable changes to this project will be documented in this file.
5
5
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6
6
  and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
7
 
8
- ## Important changes v0.1.x
8
+ ## Important changes
9
9
 
10
- - The old plugin and config need to be first removed from Homebridge and HomeKit and added again.
10
+ - v0.1.x The old plugin and config need to be first removed from Homebridge and HomeKit and added again.
11
+ - v0.4.0 Main control mode, buttons and presets need to be configured again!!!
12
+ - v1 After update to v1 and above from v0 the devices need to be added to the Home app again and the old unresponsive remove!!! This devices will be removed from all automations and scenes!!!
13
+ - v2 After update to v2 from v1 only RESTFull and MQTT config settings need to be updated in config.
14
+ - v2.4 and above require upcomming homebridge v2
15
+ - v3 After update to v3 from previous versions the plugin need to be configured using Config UI X.
11
16
 
12
- ## Important changes v0.4.0
17
+ ## [3.0.0] - (29.08.2024)
13
18
 
14
- - Main control mode, buttons and presets need to be configured again!!!
15
-
16
- ## Important changes v1
17
-
18
- - After update to v1 and above from v0 the devices need to be added to the Home app again and the old unresponsive remove!!! This devices will be removed from all automations and scenes!!!
19
-
20
- ## Important changes v2
19
+ ## Changes
21
20
 
22
- - After update to v2 from v1 only RESTFull and MQTT config settings need to be updated in config.
21
+ - added homebridge UI server
22
+ - whole new concept get all devices from melcloud usin config UI X
23
+ - added indyvidual configuration of every device
24
+ - config schema updated
25
+ - cleanup
23
26
 
24
27
  ## [2.4.0] - (28.08.2024)
25
28
 
package/README.md CHANGED
@@ -30,11 +30,10 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
30
30
  * All devices are detected automatically.
31
31
  * Support multiple MELCloud accounts, buildings, floors, areas.
32
32
  * Support temperature display units `Celsius/Fahrenheit`.
33
- * Support hide device by `DeviceId`.
34
33
  * Support control device `Presets`.
35
34
  * Support assing inividual operating mode for `Heat/Cool/Auto`.
36
- * Support direct device control using extra `Buttons`, applied for all devices of same type in account.
37
- * Support detect all device states using extra `Sensors`, applied for all devices of same type in account.
35
+ * Support direct device control using extra `Buttons`.
36
+ * Support detect all device states using extra `Sensors`.
38
37
  * Support automations, shortcuts and Siri.
39
38
  * Support external integrations, [RESTFul](https://github.com/grzegorz914/homebridge-melcloud-control?tab=readme-ov-file#restful-integration), [MQTT](https://github.com/grzegorz914/homebridge-melcloud-control?tab=readme-ov-file#mqtt-integration).
40
39
 
@@ -175,67 +174,75 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
175
174
  | `user` | Here set the MELCloud username. |
176
175
  | `passwd` | Here set the MELCloud password. |
177
176
  | `language` | Here select the MELCloud language. |
178
- | `ataDisplayMode` | Here select device control mode `Heater/Cooler`, `Thermostat`. |
179
- | `ataHeatDryFanMode` | Here select the operatiing mode for `Heat`, if this mode is not supported, it will be disabled. |
180
- | `ataCoolDryFanMode` | Here select the operatiing mode for `Cool`, if this mode is not supported, it will be disabled. |
181
- | `ataAutoDryFanMode` | Here select the operatiing mode for `Auto`, if this mode is not supported, it will be disabled.. |
182
- | `ataTemperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
183
- | `ataTemperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
184
- | `ataPresets` | This enable extra buttons for configured presets and display it in HomeKit app. |
185
- | `ataButtons.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
186
- | `ataButtons.mode` | Here select button mode, VH - Vane Horizontal, VV - Vane Horizontal. |
187
- | `ataButtons.displayType` | Here select display type in HomeKit app, possible `None/Disabled`, `Outlet`, `Switch`, `Motion Sensor`, `Occupancy Sensor`, `Contact Sensor`. |
188
- | `ataButtons.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
189
- | `ataHideDeviceById.name` | Here set Your own name. |
190
- | `ataHideDeviceById.id` | Here set `DeviceId` to be hidden and not exposed to the `Homebridge/Homekit`. |
191
- | `atwDisplayMode` | Here select main control mode `Heater/Cooler`, `Thermostat`. |
192
- | `atwTemperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
193
- | `atwTemperatureSensorFlow` | This enable extra `Flow` temperature sensors to use with automations in HomeKit app. |
194
- | `atwTemperatureSensorReturn` | This enable extra `Return` temperature sensors to use with automations in HomeKit app. |
195
- | `atwTemperatureSensorFlowZone1` | This enable extra `Flow Zone 1` temperature sensors to use with automations in HomeKit app. |
196
- | `atwTemperatureSensorReturnZone1` | This enable extra `Return Zone 1` temperature sensors to use with automations in HomeKit app. |
197
- | `atwTemperatureSensorFlowWaterTank` | This enable extra `Flow Water Tank` temperature sensors to use with automations in HomeKit app. |
198
- | `atwTemperatureSensorReturnWaterTank` | This enable extra `Return Water Tank` temperature sensors to use with automations in HomeKit app. |
199
- | `atwTemperatureSensorFlowZone2` | This enable extra `Flow Zone 2` temperature sensors to use with automations in HomeKit app. |
200
- | `atwTemperatureSensorReturnZone2` | This enable extra `Return Zone 2` temperature sensors to use with automations in HomeKit app. |
201
- | `atwPresets` | This enable extra buttons for configured presets and display it in HomeKit app. |
202
- | `atwButtons.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
203
- | `atwButtons.mode` | Here select button mode. |
204
- | `atwButtons.displayType` | Here select display type in HomeKit app, possible `None/Disabled`, `Outlet`, `Switch`, `Motion Sensor`, `Occupancy Sensor`, `Contact Sensor`. |
205
- | `atwButtons.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
206
- | `atwHideDeviceById.name` | Here set Your own name. |
207
- | `atwHideDeviceById.id` | Here set `DeviceId` to be hidden and not exposed to the `Homebridge/Homekit`. |
208
- | `ervDisplayMode` | Here select main control mode `Heater/Cooler`, `Thermostat`. |
209
- | `ervTemperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
210
- | `ervTemperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
211
- | `ervTemperatureSensorSupply` | This enable extra `Supply` temperature sensors to use with automations in HomeKit app. |
212
- | `ervPresets` | This enable extra buttons for configured presets and display it in HomeKit app. |
213
- | `ervButtons.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
214
- | `ervButtons.mode` | Here select button mode. |
215
- | `ervButtons.displayType` | Here select display type in HomeKit app, possible `None/Disabled`, `Outlet`, `Switch`, `Motion Sensor`, `Occupancy Sensor`, `Contact Sensor`. |
216
- | `ervButtons.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
217
- | `ervHideDeviceById.name` | Here set Your own name. |
218
- | `ervHideDeviceById.id` | Here set `DeviceId` to be hidden and not exposed to the `Homebridge/Homekit`. |
177
+ | `ataDevices` | Array of ATA devices created automatically after login to MELCloud from plugin config UI. |
178
+ | `ataDevices.id` | Read only data, do not change it. |
179
+ | `ataDevices.type` | Read only data, do not change it. |
180
+ | `ataDevices.name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
181
+ | `ataDevices.displayMode` | Here select device control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
182
+ | `ataDevices.heatDryFanMode` | Here select the operatiing mode for `Heat`, if this mode is not supported, it will be disabled. |
183
+ | `ataDevices.coolDryFanMode` | Here select the operatiing mode for `Cool`, if this mode is not supported, it will be disabled. |
184
+ | `ataDevices.autoDryFanMode` | Here select the operatiing mode for `Auto`, if this mode is not supported, it will be disabled.. |
185
+ | `ataDevices.temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
186
+ | `ataDevices.temperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
187
+ | `ataDevices.presets` | This enable extra buttons for configured presets and display it in HomeKit app. |
188
+ | `buttonsSensors` | Array of buttons sensors. |
189
+ | `buttonsSensors.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
190
+ | `buttonsSensors.mode` | Here select button mode, VH - Vane Horizontal, VV - Vane Horizontal. |
191
+ | `buttonsSensors.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`, `4 - Occupancy Sensor`, `5 - Contact Sensor`. |
192
+ | `buttonsSensors.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
193
+ | `atwDevices` | Array of ATA devices created automatically after login to MELCloud from plugin config UI. |
194
+ | `atwDevices.id` | Read only data, do not change it. |
195
+ | `atwDevices.type` | Read only data, do not change it. |
196
+ | `atwDevices.name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
197
+ | `atwDevices.displayMode` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
198
+ | `atwDevices.temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
199
+ | `atwDevices.temperatureSensorFlow` | This enable extra `Flow` temperature sensors to use with automations in HomeKit app. |
200
+ | `atwDevices.temperatureSensorReturn` | This enable extra `Return` temperature sensors to use with automations in HomeKit app. |
201
+ | `atwDevices.temperatureSensorFlowZone1` | This enable extra `Flow Zone 1` temperature sensors to use with automations in HomeKit app. |
202
+ | `atwDevices.temperatureSensorReturnZone1` | This enable extra `Return Zone 1` temperature sensors to use with automations in HomeKit app. |
203
+ | `atwDevices.temperatureSensorFlowWaterTank` | This enable extra `Flow Water Tank` temperature sensors to use with automations in HomeKit app. |
204
+ | `atwDevices.temperatureSensorReturnWaterTank` | This enable extra `Return Water Tank` temperature sensors to use with automations in HomeKit app. |
205
+ | `atwDevices.temperatureSensorFlowZone2` | This enable extra `Flow Zone 2` temperature sensors to use with automations in HomeKit app. |
206
+ | `atwDevices.temperatureSensorReturnZone2` | This enable extra `Return Zone 2` temperature sensors to use with automations in HomeKit app. |
207
+ | `atwDevices.presets` | This enable extra buttons for configured presets and display it in HomeKit app. |
208
+ | `buttonsSensors` | Array of buttons sensors. |
209
+ | `buttonsSensors.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
210
+ | `buttonsSensors.mode` | Here select button mode. |
211
+ | `buttonsSensors.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`, `4 - Occupancy Sensor`, `5 - Contact Sensor`. |
212
+ | `buttonsSensors.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
213
+ | `ervDevices` | Array of ATA devices created automatically after login to MELCloud from plugin config UI. |
214
+ | `ervDevices.id` | Read only data, do not change it. |
215
+ | `ervDevices.type` | Read only data, do not change it. |
216
+ | `ervDevices.name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
217
+ | `ervDevices.displayMode` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
218
+ | `ervDevices.temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
219
+ | `ervDevices.temperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
220
+ | `ervDevices.temperatureSensorSupply` | This enable extra `Supply` temperature sensors to use with automations in HomeKit app. |
221
+ | `ervDevices.presets` | This enable extra buttons for configured presets and display it in HomeKit app. |
222
+ | `buttonsSensors` | Array of buttons sensors. |
223
+ | `buttonsSensors.name` | Here set `Button Name` which You want expose to the `Homebridge/HomeKit`. |
224
+ | `buttonsSensors.mode` | Here select button mode. |
225
+ | `buttonsSensors.displayType` | Here select display type in HomeKit, `0 - None/Disabled`, `1 - Outlet`, `2 - Switch`, `3 - Motion Sensor`, `4 - Occupancy Sensor`, `5 - Contact Sensor`. |
226
+ | `buttonsSensors.namePrefix` | Here enable/disable the accessory name as a prefix for button/sensor name. |
219
227
  | `refreshInterval` | Here set the background account data refresh time in (sec), default `120s`. |
220
228
  | `deviceRefreshInterval` | Here set the background devices state refresh time in (sec), default `5s`. |
221
229
  | `enableDebugMode` | This enable deep log in homebridge console. |
222
230
  | `disableLogInfo` | This disable display log values and states on every it change. |
223
231
  | `disableLogDeviceInfo` | This disable display log device info on plugin start. |
224
232
  | `restFul` | This is RSTful server. |
225
- | `enable` | If enabled, RESTful server will start automatically and respond to any path request. |
226
- | `port` | Here set the listening `Port` for RESTful server. |
227
- | `debug` | If enabled, deep log will be present in homebridge console for RESTFul server. |
233
+ | `restFul.enable` | If enabled, RESTful server will start automatically and respond to any path request. |
234
+ | `restFul.port` | Here set the listening `Port` for RESTful server. |
235
+ | `restFul.debug` | If enabled, deep log will be present in homebridge console for RESTFul server. |
228
236
  | `mqtt` | This is MQTT Broker. |
229
- | `enable` | If enabled, MQTT Broker will start automatically and publish all awailable PV data. |
230
- | `host` | Here set the `IP Address` or `Hostname` for MQTT Broker. |
231
- | `port` | Here set the `Port` for MQTT Broker, default 1883. |
232
- | `clientId` | Here optional set the `Client Id` of MQTT Broker. |
233
- | `prefix` | Here set the `Prefix` for `Topic` or leave empty. |
234
- | `auth` | If enabled, MQTT Broker will use authorization credentials. |
235
- | `user` | Here set the MQTT Broker user. |
236
- | `passwd` | Here set the MQTT Broker password. |
237
- | `debug` | If enabled, deep log will be present in homebridge console for MQTT. |
238
- | `Display Type Buttons` | 0 - `None/Disabled`, 1 - `Outlet`, 2 - `Switch`, 3 - `Motion Sensor`, 4 - `Occupancy Sensor`, 5 - `Contact Sensor`. |
237
+ | `mqtt.enable` | If enabled, MQTT Broker will start automatically and publish all awailable PV data. |
238
+ | `mqtt.host` | Here set the `IP Address` or `Hostname` for MQTT Broker. |
239
+ | `mqtt.port` | Here set the `Port` for MQTT Broker, default 1883. |
240
+ | `mqtt.clientId` | Here optional set the `Client Id` of MQTT Broker. |
241
+ | `mqtt.prefix` | Here set the `Prefix` for `Topic` or leave empty. |
242
+ | `mqtt.auth` | If enabled, MQTT Broker will use authorization credentials. |
243
+ | `mqtt.user` | Here set the MQTT Broker user. |
244
+ | `mqtt.passwd` | Here set the MQTT Broker password. |
245
+ | `mqtt.debug` | If enabled, deep log will be present in homebridge console for MQTT. |
239
246
 
240
247
  ### RESTful Integration
241
248
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "displayName": "MELCloud Control",
3
3
  "name": "homebridge-melcloud-control",
4
- "version": "2.5.0-beta.97",
4
+ "version": "3.0.0-beta.0",
5
5
  "description": "Homebridge plugin to control Mitsubishi Air Conditioner, Heat Pump and Energy Recovery Ventilation.",
6
6
  "license": "MIT",
7
7
  "author": "grzegorz914",