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