homebridge-melcloud-control 4.0.0-beta.99 → 4.0.1-beta.0

package/CHANGELOG.md

@@ -12,17 +12,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - 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!!!
 - v2 After update to v2 from v1 only RESTFull and MQTT config settings need to be updated in config.
   - v2.4 and above require upcomming homebridge v2
-- v3 After update to v3 the plugin need to be configured using Config UI X.
-  - do not configure it manually, always using Config UI X
+- v3 After update to v3 the plugin need to be configured using Homebridge UI.
+  - do not configure it manually, always using Homebridge UI
   - required Homebridge v2.0.0 and above
+- v4 Added support for MELCloud Home.
+  - after update the old MELCloud config must be reconfigured, just remove all devices from config and connect to MELCloud again
 
-## [4.0.0] - (xx.10.2025)
+## Warning
+
+- Do not use Homebridge UI > v5.5.0 because of break config.json
+- After update to v4.x.x the old MELCloud config must be reconfigured, just remove all devices from config and connect to MELCloud again
+
+## [4.0.0] - (05.11.2025)
 
 ## Changes
 
-- added support for MELCloud Home [#215](https://github.com/grzegorz914/homebridge-melcloud-control/issues/215)
-- redme updated
+- added support for MELCloud Home ATA devices [#215](https://github.com/grzegorz914/homebridge-melcloud-control/issues/215)
+- after update the old MELCloud config must be reconfigured, just remove all devices from config and connect to MELCloud again
+- added error sensor
 - config schema updated
+- redme updated
 - cleanup
 
 ## [3.9.5] - (02.09.2025)

package/README.md

@@ -13,7 +13,7 @@
 [![GitHub pull requests](https://img.shields.io/github/issues-pr/grzegorz914/homebridge-melcloud-control.svg)](https://github.com/grzegorz914/homebridge-melcloud-control/pulls)
 [![GitHub issues](https://img.shields.io/github/issues/grzegorz914/homebridge-melcloud-control.svg)](https://github.com/grzegorz914/homebridge-melcloud-control/issues)
 
-Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation Lossnay, manufactured by Mistsubishi and connected to MELCloud.
+Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation Lossnay, manufactured by Mistsubishi and connected to MELCloud or MELCloud Home.
 
 </span>
 
@@ -21,14 +21,14 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 
 | Package | Installation | Role | Required |
 | --- | --- | --- | --- |
-| [Homebridge v2.0](https://github.com/homebridge/homebridge) | [Homebridge Wiki](https://github.com/homebridge/homebridge/wiki) | HomeKit Bridge | Required ab v3.0.0 |
-| [Config UI X](https://github.com/homebridge/homebridge-config-ui-x) | [Config UI X Wiki](https://github.com/homebridge/homebridge-config-ui-x/wiki) | Homebridge Web User Interface | Required ab v3.0.0|
+| [Homebridge v2.0.0](https://github.com/homebridge/homebridge) | [Homebridge Wiki](https://github.com/homebridge/homebridge/wiki) | HomeKit Bridge | Required |
+| [Homebridge UI <= v5.5.0](https://github.com/homebridge/homebridge-config-ui-x) | [Homebridge UI Wiki](https://github.com/homebridge/homebridge-config-ui-x/wiki) | Homebridge Web User Interface | Required |
 | [MELCloud](https://github.com/grzegorz914/homebridge-melcloud-control) | [Plug-In Wiki](https://github.com/grzegorz914/homebridge-melcloud-control/wiki) | Homebridge Plug-In | Required |
 
 ### About The Plugin
 
 * All devices are detected automatically.
-* Control devices over MELCloud server.
+* Control devices over MELCloud and MELCloud Home.
 * Support multiple accounts, buildings, floors, areas.
 * Support temperature display units `Celsius/Fahrenheit`.
 * Support assing inividual operating mode for `Heat/Cool/Auto`.
@@ -76,6 +76,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
       * Presets `ACTIV/UNACTIV`.
       * Room temperature.
       * Outdoor temperature.
+      * Error
 * Heat Pump:
   * Heater Cooler:
     * Heat Pump:
@@ -124,6 +125,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
       * Water tank temperature.
       * Flow Temperature Zone 1, 2, Hot Water.
       * Return Temperature Zone 1, 2, Hot Water.
+      * Error
 * Energy Recovery Ventilation Lossnay:
   * Heater Cooler:
     * Power `ON/OFF`.
@@ -153,6 +155,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
       * Filter maintenance.
       * CO2 detected and level.
       * PM2.5 air quality and level.
+      * Error
 
 ### HOME app current device mode display
 
@@ -187,7 +190,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 ### Configuration
 
 * Run this plugin as a [Child Bridge](https://github.com/homebridge/homebridge/wiki/Child-Bridges) (Highly Recommended), this prevent crash Homebridge if plugin crashes.
-* Install and use [Homebridge Config UI X](https://github.com/homebridge/homebridge-config-ui-x/wiki) to configure this plugin, required for version v3 and above.
+* Install and use [Homebridge UI <= v5.5.0](https://github.com/homebridge/homebridge-config-ui-x/wiki) to configure this plugin.
 * The `sample-config.json` can be edited and used as an alternative.
 
 <p align="center">
@@ -207,13 +210,13 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `user` | Here set the account username. |
 | `passwd` | Here set the account password. |
 | `language` | Here select the account language. |
-| `displayMode` | Here select the account type `None/Disabled`, `MELCloud`, `MELCloud Home`. |
+| `type` | Here select the account type `None/Disabled`, `MELCloud`, `MELCloud Home`. |
 | `ataDevices[]` | Array of ATA devices created automatically after login to MELCloud from plugin config UI. |
 | `ataDevices[].id` | Read only data, do not change it. |
 | `ataDevices[].type` | Read only data, do not change it. |
 | `ataDevices[].typeString` | Read only data, do not change it. |
 | `ataDevices[].name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
-| `ataDevices[].displayMode` | Here select device control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
+| `ataDevices[].displayType` | Here select device control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
 | `ataDevices[].heatDryFanMode` | Here select the operatiing mode for `Heat`, if this mode is not supported, it will be disabled. |
 | `ataDevices[].coolDryFanMode` | Here select the operatiing mode for `Cool`, if this mode is not supported, it will be disabled. |
 | `ataDevices[].autoDryFanMode` | Here select the operatiing mode for `Auto`, if this mode is not supported, it will be disabled.. |
@@ -234,7 +237,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `atwDevices[].type` | Read only data, do not change it. |
 | `atwDevices[].typeString` | Read only data, do not change it. |
 | `atwDevices[].name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
-| `atwDevices[].displayMode` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
+| `atwDevices[].displayType` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
 | `atwDevices[].hideZone` | Here select which zone need to be hidden `None/Disabled`, `Heat Pump`, `Heat Pump / Zone 1`, `Heat Pump / Zone 1 / Hot Water`, `Heat Pump / Zone 1 / Zone 2`, `Heat Pump / Hot Water`,`Heat Pump / Hot Water / Zone 2`, `Heat Pump / Zone 2`, `Zone 1`, `Zone 1 / Hot Water`, `Zone 1 / Hot Water / Zone 2`, `Zone 1 / Zone 2`, `Hot Water`, `Hot Water / Zone 2`, `Zone 2`, `All`. |
 | `atwDevices[].temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
 | `atwDevices[].temperatureSensorFlow` | This enable extra `Flow` temperature sensors to use with automations in HomeKit app. |
@@ -260,7 +263,7 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `ervDevices[].type` | Read only data, do not change it. |
 | `ervDevices[].typeString` | Read only data, do not change it. |
 | `ervDevices[].name` | Here You can schange the `Accessory Name` which is exposed to the `Homebridge/HomeKit`. |
-| `ervDevices[].displayMode` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
+| `ervDevices[].displayType` | Here select main control mode `None/Disabled`, `Heater/Cooler`, `Thermostat`. |
 | `ervDevices[].temperatureSensor` | This enable extra `Room` temperature sensors to use with automations in HomeKit app. |
 | `ervDevices[].temperatureSensorOutdoor` | This enable extra `Outdoor` temperature sensors to use with automations in HomeKit app. |
 | `ervDevices[].temperatureSensorSupply` | This enable extra `Supply` temperature sensors to use with automations in HomeKit app. |
@@ -277,21 +280,19 @@ Homebridge plugin for Air Conditioner, Heat Pump and Energy Recovery Ventilation
 | `refreshInterval` | Here set the background account data refresh time in (sec), default `120s`. |
 | `log{}` | Log object. |
 | `log.deviceInfo` | If enabled, log device info will be displayed by every connections device to the network. |
-| `log.sSuccess` | If enabled, success log will be displayed in console. |
+| `log.success` | If enabled, success log will be displayed in console. |
 | `log.info` | If enabled, info log will be displayed in console. |
 | `log.warn` | If enabled, warn log will be displayed in console. |
 | `log.error` | If enabled, error log will be displayed in console. |
 | `log.debug` | If enabled, debug log will be displayed in console. |
 | `restFul{}` | RSTful object. |
 | `restFul.enable` | If enabled, RESTful server will start automatically and respond to any path request. |
-| `restFul.debug` | If enabled, deep log will be present in homebridge console for RESTFul server. |
 | `mqtt{}` | MQTT object. |
 | `mqtt.enable` | If enabled, MQTT Broker will start automatically and publish all awailable PV data. |
 | `mqtt.host` | Here set the `IP Address` or `Hostname` for MQTT Broker. |
 | `mqtt.port` | Here set the `Port` for MQTT Broker, default 1883. |
 | `mqtt.clientId` | Here optional set the `Client Id` of MQTT Broker. |
 | `mqtt.prefix` | Here set the `Prefix` for `Topic` or leave empty. |
-| `mqtt.debug` | If enabled, deep log will be present in homebridge console for MQTT. |
 | `mqtt.auth{}` | MQTT authorization object. |
 | `mqtt.auth.enable` | Here enable authorization for MQTT Broker. |
 | `mqtt.auth.user` | Here set the MQTT Broker user. |