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

   1 /**
   2  * Copyright (c) 2010-2020 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 java.util.stream.Collectors.toList;
  16 import static org.openhab.binding.yamahareceiver.internal.YamahaReceiverBindingConstants.*;
  17
  18 import java.util.Collection;
  19 import java.util.Collections;
  20 import java.util.List;
  21 import java.util.Locale;
  22 import java.util.stream.IntStream;
  23
  24 import org.eclipse.jdt.annotation.NonNullByDefault;
  25 import org.eclipse.jdt.annotation.Nullable;
  26 import org.openhab.binding.yamahareceiver.internal.handler.YamahaZoneThingHandler;
  27 import org.openhab.binding.yamahareceiver.internal.state.PresetInfoState;
  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.StateDescription;
  35 import org.openhab.core.types.StateOption;
  36
  37 /**
  38  * Provide a custom channel type for the preset channel
  39  *
  40  * @author David Graeff - Initial contribution
  41  * @author Tomasz Maruszak - RX-V3900 compatibility improvements
  42  */
  43 @NonNullByDefault
  44 public class ChannelsTypeProviderPreset implements ChannelTypeProvider, ThingHandlerService {
  45     private @NonNullByDefault({}) ChannelType channelType;
  46     private @NonNullByDefault({}) ChannelTypeUID channelTypeUID;
  47     private @NonNullByDefault({}) YamahaZoneThingHandler handler;
  48
  49     @Override
  50     public Collection<ChannelType> getChannelTypes(@Nullable Locale locale) {
  51         return Collections.singleton(channelType);
  52     }
  53
  54     @Override
  55     public @Nullable ChannelType getChannelType(ChannelTypeUID channelTypeUID, @Nullable Locale locale) {
  56         if (this.channelTypeUID.equals(channelTypeUID)) {
  57             return channelType;
  58         } else {
  59             return null;
  60         }
  61     }
  62
  63     public ChannelTypeUID getChannelTypeUID() {
  64         return channelTypeUID;
  65     }
  66
  67     private StateDescription getDefaultStateDescription() {
  68         List<StateOption> options = IntStream.rangeClosed(1, 40)
  69                 .mapToObj(i -> new StateOption(Integer.toString(i), "Item_" + i)).collect(toList());
  70
  71         StateDescription state = new StateDescription(null, null, null, "%s", false, options);
  72         return state;
  73     }
  74
  75     public void changePresetNames(List<PresetInfoState.Preset> presets) {
  76         List<StateOption> options = presets.stream()
  77                 .map(preset -> new StateOption(String.valueOf(preset.getValue()), preset.getName())).collect(toList());
  78
  79         StateDescription state = new StateDescription(null, null, null, "%s", false, options);
  80         createChannelType(state);
  81     }
  82
  83     private void createChannelType(StateDescription state) {
  84         channelType = ChannelTypeBuilder.state(channelTypeUID, "Preset", "Number")
  85                 .withDescription("Select a saved channel by its preset number").withStateDescription(state).build();
  86     }
  87
  88     @NonNullByDefault({})
  89     @Override
  90     public void setThingHandler(ThingHandler handler) {
  91         this.handler = (YamahaZoneThingHandler) handler;
  92         this.handler.channelsTypeProviderPreset = this;
  93         /**
  94          * We generate a thing specific channelTypeUID, because presets absolutely depends on the thing.
  95          */
  96         channelTypeUID = new ChannelTypeUID(BINDING_ID,
  97                 CHANNEL_PLAYBACK_PRESET_TYPE_NAMED + handler.getThing().getUID().getId());
  98
  99         StateDescription state = getDefaultStateDescription();
 100         createChannelType(state);
 101     }
 102
 103     @Override
 104     public @Nullable ThingHandler getThingHandler() {
 105         return this.handler;
 106     }
 107 }