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