Improve readme

Signed-off-by: Frank Villaro-Dixon <[email protected]>
Frankkkkk · Oct 19, 2023 · 0d992b5 · 0d992b5
1 parent e24d700
commit 0d992b5
Show file tree

Hide file tree

Showing 2 changed files with 53 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -15,39 +15,58 @@ My outdoor temperature is 2.0°C
 
 # Documentation
 ```
-class DaikinAltherma(builtins.object)
- |  DaikinAltherma(adapter_ip: str)
- |  
- |  Methods defined here:
- |  
- |  set_heating(self, heating_active: bool)
- |      Whether to turn the heating on(True) or off(False).
- |      You can confirm that it works by calling self.power_state
- |  
- |  ----------------------------------------------------------------------
- |  Readonly properties defined here:
- |  
- |  adapter_model
- |      Returns the model of the LAN adapter
- |  
- |  indoor_temperature
- |      Returns the indoor temperature, in °C
- |  
- |  leaving_water_temperature
- |      Returns the heating leaving water temperature, in °C
- |  
- |  outdoor_temperature
- |      Returns the outdoor temperature, in °C
- |  
- |  power_consumption
- |      Returns the energy consumption in kWh per [D]ay, [W]eek, [M]onth
- |  
- |  power_state
- |      Returns the power state
- |  
- |  tank_temperature
- |      Returns the hot water tank temperature, in °C
- |  
+    class DaikinAltherma(builtins.object)
+     |  DaikinAltherma(adapter_ip: str)
+     |  
+     |  Methods defined here:
+     |  
+     |  __init__(self, adapter_ip: str)
+     |      Initialize self.  See help(type(self)) for accurate signature.
+     |  
+     |  set_heating(self, heating_active: bool)
+     |      Whether to turn the heating on(True) or off(False).
+     |      You can confirm that it works by calling self.power_state
+     |  
+     |  set_setpoint_temperature(self, setpoint_temperature_c: float)
+     |      Sets the heating setpoint (target) temperature, in °C
+     |  
+     |  set_tank_heating(self, powerful_active: bool)
+     |      Whether to turn the water tank heating on(True) or off(False).
+     |      You can confirm that it works by calling self.tank_powerful_state
+     |  
+     |  ----------------------------------------------------------------------
+     |  Readonly properties defined here:
+     |  
+     |  adapter_model
+     |      Returns the model of the LAN adapter
+     |  
+     |  indoor_setpoint_temperature
+     |      Returns the indoor setpoint (target) temperature, in °C
+     |  
+     |  indoor_temperature
+     |      Returns the indoor temperature, in °C
+     |  
+     |  leaving_water_temperature
+     |      Returns the heating leaving water temperature, in °C
+     |  
+     |  outdoor_temperature
+     |      Returns the outdoor temperature, in °C
+     |  
+     |  power_consumption
+     |      Returns the energy consumption in kWh per [D]ay, [W]eek, [M]onth
+     |  
+     |  power_state
+     |      Returns the power state
+     |  
+     |  tank_power_state
+     |      Returns the tank power state
+     |  
+     |  tank_powerful_state
+     |      Returns the tank powerful state
+     |  
+     |  tank_temperature
+     |      Returns the hot water tank temperature, in °C
+     |  
 ```
 
 # Acknowledgments

diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@ def read(fname):
 
 setup(
     name = "python-daikin-altherma",
-    version = "0.1.0",
+    version = "0.1.1",
     author = "Frank Villaro-Dixon",
     author_email = "[email protected]",
     description = ("Connect to daikin altherma heat pumps"),