adding proper logging through the HA logging framework

Author: Balazs H

custom_components/daikin_residential_altherma/climate.py

@@ -84,7 +84,7 @@ class DaikinClimate(ClimateEntity):
 
     def __init__(self, device):
         """Initialize the climate device."""
-        print("DAMIANO Initializing CLIMATE...")
+        _LOGGER.info("DAMIANO Initializing CLIMATE...")
         self._device = device
         self._list = {
             ATTR_HVAC_MODE: list(HA_HVAC_TO_DAIKIN),
@@ -106,7 +106,7 @@ def __init__(self, device):
             if support_preset:
                 self._supported_preset_modes.append(mode)
                 self._supported_features |= SUPPORT_PRESET_MODE
-            print("DAMIANO support_preset_mode {}: {}".format(mode,support_preset))
+            _LOGGER.info("DAMIANO support_preset_mode {}: {}".format(mode,support_preset))
 
     async def _set(self, settings):
         """Set device settings using API."""

custom_components/daikin_residential_altherma/device.py

@@ -166,7 +166,7 @@ def getDescription(self):
 
     def getLastUpdated(self):
         """Get the timestamp when data were last updated."""
-        print("DAMIANO {}: LAST UPDATE DEVICE".format(self))
+        _LOGGER.info("DAMIANO {}: LAST UPDATE DEVICE".format(self))
         return self.desc["lastUpdateReceived"]
         # return new Date(self.desc.lastUpdateReceived)
 
@@ -231,7 +231,7 @@ def get_data(self, managementPoint=None, dataPoint=None, dataPointPath=""):
 
     def get_value(self, managementPoint=None, dataPoint=None, dataPointPath=""):
         """Get the current value of a data object."""
-        print("  DAMIANO Get the current value of: {}-{}-{}".format(managementPoint,dataPoint,dataPointPath))
+        _LOGGER.info("  DAMIANO Get the current value of: {}-{}-{}".format(managementPoint,dataPoint,dataPointPath))
         data = self.get_data(managementPoint, dataPoint, dataPointPath)
         if data is None:
             return None
@@ -250,25 +250,25 @@ async def updateData(self):
         return
         # TODO: Enhance self method to also allow to get some partial data
         # like only one managementPoint or such; needs checking how to request
-        print("DEV UPDATE " + self.name)
+        _LOGGER.info("DEV UPDATE " + self.name)
         desc = await self.api.doBearerRequest("/v1/gateway-devices/" + self.getId())
         self.setJsonData(desc)
-        print("DEVICE: " + self.name)
-        print(
+        _LOGGER.info("DEVICE: " + self.name)
+        _LOGGER.info(
             "    temp: inner "
             + str(self.get_value("climateControl", "sensoryData", "/roomTemperature"))
             + " outer "
             + str(
                 self.get_value("climateControl", "sensoryData", "/outdoorTemperature")
             )
         )
-        print(
+        _LOGGER.info(
             "    current mode: "
             + str(self.get_value("climateControl", "operationMode"))
             + "  "
             + str(self.get_value("climateControl", "onOffMode"))
         )
-        print(
+        _LOGGER.info(
             "    target temp: "
             + str(
                 self.get_value(
@@ -278,7 +278,7 @@ async def updateData(self):
                 )
             )
         )
-        print(
+        _LOGGER.info(
             "    FAN: mode [{}] speed [{}]\n".format(
                 self.get_value(
                     "climateControl",

custom_components/daikin_residential_altherma/sensor.py

@@ -264,7 +264,7 @@ def factory(device: Appliance, monitored_state: str, type, period=""):
             }[SENSOR_TYPES[monitored_state][CONF_TYPE]]
             return cls(device, monitored_state,type, period)
         except Exception as error:
-            print("error: " + error)
+            # print("error: " + error)
             _LOGGER.error("%s", format(error))
             return
 
@@ -285,7 +285,7 @@ def __init__(self, device: Appliance, monitored_state: str, type,  period="") ->
                 #self._name = f"{device.name} TANK {self._sensor[CONF_NAME]}"
                 self._name = f"{device.name} {self._sensor[CONF_NAME]}"
         self._device_attribute = monitored_state
-        print("  DAMIANO Initialized sensor: {}".format(self._name))
+        _LOGGER.info("  DAMIANO Initialized sensor: {}".format(self._name))
 
     @property
     def available(self):

custom_components/daikin_residential_altherma/switch.py

@@ -36,7 +36,7 @@ async def async_setup_entry(hass, entry, async_add_entities):
         for switch in switches:
 
             if device.support_preset_mode(switch):
-                print("DAMIANO Adding Switch {}".format(switch))
+                _LOGGER.info("DAMIANO Adding Switch {}".format(switch))
                 async_add_entities([DaikinSwitch(device, switch)])
 
 
@@ -89,15 +89,15 @@ def device_info(self):
 
     async def async_update(self):
         """Retrieve latest state."""
-        print("DAMIANO {}: ASINC UPDATE SWITCH".format(self))
+        _LOGGER.info("DAMIANO {}: ASYNC UPDATE SWITCH".format(self))
         await self._device.api.async_update()
 
     async def async_turn_on(self, **kwargs):
         """Turn the zone on."""
-        print("DAMIANO {}: SWITCH TO {}".format(self._switch_id, ATTR_STATE_ON))
+        _LOGGER.info("DAMIANO {}: SWITCH TO {}".format(self._switch_id, ATTR_STATE_ON))
         await self._device.set_preset_mode_status(self._switch_id, ATTR_STATE_ON)
 
     async def async_turn_off(self, **kwargs):
         """Turn the zone off."""
-        print("DAMIANO {} SWITCH TO: {}".format(self._switch_id, ATTR_STATE_ON))
+        _LOGGER.info("DAMIANO {} SWITCH TO {}".format(self._switch_id, ATTR_STATE_ON))
         await self._device.set_preset_mode_status(self._switch_id, ATTR_STATE_OFF)

readme.md

@@ -14,7 +14,7 @@ Make sure to 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.
+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. Then you have to restart Home Assistant for the component to be loaded properly.
 
 # Using config flow
 
@@ -32,6 +32,24 @@ daikin_residential_altherma:
   password: [your_pwd]
 ```
 
+# Setting the log level
+
+If you'd like to see more granular logs, to investigate the communication or for other debugging purposes, you can set the log level in the Home Assistant config. The following lines can be added to set the overall log level for the component:
+
+```
+logger:
+  logs:
+    custom_components.daikin_residential_altherma: debug
+```
+
+If you only want to change log level on a per module basis, you can do that as well, for example if you only want debug logs for the climate:
+
+```
+logger:
+  logs:
+    custom_components.daikin_residential_altherma.climate: debug
+```
+
 # 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.