-
-
Notifications
You must be signed in to change notification settings - Fork 242
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[BasicUI] Implement new sitemap element Colortemperaturepicker
Related to openhab/openhab-core#3891 Signed-off-by: Laurent Garnier <lg.hc@free.fr>
- Loading branch information
Showing
6 changed files
with
510 additions
and
2 deletions.
There are no files selected for viewing
31 changes: 31 additions & 0 deletions
31
bundles/org.openhab.ui.basic/snippets-src/colortemppicker.html
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,31 @@ | ||
| <div class="mdl-form__row mdl-cell mdl-cell--%cells%-col mdl-cell--%cells_tablet%-col-tablet %visibility_class%"> | ||
| <span class="mdl-form__icon"> | ||
| %icon_snippet% | ||
| </span> | ||
| <span class="mdl-form__label"> | ||
| %label% | ||
| </span> | ||
| <span class="mdl-form__value mdl-form__value--colortemppicker"> | ||
| %value% | ||
| </span> | ||
| <div | ||
| class="mdl-form__control mdl-form__colortemppicker" | ||
| data-control-type="colortemppicker" | ||
| data-item="%item%" | ||
| data-state="%state%" | ||
| data-unit="%unit%" | ||
| data-widget-id="%widget_id%" | ||
| data-icon-with-state="%icon_with_state%" | ||
| data-label-color="%label_color%" | ||
| data-value-color="%value_color%" | ||
| data-icon-color="%icon_color%" | ||
| data-min="%minValue%" | ||
| data-max="%maxValue%" | ||
| data-gradient-colors="%gradientColors%" | ||
| > | ||
| <button class="mdl-button mdl-button--raised mdl-js-button mdl-js-ripple-effect mdl-form__colortemppicker--pick"> | ||
| <!-- colorize --> | ||
| <i class="material-icons"></i> | ||
| </button> | ||
| </div> | ||
| </div> |
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
195 changes: 195 additions & 0 deletions
195
....ui.basic/src/main/java/org/openhab/ui/basic/internal/render/ColortemppickerRenderer.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,195 @@ | ||
| /** | ||
| * Copyright (c) 2010-2024 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.ui.basic.internal.render; | ||
|
|
||
| import java.math.BigDecimal; | ||
|
|
||
| import javax.measure.Unit; | ||
|
|
||
| import org.eclipse.emf.common.util.ECollections; | ||
| import org.eclipse.emf.common.util.EList; | ||
| import org.eclipse.jdt.annotation.NonNullByDefault; | ||
| import org.eclipse.jdt.annotation.Nullable; | ||
| import org.openhab.core.i18n.LocaleProvider; | ||
| import org.openhab.core.i18n.TranslationProvider; | ||
| import org.openhab.core.items.Item; | ||
| import org.openhab.core.items.ItemNotFoundException; | ||
| import org.openhab.core.library.CoreItemFactory; | ||
| import org.openhab.core.library.types.QuantityType; | ||
| import org.openhab.core.library.unit.Units; | ||
| import org.openhab.core.model.sitemap.sitemap.Colortemperaturepicker; | ||
| import org.openhab.core.model.sitemap.sitemap.Widget; | ||
| import org.openhab.core.types.State; | ||
| import org.openhab.core.types.StateDescription; | ||
| import org.openhab.core.types.util.UnitUtils; | ||
| import org.openhab.core.ui.items.ItemUIRegistry; | ||
| import org.openhab.core.util.ColorUtil; | ||
| import org.openhab.ui.basic.render.RenderException; | ||
| import org.openhab.ui.basic.render.WidgetRenderer; | ||
| import org.osgi.framework.BundleContext; | ||
| import org.osgi.service.component.annotations.Activate; | ||
| import org.osgi.service.component.annotations.Component; | ||
| import org.osgi.service.component.annotations.Reference; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| /** | ||
| * <p> | ||
| * This is an implementation of the {@link WidgetRenderer} interface, which can produce HTML code for | ||
| * Colortemperaturepicker widgets. | ||
| * | ||
| * @author Laurent Garnier - Initial contribution | ||
| */ | ||
| @Component(service = WidgetRenderer.class) | ||
| @NonNullByDefault | ||
| public class ColortemppickerRenderer extends AbstractWidgetRenderer { | ||
|
|
||
| private static final long MIN_TEMPERATURE_KELVIN = 1000L; | ||
| private static final long MAX_TEMPERATURE_KELVIN = 10000L; | ||
|
|
||
| private final Logger logger = LoggerFactory.getLogger(ColortemppickerRenderer.class); | ||
|
|
||
| @Activate | ||
| public ColortemppickerRenderer(final BundleContext bundleContext, final @Reference TranslationProvider i18nProvider, | ||
| final @Reference ItemUIRegistry itemUIRegistry, final @Reference LocaleProvider localeProvider) { | ||
| super(bundleContext, i18nProvider, itemUIRegistry, localeProvider); | ||
| } | ||
|
|
||
| @Override | ||
| public boolean canRender(Widget w) { | ||
| return w instanceof Colortemperaturepicker; | ||
| } | ||
|
|
||
| @Override | ||
| public EList<Widget> renderWidget(Widget w, StringBuilder sb, String sitemap) throws RenderException { | ||
| Colortemperaturepicker ctp = (Colortemperaturepicker) w; | ||
|
|
||
| BigDecimal current = null; | ||
| Unit<?> unit = UnitUtils.parseUnit(getUnitForWidget(w)); | ||
| long min = MIN_TEMPERATURE_KELVIN; | ||
| long max = MAX_TEMPERATURE_KELVIN; | ||
| String gradientColors = "(255,255,255)"; | ||
| String itemType = null; | ||
| String itemName = w.getItem(); | ||
| if (itemName != null) { | ||
| try { | ||
| Item item = itemUIRegistry.getItem(itemName); | ||
| itemType = item.getType(); | ||
| if ((CoreItemFactory.NUMBER + ":Temperature").equals(itemType)) { | ||
| State state = itemUIRegistry.getState(w); | ||
| if (state instanceof QuantityType<?> quantityTypeState) { | ||
| current = quantityTypeState.toBigDecimal(); | ||
| if (unit == null) { | ||
| unit = quantityTypeState.getUnit(); | ||
| } | ||
| } | ||
| if (unit == Units.KELVIN || unit == Units.MIRED) { | ||
| min = getMinimumInKelvin(ctp, unit, item.getStateDescription()); | ||
| max = getMaximumInKelvin(ctp, unit, item.getStateDescription()); | ||
| logger.debug("ColortemppickerRenderer current={} unit={} min={} max={}", current, unit, min, | ||
| max); | ||
|
|
||
| StringBuilder gradientBuilder = new StringBuilder(); | ||
| for (int percent = 0; percent <= 100; percent += 5) { | ||
| double valueKelvin = (max - min) * percent / 100.0 + min; | ||
| try { | ||
| int[] rgb = ColorUtil.hsbToRgb(ColorUtil.xyToHsb(ColorUtil.kelvinToXY(valueKelvin))); | ||
| logger.debug("Gradient {}%: {} K => RGB {} {} {}", percent, valueKelvin, rgb[0], rgb[1], | ||
| rgb[2]); | ||
| gradientBuilder.append("(%d,%d,%d) %d%%,".formatted(rgb[0], rgb[1], rgb[2], percent)); | ||
| } catch (IllegalArgumentException | IndexOutOfBoundsException e) { | ||
| logger.debug("Can't get RGB for {} Kelvin, ignoring it", valueKelvin); | ||
| } | ||
| } | ||
| if (gradientBuilder.length() > 1) { | ||
| gradientColors = gradientBuilder.substring(0, gradientBuilder.length() - 1); | ||
| } | ||
| } else { | ||
| logger.warn("Invalid unit {} for Colortemperaturepicker element", unit); | ||
| } | ||
| } else { | ||
| logger.warn("Invalid item type {} for Colortemperaturepicker element", itemType); | ||
| } | ||
| } catch (ItemNotFoundException e) { | ||
| } | ||
| } | ||
|
|
||
| String snippet = getSnippet((CoreItemFactory.NUMBER + ":Temperature").equals(itemType) | ||
| && (unit == Units.KELVIN || unit == Units.MIRED) ? "colortemppicker" : "text"); | ||
|
|
||
| // Should be called before preprocessSnippet | ||
| snippet = snippet.replace("%state%", current == null ? "UNDEF" : String.valueOf(current.doubleValue())); | ||
|
|
||
| snippet = preprocessSnippet(snippet, w, true); | ||
| snippet = snippet.replace("%unit%", unit == null ? "" : unit.toString()); | ||
| snippet = snippet.replace("%minValue%", String.valueOf(min)); | ||
| snippet = snippet.replace("%maxValue%", String.valueOf(max)); | ||
| snippet = snippet.replace("%gradientColors%", gradientColors); | ||
|
|
||
| // Process the color tags | ||
| snippet = processColor(w, snippet); | ||
|
|
||
| sb.append(snippet); | ||
| return ECollections.emptyEList(); | ||
| } | ||
|
|
||
| private long getMinimumInKelvin(Colortemperaturepicker widget, Unit<?> widgetUnit, | ||
| @Nullable StateDescription stateDescription) { | ||
| BigDecimal min = null; | ||
| BigDecimal val; | ||
| if (widgetUnit == Units.KELVIN) { | ||
| min = widget.getMinValue(); | ||
| } else { | ||
| val = widget.getMaxValue(); | ||
| min = val == null ? null : BigDecimal.valueOf(1000000.0 / val.doubleValue()); | ||
| } | ||
| // Search the min in the item state description if not defined in the widget | ||
| if (min == null && stateDescription != null) { | ||
| if (isUnitInKelvin(stateDescription)) { | ||
| min = stateDescription.getMinimum(); | ||
| } else { | ||
| val = stateDescription.getMaximum(); | ||
| min = val == null ? null : BigDecimal.valueOf(1000000.0 / val.doubleValue()); | ||
| } | ||
| } | ||
| return min != null ? Math.round(min.doubleValue()) : MIN_TEMPERATURE_KELVIN; | ||
| } | ||
|
|
||
| private long getMaximumInKelvin(Colortemperaturepicker widget, Unit<?> widgetUnit, | ||
| @Nullable StateDescription stateDescription) { | ||
| BigDecimal max = null; | ||
| BigDecimal val; | ||
| if (widgetUnit == Units.KELVIN) { | ||
| max = widget.getMaxValue(); | ||
| } else { | ||
| val = widget.getMinValue(); | ||
| max = val == null ? null : BigDecimal.valueOf(1000000.0 / val.doubleValue()); | ||
| } | ||
| // Search the max in the item state description if not defined in the widget | ||
| if (max == null && stateDescription != null) { | ||
| if (isUnitInKelvin(stateDescription)) { | ||
| max = stateDescription.getMaximum(); | ||
| } else { | ||
| val = stateDescription.getMinimum(); | ||
| max = val == null ? null : BigDecimal.valueOf(1000000.0 / val.doubleValue()); | ||
| } | ||
| } | ||
| return max != null ? Math.round(max.doubleValue()) : MAX_TEMPERATURE_KELVIN; | ||
| } | ||
|
|
||
| private boolean isUnitInKelvin(StateDescription stateDescription) { | ||
| // If no pattern or pattern with no unit, assume unit for min and max is Kelvin | ||
| Unit<?> unit = UnitUtils.parseUnit(stateDescription.getPattern()); | ||
| return unit == null || unit == Units.KELVIN; | ||
| } | ||
| } |
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
Oops, something went wrong.