Skip to content

Commit

Permalink
[netatmo] Buffer last event requests per child modules (openhab#13489)
Browse files Browse the repository at this point in the history 
* Buffer last event requests per child modules
This is targetted to decrease the number of requests transmitted to Netatmo API.
Solves openhab#13358

Signed-off-by: clinique <gael@lhopital.org>
  • Loading branch information
@clinique @andan67
clinique authored and andan67 committed Nov 5, 2022
1 parent 730180e commit 6fdc6a3
Show file tree
Hide file tree
Showing 9 changed files with 101 additions and 52 deletions.
6 changes: 3 additions & 3 deletions ...hab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/EnergyApi.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ public EnergyApi(ApiBridgeHandler apiClient) {
public void switchSchedule(String homeId, String scheduleId) throws NetatmoException {
UriBuilder uriBuilder = getAppUriBuilder(SUB_PATH_SWITCH_SCHEDULE, PARAM_HOME_ID, homeId, PARAM_SCHEDULE_ID,
scheduleId);
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
}

/**
Expand All @@ -64,7 +64,7 @@ public void switchSchedule(String homeId, String scheduleId) throws NetatmoExcep
*/
public void setThermMode(String homeId, String mode) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_SET_THERM_MODE, PARAM_HOME_ID, homeId, PARAM_MODE, mode);
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
}

/**
Expand All @@ -88,6 +88,6 @@ public void setThermpoint(String homeId, String roomId, SetpointMode mode, long
uriBuilder.queryParam("temp", temp > THERM_MAX_SETPOINT ? THERM_MAX_SETPOINT : temp);
}
}
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
}
}
9 changes: 4 additions & 5 deletions ...b.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/RestManager.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,13 @@ protected <T extends ApiResponse<?>> T get(UriBuilder uriBuilder, Class<T> clazz
return executeUri(uriBuilder, HttpMethod.GET, clazz, null, null);
}

protected <T extends ApiResponse<?>> T post(UriBuilder uriBuilder, Class<T> clazz, @Nullable String payload,
@Nullable String contentType) throws NetatmoException {
return executeUri(uriBuilder, HttpMethod.POST, clazz, payload, contentType);
protected <T extends ApiResponse<?>> T post(UriBuilder uriBuilder, Class<T> clazz, @Nullable String payload)
throws NetatmoException {
return executeUri(uriBuilder, HttpMethod.POST, clazz, payload, payload == null ? null : CONTENT_APP_JSON);
}

protected <T> T post(URI uri, Class<T> clazz, Map<String, String> entries) throws NetatmoException {
return apiBridge.executeUri(uri, POST, clazz, toRequest(entries),
"application/x-www-form-urlencoded;charset=UTF-8", 3);
return apiBridge.executeUri(uri, POST, clazz, toRequest(entries), CONTENT_APP_FORM, 3);
}

private <T extends ApiResponse<?>> T executeUri(UriBuilder uriBuilder, HttpMethod method, Class<T> clazz,
Expand Down
49 changes: 20 additions & 29 deletions ...b.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/SecurityApi.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

import java.net.URI;
import java.util.Collection;
import java.util.stream.Collectors;

import javax.ws.rs.core.UriBuilder;

Expand Down Expand Up @@ -52,7 +51,7 @@ public SecurityApi(ApiBridgeHandler apiClient) {
*/
public void dropWebhook() throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_DROP_WEBHOOK);
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
}

/**
Expand All @@ -63,37 +62,33 @@ public void dropWebhook() throws NetatmoException {
*/
public boolean addwebhook(URI uri) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_ADD_WEBHOOK, PARAM_URL, uri.toString());
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
return true;
}

public Collection<HomeEvent> getPersonEvents(String homeId, String personId) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_GET_EVENTS, PARAM_HOME_ID, homeId, PARAM_PERSON_ID, personId,
PARAM_OFFSET, 1);
NAEventsDataResponse response = get(uriBuilder, NAEventsDataResponse.class);
BodyResponse<Home> body = response.getBody();
private Collection<HomeEvent> getEvents(@Nullable Object... params) throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_GET_EVENTS, params);
BodyResponse<Home> body = get(uriBuilder, NAEventsDataResponse.class).getBody();
if (body != null) {
Home home = body.getElement();
if (home != null) {
return home.getEvents().stream().filter(event -> personId.equals(event.getPersonId()))
.collect(Collectors.toList());
return home.getEvents();
}
}
throw new NetatmoException("home should not be null");
}

public Collection<HomeEvent> getHomeEvents(String homeId) throws NetatmoException {
return getEvents(PARAM_HOME_ID, homeId);
}

public Collection<HomeEvent> getPersonEvents(String homeId, String personId) throws NetatmoException {
return getEvents(PARAM_HOME_ID, homeId, PARAM_PERSON_ID, personId, PARAM_OFFSET, 1);
}

public Collection<HomeEvent> getDeviceEvents(String homeId, String deviceId, String deviceType)
throws NetatmoException {
UriBuilder uriBuilder = getApiUriBuilder(SUB_PATH_GET_EVENTS, PARAM_HOME_ID, homeId, PARAM_DEVICE_ID, deviceId,
PARAM_DEVICES_TYPE, deviceType);
BodyResponse<Home> body = get(uriBuilder, NAEventsDataResponse.class).getBody();
if (body != null) {
Home home = body.getElement();
if (home != null) {
return home.getEvents();
}
}
throw new NetatmoException("home should not be null");
return getEvents(PARAM_HOME_ID, homeId, PARAM_DEVICE_ID, deviceId, PARAM_DEVICES_TYPE, deviceType);
}

public @Nullable String ping(String vpnUrl) {
Expand All @@ -109,22 +104,18 @@ public Collection<HomeEvent> getDeviceEvents(String homeId, String deviceId, Str
public void changeStatus(String localCameraURL, boolean setOn) throws NetatmoException {
UriBuilder uriBuilder = UriBuilder.fromUri(localCameraURL).path(PATH_COMMAND).path(SUB_PATH_CHANGESTATUS);
uriBuilder.queryParam(PARAM_STATUS, setOn ? "on" : "off");
post(uriBuilder, ApiResponse.Ok.class, null, null);
post(uriBuilder, ApiResponse.Ok.class, null);
}

public void changeFloodLightMode(String homeId, String cameraId, FloodLightMode mode) throws NetatmoException {
UriBuilder uriBuilder = getAppUriBuilder(PATH_STATE);
String payload = String.format(
"{\"home\": {\"id\":\"%s\",\"modules\": [ {\"id\":\"%s\",\"floodlight\":\"%s\"} ]}}", homeId, cameraId,
mode.name().toLowerCase());
post(uriBuilder, ApiResponse.Ok.class, payload, "application/json;charset=utf-8");
String payload = String.format(PAYLOAD_FLOODLIGHT, homeId, cameraId, mode.name().toLowerCase());
post(uriBuilder, ApiResponse.Ok.class, payload);
}

public void setPersonAwayStatus(String homeId, String personId, boolean away) throws NetatmoException {
UriBuilder uriBuilder = getAppUriBuilder(away ? SUB_PATH_PERSON_AWAY : SUB_PATH_PERSON_HOME);
String payload = String.format(
away ? "{\"home_id\":\"%s\",\"person_id\":\"%s\"}" : "{\"home_id\":\"%s\",\"person_ids\":[\"%s\"]}",
homeId, personId);
post(uriBuilder, ApiResponse.Ok.class, payload, "application/json;charset=utf-8");
String payload = String.format(away ? PAYLOAD_PERSON_AWAY : PAYLOAD_PERSON_HOME, homeId, personId);
post(uriBuilder, ApiResponse.Ok.class, payload);
}
}
9 changes: 9 additions & 0 deletions ...netatmo/src/main/java/org/openhab/binding/netatmo/internal/api/data/NetatmoConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,10 @@ public enum MeasureClass {
}
}

// Content types
public static final String CONTENT_APP_JSON = "application/json;charset=utf-8";
public static final String CONTENT_APP_FORM = "application/x-www-form-urlencoded;charset=UTF-8";

// Netatmo API urls
public static final String URL_API = "https://api.netatmo.com/";
public static final String URL_APP = "https://app.netatmo.net/";
Expand Down Expand Up @@ -152,6 +156,11 @@ public enum MeasureClass {
public static final String PARAM_STATUS = "status";
public static final String PARAM_DEVICES_TYPE = "device_types";

// Payloads
public static final String PAYLOAD_FLOODLIGHT = "{\"home\": {\"id\":\"%s\",\"modules\": [ {\"id\":\"%s\",\"floodlight\":\"%s\"} ]}}";
public static final String PAYLOAD_PERSON_AWAY = "{\"home_id\":\"%s\",\"person_id\":\"%s\"}";
public static final String PAYLOAD_PERSON_HOME = "{\"home_id\":\"%s\",\"person_ids\":[\"%s\"]}";

// Autentication process params
public static final String PARAM_ERROR = "error";

Expand Down
6 changes: 2 additions & 4 deletions ...c/main/java/org/openhab/binding/netatmo/internal/handler/capability/CameraCapability.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
import static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;

Expand Down Expand Up @@ -101,9 +100,8 @@ protected void beforeNewData() {
public List<NAObject> updateReadings() {
List<NAObject> result = new ArrayList<>();
securityCapability.ifPresent(cap -> {
Collection<HomeEvent> events = cap.getDeviceEvents(handler.getId(), moduleType.apiName);
if (!events.isEmpty()) {
HomeEvent event = events.iterator().next();
HomeEvent event = cap.getLastDeviceEvent(handler.getId(), moduleType.apiName);
if (event != null) {
result.add(event);
result.addAll(event.getSubevents());
}
Expand Down
2 changes: 1 addition & 1 deletion ...src/main/java/org/openhab/binding/netatmo/internal/handler/capability/HomeCapability.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ protected List<NAObject> updateReadings(HomeApi api) {
result.add(homeStatus);
}
} catch (NetatmoException e) {
logger.warn("Error gettting Home informations : {}", e.getMessage());
logger.warn("Error getting Home informations : {}", e.getMessage());
}
return result;
}
Expand Down
7 changes: 3 additions & 4 deletions ...c/main/java/org/openhab/binding/netatmo/internal/handler/capability/PersonCapability.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@

import java.time.ZonedDateTime;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
Expand Down Expand Up @@ -90,9 +89,9 @@ public void updateEvent(Event event) {
public List<NAObject> updateReadings() {
List<NAObject> result = new ArrayList<>();
securityCapability.ifPresent(cap -> {
Collection<HomeEvent> events = cap.getPersonEvents(handler.getId());
if (!events.isEmpty()) {
result.add(events.iterator().next());
HomeEvent event = cap.getLastPersonEvent(handler.getId());
if (event != null) {
result.add(event);
}
});
return result;
Expand Down
58 changes: 56 additions & 2 deletions ...main/java/org/openhab/binding/netatmo/internal/handler/capability/SecurityCapability.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,11 @@
*/
package org.openhab.binding.netatmo.internal.handler.capability;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
Expand All @@ -27,6 +30,7 @@
import org.openhab.binding.netatmo.internal.api.dto.HomeStatusModule;
import org.openhab.binding.netatmo.internal.api.dto.HomeStatusPerson;
import org.openhab.binding.netatmo.internal.api.dto.NAHomeStatus.HomeStatus;
import org.openhab.binding.netatmo.internal.api.dto.NAObject;
import org.openhab.binding.netatmo.internal.deserialization.NAObjectMap;
import org.openhab.binding.netatmo.internal.handler.CommonInterface;
import org.slf4j.Logger;
Expand All @@ -42,6 +46,8 @@
class SecurityCapability extends RestCapability<SecurityApi> {
private final Logger logger = LoggerFactory.getLogger(SecurityCapability.class);

private static final Map<String, HomeEvent> eventBuffer = new HashMap<>();

SecurityCapability(CommonInterface handler) {
super(handler, SecurityApi.class);
}
Expand Down Expand Up @@ -110,7 +116,55 @@ protected void updateHomeEvent(HomeEvent homeEvent) {
});
}

public Collection<HomeEvent> getDeviceEvents(String cameraId, String deviceType) {
@Override
protected List<NAObject> updateReadings(SecurityApi api) {
List<NAObject> result = new ArrayList<>();
try {
Collection<HomeEvent> lastEvents = api.getHomeEvents(handler.getId());
lastEvents.stream().forEach(event -> {
HomeEvent previousEvent = eventBuffer.get(event.getCameraId());
if (previousEvent == null || previousEvent.getTime().isBefore(event.getTime())) {
eventBuffer.put(event.getCameraId(), event);
}
String personId = event.getPersonId();
if (personId != null) {
previousEvent = eventBuffer.get(personId);
if (previousEvent == null || previousEvent.getTime().isBefore(event.getTime())) {
eventBuffer.put(personId, event);
}
}
});
} catch (NetatmoException e) {
logger.warn("Error retrieving last events for home '{}' : {}", handler.getId(), e.getMessage());
}
return result;
}

public @Nullable HomeEvent getLastPersonEvent(String personId) {
HomeEvent event = eventBuffer.get(personId);
if (event == null) {
Collection<HomeEvent> events = requestPersonEvents(personId);
if (!events.isEmpty()) {
event = events.iterator().next();
eventBuffer.put(personId, event);
}
}
return event;
}

public @Nullable HomeEvent getLastDeviceEvent(String cameraId, String deviceType) {
HomeEvent event = eventBuffer.get(cameraId);
if (event == null) {
Collection<HomeEvent> events = requestDeviceEvents(cameraId, deviceType);
if (!events.isEmpty()) {
event = events.iterator().next();
eventBuffer.put(cameraId, event);
}
}
return event;
}

private Collection<HomeEvent> requestDeviceEvents(String cameraId, String deviceType) {
return getApi().map(api -> {
try {
return api.getDeviceEvents(handler.getId(), cameraId, deviceType);
Expand All @@ -121,7 +175,7 @@ public Collection<HomeEvent> getDeviceEvents(String cameraId, String deviceType)
}).orElse(List.of());
}

public Collection<HomeEvent> getPersonEvents(String personId) {
private Collection<HomeEvent> requestPersonEvents(String personId) {
return getApi().map(api -> {
try {
return api.getPersonEvents(handler.getId(), personId);
Expand Down
7 changes: 3 additions & 4 deletions ...rc/main/java/org/openhab/binding/netatmo/internal/handler/capability/SmokeCapability.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
package org.openhab.binding.netatmo.internal.handler.capability;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import org.eclipse.jdt.annotation.NonNullByDefault;
Expand Down Expand Up @@ -41,9 +40,9 @@ public SmokeCapability(CommonInterface handler, NetatmoDescriptionProvider descr
public List<NAObject> updateReadings() {
List<NAObject> result = new ArrayList<>();
securityCapability.ifPresent(cap -> {
Collection<HomeEvent> events = cap.getDeviceEvents(handler.getId(), moduleType.apiName);
if (!events.isEmpty()) {
result.add(events.iterator().next());
HomeEvent event = cap.getLastDeviceEvent(handler.getId(), moduleType.apiName);
if (event != null) {
result.add(event);
}
});
return result;
Expand Down

0 comments on commit 6fdc6a3

Please sign in to comment.