Merge branch 'develop' into feat/intelligent-device-change-repair-notice

BottlecapDave · BottlecapDave · commit 425e4918fbec · 2025-08-25T08:03:51.000+01:00
diff --git a/.github/actions/setup-python/action.yml b/.github/actions/setup-python/action.yml
@@ -0,0 +1,28 @@
+name: Setup python environment
+description: Sets up required python environment, and caches dependencies
+inputs:
+  python-version:
+    description: 'Python version to use'
+    required: true
+runs:
+  using: composite
+  steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+    - name: Display Python version
+      run: python3 -c "import sys; print(sys.version)"
+      shell: bash
+    - name: Cache pip
+      uses: actions/cache@v4
+      with:
+        path: |
+          ~/.cache/pip
+        key: ${{ runner.os }}-${{ inputs.python-version }}-pip-${{ hashFiles('**/requirements*.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ inputs.python-version }}-pip-
+    - name: Install Python modules
+      run: |
+        pip install -r requirements.test.txt
+      shell: bash
diff --git a/.github/actions/setup/action.yml b/.github/actions/setup/action.yml
@@ -4,11 +4,7 @@ runs:
   using: composite
   steps:
     - name: Install dependencies
-      run: sudo apt install libffi-dev libncurses5-dev zlib1g zlib1g-dev libssl-dev libreadline-dev libbz2-dev libsqlite3-dev
+      run: sudo apt install libffi-dev libncurses5-dev zlib1g zlib1g-dev libssl-dev libreadline-dev libbz2-dev libsqlite3-dev liblzma-dev
       shell: bash
     - name: asdf_install
-      uses: asdf-vm/actions/install@v3
-    - name: Install Python modules
-      run: |
-        pip install -r requirements.test.txt
-      shell: bash
+      uses: asdf-vm/actions/install@v4
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -36,7 +36,7 @@ jobs:
             mkdocs-material-
       - run: pip install -r requirements.txt
       - run: mkdocs build
-  
+
   deploy_docs:
     if: ${{ github.repository_owner == 'BottlecapDave' && (github.event_name == 'workflow_dispatch' || github.ref == 'refs/heads/main') }}
     name: Deploy docs
@@ -50,7 +50,7 @@ jobs:
           sparse-checkout: |
             _docs
       - name: asdf_install
-        uses: asdf-vm/actions/install@v3
+        uses: asdf-vm/actions/install@v4
       - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
       - uses: actions/cache@v4
         with:
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -41,31 +41,47 @@ jobs:
     if: ${{ github.event_name != 'schedule' || github.repository_owner == 'BottlecapDave' }}
     name: Unit Tests
     runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup
         uses: ./.github/actions/setup
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
       - name: Run unit tests
         run: |
-          python -m pytest tests/unit
+          python3 -m pytest tests/unit
   integration_tests:
     # Tests are geared towards my account, so ignore for others
     if: ${{ github.repository_owner == 'BottlecapDave' && github.repository_owner == github.actor }}
     name: Integration Tests
     runs-on: ubuntu-latest
+    timeout-minutes: 15
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Setup
         uses: ./.github/actions/setup
+      - name: Setup Python environment
+        uses: ./.github/actions/setup-python
+        with:
+          python-version: ${{ matrix.python-version }}
       - name: Run integration tests
         run: |
-          python -m pytest tests/integration
+          python3 -m pytest tests/integration
         env:
           API_KEY: ${{ secrets.OCTOPUS_ENERGY_API_TOKEN }}
           GAS_MPRN: ${{ secrets.OCTOPUS_ENERGY_GAS_MPRN }}
@@ -76,7 +92,7 @@ jobs:
   release:
     name: Release
     if: ${{ github.repository_owner == 'BottlecapDave' && (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/beta') }}
-    needs: 
+    needs:
     - validate
     - unit_tests
     - integration_tests
@@ -87,7 +103,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: asdf_install
-        uses: asdf-vm/actions/install@v3
+        uses: asdf-vm/actions/install@v4
       - name: Install dependencies
         run: npm ci
       - name: Release
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,7 +8,7 @@ We use `asdf` to manage plugins.
 asdf plugin-add nodejs
 asdf plugin-add python
 sudo apt update & sudo apt upgrade
-sudo apt install libffi-dev libncurses5-dev zlib1g zlib1g-dev libssl-dev libreadline-dev libbz2-dev libsqlite3-dev
+sudo apt install libffi-dev libncurses5-dev zlib1g zlib1g-dev libssl-dev libreadline-dev libbz2-dev libsqlite3-dev liblzma-dev
 ```
 
 ## Python
@@ -35,4 +35,4 @@ Integration tests are written utilising `pytest`. To run them
 
 ```bash
 API_KEY=<<OCTOPUS_API_KEY>> python -m pytest tests/integration
-```
+```
diff --git a/_docs/index.md b/_docs/index.md
@@ -51,7 +51,7 @@ Please follow the [setup guide](./setup/account.md) to setup your initial accoun
 
 ### Home Mini
 
-If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blog/octopus-home-mini/), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to check the box next to `I have a Home Mini`. This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
+If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blog/octopus-home-mini/) (you can request one via this link), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to check the box next to `I have a Home Mini`. This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
 
 !!! info
 
@@ -63,7 +63,7 @@ If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blo
 
 ### Home Pro
 
-If you are lucky enough to own an Octopus Home Pro, you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to configure your [Home Pro](./setup/account.md#home-pro). This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
+If you are lucky enough to own an [Octopus Home Pro](https://forum.octopus.energy/t/for-the-pro-user/8453/2352/) (note that is is no longer possible to obtain one), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to configure your [Home Pro](./setup/account.md#home-pro). This will gain [electricity entities](./entities/electricity.md#home-minipro-entities) and [gas entities](./entities/gas.md#home-minipro-entities) which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/).
 
 !!! info
 
diff --git a/_docs/setup/account.md b/_docs/setup/account.md
@@ -4,7 +4,7 @@ Setup is done entirely via the [integration UI](https://my.home-assistant.io/red
 
 ## Home Mini
 
-If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blog/octopus-home-mini/), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to check the box next to `I have a Home Mini`. This will gain the following entities which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/):
+If you are lucky enough to own an [Octopus Home Mini](https://octopus.energy/blog/octopus-home-mini/) (you can request one via this link), you can now receive this data within Home Assistant. When setting up (or editing) your account within Home Assistant, you will need to check the box next to `I have a Home Mini`. This will gain the following entities which can be added to the [energy dashboard](https://www.home-assistant.io/blog/2021/08/04/home-energy-management/):
 
 !!! info
 
@@ -73,7 +73,7 @@ In this scenario only started dispatches will be taken into account for adjustme
 
 ## Home Pro
 
-If you are lucky enough to own an [Octopus Home Pro](https://forum.octopus.energy/t/for-the-pro-user/8453/2352/), you can now receive this data locally from within Home Assistant. 
+If you are lucky enough to own an [Octopus Home Pro](https://forum.octopus.energy/t/for-the-pro-user/8453/2352/) (note that is is no longer possible to obtain one), you can now receive this data locally from within Home Assistant.
 
 !!! warning
 
@@ -128,4 +128,4 @@ Once the API has been configured, you will need to set the address to the IP add
 
 ### Entities
 
-See [entities](../entities/home_pro.md) for more information.
+See [entities](../entities/home_pro.md) for more information.
diff --git a/custom_components/octopus_energy/coordinators/electricity_rates.py b/custom_components/octopus_energy/coordinators/electricity_rates.py
@@ -190,7 +190,7 @@ async def async_refresh_electricity_rates_data(
                                            dispatches_result.dispatches.started,
                                            intelligent_rate_mode)
       
-      _LOGGER.debug(f"Rates adjusted: {new_rates}; dispatches: {dispatches_result.dispatches.to_dict()}")
+      _LOGGER.debug(f"Dispatches refreshed - Rates adjusted: {new_rates}; dispatches: {dispatches_result.dispatches.to_dict()}")
 
       # Sort our rates again _just in case_
       new_rates.sort(key=lambda rate: (rate["start"].timestamp(), rate["start"].fold))
diff --git a/custom_components/octopus_energy/coordinators/intelligent_dispatches.py b/custom_components/octopus_energy/coordinators/intelligent_dispatches.py
@@ -79,42 +79,35 @@ def __init__(self, last_evaluated: datetime, request_attempts: int, dispatches:
     self.requests_current_hour = requests_current_hour
     self.requests_current_hour_last_reset = requests_current_hour_last_reset
 
+def has_dispatch_items_changed(existing_dispatches: list[SimpleIntelligentDispatchItem], new_dispatches: list[SimpleIntelligentDispatchItem]):
+  if len(existing_dispatches) != len(new_dispatches):
+    return True
+
+  if len(existing_dispatches) > 0:
+    for i in range(0, len(existing_dispatches)):
+      if (existing_dispatches[i].start != new_dispatches[i].start or
+          existing_dispatches[i].end != new_dispatches[i].end):
+        return True
+
+  return False
+
 def has_dispatches_changed(existing_dispatches: IntelligentDispatches, new_dispatches: IntelligentDispatches):
   return (
     existing_dispatches.current_state != new_dispatches.current_state or
     len(existing_dispatches.completed) != len(new_dispatches.completed) or
-    (
-      len(existing_dispatches.completed) > 0 and
-      (
-        existing_dispatches.completed[0].start != new_dispatches.completed[0].start or
-        existing_dispatches.completed[-1].start != new_dispatches.completed[-1].start
-      )
-    ) 
-    or
+    has_dispatch_items_changed(existing_dispatches.completed, new_dispatches.completed) or
     len(existing_dispatches.planned) != len(new_dispatches.planned) or
-    (
-      len(existing_dispatches.planned) > 0 and
-      (
-        existing_dispatches.planned[0].start != new_dispatches.planned[0].start or
-        existing_dispatches.planned[-1].start != new_dispatches.planned[-1].start
-      )
-    )
-    or
+    has_dispatch_items_changed(existing_dispatches.planned, new_dispatches.planned) or
     len(existing_dispatches.started) != len(new_dispatches.started) or
-    (
-      len(existing_dispatches.started) > 0 and
-      (
-        existing_dispatches.started[0].start != new_dispatches.started[0].start or
-        existing_dispatches.started[-1].start != new_dispatches.started[-1].start
-      )
-    )
+    has_dispatch_items_changed(existing_dispatches.started, new_dispatches.started)
   )
 
 def merge_started_dispatches(current: datetime,
                              current_state: str,
                              started_dispatches: list[SimpleIntelligentDispatchItem],
                              planned_dispatches: list[IntelligentDispatchItem]):
   new_started_dispatches = clean_previous_dispatches(current, started_dispatches)
+  new_started_dispatches = list(map(lambda item: SimpleIntelligentDispatchItem(item.start, item.end), new_started_dispatches))
 
   if current_state == "SMART_CONTROL_IN_PROGRESS":
     for planned_dispatch in planned_dispatches:
diff --git a/custom_components/octopus_energy/intelligent/__init__.py b/custom_components/octopus_energy/intelligent/__init__.py
@@ -16,10 +16,9 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-def mock_intelligent_dispatches() -> IntelligentDispatches:
+def mock_intelligent_dispatches(current_state = "SMART_CONTROL_CAPABLE") -> IntelligentDispatches:
   planned: list[IntelligentDispatchItem] = []
   completed: list[IntelligentDispatchItem] = []
-  current_state = "SMART_CONTROL_CAPABLE"
 
   dispatches = [
     IntelligentDispatchItem(
diff --git a/tests/unit/coordinators/test_async_refresh_intelligent_dispatches.py b/tests/unit/coordinators/test_async_refresh_intelligent_dispatches.py
@@ -841,6 +841,8 @@ async def async_save_dispatches(*args, **kwargs):
     assert len(retrieved_dispatches.dispatches.started) == 0
     assert mock_api_called == True
 
+    assert save_dispatches_called == True
+
 @pytest.mark.asyncio
 async def test_when_retrieved_planned_dispatch_started_and_not_in_boosting_mode_then_started_dispatches_added_to():
   expected_dispatches = IntelligentDispatches("SMART_CONTROL_IN_PROGRESS", [
@@ -896,6 +898,8 @@ async def async_save_dispatches(*args, **kwargs):
     assert retrieved_dispatches.dispatches.started[0].start == current.replace(second=0, microsecond=0)
     assert retrieved_dispatches.dispatches.started[0].end == current.replace(second=0, microsecond=0) + timedelta(minutes=30)
 
+    assert save_dispatches_called == True
+
 @pytest.mark.asyncio
 async def test_when_retrieved_planned_dispatch_started_and_existing_started_dispatch_exists_in_previous_period_then_existing_started_dispatch_extended():
   expected_dispatches = IntelligentDispatches("SMART_CONTROL_IN_PROGRESS", [
@@ -924,7 +928,9 @@ async def async_save_dispatches(*args, **kwargs):
     save_dispatches_dispatches = dispatches
   
   account_info = get_account_info()
-  existing_dispatches = IntelligentDispatchesCoordinatorResult(last_retrieved - timedelta(days=60), 1, mock_intelligent_dispatches(), 1, last_retrieved)
+  existing_dispatches = IntelligentDispatchesCoordinatorResult(last_retrieved - timedelta(days=60), 1, mock_intelligent_dispatches(expected_dispatches.current_state), 1, last_retrieved)
+  existing_dispatches.dispatches.planned = expected_dispatches.planned.copy()
+  existing_dispatches.dispatches.completed = expected_dispatches.completed.copy()
   existing_dispatches.dispatches.started = [
     SimpleIntelligentDispatchItem(
       current.replace(second=0, microsecond=0) - timedelta(minutes=30),
@@ -957,8 +963,10 @@ async def async_save_dispatches(*args, **kwargs):
     assert retrieved_dispatches.dispatches.started[0].start == current.replace(second=0, microsecond=0) - timedelta(minutes=30)
     assert retrieved_dispatches.dispatches.started[0].end == current.replace(second=0, microsecond=0) + timedelta(minutes=30)
 
+    assert save_dispatches_called == True
+
 @pytest.mark.asyncio
-async def test_when_retrieved_planned_dispatch_started_and_existing_started_dispatch_exists_not_in_previous_period_then_existing_started_dispatch_extended():
+async def test_when_retrieved_planned_dispatch_started_and_existing_started_dispatch_exists_not_in_previous_period_then_existing_started_dispatch_not_extended():
   expected_dispatches = IntelligentDispatches("SMART_CONTROL_IN_PROGRESS", [
     IntelligentDispatchItem(
       current - timedelta(minutes=1),
@@ -1021,6 +1029,8 @@ async def async_save_dispatches(*args, **kwargs):
     assert retrieved_dispatches.dispatches.started[1].start == current.replace(second=0, microsecond=0)
     assert retrieved_dispatches.dispatches.started[1].end == current.replace(second=0, microsecond=0) + timedelta(minutes=30)
 
+    assert save_dispatches_called == True
+
 @pytest.mark.asyncio
 async def test_when_existing_started_dispatches_more_than_three_days_old_then_old_started_dispatches_removed():
   expected_dispatches = IntelligentDispatches("SMART_CONTROL_IN_PROGRESS", [
@@ -1080,4 +1090,6 @@ async def async_save_dispatches(*args, **kwargs):
 
     assert len(retrieved_dispatches.dispatches.started) == 1
     assert retrieved_dispatches.dispatches.started[0].start == current.replace(second=0, microsecond=0)
-    assert retrieved_dispatches.dispatches.started[0].end == current.replace(second=0, microsecond=0) + timedelta(minutes=30)
+    assert retrieved_dispatches.dispatches.started[0].end == current.replace(second=0, microsecond=0) + timedelta(minutes=30)
+
+    assert save_dispatches_called == True
