From 2b9b3dfa0f39506a9bc4f450a52726f5c9daf0f6 Mon Sep 17 00:00:00 2001 From: David Pace Date: Mon, 11 Dec 2023 00:57:59 +0100 Subject: [PATCH] [boschshc] Add support for motion detector illuminance sensor (#16021) * [boschshc] Add support for motion detector illuminance sensor - add channel and corresponding channel type - add update description - add state model - implement service and handler - add documentation - add unit test --------- Signed-off-by: David Pace --- .../org.openhab.binding.boschshc/README.md | 2 + .../devices/BoschSHCBindingConstants.java | 1 + .../motiondetector/MotionDetectorHandler.java | 11 ++++++ .../illuminance/IlluminanceService.java | 31 +++++++++++++++ .../dto/IlluminanceServiceState.java | 39 +++++++++++++++++++ .../resources/OH-INF/thing/thing-types.xml | 12 ++++++ .../main/resources/OH-INF/update/binding.xml | 10 +++++ .../MotionDetectorHandlerTest.java | 14 +++++++ 8 files changed, 120 insertions(+) create mode 100644 bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/IlluminanceService.java create mode 100644 bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/dto/IlluminanceServiceState.java diff --git a/bundles/org.openhab.binding.boschshc/README.md b/bundles/org.openhab.binding.boschshc/README.md index 3448c644c..c17ce7ff8 100644 --- a/bundles/org.openhab.binding.boschshc/README.md +++ b/bundles/org.openhab.binding.boschshc/README.md @@ -29,6 +29,7 @@ Binding for the Bosch Smart Home. ## Supported Things ### Smart Home Controller + The Smart Home Controller is the central hub that allows you to monitor and control your smart home devices from one place. **Bridge Type ID**: ``shc`` @@ -103,6 +104,7 @@ Detects every movement through an intelligent combination of passive infra-red t | Channel Type ID | Item Type | Writable | Description | | --------------- | --------- | :------: | ------------------------------ | | latest-motion | DateTime | ☐ | The date of the latest motion. | +| illuminance | Number | ☐ | The illuminance level measured by the sensor as integer value in the range 0 to 1000. Note that the sensor only reports the value if the motion light service is activated or if the illuminance state is used in a scenario trigger condition. | | battery-level | Number | ☐ | Current battery level percentage as integer number. Bosch-specific battery levels are mapped to numbers as follows: `OK`: 100, `LOW_BATTERY`: 10, `CRITICAL_LOW`: 1, `CRITICALLY_LOW_BATTERY`: 1, `NOT_AVAILABLE`: `UNDEF`. | | low-battery | Switch | ☐ | Indicates whether the battery is low (`ON`) or OK (`OFF`). | diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCBindingConstants.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCBindingConstants.java index d99006889..c52024113 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCBindingConstants.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/BoschSHCBindingConstants.java @@ -85,6 +85,7 @@ public class BoschSHCBindingConstants { public static final String CHANNEL_BRIGHTNESS = "brightness"; public static final String CHANNEL_SMOKE_CHECK = "smoke-check"; public static final String CHANNEL_SILENT_MODE = "silent-mode"; + public static final String CHANNEL_ILLUMINANCE = "illuminance"; // static device/service names public static final String SERVICE_INTRUSION_DETECTION = "intrusionDetectionSystem"; diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java index 7ec1f56ce..f828e067f 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandler.java @@ -12,6 +12,7 @@ */ package org.openhab.binding.boschshc.internal.devices.motiondetector; +import static org.openhab.binding.boschshc.internal.devices.BoschSHCBindingConstants.CHANNEL_ILLUMINANCE; import static org.openhab.binding.boschshc.internal.devices.BoschSHCBindingConstants.CHANNEL_LATEST_MOTION; import java.util.List; @@ -19,9 +20,12 @@ import java.util.List; import org.eclipse.jdt.annotation.NonNullByDefault; import org.openhab.binding.boschshc.internal.devices.AbstractBatteryPoweredDeviceHandler; import org.openhab.binding.boschshc.internal.exceptions.BoschSHCException; +import org.openhab.binding.boschshc.internal.services.illuminance.IlluminanceService; +import org.openhab.binding.boschshc.internal.services.illuminance.dto.IlluminanceServiceState; import org.openhab.binding.boschshc.internal.services.latestmotion.LatestMotionService; import org.openhab.binding.boschshc.internal.services.latestmotion.dto.LatestMotionServiceState; import org.openhab.core.library.types.DateTimeType; +import org.openhab.core.library.types.DecimalType; import org.openhab.core.thing.Thing; /** @@ -30,6 +34,7 @@ import org.openhab.core.thing.Thing; * * @author Stefan Kästle - Initial contribution * @author Christian Oeing - Use service instead of custom logic + * @author David Pace - Added illuminance channel */ @NonNullByDefault public class MotionDetectorHandler extends AbstractBatteryPoweredDeviceHandler { @@ -43,10 +48,16 @@ public class MotionDetectorHandler extends AbstractBatteryPoweredDeviceHandler { super.initializeServices(); this.createService(LatestMotionService::new, this::updateChannels, List.of(CHANNEL_LATEST_MOTION)); + this.createService(IlluminanceService::new, this::updateChannels, List.of(CHANNEL_ILLUMINANCE), true); } private void updateChannels(LatestMotionServiceState state) { DateTimeType date = new DateTimeType(state.latestMotionDetected); updateState(CHANNEL_LATEST_MOTION, date); } + + private void updateChannels(IlluminanceServiceState state) { + DecimalType illuminance = new DecimalType(state.illuminance); + updateState(CHANNEL_ILLUMINANCE, illuminance); + } } diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/IlluminanceService.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/IlluminanceService.java new file mode 100644 index 000000000..065ea0dc0 --- /dev/null +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/IlluminanceService.java @@ -0,0 +1,31 @@ +/** + * Copyright (c) 2010-2023 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.boschshc.internal.services.illuminance; + +import org.eclipse.jdt.annotation.NonNullByDefault; +import org.openhab.binding.boschshc.internal.services.BoschSHCService; +import org.openhab.binding.boschshc.internal.services.illuminance.dto.IlluminanceServiceState; + +/** + * Service for the illuminance state of the motion detector sensor. + * + * @author David Pace - Initial contribution + * + */ +@NonNullByDefault +public class IlluminanceService extends BoschSHCService { + + public IlluminanceService() { + super("MultiLevelSensor", IlluminanceServiceState.class); + } +} diff --git a/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/dto/IlluminanceServiceState.java b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/dto/IlluminanceServiceState.java new file mode 100644 index 000000000..2edc8aa11 --- /dev/null +++ b/bundles/org.openhab.binding.boschshc/src/main/java/org/openhab/binding/boschshc/internal/services/illuminance/dto/IlluminanceServiceState.java @@ -0,0 +1,39 @@ +/** + * Copyright (c) 2010-2023 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.boschshc.internal.services.illuminance.dto; + +import org.openhab.binding.boschshc.internal.services.dto.BoschSHCServiceState; + +/** + * Illuminance state of the motion detector sensor. + *

+ * Example JSON: + * + * 

+ * {
+ *   "@type": "illuminanceLevelState",
+ *   "illuminance": 32
+ * }
+ *
+ * + * @author David Pace - Initial contribution + * + */ +public class IlluminanceServiceState extends BoschSHCServiceState { + + public IlluminanceServiceState() { + super("illuminanceLevelState"); + } + + public int illuminance; +} diff --git a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml index 1ff71e37d..0f880173c 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml +++ b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/thing/thing-types.xml @@ -114,10 +114,15 @@ + + + 1 + + @@ -490,6 +495,13 @@ + + Number + + The illuminance level measured by the sensor (0 to 1000). + + + Rollershutter diff --git a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/update/binding.xml b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/update/binding.xml index 814f6b8da..78bdc3fac 100644 --- a/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/update/binding.xml +++ b/bundles/org.openhab.binding.boschshc/src/main/resources/OH-INF/update/binding.xml @@ -2,6 +2,7 @@ + @@ -12,4 +13,13 @@ + + + + + boschshc:illuminance + + + + diff --git a/bundles/org.openhab.binding.boschshc/src/test/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandlerTest.java b/bundles/org.openhab.binding.boschshc/src/test/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandlerTest.java index 2f90424a2..05d9f279d 100644 --- a/bundles/org.openhab.binding.boschshc/src/test/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandlerTest.java +++ b/bundles/org.openhab.binding.boschshc/src/test/java/org/openhab/binding/boschshc/internal/devices/motiondetector/MotionDetectorHandlerTest.java @@ -19,6 +19,7 @@ import org.junit.jupiter.api.Test; import org.openhab.binding.boschshc.internal.devices.AbstractBatteryPoweredDeviceHandlerTest; import org.openhab.binding.boschshc.internal.devices.BoschSHCBindingConstants; import org.openhab.core.library.types.DateTimeType; +import org.openhab.core.library.types.DecimalType; import org.openhab.core.thing.ChannelUID; import org.openhab.core.thing.ThingTypeUID; @@ -62,4 +63,17 @@ class MotionDetectorHandlerTest extends AbstractBatteryPoweredDeviceHandlerTest< new ChannelUID(getThing().getUID(), BoschSHCBindingConstants.CHANNEL_LATEST_MOTION), new DateTimeType("2020-04-03T19:02:19.054Z")); } + + @Test + void testUpdateChannelsIlluminanceService() { + JsonElement jsonObject = JsonParser.parseString(""" + { + "@type": "illuminanceLevelState", + "illuminance": 42 + }\ + """); + getFixture().processUpdate("MultiLevelSensor", jsonObject); + verify(getCallback()).stateUpdated( + new ChannelUID(getThing().getUID(), BoschSHCBindingConstants.CHANNEL_ILLUMINANCE), new DecimalType(42)); + } }