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

   1 /**
   2  * Copyright (c) 2010-2022 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.bondhome.internal.api;
  14
  15 import static org.openhab.binding.bondhome.internal.BondHomeBindingConstants.*;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18 import org.eclipse.jdt.annotation.Nullable;
  19
  20 import com.google.gson.annotations.Expose;
  21 import com.google.gson.annotations.SerializedName;
  22
  23 /**
  24  * This POJO represents the Bond Device state
  25  *
  26  * The incoming JSON looks like this:
  27  *
  28  * { "breeze": [ 1, 0.2, 0.9 ], "brightness": 75, "light": 1, "power": 0,
  29  * "speed": 2, "timer": 3599 }
  30  *
  31  * @author Sara Geleskie Damiano - Initial contribution
  32  */
  33 @NonNullByDefault
  34 public class BondDeviceState {
  35     // The current state hash
  36     @SerializedName("_")
  37     @Expose(serialize = false, deserialize = true)
  38     public @Nullable String hash;
  39
  40     // The device power state 1 = on, 0 = off
  41     @Expose(serialize = true, deserialize = true)
  42     public int power;
  43
  44     // The seconds remaining on timer, or 0 meaning no timer running
  45     @Expose(serialize = true, deserialize = true)
  46     public int timer;
  47
  48     // The fan speed - value from 1 to max_speed. If power=0, speed represents the
  49     // last speed setting and the speed to which the device resumes when user asks
  50     // to turn on.
  51     @Expose(serialize = true, deserialize = true)
  52     public int speed;
  53
  54     // The current breeze setting (for a ceiling fan)
  55     // array of the form[<mode>,<mean>,<var>]:
  56     // mode: (integer) 0 = breeze mode disabled, 1 = breeze mode enabled
  57     // mean: (integer) sets the average speed. 0 = minimum average speed (calm), 100 = maximum average speed (storm)
  58     // var: (integer) sets the variability of the speed. 0 = minimum variation (steady), 100 = maximum variation (gusty)
  59     @Expose(serialize = true, deserialize = true)
  60     public int[] breeze = { 0, 50, 50 };
  61
  62     // The direction of a fan with a reversible motor 1 = forward, -1 = reverse.
  63     // The forward and reverse modes are sometimes called Summer and Winter, respectively.
  64     @Expose(serialize = true, deserialize = true)
  65     public int direction;
  66
  67     // The fan light state 1 = light on, 0 = light off
  68     @Expose(serialize = true, deserialize = true)
  69     public int light;
  70
  71     // Whether separate up and down lights are enabled, if applicable
  72     // 1 = enabled, 0 = disabled
  73     // If both up_light and light are 1, then the up light will be on, and similar for down light.
  74     @SerializedName("up_light")
  75     @Expose(serialize = true, deserialize = true)
  76     public int upLight;
  77
  78     @SerializedName("down_light")
  79     @Expose(serialize = true, deserialize = true)
  80     public int downLight;
  81
  82     // The brightness of a fan light or lights
  83     @Expose(serialize = true, deserialize = true)
  84     public int brightness;
  85
  86     @Expose(serialize = true, deserialize = true)
  87     public int upLightBrightness;
  88
  89     @Expose(serialize = true, deserialize = true)
  90     public int downLightBrightness;
  91
  92     // The flame level of a fireplace - value from 1 to 100. If power=0, flame represents the last flame setting and
  93     // the flame to which the device resumes when user asks to turn on
  94     @Expose(serialize = true, deserialize = true)
  95     public int flame;
  96
  97     // Whether a device is open or closed (for motorized shades and garage doors)
  98     // 1 = open, 0 = closed
  99     @Expose(serialize = true, deserialize = true)
 100     public int open;
 101
 102     // Fan settings for a fireplace fan
 103     // fpfan_power: (integer) 1 = on, 0 = off
 104     // fpfan_speed: (integer) from 1-100
 105     @SerializedName("fpfan_power")
 106     @Expose(serialize = true, deserialize = true)
 107     public int fpfanPower;
 108
 109     @SerializedName("fpfan_speed")
 110     @Expose(serialize = true, deserialize = true)
 111     public int fpfanSpeed;
 112 }