Clean code, License and readme documentation.

Author: speleolontra

.gitignore

@@ -9671,3 +9671,4 @@ deps/share/man/man1/moggsplit.1
 deps/share/man/man1/mutagen-inspect.1
 deps/share/man/man1/mutagen-pony.1
 custom_components/hacs/validate/README.md
+custom_components/daikin_residential_altherma/NOTELONTRA.txt

LICENSE.TXT

@@ -2,9 +2,6 @@
  * * * * * * INSERIMENTO DI UN NUOVO SENSORE  * * * * * * 
 
 
- 
-
-
 1) const.py: Aggiungere una costante ATTR battezzandone il nuovo nome, es:
 
 

custom_components/daikin_residential_altherma/NOTELONTRA.txt

@@ -15,7 +15,6 @@
 _LOGGER = logging.getLogger(__name__)
 
 ENTRY_IS_SETUP = "daikin_entry_is_setup"
-_LOGGER.debug("DAMIANO daikin_entry_is_setup")
 
 PARALLEL_UPDATES = 0
 

custom_components/daikin_residential_altherma/__init__.py

@@ -23,29 +23,6 @@
 DAIKIN_DEVICES = "daikin_devices"
 DAIKIN_DISCOVERY_NEW = "daikin_discovery_new_{}"
 
-
-#ATTR_ON_OFF = "on_off"
-# ATTR_PRESET_MODE = "preset_mode"
-# ATTR_OPERATION_MODE = "operation_mode"
-# ATTR_TEMPERATURE = "temperature"
-# ATTR_TARGET_TEMPERATURE = "target_temperature"
-# ATTR_INSIDE_TEMPERATURE = "inside_temperature"
-# ATTR_OUTSIDE_TEMPERATURE = "outside_temperature"
-# # ORIG
-# ATTR_ENERGY_CONSUMPTION = "energy_consumption"
-# ATTR_HUMIDITY = "humidity"
-# ATTR_TARGET_HUMIDITY = "target_humidity"
-# ATTR_FAN_MODE = "fan_mode"
-# ATTR_FAN_SPEED = "fan_speed"
-# ATTR_HSWING_MODE = "hswing_mode"
-# ATTR_VSWING_MODE = "vswing_mode"
-# ATTR_SWING_AUTO = "auto"
-# ATTR_SWING_SWING = "swing"
-# ATTR_SWING_STOP = "stop"
-# ATTR_COOL_ENERGY = "cool_energy"
-# ATTR_HEAT_ENERGY = "heat_energy"
-
-
 # MANAGEMENT POINTS
 # ORIG
 #MP_CLIMATE = "climateControl"

custom_components/daikin_residential_altherma/const.py

@@ -42,10 +42,6 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
     """Set up Daikin climate based on config_entry."""
     sensors = []
     prog = 0
-
-    # for dev_id, device in hass.data[DAIKIN_DOMAIN][DAIKIN_DEVICES].items():
-    #     print("DAMIANO %s dev_id = %s", prog, dev_id)
-    #     prog += 1
 
     for dev_id, device in hass.data[DAIKIN_DOMAIN][DAIKIN_DEVICES].items():
         sensor = DaikinSensor.factory(device, ATTR_INSIDE_TEMPERATURE)
@@ -54,30 +50,21 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
 
         if device.support_tank_temperature:
             sensor = DaikinSensor.factory(device, ATTR_TANK_TEMPERATURE)
-            #print("DAMIANO append sensor = %s", sensor)
             sensors.append(sensor)
 
         if device.support_outside_temperature:
-            #print("DAMIANO support_outside_temperature TRUE")
             sensor = DaikinSensor.factory(device, ATTR_OUTSIDE_TEMPERATURE)
-            #print("DAMIANO append2 sensor = %s", sensor)
             sensors.append(sensor)
 
         if device.support_energy_consumption:
-            #print("DAMIANO support_energy_consumption TRUE")
             for period in SENSOR_PERIODS:
-                #print("DAMIANO period = %s", period)
-
                 sensor = DaikinSensor.factory(device, ATTR_COOL_ENERGY, period)
-                #print("DAMIANO append3 sensor = %s", sensor)
                 sensors.append(sensor)
 
                 sensor = DaikinSensor.factory(device, ATTR_HEAT_ENERGY, period)
-                #print("DAMIANO append4 sensor = %s", sensor)
                 sensors.append(sensor)
 
                 sensor = DaikinSensor.factory(device, ATTR_HEAT_TANK_ENERGY, period)
-                #print("DAMIANO append4 sensor = %s", sensor)
                 sensors.append(sensor)
 
     #print("DAMIANO add_entities: %s", sensors)

custom_components/daikin_residential_altherma/sensor.py

@@ -21,8 +21,6 @@
 _LOGGER = logging.getLogger(__name__)
 
 
-
-
 async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
     """Old way of setting up the platform.
 

custom_components/daikin_residential_altherma/switch.py

@@ -2,11 +2,27 @@
 
 This work is inspired from Rospogrigio "daikin_residential" repository (https://github.com/rospogrigio/daikin_residential) and modified to support Daikin Altherma 3 Heat Pump.
 
-# Installation:
+# WARNING
+This is a first experimental release, tested on my Daikin Altherma 3 (BRP069A78) (installed in July 2021) and Home assistant Portable version for Windows.
+The HA Integration was cloned by Rospogrigio's work, i'm not sure at 100% that is correct and i think that this integrations cannot be cannot coexist in the same home assistant. This can be a goal of next releases...
 
-Copy the daikin_residential folder and all of its contents into your Home Assistant's custom_components folder. This is often located inside of your /config folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the custom_components folder might be located at /usr/share/hassio/homeassistant. It is possible that your custom_components folder does not exist. If that is the case, create the folder in the proper location, and then copy the daikin_residential folder and all of its contents inside the newly created custom_components folder.
+# Installation using HACS:
 
-# YAML config files
+Open "HACS" section then "Integrations" and click on three points menu at top right. Click on "custom reporitories" and add "https://github.com/speleolontra/daikin_residential_altherma" as integration category.
+this will copy the "daikin_residential_altherma" folder in the "custom_components" folder of Home Assistant.
+Make sure tu restart home Assistant, then go to "Using config flow" chapter.
+
+# Manual Installation
+
+Copy the "daikin_residential_altherma" folder and all of its contents into your Home Assistant's "custom_components" folder. This is often located inside of your "/config" folder. If you are running Hass.io, use SAMBA to copy the folder over. If you are running Home Assistant Supervised, the "custom_components" folder might be located at "/usr/share/hassio/homeassistant". It is possible that your "custom_components" folder does not exist. If that is the case, create the folder in the proper location, and then copy the "daikin_residential_altherma" folder and all of its contents inside the newly created "custom_components" folder.
+
+# Using config flow
+
+Start by going to Configuration - Integration and pressing the "+ ADD INTEGRATION" button to create a new Integration, then select Daikin Residential Controller in the drop-down menu.
+
+Follow the instructions, you just have to type the email and password used in the Daikin Residential App. After pressing the "Submit" button, the integration will be added, and the Daikin devices connected to your cloud account will be created.
+
+# YAML config files (not tested)
 
 Just add the following lines to your configuration.yaml file specifying the email and password used in the Daikin Residential App, and the Daikin devices connected to your cloud account will be created.
 
@@ -20,3 +36,11 @@ daikin_residential_altherma:
 # Thanks to:
 
 This code is based on @Rospogrigio's work that in turn is based on @Apollon77 's work, in finding a way to retrieve the token set, and to send the HTTP commands over the cloud. This integration would not exist without their precious job, my job was to try and debug Rospogrigio's code to adapt at JSON from Altherma 3 controlled by Daikin Residential App.
+
+# Next steps
+
+- Evaluate an unique integration with @Rospogrigio for both device Air Conditioning and Heat Punp.
+- Better manage of climate entity (Target temperature doesn't exist on Heat Pumps)
+- Insert other read only parameter
+- Way to measure COP and SCOP.
+- other ideas?