[BMW ConnectedDrive] initial contribution

CODEOWNERS

@@ -35,6 +35,7 @@
 /bundles/org.openhab.binding.bluetooth.govee/ @cpmeister
 /bundles/org.openhab.binding.bluetooth.roaming/ @cpmeister
 /bundles/org.openhab.binding.bluetooth.ruuvitag/ @ssalonen
+/bundles/org.openhab.binding.bmwconnecteddrive/ @weymann @ntruchsess
 /bundles/org.openhab.binding.boschindego/ @jofleck
 /bundles/org.openhab.binding.boschshc/ @stefan-kaestle @coeing @GerdZanker
 /bundles/org.openhab.binding.bosesoundtouch/ @marvkis @tratho

bom/openhab-addons/pom.xml

@@ -161,6 +161,11 @@
       <artifactId>org.openhab.binding.bluetooth.ruuvitag</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.addons.bundles</groupId>
+      <artifactId>org.openhab.binding.bmwconnecteddrive</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.addons.bundles</groupId>
       <artifactId>org.openhab.binding.boschindego</artifactId>

bundles/org.openhab.binding.bmwconnecteddrive/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.bmwconnecteddrive/pom.xml

@@ -0,0 +1,17 @@
+<?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 http://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>3.1.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>org.openhab.binding.bmwconnecteddrive</artifactId>
+
+  <name>openHAB Add-ons :: Bundles :: BMWConnectedDrive Binding</name>
+
+</project>

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

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

bundles/org.openhab.binding.bmwconnecteddrive/src/main/java/org/openhab/binding/bmwconnecteddrive/internal/ConnectedDriveConfiguration.java

@@ -0,0 +1,40 @@
+/**
+ * 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.bmwconnecteddrive.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.binding.bmwconnecteddrive.internal.utils.Constants;
+
+/**
+ * The {@link ConnectedDriveConfiguration} class contains fields mapping thing configuration parameters.
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+public class ConnectedDriveConfiguration {
+
+    /**
+     * Depending on the location the correct server needs to be called
+     */
+    public String region = Constants.EMPTY;
+
+    /**
+     * BMW Connected Drive Username
+     */
+    public String userName = Constants.EMPTY;
+
+    /**
+     * BMW Connected Drive Password
+     */
+    public String password = Constants.EMPTY;
+}

bundles/org.openhab.binding.bmwconnecteddrive/src/main/java/org/openhab/binding/bmwconnecteddrive/internal/ConnectedDriveConstants.java

@@ -0,0 +1,200 @@
+/**
+ * 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.bmwconnecteddrive.internal;
+
+import java.util.Set;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.thing.ThingTypeUID;
+
+/**
+ * The {@link ConnectedDriveConstants} class defines common constants, which are
+ * used across the whole binding.
+ *
+ * @author Bernd Weymann - Initial contribution
+ * @author Norbert Truchsess - edit & send of charge profile
+ */
+@NonNullByDefault
+public class ConnectedDriveConstants {
+
+    private static final String BINDING_ID = "bmwconnecteddrive";
+
+    // Units
+    public static final String UNITS_AUTODETECT = "AUTODETECT";
+    public static final String UNITS_IMPERIAL = "IMPERIAL";
+    public static final String UNITS_METRIC = "METRIC";
+
+    public static final String VIN = "vin";
+
+    public static final int DEFAULT_IMAGE_SIZE_PX = 1024;
+    public static final int DEFAULT_REFRESH_INTERVAL_MINUTES = 5;
+    public static final String DEFAULT_IMAGE_VIEWPORT = "FRONT";
+
+    // See constants from bimmer-connected
+    // https://github.com/bimmerconnected/bimmer_connected/blob/master/bimmer_connected/vehicle.py
+    public enum VehicleType {
+        CONVENTIONAL("conv"),
+        PLUGIN_HYBRID("phev"),
+        ELECTRIC_REX("bev_rex"),
+        ELECTRIC("bev");
+
+        private final String type;
+
+        VehicleType(String s) {
+            type = s;
+        }
+
+        @Override
+        public String toString() {
+            return type;
+        }
+    }
+
+    public enum ChargingMode {
+        IMMEDIATE_CHARGING,
+        DELAYED_CHARGING
+    }
+
+    public enum ChargingPreference {
+        NO_PRESELECTION,
+        CHARGING_WINDOW
+    }
+
+    public static final Set<String> FUEL_VEHICLES = Set.of(VehicleType.CONVENTIONAL.toString(),
+            VehicleType.PLUGIN_HYBRID.toString(), VehicleType.ELECTRIC_REX.toString());
+    public static final Set<String> ELECTRIC_VEHICLES = Set.of(VehicleType.ELECTRIC.toString(),
+            VehicleType.PLUGIN_HYBRID.toString(), VehicleType.ELECTRIC_REX.toString());
+
+    // Countries with Mileage display
+    public static final Set<String> IMPERIAL_COUNTRIES = Set.of("US", "GB");
+
+    // List of all Thing Type UIDs
+    public static final ThingTypeUID THING_TYPE_CONNECTED_DRIVE_ACCOUNT = new ThingTypeUID(BINDING_ID, "account");
+    public static final ThingTypeUID THING_TYPE_CONV = new ThingTypeUID(BINDING_ID,
+            VehicleType.CONVENTIONAL.toString());
+    public static final ThingTypeUID THING_TYPE_PHEV = new ThingTypeUID(BINDING_ID,
+            VehicleType.PLUGIN_HYBRID.toString());
+    public static final ThingTypeUID THING_TYPE_BEV_REX = new ThingTypeUID(BINDING_ID,
+            VehicleType.ELECTRIC_REX.toString());
+    public static final ThingTypeUID THING_TYPE_BEV = new ThingTypeUID(BINDING_ID, VehicleType.ELECTRIC.toString());
+    public static final Set<ThingTypeUID> SUPPORTED_THING_SET = Set.of(THING_TYPE_CONNECTED_DRIVE_ACCOUNT,
+            THING_TYPE_CONV, THING_TYPE_PHEV, THING_TYPE_BEV_REX, THING_TYPE_BEV);
+
+    // Thing Group definitions
+    public static final String CHANNEL_GROUP_STATUS = "status";
+    public static final String CHANNEL_GROUP_SERVICE = "service";
+    public static final String CHANNEL_GROUP_CHECK_CONTROL = "check";
+    public static final String CHANNEL_GROUP_DOORS = "doors";
+    public static final String CHANNEL_GROUP_RANGE = "range";
+    public static final String CHANNEL_GROUP_LOCATION = "location";
+    public static final String CHANNEL_GROUP_LAST_TRIP = "last-trip";
+    public static final String CHANNEL_GROUP_LIFETIME = "lifetime";
+    public static final String CHANNEL_GROUP_REMOTE = "remote";
+    public static final String CHANNEL_GROUP_CHARGE = "charge";
+    public static final String CHANNEL_GROUP_VEHICLE_IMAGE = "image";
+    public static final String CHANNEL_GROUP_DESTINATION = "destination";
+
+    // Generic Constants for several groups
+    public static final String NAME = "name";
+    public static final String DETAILS = "details";
+    public static final String DATE = "date";
+    public static final String MILEAGE = "mileage";
+    public static final String GPS = "gps";
+    public static final String HEADING = "heading";
+
+    // Status
+    public static final String DOORS = "doors";
+    public static final String WINDOWS = "windows";
+    public static final String LOCK = "lock";
+    public static final String SERVICE_DATE = "service-date";
+    public static final String SERVICE_MILEAGE = "service-mileage";
+    public static final String CHECK_CONTROL = "check-control";
+    public static final String CHARGE_STATUS = "charge";
+    public static final String CHARGE_END_REASON = "reason";
+    public static final String CHARGE_REMAINING = "remaining";
+    public static final String LAST_UPDATE = "last-update";
+
+    // Door Details
+    public static final String DOOR_DRIVER_FRONT = "driver-front";
+    public static final String DOOR_DRIVER_REAR = "driver-rear";
+    public static final String DOOR_PASSENGER_FRONT = "passenger-front";
+    public static final String DOOR_PASSENGER_REAR = "passenger-rear";
+    public static final String HOOD = "hood";
+    public static final String TRUNK = "trunk";
+    public static final String WINDOW_DOOR_DRIVER_FRONT = "win-driver-front";
+    public static final String WINDOW_DOOR_DRIVER_REAR = "win-driver-rear";
+    public static final String WINDOW_DOOR_PASSENGER_FRONT = "win-passenger-front";
+    public static final String WINDOW_DOOR_PASSENGER_REAR = "win-passenger-rear";
+    public static final String WINDOW_REAR = "win-rear";
+    public static final String SUNROOF = "sunroof";
+
+    // Charge Profile
+    public static final String CHARGE_PROFILE_CLIMATE = "profile-climate";
+    public static final String CHARGE_PROFILE_MODE = "profile-mode";
+    public static final String CHARGE_PROFILE_PREFERENCE = "profile-prefs";
+    public static final String CHARGE_WINDOW_START = "window-start";
+    public static final String CHARGE_WINDOW_END = "window-end";
+    public static final String CHARGE_TIMER1 = "timer1";
+    public static final String CHARGE_TIMER2 = "timer2";
+    public static final String CHARGE_TIMER3 = "timer3";
+    public static final String CHARGE_OVERRIDE = "override";
+    public static final String CHARGE_DEPARTURE = "-departure";
+    public static final String CHARGE_ENABLED = "-enabled";
+    public static final String CHARGE_DAYS = "-days";
+    public static final String CHARGE_DAY_MON = "-day-mon";
+    public static final String CHARGE_DAY_TUE = "-day-tue";
+    public static final String CHARGE_DAY_WED = "-day-wed";
+    public static final String CHARGE_DAY_THU = "-day-thu";
+    public static final String CHARGE_DAY_FRI = "-day-fri";
+    public static final String CHARGE_DAY_SAT = "-day-sat";
+    public static final String CHARGE_DAY_SUN = "-day-sun";
+
+    // Range
+    public static final String RANGE_HYBRID = "hybrid";
+    public static final String RANGE_ELECTRIC = "electric";
+    public static final String SOC = "soc";
+    public static final String RANGE_FUEL = "fuel";
+    public static final String REMAINING_FUEL = "remaining-fuel";
+    public static final String RANGE_RADIUS_ELECTRIC = "radius-electric";
+    public static final String RANGE_RADIUS_FUEL = "radius-fuel";
+    public static final String RANGE_RADIUS_HYBRID = "radius-hybrid";
+
+    // Last Trip
+    public static final String DURATION = "duration";
+    public static final String DISTANCE = "distance";
+    public static final String DISTANCE_SINCE_CHARGING = "distance-since-charging";
+    public static final String AVG_CONSUMPTION = "avg-consumption";
+    public static final String AVG_COMBINED_CONSUMPTION = "avg-combined-consumption";
+    public static final String AVG_RECUPERATION = "avg-recuperation";
+
+    // Lifetime + Average Consumptions
+    public static final String TOTAL_DRIVEN_DISTANCE = "total-driven-distance";
+    public static final String SINGLE_LONGEST_DISTANCE = "single-longest-distance";
+
+    // Image
+    public static final String IMAGE_FORMAT = "png";
+    public static final String IMAGE_VIEWPORT = "view";
+    public static final String IMAGE_SIZE = "size";
+
+    // Remote Services
+    public static final String REMOTE_SERVICE_LIGHT_FLASH = "light";
+    public static final String REMOTE_SERVICE_VEHICLE_FINDER = "finder";
+    public static final String REMOTE_SERVICE_DOOR_LOCK = "lock";
+    public static final String REMOTE_SERVICE_DOOR_UNLOCK = "unlock";
+    public static final String REMOTE_SERVICE_HORN = "horn";
+    public static final String REMOTE_SERVICE_AIR_CONDITIONING = "climate";
+    public static final String REMOTE_SERVICE_CHARGE_NOW = "charge-now";
+    public static final String REMOTE_SERVICE_CHARGING_CONTROL = "charge-control";
+    public static final String REMOTE_SERVICE_COMMAND = "command";
+    public static final String REMOTE_STATE = "state";
+}

bundles/org.openhab.binding.bmwconnecteddrive/src/main/java/org/openhab/binding/bmwconnecteddrive/internal/ConnectedDriveHandlerFactory.java

@@ -0,0 +1,76 @@
+/**
+ * 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.bmwconnecteddrive.internal;
+
+import static org.openhab.binding.bmwconnecteddrive.internal.ConnectedDriveConstants.*;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+import org.openhab.binding.bmwconnecteddrive.internal.handler.BMWConnectedDriveOptionProvider;
+import org.openhab.binding.bmwconnecteddrive.internal.handler.ConnectedDriveBridgeHandler;
+import org.openhab.binding.bmwconnecteddrive.internal.handler.VehicleHandler;
+import org.openhab.binding.bmwconnecteddrive.internal.utils.Converter;
+import org.openhab.core.i18n.LocaleProvider;
+import org.openhab.core.i18n.TimeZoneProvider;
+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.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;
+
+/**
+ * The {@link ConnectedDriveHandlerFactory} is responsible for creating things and thing
+ * handlers.
+ *
+ * @author Bernd Weymann - Initial contribution
+ */
+@NonNullByDefault
+@Component(configurationPid = "binding.bmwconnecteddrive", service = ThingHandlerFactory.class)
+public class ConnectedDriveHandlerFactory extends BaseThingHandlerFactory {
+
+    private final HttpClientFactory httpClientFactory;
+    private final BMWConnectedDriveOptionProvider optionProvider;
+    private boolean imperial = false;
+
+    @Activate
+    public ConnectedDriveHandlerFactory(final @Reference HttpClientFactory hcf,
+            final @Reference BMWConnectedDriveOptionProvider op, final @Reference LocaleProvider lp,
+            final @Reference TimeZoneProvider timeZoneProvider) {
+        httpClientFactory = hcf;
+        optionProvider = op;
+        imperial = IMPERIAL_COUNTRIES.contains(lp.getLocale().getCountry());
+        Converter.setTimeZoneProvider(timeZoneProvider);
+    }
+
+    @Override
+    public boolean supportsThingType(ThingTypeUID thingTypeUID) {
+        return SUPPORTED_THING_SET.contains(thingTypeUID);
+    }
+
+    @Override
+    protected @Nullable ThingHandler createHandler(Thing thing) {
+        ThingTypeUID thingTypeUID = thing.getThingTypeUID();
+        if (THING_TYPE_CONNECTED_DRIVE_ACCOUNT.equals(thingTypeUID)) {
+            return new ConnectedDriveBridgeHandler((Bridge) thing, httpClientFactory);
+        } else if (SUPPORTED_THING_SET.contains(thingTypeUID)) {
+            VehicleHandler vh = new VehicleHandler(thing, optionProvider, thingTypeUID.getId(), imperial);
+            return vh;
+        }
+        return null;
+    }
+}