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 java.util.List;
  16 import java.util.concurrent.CompletableFuture;
  17
  18 import org.eclipse.jdt.annotation.NonNullByDefault;
  19 import org.openhab.io.homekit.internal.HomekitAccessoryUpdater;
  20 import org.openhab.io.homekit.internal.HomekitException;
  21 import org.openhab.io.homekit.internal.HomekitSettings;
  22 import org.openhab.io.homekit.internal.HomekitTaggedItem;
  23
  24 import io.github.hapjava.accessories.HomekitAccessory;
  25 import io.github.hapjava.characteristics.impl.common.ConfiguredNameCharacteristic;
  26 import io.github.hapjava.characteristics.impl.common.IdentifierCharacteristic;
  27 import io.github.hapjava.characteristics.impl.common.IsConfiguredCharacteristic;
  28 import io.github.hapjava.characteristics.impl.common.IsConfiguredEnum;
  29 import io.github.hapjava.characteristics.impl.inputsource.CurrentVisibilityStateCharacteristic;
  30 import io.github.hapjava.characteristics.impl.inputsource.CurrentVisibilityStateEnum;
  31 import io.github.hapjava.characteristics.impl.inputsource.InputDeviceTypeCharacteristic;
  32 import io.github.hapjava.characteristics.impl.inputsource.InputSourceTypeCharacteristic;
  33 import io.github.hapjava.characteristics.impl.inputsource.InputSourceTypeEnum;
  34 import io.github.hapjava.characteristics.impl.inputsource.TargetVisibilityStateCharacteristic;
  35 import io.github.hapjava.services.impl.InputSourceService;
  36
  37 /**
  38  * Implements Input Source
  39  *
  40  * This is a little different in that we don't implement the accessory interface.
  41  * This is because several of the "mandatory" characteristics we don't require,
  42  * and wait until all optional attributes are added and if they don't exist
  43  * it will create "default" values for them.
  44  *
  45  * @author Cody Cutrer - Initial contribution
  46  */
  47 @NonNullByDefault({})
  48 public class HomekitInputSourceImpl extends AbstractHomekitAccessoryImpl {
  49
  50     public HomekitInputSourceImpl(HomekitTaggedItem taggedItem, List<HomekitTaggedItem> mandatoryCharacteristics,
  51             HomekitAccessoryUpdater updater, HomekitSettings settings) throws IncompleteAccessoryException {
  52         super(taggedItem, mandatoryCharacteristics, updater, settings);
  53     }
  54
  55     @Override
  56     public void init() throws HomekitException {
  57         super.init();
  58
  59         // these charactereristics are technically mandatory, but we provide defaults if they're not provided
  60         var configuredNameCharacteristic = getCharacteristic(ConfiguredNameCharacteristic.class)
  61                 .orElseGet(() -> new ConfiguredNameCharacteristic(() -> getName(), v -> {
  62                 }, v -> {
  63                 }, () -> {
  64                 }));
  65         var inputSourceTypeCharacteristic = getCharacteristic(InputSourceTypeCharacteristic.class)
  66                 .orElseGet(() -> new InputSourceTypeCharacteristic(
  67                         () -> CompletableFuture.completedFuture(InputSourceTypeEnum.OTHER), v -> {
  68                         }, () -> {
  69                         }));
  70         var isConfiguredCharacteristic = getCharacteristic(IsConfiguredCharacteristic.class)
  71                 .orElseGet(() -> new IsConfiguredCharacteristic(
  72                         () -> CompletableFuture.completedFuture(IsConfiguredEnum.CONFIGURED), v -> {
  73                         }, v -> {
  74                         }, () -> {
  75                         }));
  76         var currentVisibilityStateCharacteristic = getCharacteristic(CurrentVisibilityStateCharacteristic.class)
  77                 .orElseGet(() -> new CurrentVisibilityStateCharacteristic(
  78                         () -> CompletableFuture.completedFuture(CurrentVisibilityStateEnum.SHOWN), v -> {
  79                         }, () -> {
  80                         }));
  81         var identifierCharacteristic = getCharacteristic(IdentifierCharacteristic.class)
  82                 .orElseGet(() -> new IdentifierCharacteristic(() -> CompletableFuture.completedFuture(1)));
  83
  84         var service = new InputSourceService(configuredNameCharacteristic, inputSourceTypeCharacteristic,
  85                 isConfiguredCharacteristic, currentVisibilityStateCharacteristic);
  86
  87         service.addOptionalCharacteristic(identifierCharacteristic);
  88         getCharacteristic(InputDeviceTypeCharacteristic.class).ifPresent(c -> service.addOptionalCharacteristic(c));
  89         getCharacteristic(TargetVisibilityStateCharacteristic.class)
  90                 .ifPresent(c -> service.addOptionalCharacteristic(c));
  91
  92         getServices().add(service);
  93     }
  94
  95     @Override
  96     public boolean isLinkable(HomekitAccessory parentAccessory) {
  97         return parentAccessory instanceof HomekitTelevisionImpl;
  98     }
  99 }