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.Characteristic;
  32 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
  33 import io.github.hapjava.characteristics.impl.garagedoor.CurrentDoorStateEnum;
  34 import io.github.hapjava.characteristics.impl.garagedoor.TargetDoorStateEnum;
  35 import io.github.hapjava.services.impl.GarageDoorOpenerService;
  36
  37 /**
  38  * Implements Garage Door Opener
  39  *
  40  * @author Eugen Freiter - Initial contribution
  41  */
  42 public class HomekitGarageDoorOpenerImpl extends AbstractHomekitAccessoryImpl implements GarageDoorOpenerAccessory {
  43     private final Logger logger = LoggerFactory.getLogger(HomekitGarageDoorOpenerImpl.class);
  44     private final BooleanItemReader obstructionReader;
  45     private final Map<CurrentDoorStateEnum, String> currentDoorStateMapping;
  46     private final Map<TargetDoorStateEnum, String> targetDoorStateMapping;
  47
  48     public HomekitGarageDoorOpenerImpl(HomekitTaggedItem taggedItem, List<HomekitTaggedItem> mandatoryCharacteristics,
  49             List<Characteristic> mandatoryRawCharacteristics, HomekitAccessoryUpdater updater, HomekitSettings settings)
  50             throws IncompleteAccessoryException {
  51         super(taggedItem, mandatoryCharacteristics, mandatoryRawCharacteristics, updater, settings);
  52         obstructionReader = createBooleanReader(OBSTRUCTION_STATUS);
  53         currentDoorStateMapping = createMapping(CURRENT_DOOR_STATE, CurrentDoorStateEnum.class, true);
  54         targetDoorStateMapping = createMapping(TARGET_DOOR_STATE, TargetDoorStateEnum.class, true);
  55     }
  56
  57     @Override
  58     public void init() throws HomekitException {
  59         super.init();
  60         addService(new GarageDoorOpenerService(this));
  61     }
  62
  63     @Override
  64     public CompletableFuture<CurrentDoorStateEnum> getCurrentDoorState() {
  65         return CompletableFuture.completedFuture(
  66                 getKeyFromMapping(CURRENT_DOOR_STATE, currentDoorStateMapping, CurrentDoorStateEnum.CLOSED));
  67     }
  68
  69     @Override
  70     public CompletableFuture<TargetDoorStateEnum> getTargetDoorState() {
  71         return CompletableFuture.completedFuture(
  72                 getKeyFromMapping(TARGET_DOOR_STATE, targetDoorStateMapping, TargetDoorStateEnum.CLOSED));
  73     }
  74
  75     @Override
  76     public CompletableFuture<Boolean> getObstructionDetected() {
  77         return CompletableFuture.completedFuture(obstructionReader.getValue());
  78     }
  79
  80     @Override
  81     public CompletableFuture<Void> setTargetDoorState(TargetDoorStateEnum targetDoorStateEnum) {
  82         HomekitCharacteristicFactory.setValueFromEnum(getCharacteristic(TARGET_DOOR_STATE).get(), targetDoorStateEnum,
  83                 targetDoorStateMapping);
  84         return CompletableFuture.completedFuture(null);
  85     }
  86
  87     @Override
  88     public void subscribeCurrentDoorState(HomekitCharacteristicChangeCallback callback) {
  89         subscribe(CURRENT_DOOR_STATE, callback);
  90     }
  91
  92     @Override
  93     public void subscribeTargetDoorState(HomekitCharacteristicChangeCallback callback) {
  94         subscribe(TARGET_DOOR_STATE, callback);
  95     }
  96
  97     @Override
  98     public void subscribeObstructionDetected(HomekitCharacteristicChangeCallback callback) {
  99         subscribe(OBSTRUCTION_STATUS, callback);
 100     }
 101
 102     @Override
 103     public void unsubscribeCurrentDoorState() {
 104         unsubscribe(CURRENT_DOOR_STATE);
 105     }
 106
 107     @Override
 108     public void unsubscribeTargetDoorState() {
 109         unsubscribe(TARGET_DOOR_STATE);
 110     }
 111
 112     @Override
 113     public void unsubscribeObstructionDetected() {
 114         unsubscribe(OBSTRUCTION_STATUS);
 115     }
 116 }