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.hue.internal.api.dto.clip2;
  14
  15 import java.util.Objects;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19 import org.openhab.core.types.State;
  20 import org.openhab.core.types.UnDefType;
  21
  22 import com.google.gson.annotations.SerializedName;
  23
  24 /**
  25  * DTO for CLIP 2 tap switch rotary dial state.
  26  *
  27  * @author Andrew Fiddian-Green - Initial contribution
  28  */
  29 @NonNullByDefault
  30 public class RelativeRotary {
  31     private @Nullable @SerializedName("last_event") RotationEvent lastEvent;
  32     private @Nullable @SerializedName("rotary_report") RotaryReport rotaryReport;
  33
  34     public State getActionState() {
  35         RotationEvent lastEvent = getLastEvent();
  36         return Objects.nonNull(lastEvent) ? lastEvent.getActionState() : UnDefType.NULL;
  37     }
  38
  39     /**
  40      * The underlying field is deprecated in the CLIP 2 API.
  41      * Renamed to RelativeRotaryReport. Indicate which type of rotary event is received.
  42      * Should be used only as fallback for older firmwares.
  43      */
  44     public @Nullable RotationEvent getLastEvent() {
  45         return lastEvent;
  46     }
  47
  48     /**
  49      * The underlying field is deprecated in the CLIP 2 API.
  50      * Renamed to RelativeRotaryReport.
  51      * Should be used only as fallback for older firmwares.
  52      */
  53     public State getStepsState() {
  54         RotationEvent lastEvent = getLastEvent();
  55         return Objects.nonNull(lastEvent) ? lastEvent.getStepsState() : UnDefType.NULL;
  56     }
  57
  58     public @Nullable RotaryReport getRotaryReport() {
  59         return rotaryReport;
  60     }
  61 }