[sensibo] Fix potential API throttling at binding start (#17091)

* refactor(sensibo): Utilize field selector in model refresh

Utilize Sensibo's field selector to get all data for all pods in one request and avoid request rate limiting

resolves openhab/openhab-addons#17090

Signed-off-by: Zalan Meggyesi <zmeggyesi@skawa.hu>

diff --git a/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/dto/pods/GetPodsRequest.java b/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/dto/pods/GetPodsRequest.java
index e47614c577e483ce1befdf280865459057656021..f881c53a628cd535888828242ab103a808816e6e 100644 (file)
--- a/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/dto/pods/GetPodsRequest.java
+++ b/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/dto/pods/GetPodsRequest.java
@@ -23,6 +23,6 @@ import org.openhab.binding.sensibo.internal.dto.AbstractRequest;
 public class GetPodsRequest extends AbstractRequest {
     @Override
     public String getRequestUrl() {
-        return "/v2/users/me/pods";
+        return "/v2/users/me/pods?fields=*";
     }
 }

diff --git a/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandler.java b/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandler.java
index 737993425a4ca468ecc9667dfbe3909f673be422..290a3cce711d0e8045dca6fe8a7c687124740c98 100644 (file)
--- a/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandler.java
+++ b/bundles/org.openhab.binding.sensibo/src/main/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandler.java
@@ -44,7 +44,6 @@ import org.openhab.binding.sensibo.internal.dto.poddetails.AcStateDTO;
 import org.openhab.binding.sensibo.internal.dto.poddetails.GetPodsDetailsRequest;
 import org.openhab.binding.sensibo.internal.dto.poddetails.PodDetailsDTO;
 import org.openhab.binding.sensibo.internal.dto.pods.GetPodsRequest;
-import org.openhab.binding.sensibo.internal.dto.pods.PodDTO;
 import org.openhab.binding.sensibo.internal.dto.setacstateproperty.SetAcStatePropertyReponse;
 import org.openhab.binding.sensibo.internal.dto.setacstateproperty.SetAcStatePropertyRequest;
 import org.openhab.binding.sensibo.internal.dto.settimer.SetTimerReponse;
@@ -184,18 +183,12 @@ public class SensiboAccountHandler extends BaseBridgeHandler {
         final SensiboModel updatedModel = new SensiboModel(System.currentTimeMillis());
 
         final GetPodsRequest getPodsRequest = new GetPodsRequest();
-        final List<PodDTO> pods = sendRequest(buildRequest(getPodsRequest), getPodsRequest,
-                new TypeToken<ArrayList<PodDTO>>() {
+        final List<PodDetailsDTO> pods = sendRequest(buildRequest(getPodsRequest), getPodsRequest,
+                new TypeToken<ArrayList<PodDetailsDTO>>() {
                 }.getType());
 
-        for (final PodDTO pod : pods) {
-            final GetPodsDetailsRequest getPodsDetailsRequest = new GetPodsDetailsRequest(pod.id);
-
-            final PodDetailsDTO podDetails = sendRequest(buildGetPodDetailsRequest(getPodsDetailsRequest),
-                    getPodsDetailsRequest, new TypeToken<PodDetailsDTO>() {
-                    }.getType());
-
-            updatedModel.addPod(new SensiboSky(podDetails));
+        for (final PodDetailsDTO pod : pods) {
+            updatedModel.addPod(new SensiboSky(pod));
         }
 
         return updatedModel;

diff --git a/bundles/org.openhab.binding.sensibo/src/test/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandlerTest.java b/bundles/org.openhab.binding.sensibo/src/test/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandlerTest.java
index d43c061d0d556097ce82ef15405a304344087847..169d4c6131b44305342214a8b3cd8fa522586597 100644 (file)
--- a/bundles/org.openhab.binding.sensibo/src/test/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandlerTest.java
+++ b/bundles/org.openhab.binding.sensibo/src/test/java/org/openhab/binding/sensibo/internal/handler/SensiboAccountHandlerTest.java
@@ -89,15 +89,9 @@ public class SensiboAccountHandlerTest {
         // Setup initial response
         final String getPodsResponse = new String(getClass().getResourceAsStream(podsResponse).readAllBytes(),
                 StandardCharsets.UTF_8);
-        stubFor(get(urlEqualTo("/api/v2/users/me/pods?apiKey=APIKEY"))
+        stubFor(get(urlEqualTo("/api/v2/users/me/pods?fields=*&apiKey=APIKEY"))
                 .willReturn(aResponse().withStatus(200).withBody(getPodsResponse)));
 
-        // Setup 2nd response with details
-        final String getPodDetailsResponse = new String(
-                getClass().getResourceAsStream(podDetailsResponse).readAllBytes(), StandardCharsets.UTF_8);
-        stubFor(get(urlEqualTo("/api/v2/pods/PODID?apiKey=APIKEY&fields=*"))
-                .willReturn(aResponse().withStatus(200).withBody(getPodDetailsResponse)));
-
         when(sensiboAccountMock.getConfiguration()).thenReturn(configuration);
         when(sensiboAccountMock.getUID()).thenReturn(new ThingUID("sensibo:account:thinguid"));
 

diff --git a/bundles/org.openhab.binding.sensibo/src/test/resources/get_pods_response.json b/bundles/org.openhab.binding.sensibo/src/test/resources/get_pods_response.json
index b22c131b0043856e3247bbfcf9ee7984d9dde9ae..9bbfc4de4ae6eaeb24d71b9cbe27b691963af051 100644 (file)
--- a/bundles/org.openhab.binding.sensibo/src/test/resources/get_pods_response.json
+++ b/bundles/org.openhab.binding.sensibo/src/test/resources/get_pods_response.json
@@ -2,7 +2,520 @@
     "status": "success",
     "result": [
         {
-            "id": "PODID"
+            "isGeofenceOnEnterEnabledForThisUser": false,
+            "isClimateReactGeofenceOnEnterEnabledForThisUser": false,
+            "isMotionGeofenceOnEnterEnabled": false,
+            "isOwner": true,
+            "minimumCoolingTemperature": null,
+            "maximumHeatingTemperature": null,
+            "restrictedMode": false,
+            "shareDevice": true,
+            "id": "PODID",
+            "qrId": "PODID",
+            "temperatureUnit": "C",
+            "room": {
+                "uid": "KSs8CMdH",
+                "name": "TEST room",
+                "icon": "Diningroom",
+                "pureBoostConfig": null
+            },
+            "acState": {
+                "timestamp": {
+                    "time": "2024-07-17T12:49:06.289306Z",
+                    "secondsAgo": 0
+                },
+                "on": true,
+                "mode": "cool",
+                "targetTemperature": 24,
+                "temperatureUnit": "C",
+                "fanLevel": "strong",
+                "swing": "stopped"
+            },
+            "lastStateChange": {
+                "time": "2024-07-17T07:58:13Z",
+                "secondsAgo": 17453
+            },
+            "lastStateChangeToOn": {
+                "time": "2024-07-17T07:57:55Z",
+                "secondsAgo": 17471
+            },
+            "lastStateChangeToOff": {
+                "time": "2024-07-15T16:24:42Z",
+                "secondsAgo": 159864
+            },
+            "location": {
+                "id": "AFGjHQoDGb",
+                "name": "K82",
+                "latLon": [
+                    0.5047875,
+                    90.0679856
+                ],
+                "address": [
+                    "TEST",
+                    "TEST"
+                ],
+                "country": "USA",
+                "countryAlpha2": "US",
+                "city": "TEST",
+                "createTime": {
+                    "time": "2018-07-16T18:44:05Z",
+                    "secondsAgo": 189453901
+                },
+                "updateTime": {
+                    "time": "2021-03-30T07:55:16Z",
+                    "secondsAgo": 104129630
+                },
+                "features": [],
+                "geofenceTriggerRadius": 200,
+                "subscription": null,
+                "technician": null,
+                "shareAnalytics": false,
+                "tariff": null,
+                "currency": "",
+                "occupancy": "n/a"
+            },
+            "connectionStatus": {
+                "isAlive": true,
+                "lastSeen": {
+                    "time": "2024-07-17T12:48:58.643540Z",
+                    "secondsAgo": 7
+                }
+            },
+            "firmwareVersion": "SKY30046",
+            "firmwareType": "esp8266ex",
+            "productModel": "skyv2",
+            "configGroup": "stable46",
+            "currentlyAvailableFirmwareVersion": "SKY30046",
+            "cleanFiltersNotificationEnabled": false,
+            "shouldShowFilterCleaningNotification": false,
+            "isGeofenceOnExitEnabled": false,
+            "isClimateReactGeofenceOnExitEnabled": false,
+            "isMotionGeofenceOnExitEnabled": false,
+            "isCalibrating": false,
+            "serial": "221804411",
+            "sensorsCalibration": {
+                "temperature": 0.0,
+                "humidity": 0.0
+            },
+            "motionSensors": [],
+            "tags": [],
+            "timer": {
+                "id": "Na2yueHNnv",
+                "isEnabled": false,
+                "acState": {
+                    "on": false
+                },
+                "createTime": "2019-12-20T04:46:15",
+                "createTimeSecondsAgo": 144403371,
+                "targetTime": "2019-12-20T05:16:15",
+                "targetTimeSecondsFromNow": -144401571
+            },
+            "schedules": [
+                {
+                    "id": "5Au8BQrsHJ",
+                    "isEnabled": false,
+                    "acState": {
+                        "on": true,
+                        "targetTemperature": 24,
+                        "temperatureUnit": "C",
+                        "mode": "heat",
+                        "fanLevel": "quiet"
+                    },
+                    "createTime": "2020-01-28T12:00:24",
+                    "createTimeSecondsAgo": 141007722,
+                    "name": null,
+                    "recurringDays": [],
+                    "targetTimeLocal": "17:00",
+                    "timezone": "Europe/Madrid",
+                    "podUid": "637uWtxr",
+                    "nextTime": "2024-07-17T15:00:00",
+                    "nextTimeSecondsFromNow": 7853
+                },
+                {
+                    "id": "PLyt93ZVvU",
+                    "isEnabled": false,
+                    "acState": {
+                        "on": false,
+                        "targetTemperature": 27,
+                        "temperatureUnit": "C",
+                        "mode": "heat",
+                        "fanLevel": "high"
+                    },
+                    "createTime": "2019-12-08T19:45:28",
+                    "createTimeSecondsAgo": 145386218,
+                    "name": null,
+                    "recurringDays": [],
+                    "targetTimeLocal": "06:30",
+                    "timezone": "Europe/Paris",
+                    "podUid": "637uWtxr",
+                    "nextTime": "2024-07-18T04:30:00",
+                    "nextTimeSecondsFromNow": 56453
+                },
+                {
+                    "id": "XqEBM7YXmd",
+                    "isEnabled": false,
+                    "acState": {
+                        "on": true,
+                        "targetTemperature": 22,
+                        "temperatureUnit": "C",
+                        "mode": "cool",
+                        "fanLevel": "high",
+                        "swing": "rangeFull",
+                        "extra": {
+                            "scheduler": {
+                                "climate_react": null,
+                                "motion": null,
+                                "on": true,
+                                "climate_react_settings": null,
+                                "pure_boost": null
+                            }
+                        }
+                    },
+                    "createTime": "2019-12-08T19:45:06",
+                    "createTimeSecondsAgo": 145386240,
+                    "name": null,
+                    "recurringDays": [
+                        "Monday",
+                        "Tuesday",
+                        "Wednesday",
+                        "Thursday",
+                        "Friday"
+                    ],
+                    "targetTimeLocal": "04:30",
+                    "timezone": "Europe/Athens",
+                    "podUid": "637uWtxr",
+                    "nextTime": "2024-07-18T02:30:00",
+                    "nextTimeSecondsFromNow": 49253
+                }
+            ],
+            "motionConfig": null,
+            "doorConfig": null,
+            "filtersCleaning": {
+                "acOnSecondsSinceLastFiltersClean": 7736243,
+                "filtersCleanSecondsThreshold": 1080000,
+                "lastFiltersCleanTime": {
+                    "time": "2022-07-01T05:43:40Z",
+                    "secondsAgo": 64566326
+                },
+                "shouldCleanFilters": true
+            },
+            "serviceSubscriptions": [],
+            "roomIsOccupied": null,
+            "mainMeasurementsSensor": null,
+            "pureBoostConfig": null,
+            "warrantyEligible": "no",
+            "warrantyEligibleUntil": {
+                "time": "2018-08-13T18:43:08Z",
+                "secondsAgo": 187034758
+            },
+            "features": [
+                "showPlus"
+            ],
+            "lastHealthcheck": null,
+            "homekitSupported": false,
+            "remoteCapabilities": {
+                "modes": {
+                    "cool": {
+                        "temperatures": {
+                            "F": {
+                                "isNative": false,
+                                "values": [
+                                    61,
+                                    63,
+                                    64,
+                                    66,
+                                    68,
+                                    70,
+                                    72,
+                                    73,
+                                    75,
+                                    77,
+                                    79,
+                                    81,
+                                    82,
+                                    84,
+                                    86
+                                ]
+                            },
+                            "C": {
+                                "isNative": true,
+                                "values": [
+                                    16,
+                                    17,
+                                    18,
+                                    19,
+                                    20,
+                                    21,
+                                    22,
+                                    23,
+                                    24,
+                                    25,
+                                    26,
+                                    27,
+                                    28,
+                                    29,
+                                    30
+                                ]
+                            }
+                        },
+                        "fanLevels": [
+                            "quiet",
+                            "low",
+                            "medium",
+                            "high",
+                            "auto",
+                            "strong"
+                        ],
+                        "swing": [
+                            "stopped",
+                            "rangeFull",
+                            "horizontal",
+                            "both"
+                        ]
+                    },
+                    "heat": {
+                        "temperatures": {
+                            "F": {
+                                "isNative": false,
+                                "values": [
+                                    50,
+                                    61,
+                                    63,
+                                    64,
+                                    66,
+                                    68,
+                                    70,
+                                    72,
+                                    73,
+                                    75,
+                                    77,
+                                    79,
+                                    81,
+                                    82,
+                                    84,
+                                    86
+                                ]
+                            },
+                            "C": {
+                                "isNative": true,
+                                "values": [
+                                    10,
+                                    16,
+                                    17,
+                                    18,
+                                    19,
+                                    20,
+                                    21,
+                                    22,
+                                    23,
+                                    24,
+                                    25,
+                                    26,
+                                    27,
+                                    28,
+                                    29,
+                                    30
+                                ]
+                            }
+                        },
+                        "fanLevels": [
+                            "quiet",
+                            "low",
+                            "medium",
+                            "high",
+                            "auto",
+                            "strong"
+                        ],
+                        "swing": [
+                            "stopped",
+                            "rangeFull",
+                            "horizontal",
+                            "both"
+                        ]
+                    },
+                    "fan": {
+                        "temperatures": {},
+                        "fanLevels": [
+                            "quiet",
+                            "low",
+                            "medium",
+                            "high",
+                            "auto",
+                            "strong"
+                        ],
+                        "swing": [
+                            "stopped",
+                            "rangeFull",
+                            "horizontal",
+                            "both"
+                        ]
+                    },
+                    "dry": {
+                        "temperatures": {
+                            "F": {
+                                "isNative": false,
+                                "values": [
+                                    61,
+                                    63,
+                                    64,
+                                    66,
+                                    68,
+                                    70,
+                                    72,
+                                    73,
+                                    75,
+                                    77,
+                                    79,
+                                    81,
+                                    82,
+                                    84,
+                                    86
+                                ]
+                            },
+                            "C": {
+                                "isNative": true,
+                                "values": [
+                                    16,
+                                    17,
+                                    18,
+                                    19,
+                                    20,
+                                    21,
+                                    22,
+                                    23,
+                                    24,
+                                    25,
+                                    26,
+                                    27,
+                                    28,
+                                    29,
+                                    30
+                                ]
+                            }
+                        },
+                        "fanLevels": [
+                            "quiet",
+                            "low",
+                            "medium",
+                            "high",
+                            "auto",
+                            "strong"
+                        ],
+                        "swing": [
+                            "stopped",
+                            "rangeFull",
+                            "horizontal",
+                            "both"
+                        ]
+                    },
+                    "auto": {
+                        "temperatures": {
+                            "F": {
+                                "isNative": false,
+                                "values": [
+                                    61,
+                                    63,
+                                    64,
+                                    66,
+                                    68,
+                                    70,
+                                    72,
+                                    73,
+                                    75,
+                                    77,
+                                    79,
+                                    81,
+                                    82,
+                                    84,
+                                    86
+                                ]
+                            },
+                            "C": {
+                                "isNative": true,
+                                "values": [
+                                    16,
+                                    17,
+                                    18,
+                                    19,
+                                    20,
+                                    21,
+                                    22,
+                                    23,
+                                    24,
+                                    25,
+                                    26,
+                                    27,
+                                    28,
+                                    29,
+                                    30
+                                ]
+                            }
+                        },
+                        "fanLevels": [
+                            "quiet",
+                            "low",
+                            "medium",
+                            "high",
+                            "auto",
+                            "strong"
+                        ],
+                        "swing": [
+                            "stopped",
+                            "rangeFull",
+                            "horizontal",
+                            "both"
+                        ]
+                    }
+                }
+            },
+            "remote": {
+                "toggle": false,
+                "window": false
+            },
+            "remoteFlavor": "Singing Wombat",
+            "remoteAlternatives": [
+                "_fujitsu1_different_swing2",
+                "_fujitsu1_selector1",
+                "_fujitsu1_different_swing",
+                "_fujitsu1_swing_reversed",
+                "_fujitsu1_power_toggle3",
+                "_fujitsu1_power_toggle2",
+                "_fujitsu1b",
+                "_fujitsu1b_for_pod",
+                "_fujitsu1_power_toggle",
+                "_fujitsu1b_different_swing",
+                "_fujitsu1_airclean",
+                "_fujitsu1_fahrenheit"
+            ],
+            "sensiboRemote": null,
+            "smartMode": null,
+            "measurements": {
+                "time": {
+                    "time": "2024-07-17T12:48:58.643540Z",
+                    "secondsAgo": 7
+                },
+                "temperature": 25.1,
+                "humidity": 60.7,
+                "feelsLike": 25.1,
+                "rssi": -81
+            },
+            "accessPoint": {
+                "ssid": "SENSIBO-I-21458",
+                "password": null
+            },
+            "macAddress": "ec:fa:bc:1d:c8:3e",
+            "autoOffMinutes": null,
+            "autoOffEnabled": false,
+            "antiMoldTimer": null,
+            "antiMoldConfig": null,
+            "powerConsumption": null,
+            "acType": null,
+            "lastRunEnergyConsumption": null,
+            "acUsage": null,
+            "optimusEnabled": true,
+            "optimusInsights": null,
+            "organization": null,
+            "hasPolicy": false
         }
     ]
-}
\ No newline at end of file
+}