-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Dynamic state options for scene channel of the bridge
- Loading branch information
Showing
5 changed files
with
222 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
bundles/org.openhab.binding.hue/src/main/java/org/openhab/binding/hue/internal/Scene.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /** | ||
| * Copyright (c) 2010-2020 Contributors to the openHAB project | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 2.0 which is available at | ||
| * http://www.eclipse.org/legal/epl-2.0 | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| */ | ||
| package org.openhab.binding.hue.internal; | ||
|
|
||
| import java.lang.reflect.Type; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNull; | ||
| import org.eclipse.smarthome.core.types.StateOption; | ||
|
|
||
| import com.google.gson.annotations.SerializedName; | ||
| import com.google.gson.reflect.TypeToken; | ||
|
|
||
| /** | ||
| * Basic scene information. | ||
| */ | ||
| public class Scene { | ||
| public static final Type GSON_TYPE = new TypeToken<Map<String, Scene>>() { | ||
| }.getType(); | ||
|
|
||
| private String id; | ||
| private String name; | ||
| @SerializedName("lights") | ||
| private List<String> lightIds; | ||
| @SerializedName("group") | ||
| private String groupId; | ||
| private boolean recycle; | ||
|
|
||
| @NonNull | ||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| void setId(String id) { | ||
| this.id = id; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the human readable name of the scene. If the name is omitted upon creation, this | ||
| * defaults to the ID. | ||
| * | ||
| * @return human readable name of the scene | ||
| */ | ||
| @NonNull | ||
| public String getName() { | ||
| return name; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the list of lights that the scene applies to. For group scenes, this list should be identical to the list | ||
| * of all lights that are in the group. | ||
| * | ||
| * @return list of lights that the scene applies to | ||
| */ | ||
| @NonNull | ||
| public List<String> getLightIds() { | ||
| return lightIds; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the group that the scene belongs to. This field is optional for scenes that applies to a specific list of | ||
| * lights instead of a group. | ||
| * | ||
| * @return the group that the scene belongs to | ||
| */ | ||
| public String getGroupId() { | ||
| return groupId; | ||
| } | ||
|
|
||
| /** | ||
| * Indicates if the scene can be recycled by the bridge. A recyclable scene is not able to be activated. | ||
| * | ||
| * @return whether the scene can be recycled | ||
| */ | ||
| public boolean isRecycle() { | ||
| return recycle; | ||
| } | ||
|
|
||
| public StateOption toStateOption(Map<String, String> groupNames) { | ||
| if (id.contentEquals(name)) { | ||
| return new StateOption(id, id); | ||
| } else { | ||
| StringBuilder stateOptionLabel = new StringBuilder(name); | ||
| if (groupId != null && groupNames.containsKey(groupId)) { | ||
| stateOptionLabel.append(" ").append(groupNames.get(groupId)); | ||
| } | ||
| stateOptionLabel.append(" ( ").append(id).append(")"); | ||
| return new StateOption(id, stateOptionLabel.toString()); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
28 changes: 28 additions & 0 deletions
28
...main/java/org/openhab/binding/hue/internal/handler/HueStateDescriptionOptionProvider.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| package org.openhab.binding.hue.internal.handler; | ||
|
|
||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.smarthome.core.thing.binding.BaseDynamicStateDescriptionProvider; | ||
| import org.eclipse.smarthome.core.thing.i18n.ChannelTypeI18nLocalizationService; | ||
| import org.eclipse.smarthome.core.thing.type.DynamicStateDescriptionProvider; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Reference; | ||
|
|
||
| /** | ||
| * Dynamic provider of state options for {@link HueBridgeHandler} while leaving other state description fields as | ||
| * original. | ||
| */ | ||
| @Component(service = { DynamicStateDescriptionProvider.class, HueStateDescriptionOptionProvider.class }) | ||
| @NonNullByDefault | ||
| public class HueStateDescriptionOptionProvider extends BaseDynamicStateDescriptionProvider { | ||
|
|
||
| @Reference | ||
| protected void setChannelTypeI18nLocalizationService( | ||
| final ChannelTypeI18nLocalizationService channelTypeI18nLocalizationService) { | ||
| this.channelTypeI18nLocalizationService = channelTypeI18nLocalizationService; | ||
| } | ||
|
|
||
| protected void unsetChannelTypeI18nLocalizationService( | ||
| final ChannelTypeI18nLocalizationService channelTypeI18nLocalizationService) { | ||
| this.channelTypeI18nLocalizationService = null; | ||
| } | ||
| } |