2 * Copyright (c) 2010-2024 Contributors to the openHAB project
4 * See the NOTICE file(s) distributed with this work for additional
7 * This program and the accompanying materials are made available under the
8 * terms of the Eclipse Public License 2.0 which is available at
9 * http://www.eclipse.org/legal/epl-2.0
11 * SPDX-License-Identifier: EPL-2.0
13 package org.openhab.binding.mercedesme.internal.handler;
15 import static org.openhab.binding.mercedesme.internal.Constants.*;
17 import java.util.ArrayList;
18 import java.util.Arrays;
19 import java.util.Collection;
20 import java.util.Collections;
21 import java.util.HashMap;
22 import java.util.List;
23 import java.util.Locale;
25 import java.util.Optional;
26 import java.util.UUID;
28 import javax.measure.Unit;
29 import javax.measure.quantity.Length;
30 import javax.measure.quantity.Temperature;
32 import org.eclipse.jdt.annotation.NonNullByDefault;
33 import org.eclipse.jdt.annotation.Nullable;
34 import org.json.JSONObject;
35 import org.openhab.binding.mercedesme.internal.Constants;
36 import org.openhab.binding.mercedesme.internal.MercedesMeCommandOptionProvider;
37 import org.openhab.binding.mercedesme.internal.MercedesMeStateOptionProvider;
38 import org.openhab.binding.mercedesme.internal.actions.VehicleActions;
39 import org.openhab.binding.mercedesme.internal.config.VehicleConfiguration;
40 import org.openhab.binding.mercedesme.internal.utils.ChannelStateMap;
41 import org.openhab.binding.mercedesme.internal.utils.Mapper;
42 import org.openhab.binding.mercedesme.internal.utils.UOMObserver;
43 import org.openhab.binding.mercedesme.internal.utils.Utils;
44 import org.openhab.core.i18n.LocationProvider;
45 import org.openhab.core.library.types.DateTimeType;
46 import org.openhab.core.library.types.DecimalType;
47 import org.openhab.core.library.types.OnOffType;
48 import org.openhab.core.library.types.PointType;
49 import org.openhab.core.library.types.QuantityType;
50 import org.openhab.core.library.types.StringType;
51 import org.openhab.core.library.unit.ImperialUnits;
52 import org.openhab.core.library.unit.SIUnits;
53 import org.openhab.core.library.unit.Units;
54 import org.openhab.core.thing.Bridge;
55 import org.openhab.core.thing.ChannelUID;
56 import org.openhab.core.thing.Thing;
57 import org.openhab.core.thing.ThingStatus;
58 import org.openhab.core.thing.ThingStatusDetail;
59 import org.openhab.core.thing.binding.BaseThingHandler;
60 import org.openhab.core.thing.binding.BridgeHandler;
61 import org.openhab.core.thing.binding.ThingHandlerService;
62 import org.openhab.core.types.Command;
63 import org.openhab.core.types.CommandOption;
64 import org.openhab.core.types.RefreshType;
65 import org.openhab.core.types.State;
66 import org.openhab.core.types.StateOption;
67 import org.openhab.core.types.UnDefType;
68 import org.slf4j.Logger;
69 import org.slf4j.LoggerFactory;
71 import com.daimler.mbcarkit.proto.Acp.ACP.CommandType;
72 import com.daimler.mbcarkit.proto.Acp.VehicleAPI.CommandState;
73 import com.daimler.mbcarkit.proto.Client.ClientMessage;
74 import com.daimler.mbcarkit.proto.VehicleCommands.AuxheatStart;
75 import com.daimler.mbcarkit.proto.VehicleCommands.AuxheatStop;
76 import com.daimler.mbcarkit.proto.VehicleCommands.ChargeProgramConfigure;
77 import com.daimler.mbcarkit.proto.VehicleCommands.CommandRequest;
78 import com.daimler.mbcarkit.proto.VehicleCommands.DoorsLock;
79 import com.daimler.mbcarkit.proto.VehicleCommands.DoorsUnlock;
80 import com.daimler.mbcarkit.proto.VehicleCommands.EngineStart;
81 import com.daimler.mbcarkit.proto.VehicleCommands.EngineStop;
82 import com.daimler.mbcarkit.proto.VehicleCommands.SigPosStart;
83 import com.daimler.mbcarkit.proto.VehicleCommands.SigPosStart.HornType;
84 import com.daimler.mbcarkit.proto.VehicleCommands.SigPosStart.LightType;
85 import com.daimler.mbcarkit.proto.VehicleCommands.SigPosStart.SigposType;
86 import com.daimler.mbcarkit.proto.VehicleCommands.SunroofClose;
87 import com.daimler.mbcarkit.proto.VehicleCommands.SunroofLift;
88 import com.daimler.mbcarkit.proto.VehicleCommands.SunroofOpen;
89 import com.daimler.mbcarkit.proto.VehicleCommands.TemperatureConfigure;
90 import com.daimler.mbcarkit.proto.VehicleCommands.TemperatureConfigure.TemperaturePoint;
91 import com.daimler.mbcarkit.proto.VehicleCommands.WindowsClose;
92 import com.daimler.mbcarkit.proto.VehicleCommands.WindowsOpen;
93 import com.daimler.mbcarkit.proto.VehicleCommands.WindowsVentilate;
94 import com.daimler.mbcarkit.proto.VehicleCommands.ZEVPreconditioningConfigureSeats;
95 import com.daimler.mbcarkit.proto.VehicleCommands.ZEVPreconditioningStart;
96 import com.daimler.mbcarkit.proto.VehicleCommands.ZEVPreconditioningStop;
97 import com.daimler.mbcarkit.proto.VehicleCommands.ZEVPreconditioningType;
98 import com.daimler.mbcarkit.proto.VehicleEvents;
99 import com.daimler.mbcarkit.proto.VehicleEvents.ChargeProgramParameters;
100 import com.daimler.mbcarkit.proto.VehicleEvents.ChargeProgramsValue;
101 import com.daimler.mbcarkit.proto.VehicleEvents.TemperaturePointsValue;
102 import com.daimler.mbcarkit.proto.VehicleEvents.VEPUpdate;
103 import com.daimler.mbcarkit.proto.VehicleEvents.VehicleAttributeStatus;
104 import com.daimler.mbcarkit.proto.Vehicleapi.AppTwinCommandStatus;
105 import com.daimler.mbcarkit.proto.Vehicleapi.AppTwinCommandStatusUpdatesByPID;
106 import com.google.protobuf.BoolValue;
107 import com.google.protobuf.Int32Value;
110 * {@link VehicleHandler} transform data into state updates and handling of vehicle commands
112 * @author Bernd Weymann - Initial contribution
113 * @author Bernd Weymann - Bugfix https://github.com/openhab/openhab-addons/issues/16932
116 public class VehicleHandler extends BaseThingHandler {
117 private static final List<String> HVAC_SEAT_LIST = Arrays
118 .asList(new String[] { GROUP_HVAC + "#" + OH_CHANNEL_FRONT_LEFT, GROUP_HVAC + "#" + OH_CHANNEL_FRONT_RIGHT,
119 GROUP_HVAC + "#" + OH_CHANNEL_REAR_LEFT, GROUP_HVAC + "#" + OH_CHANNEL_REAR_RIGHT });
121 private final Logger logger = LoggerFactory.getLogger(VehicleHandler.class);
122 private final LocationProvider locationProvider;
123 private final MercedesMeCommandOptionProvider mmcop;
124 private final MercedesMeStateOptionProvider mmsop;
126 private Map<String, UOMObserver> unitStorage = new HashMap<>();
127 private int ignitionState = -1;
128 private boolean chargingState = false;
129 private int selectedChargeProgram = -1;
130 private int activeTemperaturePoint = -1;
131 private Map<Integer, QuantityType<Temperature>> temperaturePointsStorage = new HashMap<>();
132 private JSONObject chargeGroupValueStorage = new JSONObject();
133 private Map<String, State> hvacGroupValueStorage = new HashMap<>();
134 private String vehicleType = NOT_SET;
136 Map<String, ChannelStateMap> eventStorage = new HashMap<>();
137 Optional<AccountHandler> accountHandler = Optional.empty();
138 Optional<VehicleConfiguration> config = Optional.empty();
140 public VehicleHandler(Thing thing, LocationProvider lp, MercedesMeCommandOptionProvider cop,
141 MercedesMeStateOptionProvider sop) {
143 vehicleType = thing.getThingTypeUID().getId();
144 locationProvider = lp;
150 public void initialize() {
151 config = Optional.of(getConfigAs(VehicleConfiguration.class));
152 Bridge bridge = getBridge();
153 if (bridge != null) {
154 updateStatus(ThingStatus.UNKNOWN);
155 BridgeHandler handler = bridge.getHandler();
156 if (handler != null) {
157 setCommandStateOptions();
158 accountHandler = Optional.of((AccountHandler) handler);
159 accountHandler.get().registerVin(config.get().vin, this);
161 throw new IllegalStateException("BridgeHandler is null");
164 String textKey = Constants.STATUS_TEXT_PREFIX + "vehicle" + Constants.STATUS_BRIDGE_MISSING;
165 updateStatus(ThingStatus.OFFLINE, ThingStatusDetail.CONFIGURATION_ERROR, textKey);
169 private boolean supports(final String propertyName) {
170 String supported = thing.getProperties().get(propertyName);
171 return Boolean.TRUE.toString().equals(supported);
174 private ClientMessage createCM(CommandRequest cr) {
175 return ClientMessage.newBuilder().setCommandRequest(cr).build();
179 public void dispose() {
180 accountHandler.get().unregisterVin(config.get().vin);
185 public void handleCommand(ChannelUID channelUID, Command command) {
187 * Commands shall be not that frequent so trace level for identifying problems should be feasible
189 logger.trace("Received command {} {} for {}", command.getClass(), command, channelUID);
191 if (command instanceof RefreshType) {
192 if (MB_KEY_FEATURE_CAPABILITIES.equals(channelUID.getIdWithoutGroup())
193 || MB_KEY_COMMAND_CAPABILITIES.equals(channelUID.getIdWithoutGroup())) {
194 accountHandler.ifPresent(ah -> {
195 ah.getVehicleCapabilities(config.get().vin);
198 // deliver from event storage
199 ChannelStateMap csm = eventStorage.get(channelUID.getId());
204 // ensure unit update
205 unitStorage.remove(channelUID.getIdWithoutGroup());
208 var crBuilder = CommandRequest.newBuilder().setVin(config.get().vin).setRequestId(UUID.randomUUID().toString());
209 String group = channelUID.getGroupId();
210 String channel = channelUID.getIdWithoutGroup();
211 String pin = accountHandler.get().config.get().pin;
213 logger.trace("No command {} found for {}", command, channel);
219 case OH_CHANNEL_IGNITION:
220 if (!supports(MB_KEY_COMMAND_ENGINE_START)) {
221 logger.trace("Engine Start/Stop not supported");
224 int commandValue = ((DecimalType) command).intValue();
225 if (commandValue == 4) {
226 if (Constants.NOT_SET.equals(pin)) {
227 logger.trace("Security PIN missing in Account bridge");
230 EngineStart eStart = EngineStart.newBuilder().setPin(pin).build();
231 CommandRequest cr = crBuilder.setEngineStart(eStart).build();
232 accountHandler.get().sendCommand(createCM(cr));
233 } else if (commandValue == 0) {
234 EngineStop eStop = EngineStop.newBuilder().build();
235 CommandRequest cr = crBuilder.setEngineStop(eStop).build();
236 accountHandler.get().sendCommand(createCM(cr));
239 case OH_CHANNEL_WINDOWS:
240 if (!supports(MB_KEY_COMMAND_WINDOWS_OPEN)) {
241 logger.trace("Windows control not supported");
245 switch (((DecimalType) command).intValue()) {
247 if (Constants.NOT_SET.equals(pin)) {
248 logger.trace("Security PIN missing in Account bridge");
251 WindowsVentilate wv = WindowsVentilate.newBuilder().setPin(pin).build();
252 cr = crBuilder.setWindowsVentilate(wv).build();
253 accountHandler.get().sendCommand(createCM(cr));
256 WindowsClose wc = WindowsClose.newBuilder().build();
257 cr = crBuilder.setWindowsClose(wc).build();
258 accountHandler.get().sendCommand(createCM(cr));
261 if (Constants.NOT_SET.equals(pin)) {
262 logger.trace("Security PIN missing in Account bridge");
265 WindowsOpen wo = WindowsOpen.newBuilder().setPin(pin).build();
266 cr = crBuilder.setWindowsOpen(wo).build();
267 accountHandler.get().sendCommand(createCM(cr));
270 logger.trace("No Windows movement known for {}", command);
274 case OH_CHANNEL_LOCK:
275 if (!supports(MB_KEY_COMMAND_DOORS_LOCK)) {
276 logger.trace("Door Lock not supported");
279 switch (((DecimalType) command).intValue()) {
281 DoorsLock dl = DoorsLock.newBuilder().build();
282 cr = crBuilder.setDoorsLock(dl).build();
283 accountHandler.get().sendCommand(createCM(cr));
286 if (Constants.NOT_SET.equals(pin)) {
287 logger.trace("Security PIN missing in Account bridge");
290 DoorsUnlock du = DoorsUnlock.newBuilder().setPin(pin).build();
291 cr = crBuilder.setDoorsUnlock(du).build();
292 accountHandler.get().sendCommand(createCM(cr));
295 logger.trace("No lock command mapped to {}", command);
300 logger.trace("No command {} found for {}#{}", command, group, channel);
303 break; // vehicle group
306 case OH_CHANNEL_TEMPERATURE:
307 if (!supports(MB_KEY_COMMAND_ZEV_PRECONDITION_CONFIGURE)) {
308 logger.trace("Air Conditioning Temperature Setting not supported");
311 if (command instanceof QuantityType<?> quantityTypeCommand) {
312 QuantityType<?> targetTempCelsius = quantityTypeCommand.toInvertibleUnit(SIUnits.CELSIUS);
313 if (targetTempCelsius == null) {
314 logger.trace("Cannot handle temperature command {}", quantityTypeCommand);
317 TemperatureConfigure tc = TemperatureConfigure.newBuilder()
318 .addTemperaturePoints(
319 TemperaturePoint.newBuilder().setZoneValue(activeTemperaturePoint)
320 .setTemperatureInCelsius(targetTempCelsius.intValue()).build())
322 CommandRequest cr = crBuilder.setTemperatureConfigure(tc).build();
323 accountHandler.get().sendCommand(createCM(cr));
325 logger.trace("Temperature {} shall be QuantityType with degree Celsius or Fahrenheit",
329 case OH_CHANNEL_ACTIVE:
330 if (!supports(MB_KEY_COMMAND_ZEV_PRECONDITIONING_START)) {
331 logger.trace("Air Conditioning not supported");
334 if (OnOffType.ON.equals(command)) {
335 ZEVPreconditioningStart precondStart = ZEVPreconditioningStart.newBuilder()
336 .setType(ZEVPreconditioningType.NOW).build();
337 CommandRequest cr = crBuilder.setZevPreconditioningStart(precondStart).build();
338 accountHandler.get().sendCommand(createCM(cr));
340 ZEVPreconditioningStop precondStop = ZEVPreconditioningStop.newBuilder()
341 .setType(ZEVPreconditioningType.NOW).build();
342 CommandRequest cr = crBuilder.setZevPreconditioningStop(precondStop).build();
343 accountHandler.get().sendCommand(createCM(cr));
346 case OH_CHANNEL_FRONT_LEFT:
347 case OH_CHANNEL_FRONT_RIGHT:
348 case OH_CHANNEL_REAR_LEFT:
349 case OH_CHANNEL_REAR_RIGHT:
350 configureSeats(channelUID, (State) command);
352 case OH_CHANNEL_AUX_HEAT:
353 if (!supports(MB_KEY_FEATURE_AUX_HEAT)) {
354 logger.trace("Auxiliary Heating not supported");
357 if (OnOffType.ON.equals(command)) {
358 AuxheatStart auxHeatStart = AuxheatStart.newBuilder().build();
359 CommandRequest cr = crBuilder.setAuxheatStart(auxHeatStart).build();
360 accountHandler.get().sendCommand(createCM(cr));
362 AuxheatStop auxHeatStop = AuxheatStop.newBuilder().build();
363 CommandRequest cr = crBuilder.setAuxheatStop(auxHeatStop).build();
364 accountHandler.get().sendCommand(createCM(cr));
367 case OH_CHANNEL_ZONE:
368 int zone = ((DecimalType) command).intValue();
369 if (!temperaturePointsStorage.containsKey(zone)) {
370 logger.trace("No Temperature Zone found for {}", command);
373 ChannelStateMap zoneMap = new ChannelStateMap(OH_CHANNEL_ZONE, GROUP_HVAC,
374 (DecimalType) command);
375 updateChannel(zoneMap);
376 QuantityType<Temperature> selectedTemp = temperaturePointsStorage.get(zone);
377 if (selectedTemp != null) {
378 ChannelStateMap tempCSM = new ChannelStateMap(OH_CHANNEL_TEMPERATURE, GROUP_HVAC,
380 updateChannel(tempCSM);
383 logger.trace("No command {} found for {}#{}", command, group, channel);
389 case OH_CHANNEL_SIGNAL:
390 if (!supports(MB_KEY_COMMAND_SIGPOS_START)) {
391 logger.trace("Signal Position not supported");
396 switch (((DecimalType) command).intValue()) {
398 sps = SigPosStart.newBuilder().setSigposType(SigposType.LIGHT_ONLY)
399 .setLightType(LightType.DIPPED_HEAD_LIGHT).setSigposDuration(10).build();
400 cr = crBuilder.setSigposStart(sps).build();
401 accountHandler.get().sendCommand(createCM(cr));
404 sps = SigPosStart.newBuilder().setSigposType(SigposType.HORN_ONLY).setHornRepeat(3)
405 .setHornType(HornType.HORN_LOW_VOLUME).build();
406 cr = crBuilder.setSigposStart(sps).build();
407 accountHandler.get().sendCommand(createCM(cr));
410 logger.trace("No Positioning known for {}", command);
414 logger.trace("No command {} found for {}#{}", command, group, channel);
417 break; // position group
419 if (!supports(MB_KEY_COMMAND_CHARGE_PROGRAM_CONFIGURE)) {
420 logger.trace("Charge Program Configure not supported");
423 int maxSocToSelect = 80;
424 boolean autoUnlockToSelect = false;
425 boolean sendCommand = false;
427 synchronized (chargeGroupValueStorage) {
429 case OH_CHANNEL_PROGRAM:
430 selectedChargeProgram = ((DecimalType) command).intValue();
431 if (chargeGroupValueStorage.has(Integer.toString(selectedChargeProgram))) {
432 maxSocToSelect = chargeGroupValueStorage
433 .getJSONObject(Integer.toString(selectedChargeProgram))
434 .getInt(Constants.MAX_SOC_KEY);
435 autoUnlockToSelect = chargeGroupValueStorage
436 .getJSONObject(Integer.toString(selectedChargeProgram))
437 .getBoolean(Constants.AUTO_UNLOCK_KEY);
438 updateChannel(new ChannelStateMap(OH_CHANNEL_MAX_SOC, GROUP_CHARGE,
439 QuantityType.valueOf(maxSocToSelect, Units.PERCENT)));
440 updateChannel(new ChannelStateMap(OH_CHANNEL_AUTO_UNLOCK, GROUP_CHARGE,
441 OnOffType.from(autoUnlockToSelect)));
444 logger.trace("No charge program found for {}", selectedChargeProgram);
447 case OH_CHANNEL_AUTO_UNLOCK:
448 autoUnlockToSelect = OnOffType.ON.equals(command);
451 case OH_CHANNEL_MAX_SOC:
452 maxSocToSelect = ((QuantityType<?>) command).intValue();
456 logger.trace("No command {} found for {}#{}", command, group, channel);
460 Int32Value maxSocValue = Int32Value.newBuilder().setValue(maxSocToSelect).build();
461 BoolValue autoUnlockValue = BoolValue.newBuilder().setValue(autoUnlockToSelect).build();
462 ChargeProgramConfigure cpc = ChargeProgramConfigure.newBuilder()
463 .setChargeProgramValue(selectedChargeProgram).setMaxSoc(maxSocValue)
464 .setAutoUnlock(autoUnlockValue).build();
465 CommandRequest cr = crBuilder.setChargeProgramConfigure(cpc).build();
466 accountHandler.get().sendCommand(createCM(cr));
469 break; // charge group
472 case OH_CHANNEL_SUNROOF:
473 if (!supports(MB_KEY_COMMAND_SUNROOF_OPEN)) {
474 logger.trace("Sunroof control not supported");
478 switch (((DecimalType) command).intValue()) {
480 SunroofClose sc = SunroofClose.newBuilder().build();
481 cr = crBuilder.setSunroofClose(sc).build();
482 accountHandler.get().sendCommand(createCM(cr));
485 if (Constants.NOT_SET.equals(pin)) {
486 logger.trace("Security PIN missing in Account bridge");
489 SunroofOpen so = SunroofOpen.newBuilder().setPin(pin).build();
490 cr = crBuilder.setSunroofOpen(so).build();
491 accountHandler.get().sendCommand(createCM(cr));
494 if (Constants.NOT_SET.equals(pin)) {
495 logger.trace("Security PIN missing in Account bridge");
497 SunroofLift sl = SunroofLift.newBuilder().setPin(pin).build();
498 cr = crBuilder.setSunroofLift(sl).build();
499 accountHandler.get().sendCommand(createCM(cr));
502 logger.trace("No Sunroof movement known for {}", command);
505 logger.trace("No command {} found for {}#{}", command, group, channel);
508 break; // doors group
509 default: // no group matching
510 logger.trace("No command {} found for {}#{}", command, group, channel);
515 private void configureSeats(ChannelUID channelUID, State command) {
516 String supported = thing.getProperties().get(MB_KEY_COMMAND_ZEV_PRECONDITION_CONFIGURE_SEATS);
517 if (Boolean.FALSE.toString().equals(supported)) {
518 logger.trace("Seat Conditioning not supported");
520 com.daimler.mbcarkit.proto.VehicleCommands.ZEVPreconditioningConfigureSeats.Builder builder = ZEVPreconditioningConfigureSeats
523 HVAC_SEAT_LIST.forEach(seat -> {
524 ChannelStateMap csm = eventStorage.get(seat);
526 if (csm.getState() != UnDefType.UNDEF && !seat.equals(channelUID.getId())) {
527 OnOffType oot = (OnOffType) csm.getState();
529 case GROUP_HVAC + "#" + OH_CHANNEL_FRONT_LEFT:
530 builder.setFrontLeft(OnOffType.ON.equals(oot));
532 case GROUP_HVAC + "#" + OH_CHANNEL_FRONT_RIGHT:
533 builder.setFrontRight(OnOffType.ON.equals(oot));
535 case GROUP_HVAC + "#" + OH_CHANNEL_REAR_LEFT:
536 builder.setRearLeft(OnOffType.ON.equals(oot));
538 case GROUP_HVAC + "#" + OH_CHANNEL_REAR_RIGHT:
539 builder.setRearRight(OnOffType.ON.equals(oot));
545 ZEVPreconditioningConfigureSeats seats = builder.build();
546 CommandRequest cr = CommandRequest.newBuilder().setVin(config.get().vin)
547 .setRequestId(UUID.randomUUID().toString()).setZevPreconditionConfigureSeats(seats).build();
548 ClientMessage cm = ClientMessage.newBuilder().setCommandRequest(cr).build();
549 accountHandler.get().sendCommand(cm);
553 public void distributeCommandStatus(AppTwinCommandStatusUpdatesByPID cmdUpdates) {
554 Map<Long, AppTwinCommandStatus> updates = cmdUpdates.getUpdatesByPidMap();
555 updates.forEach((key, value) -> {
557 // getting type and state may throw Exception
558 int commandType = value.getType().getNumber();
559 int commandState = value.getState().getNumber();
561 ChannelStateMap csmCommand = new ChannelStateMap(OH_CHANNEL_CMD_NAME, GROUP_COMMAND,
562 new DecimalType(commandType));
563 updateChannel(csmCommand);
565 ChannelStateMap csmState = new ChannelStateMap(OH_CHANNEL_CMD_STATE, GROUP_COMMAND,
566 new DecimalType(commandState));
567 updateChannel(csmState);
569 DateTimeType dtt = Utils.getDateTimeType(value.getTimestampInMs());
570 UOMObserver observer = null;
571 if (Locale.US.getCountry().equals(Utils.getCountry())) {
572 observer = new UOMObserver(UOMObserver.TIME_US);
574 observer = new UOMObserver(UOMObserver.TIME_ROW);
576 ChannelStateMap csmUpdated = new ChannelStateMap(OH_CHANNEL_CMD_LAST_UPDATE, GROUP_COMMAND, dtt,
578 updateChannel(csmUpdated);
579 } catch (IllegalArgumentException iae) {
580 logger.trace("Cannot decode command {} {}", value.getAllFields().toString(), iae.getMessage());
581 // silent ignore update
586 public void distributeContent(VEPUpdate data) {
587 updateStatus(ThingStatus.ONLINE);
588 boolean fullUpdate = data.getFullUpdate();
590 * Deliver proto update
592 String newProto = Utils.proto2Json(data, thing.getThingTypeUID());
593 String combinedProto = newProto;
594 ChannelUID protoUpdateChannelUID = new ChannelUID(thing.getUID(), GROUP_VEHICLE, OH_CHANNEL_PROTO_UPDATE);
595 ChannelStateMap oldProtoMap = eventStorage.get(protoUpdateChannelUID.getId());
596 if (oldProtoMap != null) {
597 String oldProto = ((StringType) oldProtoMap.getState()).toFullString();
598 Map<?, ?> combinedMap = Utils.combineMaps(new JSONObject(oldProto).toMap(),
599 new JSONObject(newProto).toMap());
600 combinedProto = (new JSONObject(combinedMap)).toString();
602 // proto updates causing large printouts in openhab.log
603 // update channel in case of user connected this channel with an item
604 ChannelStateMap dataUpdateMap = new ChannelStateMap(OH_CHANNEL_PROTO_UPDATE, GROUP_VEHICLE,
605 StringType.valueOf(combinedProto));
606 updateChannel(dataUpdateMap);
608 Map<String, VehicleAttributeStatus> atts = data.getAttributesMap();
610 * handle "simple" values
612 atts.forEach((key, value) -> {
613 ChannelStateMap csm = Mapper.getChannelStateMap(key, value);
616 * Store some values and UOM Observer
618 if (GROUP_HVAC.equals(csm.getGroup())) {
619 hvacGroupValueStorage.put(csm.getChannel(), csm.getState());
623 * handle some specific channels
625 String channel = csm.getChannel();
626 // handle range channels very specific regarding to vehicle type
627 boolean block = false;
629 case OH_CHANNEL_RANGE_ELECTRIC:
630 if (!Constants.COMBUSTION.equals(vehicleType)) {
631 ChannelStateMap radiusElectric = new ChannelStateMap(OH_CHANNEL_RADIUS_ELECTRIC,
632 GROUP_RANGE, guessRangeRadius(csm.getState()), csm.getUomObserver());
633 updateChannel(radiusElectric);
638 case OH_CHANNEL_RANGE_FUEL:
639 if (!Constants.BEV.equals(vehicleType)) {
640 ChannelStateMap radiusFuel = new ChannelStateMap(OH_CHANNEL_RADIUS_FUEL, GROUP_RANGE,
641 guessRangeRadius(csm.getState()), csm.getUomObserver());
642 updateChannel(radiusFuel);
647 case OH_CHANNEL_RANGE_HYBRID:
648 if (Constants.HYBRID.equals(vehicleType)) {
649 ChannelStateMap radiusHybrid = new ChannelStateMap(OH_CHANNEL_RADIUS_HYBRID, GROUP_RANGE,
650 guessRangeRadius(csm.getState()), csm.getUomObserver());
651 updateChannel(radiusHybrid);
657 if (!Constants.COMBUSTION.equals(vehicleType)) {
658 if (config.get().batteryCapacity > 0) {
659 float socValue = ((QuantityType<?>) csm.getState()).floatValue();
660 float batteryCapacity = config.get().batteryCapacity;
661 float chargedValue = Math.round(socValue * 1000 * batteryCapacity / 1000) / (float) 100;
662 ChannelStateMap charged = new ChannelStateMap(OH_CHANNEL_CHARGED, GROUP_RANGE,
663 QuantityType.valueOf(chargedValue, Units.KILOWATT_HOUR));
664 updateChannel(charged);
665 float unchargedValue = Math.round((100 - socValue) * 1000 * batteryCapacity / 1000)
667 ChannelStateMap uncharged = new ChannelStateMap(OH_CHANNEL_UNCHARGED, GROUP_RANGE,
668 QuantityType.valueOf(unchargedValue, Units.KILOWATT_HOUR));
669 updateChannel(uncharged);
671 ChannelStateMap charged = new ChannelStateMap(OH_CHANNEL_CHARGED, GROUP_RANGE,
672 QuantityType.valueOf(0, Units.KILOWATT_HOUR));
673 updateChannel(charged);
674 ChannelStateMap uncharged = new ChannelStateMap(OH_CHANNEL_UNCHARGED, GROUP_RANGE,
675 QuantityType.valueOf(0, Units.KILOWATT_HOUR));
676 updateChannel(uncharged);
682 case OH_CHANNEL_FUEL_LEVEL:
683 if (!Constants.BEV.equals(vehicleType)) {
684 if (config.get().fuelCapacity > 0) {
685 float fuelLevelValue = ((QuantityType<?>) csm.getState()).floatValue();
686 float fuelCapacity = config.get().fuelCapacity;
687 float litersInTank = Math.round(fuelLevelValue * 1000 * fuelCapacity / 1000)
689 ChannelStateMap tankFilled = new ChannelStateMap(OH_CHANNEL_TANK_REMAIN, GROUP_RANGE,
690 QuantityType.valueOf(litersInTank, Mapper.defaultVolumeUnit));
691 updateChannel(tankFilled);
692 float litersFree = Math.round((100 - fuelLevelValue) * 1000 * fuelCapacity / 1000)
694 ChannelStateMap tankOpen = new ChannelStateMap(OH_CHANNEL_TANK_OPEN, GROUP_RANGE,
695 QuantityType.valueOf(litersFree, Mapper.defaultVolumeUnit));
696 updateChannel(tankOpen);
698 ChannelStateMap tankFilled = new ChannelStateMap(OH_CHANNEL_TANK_REMAIN, GROUP_RANGE,
699 QuantityType.valueOf(0, Mapper.defaultVolumeUnit));
700 updateChannel(tankFilled);
701 ChannelStateMap tankOpen = new ChannelStateMap(OH_CHANNEL_TANK_OPEN, GROUP_RANGE,
702 QuantityType.valueOf(0, Mapper.defaultVolumeUnit));
703 updateChannel(tankOpen);
709 case OH_CHANNEL_COOLANT_FLUID:
710 case OH_CHANNEL_ENGINE:
711 case OH_CHANNEL_GAS_FLAP:
712 if (Constants.BEV.equals(vehicleType)) {
725 if (atts.containsKey(MB_KEY_POSITION_LAT) && atts.containsKey(MB_KEY_POSITION_LONG)) {
726 double lat = Utils.getDouble(atts.get(MB_KEY_POSITION_LAT));
727 double lon = Utils.getDouble(atts.get(MB_KEY_POSITION_LONG));
728 if (lat != -1 && lon != -1) {
729 PointType pt = new PointType(lat + "," + lon);
730 updateChannel(new ChannelStateMap(OH_CHANNEL_GPS, Constants.GROUP_POSITION, pt));
732 // calculate distance to home
733 PointType homePoint = locationProvider.getLocation();
734 Unit<Length> lengthUnit = KILOMETRE_UNIT;
735 if (homePoint != null) {
736 double distance = Utils.distance(homePoint.getLatitude().doubleValue(), lat,
737 homePoint.getLongitude().doubleValue(), lon, 0.0, 0.0);
738 UOMObserver observer = new UOMObserver(UOMObserver.LENGTH_KM_UNIT);
739 if (Locale.US.getCountry().equals(Utils.getCountry())) {
740 observer = new UOMObserver(UOMObserver.LENGTH_MILES_UNIT);
741 lengthUnit = ImperialUnits.MILE;
743 updateChannel(new ChannelStateMap(OH_CHANNEL_HOME_DISTANCE, Constants.GROUP_RANGE,
744 QuantityType.valueOf(distance / 1000, lengthUnit), observer));
746 logger.trace("No home location found");
751 logger.trace("Either Latitude {} or Longitude {} attribute nil", lat, lon);
752 updateChannel(new ChannelStateMap(OH_CHANNEL_GPS, Constants.GROUP_POSITION, UnDefType.UNDEF));
758 * handle temperature point
760 if (atts.containsKey(MB_KEY_TEMPERATURE_POINTS)) {
761 VehicleAttributeStatus hvacTemperaturePointAttribute = atts.get(MB_KEY_TEMPERATURE_POINTS);
762 if (hvacTemperaturePointAttribute != null) {
763 if (hvacTemperaturePointAttribute.hasTemperaturePointsValue()) {
764 TemperaturePointsValue tpValue = hvacTemperaturePointAttribute.getTemperaturePointsValue();
765 if (tpValue.getTemperaturePointsCount() > 0) {
766 List<VehicleEvents.TemperaturePoint> tPointList = tpValue.getTemperaturePointsList();
767 List<CommandOption> commandOptions = new ArrayList<>();
768 List<StateOption> stateOptions = new ArrayList<>();
769 tPointList.forEach(point -> {
770 String zoneName = point.getZone();
771 int zoneNumber = Utils.getZoneNumber(zoneName);
772 Unit<Temperature> temperatureUnit = Mapper.defaultTemperatureUnit;
773 UOMObserver observer = null;
774 if (hvacTemperaturePointAttribute.hasTemperatureUnit()) {
775 observer = new UOMObserver(
776 hvacTemperaturePointAttribute.getTemperatureUnit().toString());
777 Unit<?> observerUnit = observer.getUnit();
778 if (observerUnit != null) {
779 temperatureUnit = observerUnit.asType(Temperature.class);
782 ChannelUID cuid = new ChannelUID(thing.getUID(), GROUP_HVAC, OH_CHANNEL_TEMPERATURE);
783 mmcop.setCommandOptions(cuid, Utils.getTemperatureOptions(temperatureUnit));
784 if (zoneNumber > 0) {
785 if (activeTemperaturePoint == -1) {
786 activeTemperaturePoint = zoneNumber;
788 double temperature = point.getTemperature();
789 if (point.getTemperatureDisplayValue() != null) {
790 if (point.getTemperatureDisplayValue().strip().length() > 0) {
792 temperature = Double.valueOf(point.getTemperatureDisplayValue());
793 } catch (NumberFormatException nfe) {
794 logger.trace("Cannot transform Temperature Display Value {} into Double",
795 point.getTemperatureDisplayValue());
799 QuantityType<Temperature> temperatureState = QuantityType.valueOf(temperature,
801 temperaturePointsStorage.put(zoneNumber, temperatureState);
802 if (activeTemperaturePoint == zoneNumber) {
803 ChannelStateMap zoneCSM = new ChannelStateMap(OH_CHANNEL_ZONE, Constants.GROUP_HVAC,
804 new DecimalType(activeTemperaturePoint));
805 updateChannel(zoneCSM);
806 ChannelStateMap tempCSM = new ChannelStateMap(OH_CHANNEL_TEMPERATURE,
807 Constants.GROUP_HVAC, temperatureState, observer);
808 updateChannel(tempCSM);
811 logger.trace("No Integer mapping found for Temperature Zone {}", zoneName);
813 commandOptions.add(new CommandOption(Integer.toString(zoneNumber), zoneName));
814 stateOptions.add(new StateOption(Integer.toString(zoneNumber), zoneName));
816 ChannelUID cuid = new ChannelUID(thing.getUID(), GROUP_HVAC, OH_CHANNEL_ZONE);
817 mmcop.setCommandOptions(cuid, commandOptions);
818 mmsop.setStateOptions(cuid, stateOptions);
820 // don't set to undef - maybe partial update
821 logger.trace("No TemperaturePoints found - list empty");
824 // don't set to undef - maybe partial update
825 logger.trace("No TemperaturePointsValue found");
828 // don't set to undef - maybe partial update
829 logger.trace("No TemperaturePoints found");
832 // full update acknowledged - set to undef
834 ChannelStateMap zoneMap = new ChannelStateMap(OH_CHANNEL_ZONE, Constants.GROUP_HVAC, UnDefType.UNDEF);
835 updateChannel(zoneMap);
836 QuantityType<Temperature> tempState = QuantityType.valueOf(-1, Mapper.defaultTemperatureUnit);
837 ChannelStateMap tempMap = new ChannelStateMap(OH_CHANNEL_TEMPERATURE, Constants.GROUP_HVAC, tempState);
838 updateChannel(tempMap);
843 * handle Charge Program
845 if (Constants.BEV.equals(thing.getThingTypeUID().getId())
846 || Constants.HYBRID.equals(thing.getThingTypeUID().getId())) {
847 VehicleAttributeStatus vas = atts.get(MB_KEY_CHARGE_PROGRAMS);
849 ChargeProgramsValue cpv = vas.getChargeProgramsValue();
850 if (cpv.getChargeProgramParametersCount() > 0) {
851 List<ChargeProgramParameters> chargeProgramParameters = cpv.getChargeProgramParametersList();
852 List<CommandOption> commandOptions = new ArrayList<>();
853 List<StateOption> stateOptions = new ArrayList<>();
854 synchronized (chargeGroupValueStorage) {
855 chargeGroupValueStorage.clear();
856 chargeProgramParameters.forEach(program -> {
857 String programName = program.getChargeProgram().name();
858 int number = Utils.getChargeProgramNumber(programName);
860 JSONObject programValuesJson = new JSONObject();
861 programValuesJson.put(Constants.MAX_SOC_KEY, program.getMaxSoc());
862 programValuesJson.put(Constants.AUTO_UNLOCK_KEY, program.getAutoUnlock());
863 chargeGroupValueStorage.put(Integer.toString(number), programValuesJson);
864 commandOptions.add(new CommandOption(Integer.toString(number), programName));
865 stateOptions.add(new StateOption(Integer.toString(number), programName));
870 ChannelUID cuid = new ChannelUID(thing.getUID(), GROUP_CHARGE, OH_CHANNEL_PROGRAM);
871 mmcop.setCommandOptions(cuid, commandOptions);
872 mmsop.setStateOptions(cuid, stateOptions);
873 vas = atts.get(MB_KEY_SELECTED_CHARGE_PROGRAM);
875 selectedChargeProgram = (int) vas.getIntValue();
876 ChargeProgramParameters cpp = cpv.getChargeProgramParameters(selectedChargeProgram);
877 ChannelStateMap programMap = new ChannelStateMap(OH_CHANNEL_PROGRAM, GROUP_CHARGE,
878 DecimalType.valueOf(Integer.toString(selectedChargeProgram)));
879 updateChannel(programMap);
880 ChannelStateMap maxSocMap = new ChannelStateMap(OH_CHANNEL_MAX_SOC, GROUP_CHARGE,
881 QuantityType.valueOf((double) cpp.getMaxSoc(), Units.PERCENT));
882 updateChannel(maxSocMap);
883 ChannelStateMap autoUnlockMap = new ChannelStateMap(OH_CHANNEL_AUTO_UNLOCK, GROUP_CHARGE,
884 OnOffType.from(cpp.getAutoUnlock()));
885 updateChannel(autoUnlockMap);
888 logger.trace("No Charge Program property available for {}", thing.getThingTypeUID());
892 logger.trace("No Charge Programs found");
898 * Check if Websocket shall be kept alive
900 accountHandler.get().keepAlive(ignitionState == 4 || chargingState);
904 * Easy function but there's some measures behind:
905 * Guessing the range of the Vehicle on Map. If you can drive x kilometers with your Vehicle it's not feasible to
906 * project this x km Radius on Map. The roads to be taken are causing some overhead because they are not a straight
907 * line from Location A to B.
908 * I've taken some measurements to calculate the overhead factor based on Google Maps
909 * Berlin - Dresden: Road Distance: 193 air-line Distance 167 = Factor 87%
910 * Kassel - Frankfurt: Road Distance: 199 air-line Distance 143 = Factor 72%
911 * After measuring more distances you'll find out that the outcome is between 70% and 90%. So
913 * This depends also on the roads of a concrete route but this is only a guess without any Route Navigation behind
916 * @return mapping from air-line distance to "real road" distance
918 public static State guessRangeRadius(State state) {
919 if (state instanceof QuantityType<?> qt) {
920 double radius = qt.intValue() * 0.8;
921 return QuantityType.valueOf(Math.round(radius), qt.getUnit());
923 return QuantityType.valueOf(-1, Units.ONE);
926 protected void updateChannel(ChannelStateMap csm) {
927 String channel = csm.getChannel();
928 ChannelUID cuid = new ChannelUID(thing.getUID(), csm.getGroup(), channel);
929 eventStorage.put(cuid.getId(), csm);
932 * proto updates causing large printouts in openhab.log
933 * only log in case of channel is connected to an item
935 if (OH_CHANNEL_PROTO_UPDATE.equals(csm.getChannel())) {
936 ChannelUID protoUpdateChannelUID = new ChannelUID(thing.getUID(), GROUP_VEHICLE, OH_CHANNEL_PROTO_UPDATE);
937 if (!isLinked(protoUpdateChannelUID)) {
938 eventStorage.put(protoUpdateChannelUID.getId(), csm);
944 * Check correct channel patterns
946 if (csm.hasUomObserver()) {
947 UOMObserver deliveredObserver = csm.getUomObserver();
948 UOMObserver storedObserver = unitStorage.get(channel);
949 boolean change = true;
950 if (storedObserver != null) {
951 change = !storedObserver.equals(deliveredObserver);
953 // Channel adaptions for items with configurable units
954 String pattern = deliveredObserver.getPattern(csm.getGroup(), csm.getChannel());
955 if (pattern != null) {
956 if (pattern.startsWith("%") && change) {
957 mmsop.setStatePattern(cuid, pattern);
959 handleComplexTripPattern(channel, pattern);
962 unitStorage.put(channel, deliveredObserver);
966 * Check if Websocket shall be kept alive during charging or driving
968 if (!UnDefType.UNDEF.equals(csm.getState())) {
969 if (GROUP_VEHICLE.equals(csm.getGroup()) && OH_CHANNEL_IGNITION.equals(csm.getChannel())) {
970 ignitionState = ((DecimalType) csm.getState()).intValue();
971 } else if (GROUP_CHARGE.equals(csm.getGroup()) && OH_CHANNEL_ACTIVE.equals(csm.getChannel())) {
972 chargingState = OnOffType.ON.equals((csm.getState()));
976 if (OH_CHANNEL_ZONE.equals(channel) && !UnDefType.UNDEF.equals(csm.getState())) {
977 activeTemperaturePoint = ((DecimalType) csm.getState()).intValue();
980 updateState(cuid, csm.getState());
983 private void handleComplexTripPattern(String channel, String pattern) {
985 case OH_CHANNEL_CONS_EV:
986 case OH_CHANNEL_CONS_EV_RESET:
987 StringType consumptionUnitEv = StringType.valueOf(pattern);
988 ChannelStateMap csmEv = new ChannelStateMap(OH_CHANNEL_CONS_EV_UNIT, GROUP_TRIP, consumptionUnitEv);
989 updateChannel(csmEv);
991 case OH_CHANNEL_CONS_CONV:
992 case OH_CHANNEL_CONS_CONV_RESET:
993 StringType consumptionUnitFuel = StringType.valueOf(pattern);
994 ChannelStateMap csmFuel = new ChannelStateMap(OH_CHANNEL_CONS_CONV_UNIT, GROUP_TRIP,
995 consumptionUnitFuel);
996 updateChannel(csmFuel);
1002 public void updateStatus(ThingStatus ts, ThingStatusDetail tsd, @Nullable String details) {
1003 super.updateStatus(ts, tsd, details);
1007 public void updateStatus(ThingStatus ts) {
1008 if (ThingStatus.ONLINE.equals(ts) && !ThingStatus.ONLINE.equals(thing.getStatus())) {
1009 if (accountHandler.isPresent()) {
1010 accountHandler.get().getVehicleCapabilities(config.get().vin);
1013 super.updateStatus(ts);
1016 public void setFeatureCapabilities(@Nullable String capabilities) {
1017 if (capabilities != null) {
1018 ChannelStateMap csm = new ChannelStateMap(MB_KEY_FEATURE_CAPABILITIES, GROUP_VEHICLE,
1019 StringType.valueOf(capabilities));
1024 public void setCommandCapabilities(@Nullable String capabilities) {
1025 if (capabilities != null) {
1026 ChannelStateMap csm = new ChannelStateMap(MB_KEY_COMMAND_CAPABILITIES, GROUP_VEHICLE,
1027 StringType.valueOf(capabilities));
1032 private void setCommandStateOptions() {
1033 List<StateOption> commandTypeOptions = new ArrayList<>();
1034 CommandType[] ctValues = CommandType.values();
1035 for (int i = 0; i < ctValues.length; i++) {
1036 if (!UNRECOGNIZED.equals(ctValues[i].toString())) {
1037 StateOption co = new StateOption(Integer.toString(ctValues[i].getNumber()), ctValues[i].toString());
1038 commandTypeOptions.add(co);
1041 mmsop.setStateOptions(new ChannelUID(thing.getUID(), GROUP_COMMAND, OH_CHANNEL_CMD_NAME), commandTypeOptions);
1042 List<StateOption> commandStateOptions = new ArrayList<>();
1043 CommandState[] csValues = CommandState.values();
1044 for (int j = 0; j < csValues.length; j++) {
1045 if (!UNRECOGNIZED.equals(csValues[j].toString())) {
1046 StateOption so = new StateOption(Integer.toString(csValues[j].getNumber()), csValues[j].toString());
1047 commandStateOptions.add(so);
1050 mmsop.setStateOptions(new ChannelUID(thing.getUID(), GROUP_COMMAND, OH_CHANNEL_CMD_STATE), commandStateOptions);
1057 public Collection<Class<? extends ThingHandlerService>> getServices() {
1058 return Collections.singleton(VehicleActions.class);
1061 public void sendPoi(JSONObject poi) {
1062 accountHandler.get().sendPoi(config.get().vin, poi);