Merge pull request #4 from Frankkkkk/moar

Add moar things

.github/workflows/nose2.yaml

@@ -0,0 +1,21 @@
+name: Python unit tests
+
+on:
+  pull_request:
+
+jobs:
+  unittests:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: >-
+        python -m pip install --user --upgrade nose2 websocket-client dpath
+    - name: Unit test
+      run: >-
+        nose2

Pipfile

@@ -9,6 +9,7 @@ websocket-client = "*"
 
 [dev-packages]
 flake8 = "*"
+nose2 = "*"
 
 [requires]
 python_version = "3.10"

README.md

@@ -3,16 +3,36 @@ talks to daikin altherma via LAN adapter BRP069A61 or BRP069A62
 
 # How to use
 ## How to install ?
-Simply type `pip3 install python-daikin-altherma`
+Simply get it from [pypi](https://pypi.org/project/python-daikin-altherma/) by:
+`pip3 install python-daikin-altherma`
 
 ## How to run
 ```python3
 >>> from daikin_altherma import DaikinAltherma
 >>> d = DaikinAltherma('192.168.10.126')
 >>> print(f'My outdoor temperature is {d.outdoor_temperature}°C')
 My outdoor temperature is 2.0°C
+>>> d.print_all_status()
+Daikin adapter: 192.168.11.100 BRP069A61
+Daikin unit: EAVH16S23DA6V 0
+Daikin time: 2023-10-20 18:56:08
+Hot water tank:
+    Current: 48.0°C (target 49.0°C)
+    Heating enabled: True (Powerful: False)
+Heating:
+    Outdoor temp:14.0°C
+    Indoor temp: 21.5°C
+    Heating target: 24.0°C (is heating enabled: True)
+    Leaving water: 29.0°C
+    Heating mode: heating
+    Schedule: {'Mo': {'0000': 18.0, '0600': 20.0, '1200': 22.0, '1500': 20.0, '1800': 18.0}, 'Tu': {'0000': 18.0, '0600': 20.0, '1800': 18.0}, 'We': {'0000': 18.0, '0600': 20.0, '1800': 18.0}, 'Th': {'0000': 18.0, '0600': 20.0, '1200': 22.0, '1500': 20.0, '1800': 18.0}, 'Fr': {'0000': 18.0, '0600': 20.0, '1200': 22.0, '1500': 20.0, '1800': 18.0}, 'Sa': {'0000': 18.0, '0600': 20.0, '1200': 22.0, '1500': 20.0, '1800': 18.0}, 'Su': {'0000': 18.0, '0600': 20.0, '1200': 22.0, '1500': 20.0, '1800': 18.0}}
+
 ```
 
+## Schedules
+You can set schedules using `set_heating_schedule(schedule)`. Your best bet is to
+look at the [example file](example.py).
+
 # Documentation
 ```
     class DaikinAltherma(builtins.object)
@@ -23,50 +43,113 @@ My outdoor temperature is 2.0°C
      |  __init__(self, adapter_ip: str)
      |      Initialize self.  See help(type(self)) for accurate signature.
      |  
-     |  set_heating(self, heating_active: bool)
+     |  print_all_status(self)
+     |  
+     |  set_heating_enabled(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
+     |      You can confirm that it works by calling self.is_heating_enabled
+     |  
+     |  set_heating_schedule(self, schedule: dict[str, dict[str, float]])
+     |      Sets the heating schedule for the heating.
      |  
      |  set_setpoint_temperature(self, setpoint_temperature_c: float)
      |      Sets the heating setpoint (target) temperature, in °C
      |  
-     |  set_tank_heating(self, powerful_active: bool)
+     |  set_tank_heating_enabled(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
+     |      You can confirm that it works by calling self.is_tank_heating_enabled
      |  
      |  ----------------------------------------------------------------------
      |  Readonly properties defined here:
      |  
      |  adapter_model
-     |      Returns the model of the LAN adapter
+     |      Returns the model of the LAN adapter.
+     |      Ex: BRP069A61
+     |  
+     |  heating_mode
+     |      This function name makes no sense, because it
+     |      returns whether the heat pump is heating or cooling.
      |  
      |  indoor_setpoint_temperature
      |      Returns the indoor setpoint (target) temperature, in °C
      |  
      |  indoor_temperature
      |      Returns the indoor temperature, in °C
      |  
+     |  indoor_unit_software_version
+     |      Returns the unit software version
+     |  
+     |  indoor_unit_version
+     |      Returns the unit version
+     |  
+     |  is_heating_enabled
+     |      Returns if the unit heating is enabled
+     |  
+     |  is_tank_heating_enabled
+     |      Returns if the tank heating is currently enabled
+     |  
+     |  is_tank_powerful
+     |      Returns if the tank is in powerful state
+     |  
      |  leaving_water_temperature
      |      Returns the heating leaving water temperature, in °C
      |  
      |  outdoor_temperature
      |      Returns the outdoor temperature, in °C
      |  
+     |  outdoor_unit_software_version
+     |      Returns the unit software version
+     |  
+     |  pin_code
+     |      Returns the pin code of the LAN adapter
+     |  
      |  power_consumption
      |      Returns the energy consumption in kWh per [D]ay, [W]eek, [M]onth
      |  
-     |  power_state
-     |      Returns the power state
+     |  remote_setting_version
+     |      Returns the remote console setting version
+     |  
+     |  remote_software_version
+     |      Returns the remote console setting software version
      |  
-     |  tank_power_state
-     |      Returns the tank power state
+     |  schedule_list_heating
+     |      Returns the Schedule list heating
      |  
-     |  tank_powerful_state
-     |      Returns the tank powerful state
+     |  schedule_next
+     |      What will happen next the temperature
+     |  
+     |  tank_setpoint_temperature
+     |      Returns the hot water tank setpoint (target) temperature, in °C
      |  
      |  tank_temperature
      |      Returns the hot water tank temperature, in °C
      |  
+     |  unit_datetime
+     |      Returns the current date of the unit. Takes time to refresh
+     |  
+     |  unit_model
+     |      Returns the model of the heating unit.
+     |      Ex: EAVH16S23DA6V
+     |  
+     |  unit_type
+     |      Returns the type of unit
+     |  
+     |  ----------------------------------------------------------------------
+     |  Data descriptors defined here:
+     |  
+     |  __dict__
+     |      dictionary for instance variables (if defined)
+     |  
+     |  __weakref__
+     |      list of weak references to the object (if defined)
+     |  
+     |  ----------------------------------------------------------------------
+     |  Data and other attributes defined here:
+     |  
+     |  DAYS = ['Mo', 'Tu', 'We', 'Th', 'Fr', 'Sa', 'Su']
+     |  
+     |  UserAgent = 'python-daikin-altherma'
+
 ```
 
 # Acknowledgments