[onecta] Initial contribution

bom/openhab-addons/pom.xml

@@ -1326,6 +1326,11 @@
       <artifactId>org.openhab.binding.onewiregpio</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.addons.bundles</groupId>
+      <artifactId>org.openhab.binding.onecta</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.addons.bundles</groupId>
       <artifactId>org.openhab.binding.onkyo</artifactId>

bundles/org.openhab.binding.onecta/NOTICE

@@ -0,0 +1,25 @@
+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
+
+== Third-party Content
+
+jackson
+* License: Apache 2.0 License
+* Project: https://github.com/FasterXML/jackson
+* Source:  https://github.com/FasterXML/jackson
+
+gson
+* License: Apache 2.0 License
+* Project: https://github.com/google/gson
+* Source:  https://github.com/google/gson

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

@@ -0,0 +1,28 @@
+<?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.onecta</artifactId>
+
+  <name>openHAB Add-ons :: Bundles :: Onecta Binding</name>
+  <dependencies>
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-annotations</artifactId>
+      <version>${jackson.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>com.google.code.gson</groupId>
+      <artifactId>gson</artifactId>
+      <version>${gson.version}</version>
+    </dependency>
+  </dependencies>
+</project>

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

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<features name="org.openhab.binding.onecta-${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-onecta" description="Onecta Binding" version="${project.version}">
+		<feature>openhab-runtime-base</feature>
+		<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.onecta/${project.version}</bundle>
+	</feature>
+</features>

bundles/org.openhab.binding.onecta/src/main/java/org/openhab/binding/onecta/internal/OnectaBridgeConstants.java

@@ -0,0 +1,54 @@
+/**
+ * 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.onecta.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.thing.ThingTypeUID;
+
+/**
+ * The {@link OnectaBridgeConstants} class defines common constants, which are
+ * used across the whole binding.
+ *
+ * @author Alexander Drent - Initial contribution
+ */
+@NonNullByDefault
+public class OnectaBridgeConstants {
+
+    private static final String BINDING_ID = "onecta";
+    public static final String BRIDGE = "account";
+    // List of all Device Types
+    public static final String DEVICE_TYPE_GATEWAY = "gateway";
+    public static final String DEVICE_TYPE_CLIMATECONTROL = "climate-control";
+    public static final String DEVICE_TYPE_WATERTANK = "domestic-hotwatertank";
+    public static final String DEVICE_TYPE_INDOORUNIT = "indoor-unit";
+
+    // List of config parameters
+    public static final String CONFIG_PAR_PASSWORD = "password";
+    public static final String CONFIG_PAR_USERID = "userId";
+    public static final String CONFIG_PAR_REFRESHINTERVAL = "refreshInterval";
+    public static final String CONFIG_PAR_UNITID = "unitID";
+    public static final String CHANNEL_OPENHAB_HOST = "openhabHost";
+
+    // List of all Bridge Thing Type UIDs
+    public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, BRIDGE);
+
+    // List of all Thing Type UIDs
+    public static final ThingTypeUID THING_TYPE_CLIMATECONTROL = new ThingTypeUID(BINDING_ID,
+            DEVICE_TYPE_CLIMATECONTROL);
+    public static final ThingTypeUID THING_TYPE_GATEWAY = new ThingTypeUID(BINDING_ID, DEVICE_TYPE_GATEWAY);
+    public static final ThingTypeUID THING_TYPE_WATERTANK = new ThingTypeUID(BINDING_ID, DEVICE_TYPE_WATERTANK);
+    public static final ThingTypeUID THING_TYPE_INDOORUNIT = new ThingTypeUID(BINDING_ID, DEVICE_TYPE_INDOORUNIT);
+
+    public static final String THIRD_PARTY_ENDPOINTS_BASENAME = "https://idp.onecta.daikineurope.com/v1/oidc";
+    public static final String OAUTH2_SERVICE_HANDLE = BINDING_ID + ":" + BRIDGE;
+}

bundles/org.openhab.binding.onecta/src/main/java/org/openhab/binding/onecta/internal/OnectaBridgeHandlerFactory.java

@@ -0,0 +1,111 @@
+/**
+ * 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.onecta.internal;
+
+import static org.openhab.binding.onecta.internal.OnectaBridgeConstants.*;
+
+import java.util.HashMap;
+import java.util.Hashtable;
+import java.util.Map;
+import java.util.Set;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.binding.onecta.internal.handler.OnectaBridgeHandler;
+import org.openhab.binding.onecta.internal.handler.OnectaDeviceHandler;
+import org.openhab.binding.onecta.internal.handler.OnectaGatewayHandler;
+import org.openhab.binding.onecta.internal.handler.OnectaIndoorUnitHandler;
+import org.openhab.binding.onecta.internal.handler.OnectaWaterTankHandler;
+import org.openhab.binding.onecta.internal.oauth2.auth.OAuthTokenRefresher;
+import org.openhab.binding.onecta.internal.service.DeviceDiscoveryService;
+import org.openhab.core.config.discovery.DiscoveryService;
+import org.openhab.core.io.net.http.HttpClientFactory;
+import org.openhab.core.thing.Bridge;
+import org.openhab.core.thing.Thing;
+import org.openhab.core.thing.ThingTypeUID;
+import org.openhab.core.thing.ThingUID;
+import org.openhab.core.thing.binding.BaseThingHandlerFactory;
+import org.openhab.core.thing.binding.ThingHandler;
+import org.openhab.core.thing.binding.ThingHandlerFactory;
+import org.osgi.framework.ServiceRegistration;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Reference;
+
+/**
+ * The {@link OnectaBridgeHandlerFactory} is responsible for creating things and thing
+ * handlers.
+ *
+ * @author Alexander Drent - Initial contribution
+ */
+@NonNullByDefault
+@Component(configurationPid = "binding.onecta", service = ThingHandlerFactory.class)
+public class OnectaBridgeHandlerFactory extends BaseThingHandlerFactory {
+
+    private static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Set.of(THING_TYPE_BRIDGE,
+            THING_TYPE_CLIMATECONTROL, THING_TYPE_GATEWAY, THING_TYPE_WATERTANK, THING_TYPE_INDOORUNIT);
+
+    private Map<ThingUID, ServiceRegistration<?>> discoveryServiceRegs = new HashMap<>();
+    private OnectaConfiguration onectaConfiguration = new OnectaConfiguration();
+
+    @Activate
+    public OnectaBridgeHandlerFactory(@Reference HttpClientFactory httpClientFactory,
+            @Reference OAuthTokenRefresher openHabOAuthTokenRefresher) {
+        onectaConfiguration.setHttpClientFactory(httpClientFactory);
+        OnectaConfiguration.setOAuthTokenRefresher(openHabOAuthTokenRefresher);
+    }
+
+    @Override
+    public boolean supportsThingType(ThingTypeUID thingTypeUID) {
+        return SUPPORTED_THING_TYPES_UIDS.contains(thingTypeUID);
+    }
+
+    @Override
+    protected @Nullable ThingHandler createHandler(Thing thing) {
+        ThingTypeUID thingTypeUID = thing.getThingTypeUID();
+
+        if (thingTypeUID.equals((THING_TYPE_BRIDGE))) {
+            OnectaBridgeHandler bridgeHandler = new OnectaBridgeHandler((Bridge) thing);
+            onectaConfiguration.setBridgeThing((Bridge) thing);
+
+            DeviceDiscoveryService deviceDiscoveryService = new DeviceDiscoveryService(bridgeHandler);
+            bridgeHandler.setDiscovery(deviceDiscoveryService);
+
+            this.discoveryServiceRegs.put(thing.getUID(), bundleContext.registerService(
+                    DiscoveryService.class.getName(), deviceDiscoveryService, new Hashtable<String, Object>()));
+
+            return bridgeHandler;
+        } else if (thingTypeUID.equals(THING_TYPE_CLIMATECONTROL)) {
+            return new OnectaDeviceHandler(thing);
+        } else if (thingTypeUID.equals((THING_TYPE_GATEWAY))) {
+            return new OnectaGatewayHandler(thing);
+        } else if (thingTypeUID.equals((THING_TYPE_WATERTANK))) {
+            return new OnectaWaterTankHandler(thing);
+        } else if (thingTypeUID.equals((THING_TYPE_INDOORUNIT))) {
+            return new OnectaIndoorUnitHandler(thing);
+        }
+        return null;
+    }
+
+    @Override
+    protected void removeHandler(ThingHandler handler) {
+        if (handler.getThing().getThingTypeUID().equals(THING_TYPE_BRIDGE)) {
+            ServiceRegistration<?> serviceReg = this.discoveryServiceRegs.get(handler.getThing().getUID());
+            if (serviceReg != null) {
+                serviceReg.unregister();
+                discoveryServiceRegs.remove(handler.getThing().getUID());
+            }
+        }
+        super.removeHandler(handler);
+    }
+}

bundles/org.openhab.binding.onecta/src/main/java/org/openhab/binding/onecta/internal/OnectaConfiguration.java

@@ -0,0 +1,69 @@
+/**
+ * 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.onecta.internal;
+
+import static org.openhab.binding.onecta.internal.OnectaBridgeConstants.*;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.eclipse.jetty.client.HttpClient;
+import org.openhab.binding.onecta.internal.oauth2.auth.OAuthTokenRefresher;
+import org.openhab.core.io.net.http.HttpClientFactory;
+import org.openhab.core.thing.Thing;
+
+/**
+ * The {@link OnectaConfiguration} class contains fields mapping thing configuration parameters.
+ *
+ * @author Alexander Drent - Initial contribution
+ */
+@NonNullByDefault
+public class OnectaConfiguration {
+
+    /**
+     * Sample configuration parameters. Replace with your own.
+     */
+    private @Nullable static Thing bridgeThing = null;
+    private @Nullable static HttpClientFactory httpClientFactory = null;
+
+    private @Nullable static HttpClient httpClient = null;
+    private @Nullable static OAuthTokenRefresher openHabOAuthTokenRefresher = null;
+
+    public static void setHttpClientFactory(HttpClientFactory httpClientFactory) {
+        OnectaConfiguration.httpClientFactory = httpClientFactory;
+        httpClient = httpClientFactory.getCommonHttpClient();
+    }
+
+    public static void setBridgeThing(Thing bridgeThing) {
+        OnectaConfiguration.bridgeThing = bridgeThing;
+    }
+
+    public static String getHost() {
+        return OnectaConfiguration.bridgeThing.getConfiguration().get(CHANNEL_OPENHAB_HOST).toString();
+    };
+
+    public static @Nullable HttpClient getHttpClient() {
+        return httpClient;
+    }
+
+    public static @Nullable HttpClientFactory getHttpClientFactory() {
+        return httpClientFactory;
+    }
+
+    public static void setOAuthTokenRefresher(OAuthTokenRefresher openHabOAuthTokenRefresher) {
+        OnectaConfiguration.openHabOAuthTokenRefresher = openHabOAuthTokenRefresher;
+    }
+
+    public static @Nullable OAuthTokenRefresher getOAuthTokenRefresher() {
+        return openHabOAuthTokenRefresher;
+    }
+}

bundles/org.openhab.binding.onecta/src/main/java/org/openhab/binding/onecta/internal/OnectaDeviceConstants.java

@@ -0,0 +1,70 @@
+/**
+ * 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.onecta.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+
+/**
+ * The {@link OnectaDeviceConstants} class defines common constants, which are
+ * used across the whole binding.
+ *
+ * @author Alexander Drent - Initial contribution
+ */
+@NonNullByDefault
+public class OnectaDeviceConstants {
+
+    // List of all Channel ids
+    public static final String CHANNEL_AC_TEMP = "basic#settemp";
+    public static final String CHANNEL_AC_TEMPMIN = "basic#settempmin";
+    public static final String CHANNEL_AC_TEMPMAX = "basic#settempmax";
+    public static final String CHANNEL_AC_TEMPSTEP = "basic#settempstep";
+    public static final String CHANNEL_AC_TARGETTEMP = "basic#targettemp";
+    public static final String CHANNEL_AC_TARGETTEMPMIN = "basic#targettempmin";
+    public static final String CHANNEL_AC_TARGETTEMPMAX = "basic#targettempmax";
+    public static final String CHANNEL_AC_TARGETTEMPSTEP = "basic#targettempstep";
+    public static final String CHANNEL_INDOOR_TEMP = "basic#indoortemp";
+    public static final String CHANNEL_LEAVINGWATER_TEMP = "basic#leavingwatertemp";
+    public static final String CHANNEL_OUTDOOR_TEMP = "basic#outdoortemp";
+    public static final String CHANNEL_INDOOR_HUMIDITY = "basic#humidity";
+    public static final String CHANNEL_AC_POWER = "basic#power";
+    public static final String CHANNEL_AC_POWERFULMODE = "basic#powerfulmode";
+    public static final String CHANNEL_AC_RAWDATA = "extra#rawdata";
+    public static final String CHANNEL_AC_OPERATIONMODE = "basic#operationmode";
+    public static final String CHANNEL_AC_NAME = "basic#name";
+    public static final String CHANNEL_AC_FANSPEED = "basic#fanspeed";
+    public static final String CHANNEL_AC_FANMOVEMENT_HOR = "basic#fandirhor";
+    public static final String CHANNEL_AC_FANMOVEMENT_VER = "basic#fandirver";
+    public static final String CHANNEL_AC_FANMOVEMENT = "basic#fandir";
+    public static final String CHANNEL_AC_ECONOMODE = "basic#economode";
+    public static final String CHANNEL_AC_STREAMER = "basic#streamer";
+    public static final String CHANNEL_AC_HOLIDAYMODE = "basic#holidaymode";
+    public static final String CHANNEL_AC_SETPOINT_LEAVINGWATER_OFFSET = "basic#setleavingwateroffset";
+    public static final String CHANNEL_AC_SETPOINT_LEAVINGWATER_TEMP = "basic#setleavingwatertemp";
+    public static final String CHANNEL_AC_TIMESTAMP = "basic#timestamp";
+    public static final String CHANNEL_AC_DEMANDCONTROL = "demandcontrol#demandcontrol";
+    public static final String CHANNEL_AC_DEMANDCONTROLFIXEDVALUE = "demandcontrol#demandcontrolfixedvalue";
+    public static final String CHANNEL_AC_DEMANDCONTROLFIXEDSTEPVALUE = "demandcontrol#demandcontrolfixedstepvalue";
+    public static final String CHANNEL_AC_DEMANDCONTROLFIXEDMINVALUE = "demandcontrol#demandcontrolfixedminvalue";
+    public static final String CHANNEL_AC_DEMANDCONTROLFIXEDMAXVALUE = "demandcontrol#demandcontrolfixedmaxvalue";
+    public static final String CHANNEL_AC_ENERGY_COOLING_DAY = "consumption-data-cooling#energycoolingday-%s";
+    public static final String CHANNEL_AC_ENERGY_COOLING_WEEK = "consumption-data-cooling#energycoolingweek-%s";
+    public static final String CHANNEL_AC_ENERGY_COOLING_MONTH = "consumption-data-cooling#energycoolingmonth-%s";
+    public static final String CHANNEL_AC_ENERGY_HEATING_DAY = "consumption-data-heating#energyheatingday-%s";
+    public static final String CHANNEL_AC_ENERGY_HEATING_WEEK = "consumption-data-heating#energyheatingweek-%s";
+    public static final String CHANNEL_AC_ENERGY_HEATING_MONTH = "consumption-data-heating#energyheatingmonth-%s";
+    public static final String CHANNEL_AC_ENERGY_HEATING_CURRENT_DAY = "consumption-data-heating#energyheatingcurrentday";
+    public static final String CHANNEL_AC_ENERGY_HEATING_CURRENT_YEAR = "consumption-data-heating#energyheatingcurrentyear";
+    public static final String CHANNEL_AC_ENERGY_COOLING_CURRENT_DAY = "consumption-data-cooling#energycoolingcurrentday";
+    public static final String CHANNEL_AC_ENERGY_COOLING_CURRENT_YEAR = "consumption-data-cooling#energycoolingcurrentyear";
+    public static final String PROPERTY_AC_NAME = "name";
+}