git.basschouten.com Git - openhab-addons.git/blob

   1 /**
   2  * Copyright (c) 2010-2024 Contributors to the openHAB project
   3  *
   4  * See the NOTICE file(s) distributed with this work for additional
   5  * information.
   6  *
   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
  10  *
  11  * SPDX-License-Identifier: EPL-2.0
  12  */
  13 package org.openhab.io.homekit.internal.accessories;
  14
  15 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.CURRENT_DOOR_STATE;
  16 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.OBSTRUCTION_STATUS;
  17 import static org.openhab.io.homekit.internal.HomekitCharacteristicType.TARGET_DOOR_STATE;
  18
  19 import java.util.List;
  20 import java.util.Map;
  21 import java.util.concurrent.CompletableFuture;
  22
  23 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
  24 import org.openhab.io.homekit.internal.HomekitException;
  25 import org.openhab.io.homekit.internal.HomekitSettings;
  26 import org.openhab.io.homekit.internal.HomekitTaggedItem;
  27 import org.slf4j.Logger;
  28 import org.slf4j.LoggerFactory;
  29
  30 import io.github.hapjava.accessories.GarageDoorOpenerAccessory;
  31 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
  32 import io.github.hapjava.characteristics.impl.garagedoor.CurrentDoorStateEnum;
  33 import io.github.hapjava.characteristics.impl.garagedoor.TargetDoorStateEnum;
  34 import io.github.hapjava.services.impl.GarageDoorOpenerService;
  35
  36 /**
  37  * Implements Garage Door Opener
  38  *
  39  * @author Eugen Freiter - Initial contribution
  40  */
  41 public class HomekitGarageDoorOpenerImpl extends AbstractHomekitAccessoryImpl implements GarageDoorOpenerAccessory {
  42     private final Logger logger = LoggerFactory.getLogger(HomekitGarageDoorOpenerImpl.class);
  43     private final BooleanItemReader obstructionReader;
  44     private final Map<CurrentDoorStateEnum, String> currentDoorStateMapping;
  45     private final Map<TargetDoorStateEnum, String> targetDoorStateMapping;
  46
  47     public HomekitGarageDoorOpenerImpl(HomekitTaggedItem taggedItem, List<HomekitTaggedItem> mandatoryCharacteristics,
  48             HomekitAccessoryUpdater updater, HomekitSettings settings) throws IncompleteAccessoryException {
  49         super(taggedItem, mandatoryCharacteristics, updater, settings);
  50         obstructionReader = createBooleanReader(OBSTRUCTION_STATUS);
  51         currentDoorStateMapping = createMapping(CURRENT_DOOR_STATE, CurrentDoorStateEnum.class, true);
  52         targetDoorStateMapping = createMapping(TARGET_DOOR_STATE, TargetDoorStateEnum.class, true);
  53     }
  54
  55     @Override
  56     public void init() throws HomekitException {
  57         super.init();
  58         getServices().add(new GarageDoorOpenerService(this));
  59     }
  60
  61     @Override
  62     public CompletableFuture<CurrentDoorStateEnum> getCurrentDoorState() {
  63         return CompletableFuture.completedFuture(
  64                 getKeyFromMapping(CURRENT_DOOR_STATE, currentDoorStateMapping, CurrentDoorStateEnum.CLOSED));
  65     }
  66
  67     @Override
  68     public CompletableFuture<TargetDoorStateEnum> getTargetDoorState() {
  69         return CompletableFuture.completedFuture(
  70                 getKeyFromMapping(TARGET_DOOR_STATE, targetDoorStateMapping, TargetDoorStateEnum.CLOSED));
  71     }
  72
  73     @Override
  74     public CompletableFuture<Boolean> getObstructionDetected() {
  75         return CompletableFuture.completedFuture(obstructionReader.getValue());
  76     }
  77
  78     @Override
  79     public CompletableFuture<Void> setTargetDoorState(TargetDoorStateEnum targetDoorStateEnum) {
  80         HomekitCharacteristicFactory.setValueFromEnum(getCharacteristic(TARGET_DOOR_STATE).get(), targetDoorStateEnum,
  81                 targetDoorStateMapping);
  82         return CompletableFuture.completedFuture(null);
  83     }
  84
  85     @Override
  86     public void subscribeCurrentDoorState(HomekitCharacteristicChangeCallback callback) {
  87         subscribe(CURRENT_DOOR_STATE, callback);
  88     }
  89
  90     @Override
  91     public void subscribeTargetDoorState(HomekitCharacteristicChangeCallback callback) {
  92         subscribe(TARGET_DOOR_STATE, callback);
  93     }
  94
  95     @Override
  96     public void subscribeObstructionDetected(HomekitCharacteristicChangeCallback callback) {
  97         subscribe(OBSTRUCTION_STATUS, callback);
  98     }
  99
 100     @Override
 101     public void unsubscribeCurrentDoorState() {
 102         unsubscribe(CURRENT_DOOR_STATE);
 103     }
 104
 105     @Override
 106     public void unsubscribeTargetDoorState() {
 107         unsubscribe(TARGET_DOOR_STATE);
 108     }
 109
 110     @Override
 111     public void unsubscribeObstructionDetected() {
 112         unsubscribe(OBSTRUCTION_STATUS);
 113     }
 114 }