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

   1 /**
   2  * Copyright (c) 2010-2023 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.binding.yamahareceiver.internal;
  14
  15 import static org.openhab.binding.yamahareceiver.internal.YamahaReceiverBindingConstants.Inputs.*;
  16
  17 import java.util.ArrayList;
  18 import java.util.Collection;
  19 import java.util.List;
  20 import java.util.Locale;
  21 import java.util.Map;
  22 import java.util.Map.Entry;
  23 import java.util.Set;
  24
  25 import org.eclipse.jdt.annotation.NonNullByDefault;
  26 import org.eclipse.jdt.annotation.Nullable;
  27 import org.openhab.binding.yamahareceiver.internal.handler.YamahaZoneThingHandler;
  28 import org.openhab.core.thing.binding.ThingHandler;
  29 import org.openhab.core.thing.binding.ThingHandlerService;
  30 import org.openhab.core.thing.type.ChannelType;
  31 import org.openhab.core.thing.type.ChannelTypeBuilder;
  32 import org.openhab.core.thing.type.ChannelTypeProvider;
  33 import org.openhab.core.thing.type.ChannelTypeUID;
  34 import org.openhab.core.types.StateDescriptionFragment;
  35 import org.openhab.core.types.StateDescriptionFragmentBuilder;
  36 import org.openhab.core.types.StateOption;
  37
  38 /**
  39  * Provide a custom channel type for available inputs
  40  *
  41  * @author David Graeff - Initial contribution
  42  * @author Tomasz Maruszak - Refactoring the input source names.
  43  */
  44 @NonNullByDefault
  45 public class ChannelsTypeProviderAvailableInputs implements ChannelTypeProvider, ThingHandlerService {
  46     private @NonNullByDefault({}) ChannelType channelType;
  47     private @NonNullByDefault({}) ChannelTypeUID channelTypeUID;
  48     private @NonNullByDefault({}) YamahaZoneThingHandler handler;
  49
  50     @Override
  51     public Collection<ChannelType> getChannelTypes(@Nullable Locale locale) {
  52         return Set.of(channelType);
  53     }
  54
  55     @Override
  56     public @Nullable ChannelType getChannelType(ChannelTypeUID channelTypeUID, @Nullable Locale locale) {
  57         if (this.channelTypeUID.equals(channelTypeUID)) {
  58             return channelType;
  59         } else {
  60             return null;
  61         }
  62     }
  63
  64     public ChannelTypeUID getChannelTypeUID() {
  65         return channelTypeUID;
  66     }
  67
  68     private void createChannelType(StateDescriptionFragment state) {
  69         channelType = ChannelTypeBuilder.state(channelTypeUID, "Input source", "String")
  70                 .withDescription("Select the input source of the AVR").withStateDescriptionFragment(state).build();
  71     }
  72
  73     private StateDescriptionFragment getDefaultStateDescription() {
  74         List<StateOption> options = new ArrayList<>();
  75         options.add(new StateOption(INPUT_NET_RADIO, "Net Radio"));
  76         options.add(new StateOption(INPUT_PC, "PC"));
  77         options.add(new StateOption(INPUT_USB, "USB"));
  78         options.add(new StateOption(INPUT_TUNER, "Tuner"));
  79         options.add(new StateOption("MULTI_CH", "Multi Channel"));
  80         // Note: this might need review in the future, it should be 'HDMI 1', the 'HDMI_1' are XML node names, not
  81         // source names.
  82         options.add(new StateOption("HDMI_1", "HDMI 1"));
  83         options.add(new StateOption("HDMI_2", "HDMI 2"));
  84         options.add(new StateOption("HDMI_3", "HDMI 3"));
  85         options.add(new StateOption("HDMI_4", "HDMI 4"));
  86         options.add(new StateOption("HDMI_5", "HDMI 5"));
  87         options.add(new StateOption("HDMI_6", "HDMI 6"));
  88         options.add(new StateOption("HDMI_7", "HDMI 7"));
  89         options.add(new StateOption("AV_1", "AV 1"));
  90         options.add(new StateOption("AV_2", "AV 2"));
  91         options.add(new StateOption("AV_3", "AV 3"));
  92         options.add(new StateOption("AV_4", "AV 4"));
  93         options.add(new StateOption("AV_5", "AV 5"));
  94         options.add(new StateOption("AV_6", "AV 6"));
  95         options.add(new StateOption("AV_7", "AV 7"));
  96         options.add(new StateOption("PHONO", "Phono"));
  97         options.add(new StateOption("V_AUX", "Aux"));
  98         options.add(new StateOption("AUDIO_1", "Audio 1"));
  99         options.add(new StateOption("AUDIO_2", "Audio 2"));
 100         options.add(new StateOption("AUDIO_3", "Audio 3"));
 101         options.add(new StateOption("AUDIO_4", "Audio 4"));
 102         options.add(new StateOption(INPUT_DOCK, "DOCK"));
 103         options.add(new StateOption(INPUT_IPOD, "iPod"));
 104         options.add(new StateOption(INPUT_IPOD_USB, "iPod/USB"));
 105         options.add(new StateOption(INPUT_BLUETOOTH, "Bluetooth"));
 106         options.add(new StateOption("UAW", "UAW"));
 107         options.add(new StateOption("NET", "NET"));
 108         options.add(new StateOption(INPUT_SIRIUS, "Sirius"));
 109         options.add(new StateOption(INPUT_RHAPSODY, "Rhapsody"));
 110         options.add(new StateOption("SIRIUS_IR", "SIRIUS IR"));
 111         options.add(new StateOption(INPUT_PANDORA, "Pandora"));
 112         options.add(new StateOption(INPUT_NAPSTER, "Napster"));
 113         options.add(new StateOption(INPUT_SPOTIFY, "Spotify"));
 114         return StateDescriptionFragmentBuilder.create().withPattern("%s").withReadOnly(false).withOptions(options)
 115                 .build();
 116     }
 117
 118     public void changeAvailableInputs(Map<String, String> availableInputs) {
 119         List<StateOption> options = new ArrayList<>();
 120         for (Entry<String, String> inputEntry : availableInputs.entrySet()) {
 121             options.add(new StateOption(inputEntry.getKey(), inputEntry.getValue()));
 122         }
 123         createChannelType(StateDescriptionFragmentBuilder.create().withPattern("%s").withReadOnly(false)
 124                 .withOptions(options).build());
 125     }
 126
 127     @NonNullByDefault({})
 128     @Override
 129     public void setThingHandler(ThingHandler handler) {
 130         this.handler = (YamahaZoneThingHandler) handler;
 131         this.handler.channelsTypeProviderAvailableInputs = this;
 132         channelTypeUID = new ChannelTypeUID(YamahaReceiverBindingConstants.BINDING_ID,
 133                 YamahaReceiverBindingConstants.CHANNEL_INPUT_TYPE_AVAILABLE + handler.getThing().getUID().getId());
 134         createChannelType(getDefaultStateDescription());
 135     }
 136
 137     @Override
 138     public @Nullable ThingHandler getThingHandler() {
 139         return handler;
 140     }
 141 }