Skip to content

RobHofmann/HomeAssistant-GreeClimateComponent

Repository files navigation

hacs_badge

HomeAssistant-GreeClimateComponent

Custom Gree climate component written in Python3 for Home Assistant. Controls ACs supporting the Gree protocol.

For a comprehensive list of tested devices, see Supported Devices.

Tested on Home Assistant 2025.6.3

If you are experiencing issues please be sure to provide details about your device, Home Assistant version and what exactly went wrong.

If your HVAC has already been configured to be controlled remotely by an android app, the encryption key might have changed.

To configure HVAC wifi (without the android app): https://github.com/arthurkrupa/gree-hvac-mqtt-bridge#configuring-hvac-wifi

HACS

This component is added to HACS default repository list.

Config Flow - UI Configuration (recommended)

The integration can be added from the Home Assistant UI.

  1. Navigate to Settings > Devices & Services and click Add Integration.
  2. Search for Gree Climate and fill in the desired name, host, port and MAC address.
  3. After setup you can open the integration options to configure additional parameters.
  4. Saving any changes in the options dialog automatically reloads the integration, so new settings take effect immediately without restarting Home Assistant.

Manual Installation

  1. (Skip if using HACS) Copy the custom_components folder to your own hassio /config folder.

  2. YAML Configuration: See manual-configuration.yaml for a complete configuration example with all available options and detailed comments.

    Basic example:

    gree:
      - name: "First AC"
        host: "192.168.1.101"
        mac: "20-FA-BB-12-34-56"
        encryption_version: 2
  3. In your configuration.yaml add the following:

    climate: !include your_configuration.yaml
  4. (Optional) Add info logging to this component (to see if/how it works)

    logger:
      default: error
      logs:
        custom_components.gree: debug
        custom_components.gree.climate: debug
  5. (Optional) Provide encryption key if you have it or feel like extracting it.

    One way is to pull the sqlite db from android device like described here:

    https://stackoverflow.com/questions/9997976/android-pulling-sqlite-database-android-device

    adb backup -f ~/backup.ab -noapk com.gree.ewpesmart
    dd if=data.ab bs=1 skip=24 | python -c "import zlib,sys;sys.stdout.write(zlib.decompress(sys.stdin.read()))" | tar -xvf -
    sqlite3 data.ab 'select privateKey from db_device_20170503;' # but table name can differ a little bit.

    Write it down in climate.yaml: encryption_key: <key>.

    If you are getting an UTF-8 error (like: "UnicodeDecodeError: 'utf-8' codec can't decode byte 0xda in position 1: invalid continuation byte"), see #318.

  6. (Optional) Provide the uid parameter (can be sniffed). This is not needed for all devices.

  7. (Optional) You can set custom icons by modifying the icon translation file icons.json. Refer to this documentation: https://developers.home-assistant.io/docs/core/integration-quality-scale/rules/icon-translations/

Additional Sensors

The integration supports additional sensors if your Gree device has them:

Outside Temperature Sensor

If your AC unit has an outside temperature sensor, it will be automatically detected and exposed as:

  • Climate entity attribute: outside_temperature (accessible via {{ state_attr('climate.your_ac', 'outside_temperature') }})
  • Separate sensor entity: sensor.your_ac_outside_temperature

Humidity Sensor

If your AC unit has a built-in room humidity sensor, it will be automatically detected and exposed as:

  • Climate entity attribute: room_humidity (accessible via {{ state_attr('climate.your_ac', 'room_humidity') }})
  • Separate sensor entity: sensor.your_ac_room_humidity

Available Switches and Controls

The integration exposes various entities to configure additional features of your Gree AC unit. All entities are created by default when the integration is set up, but their availability depends on the current HVAC mode and status. Entity availability may also vary depending on your specific Gree AC model and firmware version. These controls allow you to toggle special modes and adjust settings:

Basic Control Switches

  • X-Fan: Enables or disables the X-Fan mode for extra drying when turning off
  • Lights: Controls the display lights on the air conditioner unit
  • Health: Enables or disables the Health mode for air ionization and purification
  • Beeper: Controls the beeper sounds from the air conditioner unit. When enabled, the unit will make sounds for button presses and status changes

Energy and Comfort Switches

  • Power Save: Enables or disables the power saving mode for energy efficiency. Only available in cooling mode
  • 8°C Heat: Enables or disables the 8°C heating mode for frost protection. Only available in heating mode
  • Sleep: Enables or disables the sleep mode for comfortable overnight operation. Only available in cooling or heating mode
  • Air: Enables or disables the fresh air circulation mode

Advanced Control Switches

  • Anti Direct Blow: Prevents direct air flow from blowing on people by adjusting the air deflector position
  • Light Sensor: Enables or disables light sensor for automatic brightness. Requires lights to be enabled

Configuration Controls

  • Auto X-Fan: Automatically controls the X-Fan mode based on HVAC operations. When enabled, X-Fan will automatically turn on in cooling and dry modes. Note: This is an integration feature, not an actual AC unit state
  • Auto Light: Automatically controls the display lights based on HVAC operations. When enabled, lights will turn on/off with the AC unit. Note: This is an integration feature, not an actual AC unit state
  • Temperature Step: Sets the increment step for adjusting the target temperature. This allows you to configure how much the temperature changes when using the up/down controls in Home Assistant
  • External Temperature Sensor: Select a temperature sensor entity to use instead of the built-in AC sensor. Choose 'None' to use the built-in sensor. This is useful if you have a more accurate room temperature sensor that you want the AC to use for temperature readings

Credits

This project is based on the work of several contributors and projects:

About

Custom Gree climate component written in Python3 for Home Assistant. Controls AC's supporting the Gree protocol.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages