demus/openhab-addons
1
0
Fork 0
mirror of https://github.com/openhab/openhab-addons.git synced 2025-01-25 14:55:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

[netatmo] Rework room actions (#12870)

Browse Source 
* [netatmo] Rework room actions
* Clarify what thermostat modes can be used for the action

Fix #12836

Signed-off-by: Laurent Garnier <lg.hc@free.fr>
This commit is contained in:
lolodomo 2022-06-13 08:07:22 +02:00 committed by GitHub
parent ebca0812d1
commit 770d32ce99
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 118 additions and 89 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
bundles/org.openhab.binding.netatmo/README.md
View File

@ -574,10 +574,10 @@ Person things are automatically created in discovery process for all known perso
All these channels except at-home are read only.
# Configuration Examples
## Configuration Examples
## things/netatmo.things
### things/netatmo.things
```
Bridge netatmo:account:home "Netatmo Account" [clientId="xxxxx", clientSecret="yyyy", refreshToken="zzzzz"] {
@ -596,7 +596,7 @@ Bridge netatmo:account:home "Netatmo Account" [clientId="xxxxx", clientSecret="y
```
## Sample configuration of live-stream-url channels:
### Sample configuration of live-stream-url channels:
```
....
@ -609,7 +609,7 @@ Bridge netatmo:account:home "Netatmo Account" [clientId="xxxxx", clientSecret="y
```
## items/netatmo.items
### items/netatmo.items
```
# Indoor Module
@ -648,7 +648,7 @@ Number:Length Rain_Hour "Rain Last Hour [%.1f %un
Number:Length Rain_Today "Rain Today [%.1f %unit%]" <rain> { channel = "netatmo:rain:home:inside:rainModule:rain#sum-24"}
```
## sitemaps/netatmo.sitemap
### sitemaps/netatmo.sitemap
```
sitemap netatmo label="Netatmo" {
@ -696,26 +696,74 @@ sitemap netatmo label="Netatmo" {
}
```
## Rule Actions
# Sample data
Multiple actions are supported by this binding. In classic rules these are accessible as shown in this example (adjust getActions with your ThingId):
Example
```
val actions = getActions("netatmo","netatmo:room:home:home:livingroom")
if(null === actions) {
logInfo("actions", "Actions not found, check thing ID")
return
}
```
### setThermRoomTempSetpoint(temp,endtime)
Sends a temperature setpoint (and switch to manual mode) to the thermostat for a room with an end time.
Parameters:
| Name | Description |
|---------|----------------------------------------------------------------------|
| temp | The temperature setpoint. |
| endtime | Time the setpoint should end (Local Unix time in seconds). |
Example:
```
actions.setThermRoomTempSetpoint(19.0, 1654387205)
```
### setThermRoomModeSetpoint(mode,endtime)
Sends a mode to the thermostat for a room with an optional end time.
Parameters:
| Name | Description |
|---------|----------------------------------------------------------------------|
| mode | The mode to set: MANUAL, MAX or HOME. |
| endtime | Time the setpoint should end (Local Unix time in seconds). |
Example:
```
actions.setThermRoomModeSetpoint("MANUAL", 1654387205)
actions.setThermRoomModeSetpoint("HOME", null)
```
## Sample data
If you want to evaluate this binding but have not got a Netatmo station yourself
yet, you can search on the web for a publicly shared weather station.
# Icons
## Icons
The following icons are used by original Netatmo web app:
## Modules
### Modules
- https://my.netatmo.com/images/my/app/module_int.png
- https://my.netatmo.com/images/my/app/module_ext.png
- https://my.netatmo.com/images/my/app/module_rain.png
## Battery status
### Battery status
- https://my.netatmo.com/images/my/app/battery_verylow.png
- https://my.netatmo.com/images/my/app/battery_low.png
@ -724,7 +772,7 @@ The following icons are used by original Netatmo web app:
- https://my.netatmo.com/images/my/app/battery_full.png
## Signal status
### Signal status
- https://my.netatmo.com/images/my/app/signal_verylow.png
- https://my.netatmo.com/images/my/app/signal_low.png
@ -733,7 +781,7 @@ The following icons are used by original Netatmo web app:
- https://my.netatmo.com/images/my/app/signal_full.png
## Wifi status
### Wifi status
- https://my.netatmo.com/images/my/app/wifi_low.png
- https://my.netatmo.com/images/my/app/wifi_medium.png

125
bundles/org.openhab.binding.netatmo/src/main/java/org/openhab/binding/netatmo/internal/action/RoomActions.java
View File

@ -14,6 +14,7 @@ package org.openhab.binding.netatmo.internal.action;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
@ -61,90 +62,68 @@ public class RoomActions implements ThingActions {
return (ThingHandler) handler;
}
/**
* The setThermpoint room thing action
*/
@RuleAction(label = "@text/actionLabel", description = "@text/actionDesc")
public void setThermpoint(
@ActionInput(name = "setpoint", label = "@text/actionInputSetpointLabel", description = "@text/actionInputSetpointDesc") @Nullable Double temp,
@RuleAction(label = "@text/actionSetThermRoomTempSetpointLabel", description = "@text/actionSetThermRoomTempSetpointDesc")
public void setThermRoomTempSetpoint(
@ActionInput(name = "temp", label = "@text/actionInputSetpointLabel", description = "@text/actionInputSetpointDesc") @Nullable Double temp,
@ActionInput(name = "endtime", label = "@text/actionInputEndtimeLabel", description = "@text/actionInputEndtimeDesc") @Nullable Long endTime) {
setThermpoint(temp, endTime, "MANUAL");
CommonInterface roomHandler = handler;
if (roomHandler == null) {
logger.info("Handler not set for room thing actions.");
return;
} else if (temp == null) {
logger.info("Temperature is required, action ignored");
return;
} else if (endTime == null) {
logger.info("Temperature provided but no endtime given, action ignored");
return;
}
energy.ifPresent(cap -> cap.setRoomThermTemp(roomHandler.getId(), temp, endTime, SetpointMode.MANUAL));
}
@RuleAction(label = "@text/actionLabel", description = "@text/actionDesc")
public void seThermpoint(
@RuleAction(label = "@text/actionSetThermRoomModeSetpointLabel", description = "@text/actionSetThermRoomModeSetpointDesc")
public void setThermRoomModeSetpoint(
@ActionInput(name = "mode", label = "@text/actionInputModeLabel", description = "@text/actionInputModeDesc") @Nullable String mode,
@ActionInput(name = "endtime", label = "@text/actionInputEndtimeLabel", description = "@text/actionInputEndtimeDesc") @Nullable Long endTime) {
setThermpoint(null, endTime, mode);
}
@RuleAction(label = "@text/actionLabel", description = "@text/actionDesc")
public void setThermpoint(
@ActionInput(name = "setpoint", label = "@text/actionInputSetpointLabel", description = "@text/actionInputSetpointDesc") @Nullable Double temp,
@ActionInput(name = "endtime", label = "@text/actionInputEndtimeLabel", description = "@text/actionInputEndtimeDesc") @Nullable Long endTime,
@ActionInput(name = "mode", label = "@text/actionInputModeLabel", description = "@text/actionInputModeDesc") @Nullable String mode) {
CommonInterface roomHandler = handler;
if (roomHandler != null) {
String roomId = roomHandler.getId();
SetpointMode targetMode = SetpointMode.UNKNOWN;
Long targetEndTime = endTime;
Double targetTemp = temp;
if (mode != null) {
try {
targetMode = SetpointMode.valueOf(mode);
if (!ALLOWED_MODES.contains(targetMode)) {
logger.info("Mode can only be MAX, HOME or MANUAL for a room");
return;
}
} catch (IllegalArgumentException e) {
logger.info("Invalid mode passed : {} - {}", mode, e.getMessage());
return;
}
}
if (temp != null) {
logger.debug("Temperature provided, mode forced to MANUAL.");
targetMode = SetpointMode.MANUAL;
if (targetEndTime == null) {
logger.info("Temperature provided but no endtime given, action ignored");
return;
}
} else {
if (SetpointMode.HOME.equals(targetMode)) {
targetEndTime = 0L;
targetTemp = 0.0;
} else {
logger.info("mode is required if no temperature setpoint provided");
return;
}
}
try {
double setpointTemp = targetTemp != null ? targetTemp : 0;
long setpointEnd = targetEndTime;
SetpointMode setpointMode = targetMode;
energy.ifPresent(cap -> cap.setRoomThermTemp(roomId, setpointTemp, setpointEnd, setpointMode));
} catch (IllegalArgumentException e) {
logger.debug("Ignoring setRoomThermpoint command due to illegal argument exception: {}",
e.getMessage());
}
} else {
if (roomHandler == null) {
logger.info("Handler not set for room thing actions.");
return;
} else if (mode == null) {
logger.info("Mode is required, action ignored");
return;
}
SetpointMode targetMode = SetpointMode.UNKNOWN;
try {
targetMode = SetpointMode.valueOf(mode);
if (!ALLOWED_MODES.contains(targetMode)) {
logger.info("Mode can only be {} for a room",
ALLOWED_MODES.stream().map(s -> s.name()).collect(Collectors.joining(", ")));
return;
}
} catch (IllegalArgumentException e) {
logger.info("Invalid mode passed : {} - {}", mode, e.getMessage());
return;
}
Long targetEndTime = endTime;
if (SetpointMode.HOME.equals(targetMode)) {
targetEndTime = 0L;
} else if (targetEndTime == null) {
logger.info("No endtime given, action ignored");
return;
}
long setpointEnd = targetEndTime;
SetpointMode setpointMode = targetMode;
energy.ifPresent(cap -> cap.setRoomThermTemp(roomHandler.getId(), 0, setpointEnd, setpointMode));
}
/**
* Static setThermpoint method for Rules DSL backward compatibility
*/
public static void setThermpoint(ThingActions actions, @Nullable Double temp, @Nullable Long endTime,
@Nullable String mode) {
((RoomActions) actions).setThermpoint(temp, endTime, mode);
public static void setThermRoomTempSetpoint(ThingActions actions, @Nullable Double temp, @Nullable Long endTime) {
((RoomActions) actions).setThermRoomTempSetpoint(temp, endTime);
}
public static void setThermpoint(ThingActions actions, @Nullable Double temp, @Nullable Long endTime) {
setThermpoint(actions, temp, endTime, null);
}
public static void setThermpoint(ThingActions actions, @Nullable String mode, @Nullable Long endTime) {
setThermpoint(actions, null, endTime, mode);
public static void setThermRoomModeSetpoint(ThingActions actions, @Nullable String mode, @Nullable Long endTime) {
((RoomActions) actions).setThermRoomModeSetpoint(mode, endTime);
}
}

12
bundles/org.openhab.binding.netatmo/src/main/resources/OH-INF/i18n/netatmo.properties
View File

@ -398,11 +398,13 @@ request-time-out = Request timed out - will attempt reconnection later
# actions
actionSetThermRoomTempSetpointLabel = send temperature setpoint to the thermostat for a room
actionSetThermRoomTempSetpointDesc = Sends a temperature setpoint (and switch to manual mode) to the thermostat for a room with an end time.
actionInputSetpointLabel = Setpoint
actionInputSetpointDesc = The temperature setpoint
actionInputSetpointDesc = The temperature setpoint.
actionInputEndtimeLabel = Endtime
actionInputEndtimeDesc = Time the setpoint should end
actionInputEndtimeDesc = Time the setpoint should end (Local Unix time in seconds).
actionSetThermRoomModeSetpointLabel = send mode to the thermostat for a room
actionSetThermRoomModeSetpointDesc = Sends a mode to the thermostat for a room with an optional end time.
actionInputModeLabel = Mode
actionInputModeDesc = The mode to set: MANUAL, SCHEDULE or FG (Frost-Guard)
actionLabel = send a set room thermpoint command
actionDesc = Send set room thermpoint command with endtime.
actionInputModeDesc = The mode to set: MANUAL, MAX or HOME.