homebridge-gree-ac 1.0.2 → 2.0.0

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## [2.0.0] - 2023-10-26
+
+Homebridge platform plugin. **_homebridge-gee-ac_**
+
+**Don't forget to reconfigure the plugin and re-set-up scenes and automations in Home App if upgraded from earlier version!**
+
+### Major changes
+
+- Completly rewritten from the base as a platform plugin
+- This is the successor of the original platform plugin _@eibenp/homebridge-gree-airconditioner_ which is now obsolete on that name
+
+## [1.0.x]
+
+All 1.0.x versions are now obsolete
+
+- Original accessory plugin _homebridge-gee-ac_ maintained by _duculete_
+- Original platform plugin _@eibenp/homebridge-gree-airconditioner_ maintained by _eibenp_

package/LICENSE

@@ -1,21 +1,176 @@
-MIT License
-
-Copyright (c) 2018 Alexandru Dragoescu
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -1,42 +1,180 @@
-# Control Gree Air Conditioning with homekit
-
-This plugins is based on Gree HVAC MQTT bridge (https://github.com/arthurkrupa/gree-hvac-mqtt-bridge).
-
-## Requirements 
-- NodeJS (>=8.9.3) with NPM
-- An MQTT broker and Gree smart HVAC device on the same network
-
-You need a mqtt server to read the ambient temperature. You can use an ESP8266 with DHTXX sensor and post temperature value to a topic in a mqtt server. That should be the temperature on the room where the AC is installed.
-
-For each AC device you need to add an accesory and specify the IP address of the device (and mqtt topic to read the ambient temperature).
-
-## Usage Example:
-```
-{
-    "bridge": {
-        "name": "Homebridge",
-        "username": "CC:22:3D:E3:CE:30",
-        "port": 51826,
-        "pin": "123-45-568"
-    },
-    "accessories": [
-        {
-            "accessory": "GreeAC",
-            "host": "192.168.1.X",
-            "name": "Office AC",
-            "updateInterval": 10000,
-            "mqttUrl": "mqtt://127.0.0.1",
-            "currentTempTopic": "home/office/temperature"
-        },
-        {
-            "accessory": "GreeAC",
-            "host": "192.168.1.Y",
-            "name": "Bedroom AC",
-            "updateInterval": 10000,
-            "mqttUrl": "mqtt://127.0.0.1",
-            "currentTempTopic": "home/bedroom/temperature"
-        }
-    ]
-}
-```
-
+[![npm](https://badgen.net/npm/v/homebridge-gree-ac/latest?icon=npm&label)](https://www.npmjs.com/package/homebridge-gree-ac)
+[![npm](https://badgen.net/npm/dt/homebridge-gree-ac?label=downloads)](https://www.npmjs.com/package/homebridge-gree-ac)
+[![Donate](https://badgen.net/badge/donate/paypal/yellow)](https://paypal.me/eibenp)
+
+> _*** Breaking changes ***_
+> 
+> Please read the [**Upgrade section**](#upgrade) before upgrading from version earlier than **v2.0.0** !
+
+# Homebridge GREE Air Conditioner Platform Plugin
+
+[Homebridge GREE Air Conditioner Platform Plugin](https://github.com/eibenp/homebridge-gree-airconditioner) is a dynamic platform plugin for [Homebridge](https://github.com/homebridge/homebridge) which allows control of GREE Air Conditioner devices from [Apple's Home app](https://www.apple.com/home-app/). (Make GREE Air Conditioner HomeKit compatible.)
+
+You can add all of your GREE Air Conditioner devices to the Home App by specifying the network broadcast address, and Homebridge will find all connected devices. Each device appears in the Home App as a Heater Cooler device. It is also possible to add a separate Termperature Sensor (if temperature sensor is supported by the physical device). This allows to define automations (e.g. turn on) based on current temperature in the room. Be careful, if the device does not support internal temperature sensor but is added as a separate accessory, Home App will display the target temperature not the measured one. Child accessory does not appear in Home App if physical sensor is not available in the AC unit.
+
+Quiet / Auto / Powerful mode is supported by the fan speed control. Minimum value turns on Quiet mode. Next value is Auto mode. Maximum value is Powerful mode. All other values between them are exact fan speeds (Low, MediumLow**, Medium, MediumHigh**, High)
+
+** these values are supported only on 5-speed units
+
+It is recommended to add all devices to the Homebridge configuration, so that you can control all their parameters. If you don't want to control all of the devices in Home App, then you need to add to the configuration and disable the ones you don't need. Devices are identified by MAC Address (Serial Number). It can be queried using the official [GREE+ mobile app](https://apps.apple.com/us/app/gree/id1167857672). (The app is required to connect the devices to the local WiFi network for the first time.)
+
+xFan function is also supported, but it works automatically if enabled in Homebridge configuration. If xFan is enabled for the device, it is automatically turned on when you select a supported operating mode in Home App. If xFan is disabled, the Home App will not modify its actual setting in any case.
+
+Temperature display units of the physical device can be controlled using the Home App. (Configuration settings are required to be specified always in Degrees Celsius, independently from the display units.)
+
+Vertical swing mode can be turned on/off, but special swing settings can't be controlled using the Home App.
+
+This plugin is designed to be as simple and clear as possible and supports primarily the functions of the Home App's Heater Cooler accessory.
+
+## Requirements
+
+* Node.js (>= 18.15.0 || >= 20.8.0) with NPM
+* Homebridge (>= 1.6.0)
+
+You need to specify the local network broadcast address (192.168.1.255 in many home environments) and it's also recommended to add the device and specify its MAC address (Serial Number) in the configuration file.
+
+It is highly recommended to use static IP addresses for connected devices. Using a dynamic IP address may require a restart of the Homebridge service on an address change to reconnect the device. Most routers offer static DHCP leases. (Please look at your router's documentation!)
+
+## Supported devices
+
+* GREE Air Conditioners with WiFi support
+* May work with other GREE compatible AC units
+
+## Known limitations
+
+This plugin was designed to support the Home App's Heater Cooler functionality using GREE Air Conditioners. Some special features of GREE AC's are not supported natively by Apple and also dismiss support in this plugin.
+* Fan and dry modes are not supported. They may work if set directly on the device until you change operating mode. They can't be turned on using Home App.
+* Lights of the AC unit can't be controlled.
+* Additional device functions (e.g. health mode, sleep, SE) are not supported.
+* Horizontal swing control is not supported, it remains the same as set directly on the device.
+* GREE AC units do not support temperature ranges in auto mode, so temperature ranges have zero length in Home App.
+* GREE AC units are not able to display decimals of temperature values (if set to half a degree, e.g. 21.5 °C, then unit display may not be in sync with temperature set in Home App).
+* Not all half a degree values are supported in °C mode (GREE AC units are designed to support only integer °C and °F values). Unsupported values are automatically updated to the nearest supported values.
+* There is no way to get current heating-cooling state from the AC unit in auto mode, so displayed state in the Home App is based on temperature measurement, but internal sensor is not precise enough to always display the correct state.
+
+## Installation instructions
+
+It is recommended to install the plugin using the graphical user interface of Homebridge ([Homebridge Config UI X](https://www.npmjs.com/package/homebridge-config-ui-x)). You can find the plugin if you search on the Plugins page for GREE Air Conditioner ('GREE AC' or 'homebridge-gree-ac' if you'd like an exact match). It is recommended to configure the plugin using the same GUI controls.
+
+Command line install:
+```
+npm install homebridge-gree-ac -g
+```
+If successfully installed and configured, your devices will appear on the Homebridge GUI Accessories page and also in Home App (if Homebridge is already connected to the Home App). (If the additional temperature sensor is enabled, then 2 items will be displayed for supported devices (Heater Cooler and Temperature Sensor).)
+
+## Upgrade
+
+There is no clean way to update the plugin to release v2.0.0 or later if you are using an older version (v1.x.x). You need to remove and reinstall the plugin during upgrade.
+
+### Upgrade steps
+
+1. Check out your current settings in Homebridge and also in Homekit (including scenes and automation rules)
+2. Uninstall the old version (this will remove all settings also)
+3. Install the new version
+4. Configure plugin in Homebridge
+5. Assign accessories to rooms and recreate scenes and automations in Homekit
+
+## Example configuration
+_Only the relevant part of the configuration file is displayed:_
+```
+    "platforms": [
+        {
+            "name": "Gree Air Conditioner",
+            "platform": "GREEAirConditioner",
+            "port": 7002,
+            "scanAddress": "192.168.1.255",
+            "scanCount": 10,
+            "scanTimeout": 5,
+            "devices": [
+                {
+                    "mac": "502cc6000000",
+                    "name": "Living room AC",
+                    "model": "Pulse 3.2kW GWH12AGB-K6DNA1A/I",
+                    "speedSteps": 5,
+                    "statusUpdateInterval": 10,
+                    "sensorOffset": 40,
+                    "minimumTargetTemperature": 16,
+                    "maximumTargetTemperature": 30,
+                    "xFanEnabled": true,
+                    "temperatureSensor": "disabled",
+                    "disabled": false
+                }
+            ]
+        }
+    ]
+```
+* name - Unique name of the platform plugin
+* platform - **GREEAirConditioner** (fixed name, it identifies the plugin)
+* port - free UDP port (homebridge will use this port for network communication; it is recommended to select a port which is not used and the next 256 ports are also available because devices will be bound to a separate port based on the last part of the device's IPv4 address and the port specified in the configuration)
+* scanAddress - local network broadcast address (some network knowledge is required to determine this address; in many cases its default value is 192.168.1.255)
+* scanCount - number of retries for locating devices on the network (minimum 3 retries have to be specified)
+* scanTimeout - time period in seconds between device query retries
+* devices - devices should be listed in this block (specify as many devices as you have on your network)
+* mac - MAC address (Serial Number) of the device
+* name - custom name of the device (optional)
+* model - model name, information only (optional)
+* speedSteps - fan speed steps of the unit (valid values are: 3 and 5)
+* statusUpdateInterval - device status will be refreshed based on this interval (in seconds)
+* sensorOffset - device temperature sensor offset value for current temperature calibration (default is 40 °C, must be specified in Degrees Celsius)
+* minimumTargetTemperature - minimum target temperature accepted by the device (default is 16 °C, must be specified in Degrees Celsius, valid values: 16-30)
+* maximumTargetTemperature - maximum target temperature accepted by the device (default is 30 °C, must be specified in Degrees Celsius, valid values: 16-30)
+* xFanEnabled - automatically turn on xFan functionality in supported device modes (xFan actual setting is not modified by the Home App if disabled)
+* temperatureSensor - control additional temperature sensor accessory in Home App (disabled = do not add to Home App / child = add as a child accessory / separate = add as a separate (independent) accessory)
+* disabled - set to true if you do not want to control this device in the Home App (old devices can be removed using this parameter)
+
+![Homebridge UI](./uiconfig.jpg)
+
+## Tips
+
+### MAC Address in GREE+ mobile app
+
+Open selected device and in the upper right corner select menu symbol:
+
+![AC device](./greedevice.jpg)![MAC Address](./greemac.jpg)
+
+### Network broadcast address
+
+All devices on the local network use the same broadcast address. The broadcast address can be calculated from the IP address and the subnet mask of any device which is connected to the LAN. (E.g. your router or computer) You can find several online calculators which help to determine the broadcast address.
+
+On Unix-like systems you can query the broadcast address using the following command:
+```bash
+ifconfig | grep broadcast
+# result
+# inet 192.168.1.10 netmask 0xffffff00 broadcast 192.168.1.255
+```
+On Windows there is no easy way to read the broadcast address. You can query the IP address and the subnet mask using the following command:
+```cmd
+ipconfig
+# result
+# IPv4 Address. . . . . . . . . . . : 192.168.1.10
+# Subnet Mask . . . . . . . . . . . : 255.255.255.0
+# Default Gateway . . . . . . . . . : 192.168.1.254
+```
+
+### Device settings
+
+Some settings are initialized by Home App only once (when enabling the device). They can only be changed by disabling and re-enabling the device. The following settings are affected:
+
+* name
+* model
+* speedSteps
+* minimumTargetTemperature
+* maximumTargetTemperature
+
+### Temperature display units
+
+Home App allows to set the device temperature display units but it is independent from the temperature units shown in Home App. Home App always displays temperature values as specified by iOS/MacOS (can be changed in Preferences / Regional settings section). Display unit conversion is made by the Home App device.
+
+### Temperature measurement
+
+Temperature measurement is not perfect if using the built-in sensor. It is highly affected by current operation and can differ from actual temperature of other places in the room. It is recommended to use a sperarate temperature sensor and place it not too close to the AC unit.
+
+## Refs & Credits
+
+Special thanks to [tomikaa87](https://github.com/tomikaa87) and [kongkx](https://github.com/kongkx) for GREE network protocol information and code samples.
+
+- [homebridge-gree-air-conditioner](https://github.com/kongkx/homebridge-gree-air-conditioner)
+- [gree-remote](https://github.com/tomikaa87/gree-remote)
+- [homebridge-gree-heatercooler](https://github.com/ddenisyuk/homebridge-gree-heatercooler)
+- [Homebridge API](https://developers.homebridge.io/)
+- [Homebridge Platform Plugin Template](https://github.com/homebridge/homebridge-plugin-template)