[WIP] [dirigera] Initial contribution

CODEOWNERS

@@ -79,6 +79,7 @@
 /bundles/org.openhab.binding.deutschebahn/ @soenkekueper
 /bundles/org.openhab.binding.digiplex/ @rmichalak
 /bundles/org.openhab.binding.digitalstrom/ @openhab/add-ons-maintainers
+/bundles/org.openhab.binding.dirigera/ @weymann
 /bundles/org.openhab.binding.dlinksmarthome/ @MikeJMajor
 /bundles/org.openhab.binding.dmx/ @openhab/add-ons-maintainers
 /bundles/org.openhab.binding.dolbycp/ @Cybso

bom/openhab-addons/pom.xml

@@ -386,6 +386,11 @@
       <artifactId>org.openhab.binding.digitalstrom</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.addons.bundles</groupId>
+      <artifactId>org.openhab.binding.dirigera</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.addons.bundles</groupId>
       <artifactId>org.openhab.binding.dlinksmarthome</artifactId>

bundles/org.openhab.binding.dirigera/NOTICE

@@ -0,0 +1,13 @@
+This content is produced and maintained by the openHAB project.
+
+* Project home: https://www.openhab.org
+
+== Declared Project Licenses
+
+This program and the accompanying materials are made available under the terms
+of the Eclipse Public License 2.0 which is available at
+https://www.eclipse.org/legal/epl-2.0/.
+
+== Source Code
+
+https://github.com/openhab/openhab-addons

bundles/org.openhab.binding.dirigera/pom.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.openhab.addons.bundles</groupId>
+    <artifactId>org.openhab.addons.reactor.bundles</artifactId>
+    <version>4.3.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>org.openhab.binding.dirigera</artifactId>
+
+  <name>openHAB Add-ons :: Bundles :: Dirigera Binding</name>
+  <dependencies>
+    <!-- version needs to match with other projects like org.openhab.io.openhabcloud.pom.xml -->
+    <dependency>
+      <groupId>org.json</groupId>
+      <artifactId>json</artifactId>
+      <version>20231013</version>
+      <scope>compile</scope>
+    </dependency>
+  </dependencies>
+
+</project>

bundles/org.openhab.binding.dirigera/src/main/feature/feature.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<features name="org.openhab.binding.dirigera-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
+	<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>
+
+	<feature name="openhab-binding-dirigera" description="Dirigera Binding" version="${project.version}">
+		<feature>openhab-runtime-base</feature>
+		<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.dirigera/${project.version}</bundle>
+	</feature>
+</features>

bundles/org.openhab.binding.dirigera/src/main/java/org/openhab/binding/dirigera/internal/DirigeraCommandProvider.java

@@ -0,0 +1,41 @@
+/**
+ * Copyright (c) 2010-2024 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.dirigera.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.events.EventPublisher;
+import org.openhab.core.thing.binding.BaseDynamicCommandDescriptionProvider;
+import org.openhab.core.thing.i18n.ChannelTypeI18nLocalizationService;
+import org.openhab.core.thing.link.ItemChannelLinkRegistry;
+import org.openhab.core.thing.type.DynamicCommandDescriptionProvider;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+
+/**
+ * Dynamic provider of command options while leaving other state description fields as original.
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+@Component(service = { DynamicCommandDescriptionProvider.class, DirigeraCommandProvider.class })
+public class DirigeraCommandProvider extends BaseDynamicCommandDescriptionProvider {
+    @Activate
+    public DirigeraCommandProvider(final @Reference EventPublisher eventPublisher, //
+            final @Reference ItemChannelLinkRegistry itemChannelLinkRegistry, //
+            final @Reference ChannelTypeI18nLocalizationService channelTypeI18nLocalizationService) {
+        this.eventPublisher = eventPublisher;
+        this.itemChannelLinkRegistry = itemChannelLinkRegistry;
+        this.channelTypeI18nLocalizationService = channelTypeI18nLocalizationService;
+    }
+}

bundles/org.openhab.binding.dirigera/src/main/java/org/openhab/binding/dirigera/internal/DirigeraHandlerFactory.java

@@ -0,0 +1,174 @@
+/**
+ * Copyright (c) 2010-2024 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.dirigera.internal;
+
+import static org.openhab.binding.dirigera.internal.Constants.*;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.eclipse.jetty.client.HttpClient;
+import org.eclipse.jetty.client.WWWAuthenticationProtocolHandler;
+import org.eclipse.jetty.util.ssl.SslContextFactory;
+import org.openhab.binding.dirigera.internal.discovery.DirigeraDiscoveryManager;
+import org.openhab.binding.dirigera.internal.handler.DirigeraHandler;
+import org.openhab.binding.dirigera.internal.handler.airpurifier.AirPurifierHandler;
+import org.openhab.binding.dirigera.internal.handler.blind.BlindHandler;
+import org.openhab.binding.dirigera.internal.handler.controller.BlindsControllerHandler;
+import org.openhab.binding.dirigera.internal.handler.controller.DoubleShortcutControllerHandler;
+import org.openhab.binding.dirigera.internal.handler.controller.LightControllerHandler;
+import org.openhab.binding.dirigera.internal.handler.controller.ShortcutControllerHandler;
+import org.openhab.binding.dirigera.internal.handler.controller.SoundControllerHandler;
+import org.openhab.binding.dirigera.internal.handler.light.ColorLightHandler;
+import org.openhab.binding.dirigera.internal.handler.light.DimmableLightHandler;
+import org.openhab.binding.dirigera.internal.handler.light.SwitchLightHandler;
+import org.openhab.binding.dirigera.internal.handler.light.TemperatureLightHandler;
+import org.openhab.binding.dirigera.internal.handler.plug.PowerPlugHandler;
+import org.openhab.binding.dirigera.internal.handler.plug.SimplePlugHandler;
+import org.openhab.binding.dirigera.internal.handler.plug.SmartPlugHandler;
+import org.openhab.binding.dirigera.internal.handler.repeater.RepeaterHandler;
+import org.openhab.binding.dirigera.internal.handler.scene.SceneHandler;
+import org.openhab.binding.dirigera.internal.handler.sensor.AirQualityHandler;
+import org.openhab.binding.dirigera.internal.handler.sensor.ContactSensorHandler;
+import org.openhab.binding.dirigera.internal.handler.sensor.MotionLightSensorHandler;
+import org.openhab.binding.dirigera.internal.handler.sensor.MotionSensorHandler;
+import org.openhab.binding.dirigera.internal.handler.sensor.WaterSensorHandler;
+import org.openhab.binding.dirigera.internal.handler.speaker.SpeakerHandler;
+import org.openhab.core.i18n.LocationProvider;
+import org.openhab.core.i18n.TimeZoneProvider;
+import org.openhab.core.net.NetworkAddressService;
+import org.openhab.core.storage.Storage;
+import org.openhab.core.storage.StorageService;
+import org.openhab.core.thing.Bridge;
+import org.openhab.core.thing.Thing;
+import org.openhab.core.thing.ThingTypeUID;
+import org.openhab.core.thing.binding.BaseThingHandlerFactory;
+import org.openhab.core.thing.binding.ThingHandler;
+import org.openhab.core.thing.binding.ThingHandlerFactory;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+/**
+ * The {@link DirigeraHandlerFactory} is responsible for creating things and thing
+ * handlers.
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+@Component(configurationPid = "binding.dirigera", service = ThingHandlerFactory.class)
+public class DirigeraHandlerFactory extends BaseThingHandlerFactory {
+    private final Logger logger = LoggerFactory.getLogger(DirigeraHandlerFactory.class);
+    private final DirigeraDiscoveryManager discoveryManager;
+    private final DirigeraCommandProvider commandProvider;
+    private final TimeZoneProvider timeZoneProvider;
+    private final LocationProvider locationProvider;
+    private final Storage<String> bindingStorage;
+    private final HttpClient insecureClient;
+
+    @Activate
+    public DirigeraHandlerFactory(@Reference StorageService storageService,
+            final @Reference NetworkAddressService networkService, final @Reference DirigeraDiscoveryManager manager,
+            final @Reference TimeZoneProvider timeZoneProvider, final @Reference LocationProvider locationProvider,
+            final @Reference DirigeraCommandProvider commandProvider) {
+        this.discoveryManager = manager;
+        this.timeZoneProvider = timeZoneProvider;
+        this.locationProvider = locationProvider;
+        this.commandProvider = commandProvider;
+        this.insecureClient = new HttpClient(new SslContextFactory.Client(true));
+        insecureClient.setUserAgentField(null);
+        try {
+            this.insecureClient.start();
+            // from https://github.com/jetty-project/jetty-reactive-httpclient/issues/33#issuecomment-777771465
+            insecureClient.getProtocolHandlers().remove(WWWAuthenticationProtocolHandler.NAME);
+        } catch (Exception e) {
+            // catching exception is necessary due to the signature of HttpClient.start()
+            logger.warn("Failed to start http client: {}", e.getMessage());
+            throw new IllegalStateException("Could not create HttpClient", e);
+        }
+        String ip = networkService.getPrimaryIpv4HostAddress();
+        if (ip == null) {
+            logger.warn("Cannot find host IP");
+            ip = "";
+        } else {
+            manager.initialize(insecureClient, ip);
+        }
+        bindingStorage = storageService.getStorage(BINDING_ID);
+    }
+
+    @Override
+    public boolean supportsThingType(ThingTypeUID thingTypeUID) {
+        boolean isSupported = SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
+        // logger.warn("Request for {} is supported {}", thingTypeUID, isSupported);
+        return isSupported;
+    }
+
+    @Override
+    protected @Nullable ThingHandler createHandler(Thing thing) {
+        ThingTypeUID thingTypeUID = thing.getThingTypeUID();
+        if (THING_TYPE_GATEWAY.equals(thingTypeUID)) {
+            return new DirigeraHandler((Bridge) thing, insecureClient, bindingStorage, discoveryManager,
+                    timeZoneProvider, locationProvider, commandProvider, bundleContext);
+        } else if (THING_TYPE_COLOR_LIGHT.equals(thingTypeUID)) {
+            return new ColorLightHandler(thing, COLOR_LIGHT_MAP);
+        } else if (THING_TYPE_TEMPERATURE_LIGHT.equals(thingTypeUID)) {
+            return new TemperatureLightHandler(thing, TEMPERATURE_LIGHT_MAP);
+        } else if (THING_TYPE_DIMMABLE_LIGHT.equals(thingTypeUID)) {
+            return new DimmableLightHandler(thing, TEMPERATURE_LIGHT_MAP);
+        } else if (THING_TYPE_SWITCH_LIGHT.equals(thingTypeUID)) {
+            return new SwitchLightHandler(thing, TEMPERATURE_LIGHT_MAP);
+        } else if (THING_TYPE_MOTION_SENSOR.equals(thingTypeUID)) {
+            return new MotionSensorHandler(thing, MOTION_SENSOR_MAP);
+            // } else if (THING_TYPE_LIGHT_SENSOR.equals(thingTypeUID)) {
+            // return new LightSensorHandler(thing, LIGHT_SENSOR_MAP);
+        } else if (THING_TYPE_MOTION_LIGHT_SENSOR.equals(thingTypeUID)) {
+            return new MotionLightSensorHandler(thing, MOTION_LIGHT_SENSOR_MAP);
+        } else if (THING_TYPE_CONTACT_SENSOR.equals(thingTypeUID)) {
+            return new ContactSensorHandler(thing, CONTACT_SENSOR_MAP);
+        } else if (THING_TYPE_SIMPLE_PLUG.equals(thingTypeUID)) {
+            return new SimplePlugHandler(thing, SMART_PLUG_MAP);
+        } else if (THING_TYPE_POWER_PLUG.equals(thingTypeUID)) {
+            return new PowerPlugHandler(thing, SMART_PLUG_MAP);
+        } else if (THING_TYPE_SMART_PLUG.equals(thingTypeUID)) {
+            return new SmartPlugHandler(thing, SMART_PLUG_MAP);
+        } else if (THING_TYPE_SPEAKER.equals(thingTypeUID)) {
+            return new SpeakerHandler(thing, SPEAKER_MAP);
+        } else if (THING_TYPE_SCENE.equals(thingTypeUID)) {
+            return new SceneHandler(thing, SCENE_MAP, timeZoneProvider);
+        } else if (THING_TYPE_REPEATER.equals(thingTypeUID)) {
+            return new RepeaterHandler(thing, REPEATER_MAP);
+        } else if (THING_TYPE_LIGHT_CONTROLLER.equals(thingTypeUID)) {
+            return new LightControllerHandler(thing, LIGHT_CONTROLLER_MAP);
+        } else if (THING_TYPE_BLIND_CONTROLLER.equals(thingTypeUID)) {
+            return new BlindsControllerHandler(thing, BLIND_CONTROLLER_MAP);
+        } else if (THING_TYPE_SOUND_CONTROLLER.equals(thingTypeUID)) {
+            return new SoundControllerHandler(thing, SOUND_CONTROLLER_MAP);
+        } else if (THING_TYPE_SINGLE_SHORTCUT_CONTROLLER.equals(thingTypeUID)) {
+            return new ShortcutControllerHandler(thing, SHORTCUT_CONTROLLER_MAP, bindingStorage);
+        } else if (THING_TYPE_DOUBLE_SHORTCUT_CONTROLLER.equals(thingTypeUID)) {
+            return new DoubleShortcutControllerHandler(thing, SHORTCUT_CONTROLLER_MAP, bindingStorage);
+        } else if (THING_TYPE_AIR_QUALITY.equals(thingTypeUID)) {
+            return new AirQualityHandler(thing, AIR_QUALITY_MAP);
+        } else if (THING_TYPE_WATER_SENSOR.equals(thingTypeUID)) {
+            return new WaterSensorHandler(thing, WATER_SENSOR_MAP);
+        } else if (THING_TYPE_BLIND.equals(thingTypeUID)) {
+            return new BlindHandler(thing, BLINDS_MAP);
+        } else if (THING_TYPE_AIR_PURIFIER.equals(thingTypeUID)) {
+            return new AirPurifierHandler(thing, AIR_PURIFIER_MAP);
+        } else {
+            logger.info("Request for {} doesn't match {}", thingTypeUID, THING_TYPE_GATEWAY);
+            return null;
+        }
+    }
+}

bundles/org.openhab.binding.dirigera/src/main/java/org/openhab/binding/dirigera/internal/config/BaseDeviceConfiguration.java

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2010-2024 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.dirigera.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * The {@link BaseDeviceConfiguration} configuration for all devices
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+public class BaseDeviceConfiguration {
+
+    public String id = "";
+}

bundles/org.openhab.binding.dirigera/src/main/java/org/openhab/binding/dirigera/internal/config/ColorLightConfiguration.java

@@ -0,0 +1,27 @@
+/**
+ * Copyright (c) 2010-2024 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.dirigera.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * {@link ColorLightConfiguration} configuration for lights with temperature or color attributes
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+public class ColorLightConfiguration extends BaseDeviceConfiguration {
+
+    public int fadeTime = 750;
+    public int fadeSequence = 0;
+}

bundles/org.openhab.binding.dirigera/src/main/java/org/openhab/binding/dirigera/internal/config/DirigeraConfiguration.java

@@ -0,0 +1,32 @@
+/**
+ * Copyright (c) 2010-2024 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.dirigera.internal.config;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * The {@link DirigeraConfiguration} class contains fields mapping thing configuration parameters.
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+public class DirigeraConfiguration extends BaseDeviceConfiguration {
+
+    public String ipAddress = "";
+    public boolean discovery = true;
+
+    @Override
+    public String toString() {
+        return "IP: " + ipAddress + ", ID: " + id;
+    }
+}