-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[enocean] Add support for Soda Handles (EEP D2-06-01) (#11230)
* added data validation Signed-off-by: Thomas Lauterbach <[email protected]> * Revert "added data validation" This reverts commit 9451010. Signed-off-by: Thomas Lauterbach <[email protected]> * added calibration channels Signed-off-by: Thomas Lauterbach <[email protected]> * added calibration channels Signed-off-by: Thomas Lauterbach <[email protected]> * initial d20601 impl Signed-off-by: Thomas Lauterbach <[email protected]> * fixed D20601 temp and battery Signed-off-by: Thomas Lauterbach <[email protected]> * README updated and changed D20601 to mechanical handle Signed-off-by: Thomas Lauterbach <[email protected]> * spotless Signed-off-by: Thomas Lauterbach <[email protected]> * use common events Signed-off-by: Thomas Lauterbach <[email protected]> * fix spotless Signed-off-by: Thomas Lauterbach <[email protected]> * Revert "added calibration channels" This reverts commit 6287b4b. Signed-off-by: Thomas Lauterbach <[email protected]> * Revert "added calibration channels" This reverts commit fca8b4b. Signed-off-by: Thomas Lauterbach <[email protected]> * Revert "Revert "added data validation"" This reverts commit e8ff27f. Signed-off-by: Thomas Lauterbach <[email protected]> * Revert "added data validation" This reverts commit 8d7bd95. Signed-off-by: Thomas Lauterbach <[email protected]> * added more comments and fixed channel labels Signed-off-by: Thomas Lauterbach <[email protected]> * added state enums Signed-off-by: Thomas Lauterbach <[email protected]> * added missing modifiers Signed-off-by: Thomas Lauterbach <[email protected]> * fixed typo in comment Signed-off-by: Thomas Lauterbach <[email protected]> * upstream changes Signed-off-by: Thomas Lauterbach <[email protected]> Co-authored-by: Thomas Lauterbach <[email protected]>
- Loading branch information
1 parent
1e57450
commit a253250
Showing
7 changed files
with
337 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
275 changes: 275 additions & 0 deletions
275
...inding.enocean/src/main/java/org/openhab/binding/enocean/internal/eep/D2_06/D2_06_01.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,275 @@ | ||
| /** | ||
| * Copyright (c) 2010-2021 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.enocean.internal.eep.D2_06; | ||
|
|
||
| import static org.openhab.binding.enocean.internal.EnOceanBindingConstants.*; | ||
|
|
||
| import java.util.Arrays; | ||
| import java.util.Optional; | ||
| import java.util.function.Function; | ||
|
|
||
| import org.openhab.binding.enocean.internal.eep.Base._VLDMessage; | ||
| import org.openhab.binding.enocean.internal.messages.ERP1Message; | ||
| import org.openhab.core.config.core.Configuration; | ||
| import org.openhab.core.library.types.DecimalType; | ||
| import org.openhab.core.library.types.OnOffType; | ||
| import org.openhab.core.library.types.QuantityType; | ||
| import org.openhab.core.library.types.StringType; | ||
| import org.openhab.core.library.unit.SIUnits; | ||
| import org.openhab.core.library.unit.Units; | ||
| import org.openhab.core.thing.CommonTriggerEvents; | ||
| import org.openhab.core.types.State; | ||
| import org.openhab.core.types.UnDefType; | ||
|
|
||
| /** | ||
| * Implementation of the D2_06_01 EEP as used by window handles manufactured by Soda GmbH. All channels except the | ||
| * battery channels may be not supported by the physical device (depending on the actual model). If a channel is not | ||
| * supported by a device it will transmit a 'not supported' message which is ignored by this implementation. | ||
| * Consequently channels that are not supported by the physical device will never send updates to linked items. | ||
| * | ||
| * @author Thomas Lauterbach - Initial contribution | ||
| */ | ||
| public class D2_06_01 extends _VLDMessage { | ||
|
|
||
| private enum MessageType { | ||
|
|
||
| SENSORVALUES(0x00), | ||
| CONFIGURATIONREPORT(0x10), | ||
| LOGDATA01(0x20), | ||
| LOGDATA02(0x21), | ||
| LOGDATA03(0x22), | ||
| LOGDATA04(0x23), | ||
| CONTROLANDSETTINGS(0x80); | ||
|
|
||
| private int intValue; | ||
|
|
||
| private MessageType(int intValue) { | ||
| this.intValue = intValue; | ||
| } | ||
|
|
||
| private int getIntValue() { | ||
| return this.intValue; | ||
| } | ||
| } | ||
|
|
||
| private enum SashState { | ||
|
|
||
| // WINDOWSTATEUNDEFINED(0x00, "UNDEFINED"), | ||
| NOTTILTED(0x01, "NOT TILTED"), | ||
| TILTED(0x02, "TILTED"); | ||
|
|
||
| private int intValue; | ||
| private String textValue; | ||
|
|
||
| private SashState(int intValue, String textValue) { | ||
| this.intValue = intValue; | ||
| this.textValue = textValue; | ||
| } | ||
|
|
||
| private String getTextValue() { | ||
| return this.textValue; | ||
| } | ||
|
|
||
| private static Optional<SashState> valueOf(int intValue) { | ||
| return Arrays.stream(values()).filter(sashState -> sashState.intValue == intValue).findFirst(); | ||
| } | ||
| } | ||
|
|
||
| private enum HandleState { | ||
|
|
||
| // HANDLEPOSITIONUNDEFINED(0x00, "UNDEFINED"), | ||
| HANDLEUP(0x01, "UP"), | ||
| HANDLEDOWN(0x02, "DOWN"), | ||
| HANDLELEFT(0x03, "LEFT"), | ||
| HANDLERIGHT(0x04, "RIGHT"); | ||
|
|
||
| private int intValue; | ||
| private String textValue; | ||
|
|
||
| private HandleState(int intValue, String textValue) { | ||
| this.intValue = intValue; | ||
| this.textValue = textValue; | ||
| } | ||
|
|
||
| private String getTextValue() { | ||
| return this.textValue; | ||
| } | ||
|
|
||
| private static Optional<HandleState> valueOf(int intValue) { | ||
| return Arrays.stream(values()).filter(handleState -> handleState.intValue == intValue).findFirst(); | ||
| } | ||
| } | ||
|
|
||
| private enum MotionState { | ||
|
|
||
| MOTIONNOTTRIGGERED(0x00, "OFF"), | ||
| MOTIONTRIGGERED(0x01, "ON"); | ||
|
|
||
| private int intValue; | ||
| private String textValue; | ||
|
|
||
| private MotionState(int intValue, String textValue) { | ||
| this.intValue = intValue; | ||
| this.textValue = textValue; | ||
| } | ||
|
|
||
| private String getTextValue() { | ||
| return this.textValue; | ||
| } | ||
|
|
||
| private static Optional<MotionState> valueOf(int intValue) { | ||
| return Arrays.stream(values()).filter(motionState -> motionState.intValue == intValue).findFirst(); | ||
| } | ||
| } | ||
|
|
||
| public D2_06_01() { | ||
| super(); | ||
| } | ||
|
|
||
| public D2_06_01(ERP1Message packet) { | ||
| super(packet); | ||
| } | ||
|
|
||
| protected State getWindowSashState() { | ||
| Optional<SashState> sashState = SashState.valueOf(bytes[2] & 0x0F); | ||
| if (sashState.isPresent()) { | ||
| return new StringType(sashState.get().getTextValue()); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getWindowHandleState() { | ||
| Optional<HandleState> handleState = HandleState.valueOf(bytes[2] >>> 4); | ||
| if (handleState.isPresent()) { | ||
| return new StringType(handleState.get().getTextValue()); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getMotionState() { | ||
| Optional<MotionState> motionState = MotionState.valueOf(bytes[4] >>> 4); | ||
| if (motionState.isPresent()) { | ||
| return OnOffType.from(motionState.get().getTextValue()); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getTemperature() { | ||
| double unscaledTemp = (double) (bytes[5] & 0xFF); | ||
| if (unscaledTemp <= 250) { | ||
| double scaledTemp = unscaledTemp * 0.32 - 20; | ||
| return new QuantityType<>(scaledTemp, SIUnits.CELSIUS); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getHumidity() { | ||
| int unscaledHumidity = bytes[6] & 0xFF; | ||
| if (unscaledHumidity <= 200) { | ||
| double scaledHumidity = unscaledHumidity * 0.5; | ||
| return new DecimalType(scaledHumidity); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getIllumination() { | ||
| int illumination = ((bytes[7] & 0xFF) << 8) | (bytes[8] & 0xFF); | ||
| if (illumination <= 60000) { | ||
| return new QuantityType<>(illumination, Units.LUX); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| protected State getBatteryLevel() { | ||
| int unscaledBatteryLevel = ((bytes[9] & 0xFF) >> 3); | ||
| if (unscaledBatteryLevel <= 20) { | ||
| return new DecimalType(unscaledBatteryLevel * 5); | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
|
|
||
| @Override | ||
| protected String convertToEventImpl(String channelId, String channelTypeId, String lastEvent, | ||
| Configuration config) { | ||
|
|
||
| // Sensor values | ||
| if (bytes[0] == MessageType.SENSORVALUES.getIntValue()) { | ||
| switch (channelId) { | ||
| case CHANNEL_WINDOWBREACHEVENT: | ||
| if ((bytes[1] >>> 4) == 0x01) { | ||
| return "ALARM"; | ||
| } | ||
| break; | ||
| case CHANNEL_PROTECTIONPLUSEVENT: | ||
| if ((bytes[1] & 0x0F) == 0x01) { | ||
| return "ALARM"; | ||
| } | ||
| break; | ||
| case CHANNEL_PUSHBUTTON: | ||
| int buttonEvent = bytes[3] >>> 4; | ||
| switch (buttonEvent) { | ||
| case 0x01: | ||
| return CommonTriggerEvents.PRESSED; | ||
| case 0x02: | ||
| return CommonTriggerEvents.RELEASED; | ||
| } | ||
| break; | ||
| case CHANNEL_PUSHBUTTON2: | ||
| int buttonEvent2 = bytes[3] & 0x0F; | ||
| switch (buttonEvent2) { | ||
| case 0x01: | ||
| return CommonTriggerEvents.PRESSED; | ||
| case 0x02: | ||
| return CommonTriggerEvents.RELEASED; | ||
| } | ||
| break; | ||
| case CHANNEL_VACATIONMODETOGGLEEVENT: | ||
| int vacationModeToggleEvent = bytes[4] & 0x0F; | ||
| switch (vacationModeToggleEvent) { | ||
| case 0x01: | ||
| return "ACTIVATED"; | ||
| case 0x02: | ||
| return "DEACTIVATED"; | ||
| } | ||
| break; | ||
| } | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| @Override | ||
| public State convertToStateImpl(String channelId, String channelTypeId, Function<String, State> getCurrentStateFunc, | ||
| Configuration config) { | ||
|
|
||
| // Sensor values | ||
| if (bytes[0] == MessageType.SENSORVALUES.getIntValue()) { | ||
| switch (channelId) { | ||
| case CHANNEL_WINDOWSASHSTATE: | ||
| return getWindowSashState(); | ||
| case CHANNEL_WINDOWHANDLESTATE: | ||
| return getWindowHandleState(); | ||
| case CHANNEL_MOTIONDETECTION: | ||
| return getMotionState(); | ||
| case CHANNEL_INDOORAIRTEMPERATURE: | ||
| return getTemperature(); | ||
| case CHANNEL_HUMIDITY: | ||
| return getHumidity(); | ||
| case CHANNEL_ILLUMINATION: | ||
| return getIllumination(); | ||
| case CHANNEL_BATTERY_LEVEL: | ||
| return getBatteryLevel(); | ||
| } | ||
| } | ||
| return UnDefType.UNDEF; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.