Skip to content

Commit

Permalink
Adding a proper readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cjaliaga committed Aug 30, 2022
1 parent d6c9df2 commit 4c4aff2
Showing 1 changed file with 72 additions and 1 deletion.
73 changes: 72 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,72 @@
# home-assistant-aquarea
# Manage Panasonic Aquarea Smart Cloud devices from Home Assistant

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-41BDF5.svg)](https://github.com/hacs/integration)
![GitHub Release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/cjaliaga/home-assistant-aquarea?include_prereleases)

Panasonic Aquarea Smart Cloud is a cloud service that allows you to control your Panasonic Aquarea heat pump from your smartphone. This integration allows you to control your heat pump from Home Assistant.

The integration uses [aioaquarea](https://github.com/cjaliaga/aioaquarea) to communicate with the Panasonic Aquarea Smart Cloud service.

This integration is currently in beta. Please report any issues you find and any feedback you may have. Thanks!

**⚠️ Make sure to read the 'Remarks' and 'Warning' sections**

## Features
* Climate entity per device zone that allows you to control the operation mode and read the current temperature of the device/zone.
* Sensor entity for the outdoor temperature.
* Water heater entity for the hot water tank (if the device has one).
* Diagnostic sensor to indicate if the device has any problem (such not enough water flow).

## Features in the works
* Consumption sensors.
* Weekly schedule.
* Set the device in eco mode/quiet mode/holiday mode (if the device supports it).
* Set the device in away mode (if the device supports it).
* Investigate if it's possible to set target temperature for the zone on devices that support it.


## Remarks
Panasonic only allows one connection per account at the same time. This means that if you open the session from the Panasonic Confort Cloud app or the Panasonic Confort Cloud website, the session will be closed and you will be disconnected from Home Assistant. The integration will try to reconnect automatically, clossing the session from the app or the website. If you want to use the app or the website, you will have to temporarily disable the integration.

## Installation

### Using [HACS](https://hacs.xyz/) (recommended)

- Copy this repo URL

- Go to HACS > Integrations > 3 dots > Custom repositories
- On the "Repository" field put the URL copied before
- On the "Category" select "Integration"
- Click the "Download" button and download latest version.
- Restart Home Assistant
- Click this button >>
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=aquarea)
- or Go to "Settings" >> "Devices & Services", click "+ ADD INTEGRATION" and select "Aquarea Smart Cloud"

- Follow the configuration steps. You'll need to provide your Panasonic ID and your password. The integration will discover the devices associated to your Panasonic ID.

### Manual installation
- Copy the folder named `aquarea` from the [latest release](https://github.com/cjaliaga/home-assistant-aquarea/releases/latest) to the `custom_components` folder in your config folder.
- Restart HA
- Click this button >>
[![Open your Home Assistant instance and start setting up a new integration.](https://my.home-assistant.io/badges/config_flow_start.svg)](https://my.home-assistant.io/redirect/config_flow_start/?domain=aquarea)
- or Go to "Settings" >> "Devices & Services", click "+ ADD INTEGRATION" and select "Aquarea Smart Cloud"

- Follow the configuration steps. You'll need to provide your Panasonic ID and your password. The integration will discover the devices associated to your Panasonic ID.

## Warning
This integration is currently in beta. It supports several devices but it has been tested with a single device. If you have multiple devices under the same Panasonic ID, please test it and report any issue you find.

The integration also supports devices with several zones, but it has not been tested with multiple zones. If you have a device with multiple zones, please test it and report any issue you find.

The integration has been tested with a heat pump with a hot water tank, but it has not been tested with a heat pump without a hot water tank. If you have a heat pump without a hot water tank, please test it and report any issue you find.

My device currently doesn't allow to set temperatures for the zone (it only allows to set the operation mode). If your device allows to set temperatures, please contact me so I can add support for it.

## Disclaimer

THIS PROJECT IS NOT IN ANY WAY ASSOCIATED WITH OR RELATED TO PANASONIC. The information here and online is for educational and resource purposes only and therefore the developers do not endorse or condone any inappropriate use of it, and take no legal responsibility for the functionality or security of your devices.

## Acknowledgements and alternatives

Big thanks to [ronhks](https://github.com/ronhks) for his awesome work on the [Panasonic Aquaera Smart Cloud integration with MQTT](https://github.com/ronhks/panasonic-aquarea-smart-cloud-mqtt). You can use his integration if you want to use MQTT instead.

0 comments on commit 4c4aff2

Please sign in to comment.