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.netatmo.internal.api.data;
  14
  15 import static org.openhab.binding.netatmo.internal.NetatmoBindingConstants.*;
  16 import static org.openhab.core.library.CoreItemFactory.*;
  17 import static org.openhab.core.library.unit.MetricPrefix.*;
  18
  19 import java.net.URI;
  20 import java.util.Arrays;
  21 import java.util.EnumSet;
  22 import java.util.HashMap;
  23 import java.util.Map;
  24 import java.util.Set;
  25 import java.util.stream.Collectors;
  26 import java.util.stream.Stream;
  27
  28 import javax.measure.Unit;
  29
  30 import org.eclipse.jdt.annotation.NonNullByDefault;
  31 import org.openhab.core.library.unit.SIUnits;
  32 import org.openhab.core.library.unit.Units;
  33 import org.openhab.core.types.StateDescriptionFragment;
  34 import org.openhab.core.types.StateDescriptionFragmentBuilder;
  35 import org.openhab.core.types.util.UnitUtils;
  36
  37 import com.google.gson.annotations.SerializedName;
  38
  39 /**
  40  * This class holds various definitions and settings provided by the Netatmo
  41  * API documentation
  42  *
  43  * @author Gaël L'hopital - Initial contribution
  44  */
  45 @NonNullByDefault
  46 public class NetatmoConstants {
  47     public static class Measure {
  48         public final double minValue;
  49         public final double maxValue;
  50         public final int scale;
  51         public final Unit<?> unit;
  52
  53         private Measure(double minValue, double maxValue, double precision, Unit<?> unit) {
  54             this.minValue = minValue;
  55             this.maxValue = maxValue;
  56             this.unit = unit;
  57             String[] splitter = Double.valueOf(precision).toString().split("\\.");
  58             if (splitter.length > 1) {
  59                 int dec = Integer.parseInt(splitter[1]);
  60                 this.scale = dec > 0 ? Integer.toString(dec).length() : 0;
  61             } else {
  62                 this.scale = 0;
  63             }
  64         }
  65     }
  66
  67     public static class MeasureChannelDetails {
  68         private static final StateDescriptionFragmentBuilder BUILDER = StateDescriptionFragmentBuilder.create();
  69         public final URI configURI;
  70         public final String itemType;
  71         public final StateDescriptionFragment stateDescriptionFragment;
  72
  73         private MeasureChannelDetails(String measureType, String itemType, String pattern) {
  74             this.configURI = URI.create(String.join(":", BINDING_ID, measureType, "config"));
  75             this.itemType = itemType;
  76             this.stateDescriptionFragment = BUILDER.withReadOnly(true).withPattern(pattern).build();
  77         }
  78     }
  79
  80     public enum MeasureClass {
  81         INSIDE_TEMPERATURE(0, 50, 0.3, SIUnits.CELSIUS, "temp", "measure", true),
  82         OUTSIDE_TEMPERATURE(-40, 65, 0.3, SIUnits.CELSIUS, "temp", "measure", true),
  83         HEAT_INDEX(-40, 65, 1, SIUnits.CELSIUS, "", "", false),
  84         PRESSURE(260, 1260, 0.1, HECTO(SIUnits.PASCAL), "pressure", "measure", true),
  85         CO2(0, 5000, 50, Units.PARTS_PER_MILLION, "co2", "measure", true),
  86         NOISE(35, 120, 1, Units.DECIBEL, "noise", "measure", true),
  87         RAIN_QUANTITY(0, Double.MAX_VALUE, 0.1, MILLI(SIUnits.METRE), "sum_rain", "sum_rain", false),
  88         RAIN_INTENSITY(0, 150, 0.1, Units.MILLIMETRE_PER_HOUR, "", "", false),
  89         WIND_SPEED(0, 160, 1.8, SIUnits.KILOMETRE_PER_HOUR, "", "", false),
  90         WIND_ANGLE(0, 360, 5, Units.DEGREE_ANGLE, "", "", false),
  91         HUMIDITY(0, 100, 3, Units.PERCENT, "hum", "measure", true);
  92
  93         public static final EnumSet<MeasureClass> AS_SET = EnumSet.allOf(MeasureClass.class);
  94
  95         public final Measure measureDefinition;
  96         public final String apiDescriptor;
  97         public final Map<String, MeasureChannelDetails> channels = new HashMap<>(2);
  98
  99         MeasureClass(double min, double max, double precision, Unit<?> unit, String apiDescriptor, String confFragment,
 100                 boolean canScale) {
 101             this.measureDefinition = new Measure(min, max, precision, unit);
 102             this.apiDescriptor = apiDescriptor;
 103             if (!apiDescriptor.isBlank()) {
 104                 String dimension = UnitUtils.getDimensionName(unit);
 105
 106                 channels.put(String.join("-", apiDescriptor, "measurement"),
 107                         new MeasureChannelDetails(confFragment, String.join(":", NUMBER, dimension),
 108                                 String.format("%%.%df %s", measureDefinition.scale, UnitUtils.UNIT_PLACEHOLDER)));
 109                 if (canScale) {
 110                     channels.put(String.join("-", apiDescriptor, GROUP_TIMESTAMP), new MeasureChannelDetails(
 111                             GROUP_TIMESTAMP, DATETIME, "@text/extensible-channel-type.timestamp.pattern"));
 112                 }
 113             }
 114         }
 115     }
 116
 117     // Content types
 118     public static final String CONTENT_APP_JSON = "application/json;charset=utf-8";
 119     public static final String CONTENT_APP_FORM = "application/x-www-form-urlencoded;charset=UTF-8";
 120
 121     // Netatmo API urls
 122     public static final String URL_API = "https://api.netatmo.com/";
 123     public static final String PATH_OAUTH = "oauth2";
 124     public static final String SUB_PATH_TOKEN = "token";
 125     public static final String SUB_PATH_AUTHORIZE = "authorize";
 126     public static final String PATH_API = "api";
 127     public static final String PATH_COMMAND = "command";
 128     public static final String PATH_STATE = "setstate";
 129     public static final String SUB_PATH_PERSON_AWAY = "setpersonsaway";
 130     public static final String SUB_PATH_PERSON_HOME = "setpersonshome";
 131     public static final String SUB_PATH_HOMES_DATA = "homesdata";
 132     public static final String SUB_PATH_ADD_WEBHOOK = "addwebhook";
 133     public static final String SUB_PATH_DROP_WEBHOOK = "dropwebhook";
 134     public static final String SUB_PATH_SET_ROOM_THERMPOINT = "setroomthermpoint";
 135     public static final String SUB_PATH_SET_THERM_MODE = "setthermmode";
 136     public static final String SUB_PATH_SWITCH_SCHEDULE = "switchschedule";
 137     public static final String SUB_PATH_GET_STATION = "getstationsdata";
 138     public static final String SUB_PATH_GET_MEASURE = "getmeasure";
 139     public static final String SUB_PATH_HOMESTATUS = "homestatus";
 140     public static final String SUB_PATH_HOMECOACH = "gethomecoachsdata";
 141     public static final String SUB_PATH_GET_EVENTS = "getevents";
 142     public static final String SUB_PATH_PING = "ping";
 143     public static final String SUB_PATH_CHANGESTATUS = "changestatus";
 144     public static final String PARAM_DEVICE_ID = "device_id";
 145     public static final String PARAM_MODULE_ID = "module_id";
 146     public static final String PARAM_HOME_ID = "home_id";
 147     public static final String PARAM_ROOM_ID = "room_id";
 148     public static final String PARAM_PERSON_ID = "person_id";
 149     public static final String PARAM_EVENT_ID = "event_id";
 150     public static final String PARAM_SCHEDULE_ID = "schedule_id";
 151     public static final String PARAM_OFFSET = "offset";
 152     public static final String PARAM_GATEWAY_TYPE = "gateway_types";
 153     public static final String PARAM_MODE = "mode";
 154     public static final String PARAM_URL = "url";
 155     public static final String PARAM_FAVORITES = "get_favorites";
 156     public static final String PARAM_STATUS = "status";
 157     public static final String PARAM_DEVICES_TYPE = "device_types";
 158
 159     // Payloads
 160     public static final String PAYLOAD_FLOODLIGHT = "{\"home\": {\"id\":\"%s\",\"modules\": [ {\"id\":\"%s\",\"floodlight\":\"%s\"} ]}}";
 161     public static final String PAYLOAD_PERSON_AWAY = "{\"home_id\":\"%s\",\"person_id\":\"%s\"}";
 162     public static final String PAYLOAD_PERSON_HOME = "{\"home_id\":\"%s\",\"person_ids\":[\"%s\"]}";
 163
 164     // Autentication process params
 165     public static final String PARAM_ERROR = "error";
 166
 167     // Global variables
 168     public static final int THERM_MAX_SETPOINT = 30;
 169
 170     // Token scopes
 171     public static enum Scope {
 172         @SerializedName("read_station")
 173         READ_STATION,
 174         @SerializedName("read_thermostat")
 175         READ_THERMOSTAT,
 176         @SerializedName("write_thermostat")
 177         WRITE_THERMOSTAT,
 178         @SerializedName("read_camera")
 179         READ_CAMERA,
 180         @SerializedName("write_camera")
 181         WRITE_CAMERA,
 182         @SerializedName("access_camera")
 183         ACCESS_CAMERA,
 184         @SerializedName("read_presence")
 185         READ_PRESENCE,
 186         @SerializedName("write_presence")
 187         WRITE_PRESENCE,
 188         @SerializedName("access_presence")
 189         ACCESS_PRESENCE,
 190         @SerializedName("read_smokedetector")
 191         READ_SMOKEDETECTOR,
 192         @SerializedName("read_homecoach")
 193         READ_HOMECOACH,
 194         @SerializedName("read_doorbell")
 195         READ_DOORBELL,
 196         @SerializedName("write_doorbell")
 197         WRITE_DOORBELL,
 198         @SerializedName("access_doorbell")
 199         ACCESS_DOORBELL,
 200         @SerializedName("read_carbonmonoxidedetector")
 201         READ_CARBONMONOXIDEDETECTOR,
 202         UNKNOWN;
 203     }
 204
 205     private static final Scope[] SMOKE_SCOPES = { Scope.READ_SMOKEDETECTOR };
 206     private static final Scope[] CARBON_MONOXIDE_SCOPES = { Scope.READ_CARBONMONOXIDEDETECTOR };
 207     private static final Scope[] AIR_CARE_SCOPES = { Scope.READ_HOMECOACH };
 208     private static final Scope[] WEATHER_SCOPES = { Scope.READ_STATION };
 209     private static final Scope[] THERMOSTAT_SCOPES = { Scope.READ_THERMOSTAT, Scope.WRITE_THERMOSTAT };
 210     private static final Scope[] WELCOME_SCOPES = { Scope.READ_CAMERA, Scope.WRITE_CAMERA, Scope.ACCESS_CAMERA };
 211     private static final Scope[] DOORBELL_SCOPES = { Scope.READ_DOORBELL, Scope.WRITE_DOORBELL, Scope.ACCESS_DOORBELL };
 212     private static final Scope[] PRESENCE_SCOPES = { Scope.READ_PRESENCE, Scope.WRITE_PRESENCE, Scope.ACCESS_PRESENCE };
 213
 214     public static enum FeatureArea {
 215         AIR_CARE(AIR_CARE_SCOPES),
 216         WEATHER(WEATHER_SCOPES),
 217         ENERGY(THERMOSTAT_SCOPES),
 218         SECURITY(WELCOME_SCOPES, PRESENCE_SCOPES, SMOKE_SCOPES, DOORBELL_SCOPES, CARBON_MONOXIDE_SCOPES),
 219         NONE();
 220
 221         public static String ALL_SCOPES = EnumSet.allOf(FeatureArea.class).stream().map(fa -> fa.scopes)
 222                 .flatMap(Set::stream).map(s -> s.name().toLowerCase()).collect(Collectors.joining(" "));
 223
 224         public final Set<Scope> scopes;
 225
 226         FeatureArea(Scope[]... scopeArrays) {
 227             this.scopes = Stream.of(scopeArrays).flatMap(Arrays::stream).collect(Collectors.toSet());
 228         }
 229     }
 230
 231     // Radio signal quality thresholds
 232     static final int[] WIFI_SIGNAL_LEVELS = new int[] { 99, 84, 69, 54 }; // Resp : bad, average, good, full
 233     static final int[] RADIO_SIGNAL_LEVELS = new int[] { 90, 80, 70, 60 }; // Resp : low, medium, high, full
 234
 235     // Thermostat definitions
 236     public static enum SetpointMode {
 237         @SerializedName("program")
 238         PROGRAM("program"),
 239         @SerializedName("away")
 240         AWAY("away"),
 241         @SerializedName("hg")
 242         FROST_GUARD("hg"),
 243         @SerializedName("manual")
 244         MANUAL("manual"),
 245         @SerializedName("off")
 246         OFF("off"),
 247         @SerializedName("max")
 248         MAX("max"),
 249         @SerializedName("schedule")
 250         SCHEDULE("schedule"),
 251         HOME("home"),
 252         UNKNOWN("");
 253
 254         public final String apiDescriptor;
 255
 256         SetpointMode(String descriptor) {
 257             this.apiDescriptor = descriptor;
 258         }
 259     }
 260
 261     public static enum ThermostatZoneType {
 262         @SerializedName("0")
 263         DAY("0"),
 264         @SerializedName("1")
 265         NIGHT("1"),
 266         @SerializedName("2")
 267         AWAY("2"),
 268         @SerializedName("3")
 269         FROST_GUARD("3"),
 270         @SerializedName("4")
 271         CUSTOM("4"),
 272         @SerializedName("5")
 273         ECO("5"),
 274         @SerializedName("8")
 275         COMFORT("8"),
 276         UNKNOWN("");
 277
 278         public final String zoneId;
 279
 280         private ThermostatZoneType(String id) {
 281             zoneId = id;
 282         }
 283     }
 284
 285     public enum FloodLightMode {
 286         @SerializedName("on")
 287         ON,
 288         @SerializedName("off")
 289         OFF,
 290         @SerializedName("auto")
 291         AUTO,
 292         UNKNOWN;
 293     }
 294
 295     public enum EventCategory {
 296         @SerializedName("human")
 297         HUMAN,
 298         @SerializedName("animal")
 299         ANIMAL,
 300         @SerializedName("vehicle")
 301         VEHICLE,
 302         UNKNOWN;
 303     }
 304
 305     public enum TrendDescription {
 306         @SerializedName("up")
 307         UP,
 308         @SerializedName("stable")
 309         STABLE,
 310         @SerializedName("down")
 311         DOWN,
 312         UNKNOWN;
 313     }
 314
 315     public enum VideoStatus {
 316         @SerializedName("recording")
 317         RECORDING,
 318         @SerializedName("available")
 319         AVAILABLE,
 320         @SerializedName("deleted")
 321         DELETED,
 322         UNKNOWN;
 323     }
 324
 325     public enum SdCardStatus {
 326         @SerializedName("1")
 327         SD_CARD_MISSING,
 328         @SerializedName("2")
 329         SD_CARD_INSERTED,
 330         @SerializedName("3")
 331         SD_CARD_FORMATTED,
 332         @SerializedName("4")
 333         SD_CARD_WORKING,
 334         @SerializedName("5")
 335         SD_CARD_DEFECTIVE,
 336         @SerializedName("6")
 337         SD_CARD_INCOMPATIBLE_SPEED,
 338         @SerializedName("7")
 339         SD_CARD_INSUFFICIENT_SPACE,
 340         UNKNOWN;
 341     }
 342
 343     public enum AlimentationStatus {
 344         @SerializedName("1")
 345         ALIM_INCORRECT_POWER,
 346         @SerializedName("2")
 347         ALIM_CORRECT_POWER,
 348         UNKNOWN;
 349     }
 350
 351     public enum BatteryState {
 352         @SerializedName("full")
 353         FULL(100),
 354         @SerializedName("high")
 355         HIGH(80),
 356         @SerializedName("medium")
 357         MEDIUM(50),
 358         @SerializedName("low")
 359         LOW(15),
 360         UNKNOWN(-1);
 361
 362         public final int level;
 363
 364         BatteryState(int i) {
 365             this.level = i;
 366         }
 367     }
 368
 369     public enum ServiceError {
 370         @SerializedName("99")
 371         UNKNOWN,
 372         @SerializedName("-2")
 373         UNKNOWN_ERROR_IN_OAUTH,
 374         @SerializedName("-1")
 375         GRANT_IS_INVALID,
 376         @SerializedName("1")
 377         ACCESS_TOKEN_MISSING,
 378         @SerializedName("2")
 379         INVALID_TOKEN_MISSING,
 380         @SerializedName("3")
 381         ACCESS_TOKEN_EXPIRED,
 382         @SerializedName("5")
 383         APPLICATION_DEACTIVATED,
 384         @SerializedName("7")
 385         NOTHING_TO_MODIFY,
 386         @SerializedName("9")
 387         DEVICE_NOT_FOUND,
 388         @SerializedName("10")
 389         MISSING_ARGUMENTS,
 390         @SerializedName("13")
 391         OPERATION_FORBIDDEN,
 392         @SerializedName("19")
 393         IP_NOT_FOUND,
 394         @SerializedName("21")
 395         INVALID_ARGUMENT,
 396         @SerializedName("22")
 397         APPLICATION_NOT_FOUND,
 398         @SerializedName("23")
 399         USER_NOT_FOUND,
 400         @SerializedName("25")
 401         INVALID_DATE,
 402         @SerializedName("26")
 403         MAXIMUM_USAGE_REACHED,
 404         @SerializedName("30")
 405         INVALID_REFRESH_TOKEN,
 406         @SerializedName("31")
 407         METHOD_NOT_FOUND,
 408         @SerializedName("35")
 409         UNABLE_TO_EXECUTE,
 410         @SerializedName("36")
 411         PROHIBITED_STRING,
 412         @SerializedName("37")
 413         NO_MORE_SPACE_AVAILABLE_ON_THE_CAMERA,
 414         @SerializedName("40")
 415         JSON_GIVEN_HAS_AN_INVALID_ENCODING,
 416         @SerializedName("41")
 417         DEVICE_IS_UNREACHABLE;
 418     }
 419 }