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.toString(precision).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_SIREN_PRESENCE = "{\"home\": {\"id\":\"%s\",\"modules\": [ {\"id\":\"%s\",\"siren_status\":\"%s\"} ]}}";
 162     public static final String PAYLOAD_PERSON_AWAY = "{\"home_id\":\"%s\",\"person_id\":\"%s\"}";
 163     public static final String PAYLOAD_PERSON_HOME = "{\"home_id\":\"%s\",\"person_ids\":[\"%s\"]}";
 164
 165     // Autentication process params
 166     public static final String PARAM_ERROR = "error";
 167
 168     // Global variables
 169     public static final int THERM_MAX_SETPOINT = 30;
 170
 171     // Token scopes
 172     public enum Scope {
 173         @SerializedName("read_station")
 174         READ_STATION,
 175         @SerializedName("read_thermostat")
 176         READ_THERMOSTAT,
 177         @SerializedName("write_thermostat")
 178         WRITE_THERMOSTAT,
 179         @SerializedName("read_camera")
 180         READ_CAMERA,
 181         @SerializedName("write_camera")
 182         WRITE_CAMERA,
 183         @SerializedName("access_camera")
 184         ACCESS_CAMERA,
 185         @SerializedName("read_presence")
 186         READ_PRESENCE,
 187         @SerializedName("write_presence")
 188         WRITE_PRESENCE,
 189         @SerializedName("access_presence")
 190         ACCESS_PRESENCE,
 191         @SerializedName("read_smokedetector")
 192         READ_SMOKEDETECTOR,
 193         @SerializedName("read_homecoach")
 194         READ_HOMECOACH,
 195         @SerializedName("read_doorbell")
 196         READ_DOORBELL,
 197         @SerializedName("write_doorbell")
 198         WRITE_DOORBELL,
 199         @SerializedName("access_doorbell")
 200         ACCESS_DOORBELL,
 201         @SerializedName("read_carbonmonoxidedetector")
 202         READ_CARBONMONOXIDEDETECTOR,
 203         UNKNOWN
 204     }
 205
 206     private static final Scope[] SMOKE_SCOPES = { Scope.READ_SMOKEDETECTOR };
 207     private static final Scope[] CARBON_MONOXIDE_SCOPES = { Scope.READ_CARBONMONOXIDEDETECTOR };
 208     private static final Scope[] AIR_CARE_SCOPES = { Scope.READ_HOMECOACH };
 209     private static final Scope[] WEATHER_SCOPES = { Scope.READ_STATION };
 210     private static final Scope[] THERMOSTAT_SCOPES = { Scope.READ_THERMOSTAT, Scope.WRITE_THERMOSTAT };
 211     private static final Scope[] WELCOME_SCOPES = { Scope.READ_CAMERA, Scope.WRITE_CAMERA, Scope.ACCESS_CAMERA };
 212     private static final Scope[] DOORBELL_SCOPES = { Scope.READ_DOORBELL, Scope.WRITE_DOORBELL, Scope.ACCESS_DOORBELL };
 213     private static final Scope[] PRESENCE_SCOPES = { Scope.READ_PRESENCE, Scope.WRITE_PRESENCE, Scope.ACCESS_PRESENCE };
 214
 215     public enum FeatureArea {
 216         AIR_CARE(AIR_CARE_SCOPES),
 217         WEATHER(WEATHER_SCOPES),
 218         ENERGY(THERMOSTAT_SCOPES),
 219         SECURITY(WELCOME_SCOPES, PRESENCE_SCOPES, SMOKE_SCOPES, DOORBELL_SCOPES, CARBON_MONOXIDE_SCOPES),
 220         NONE();
 221
 222         public static String ALL_SCOPES = EnumSet.allOf(FeatureArea.class).stream().map(fa -> fa.scopes)
 223                 .flatMap(Set::stream).map(s -> s.name().toLowerCase()).collect(Collectors.joining(" "));
 224
 225         public final Set<Scope> scopes;
 226
 227         FeatureArea(Scope[]... scopeArrays) {
 228             this.scopes = Stream.of(scopeArrays).flatMap(Arrays::stream).collect(Collectors.toSet());
 229         }
 230     }
 231
 232     // Radio signal quality thresholds
 233     static final int[] WIFI_SIGNAL_LEVELS = new int[] { 99, 84, 69, 54 }; // Resp : bad, average, good, full
 234     static final int[] RADIO_SIGNAL_LEVELS = new int[] { 90, 80, 70, 60 }; // Resp : low, medium, high, full
 235
 236     // Thermostat definitions
 237     public enum SetpointMode {
 238         @SerializedName("program")
 239         PROGRAM("program"),
 240         @SerializedName("away")
 241         AWAY("away"),
 242         @SerializedName("hg")
 243         FROST_GUARD("hg"),
 244         @SerializedName("manual")
 245         MANUAL("manual"),
 246         @SerializedName("off")
 247         OFF("off"),
 248         @SerializedName("max")
 249         MAX("max"),
 250         @SerializedName("schedule")
 251         SCHEDULE("schedule"),
 252         HOME("home"),
 253         UNKNOWN("");
 254
 255         public final String apiDescriptor;
 256
 257         SetpointMode(String descriptor) {
 258             this.apiDescriptor = descriptor;
 259         }
 260     }
 261
 262     public enum ThermostatZoneType {
 263         @SerializedName("0")
 264         DAY("0"),
 265         @SerializedName("1")
 266         NIGHT("1"),
 267         @SerializedName("2")
 268         AWAY("2"),
 269         @SerializedName("3")
 270         FROST_GUARD("3"),
 271         @SerializedName("4")
 272         CUSTOM("4"),
 273         @SerializedName("5")
 274         ECO("5"),
 275         @SerializedName("8")
 276         COMFORT("8"),
 277         UNKNOWN("");
 278
 279         public final String zoneId;
 280
 281         private ThermostatZoneType(String id) {
 282             zoneId = id;
 283         }
 284     }
 285
 286     public enum FloodLightMode {
 287         @SerializedName("on")
 288         ON,
 289         @SerializedName("off")
 290         OFF,
 291         @SerializedName("auto")
 292         AUTO,
 293         UNKNOWN
 294     }
 295
 296     public enum EventCategory {
 297         @SerializedName("human")
 298         HUMAN,
 299         @SerializedName("animal")
 300         ANIMAL,
 301         @SerializedName("vehicle")
 302         VEHICLE,
 303         UNKNOWN
 304     }
 305
 306     public enum TrendDescription {
 307         @SerializedName("up")
 308         UP,
 309         @SerializedName("stable")
 310         STABLE,
 311         @SerializedName("down")
 312         DOWN,
 313         UNKNOWN
 314     }
 315
 316     public enum VideoStatus {
 317         @SerializedName("recording")
 318         RECORDING,
 319         @SerializedName("available")
 320         AVAILABLE,
 321         @SerializedName("deleted")
 322         DELETED,
 323         UNKNOWN
 324     }
 325
 326     public enum SdCardStatus {
 327         @SerializedName("1")
 328         SD_CARD_MISSING,
 329         @SerializedName("2")
 330         SD_CARD_INSERTED,
 331         @SerializedName("3")
 332         SD_CARD_FORMATTED,
 333         @SerializedName("4")
 334         SD_CARD_WORKING,
 335         @SerializedName("5")
 336         SD_CARD_DEFECTIVE,
 337         @SerializedName("6")
 338         SD_CARD_INCOMPATIBLE_SPEED,
 339         @SerializedName("7")
 340         SD_CARD_INSUFFICIENT_SPACE,
 341         UNKNOWN
 342     }
 343
 344     public enum AlimentationStatus {
 345         @SerializedName("1")
 346         ALIM_INCORRECT_POWER,
 347         @SerializedName("2")
 348         ALIM_CORRECT_POWER,
 349         UNKNOWN
 350     }
 351
 352     public enum SirenStatus {
 353         SOUND,
 354         NO_SOUND,
 355         UNKNOWN;
 356
 357         public static SirenStatus get(String value) {
 358             try {
 359                 return valueOf(value.toUpperCase());
 360             } catch (IllegalArgumentException e) {
 361                 return UNKNOWN;
 362             }
 363         }
 364     }
 365
 366     public enum BatteryState {
 367         @SerializedName("full")
 368         FULL(100),
 369         @SerializedName("high")
 370         HIGH(80),
 371         @SerializedName("medium")
 372         MEDIUM(50),
 373         @SerializedName("low")
 374         LOW(15),
 375         UNKNOWN(-1);
 376
 377         public final int level;
 378
 379         BatteryState(int i) {
 380             this.level = i;
 381         }
 382     }
 383
 384     public enum ServiceError {
 385         @SerializedName("99")
 386         UNKNOWN,
 387         @SerializedName("-2")
 388         UNKNOWN_ERROR_IN_OAUTH,
 389         @SerializedName("-1")
 390         GRANT_IS_INVALID,
 391         @SerializedName("1")
 392         ACCESS_TOKEN_MISSING,
 393         @SerializedName("2")
 394         INVALID_TOKEN_MISSING,
 395         @SerializedName("3")
 396         ACCESS_TOKEN_EXPIRED,
 397         @SerializedName("5")
 398         APPLICATION_DEACTIVATED,
 399         @SerializedName("7")
 400         NOTHING_TO_MODIFY,
 401         @SerializedName("9")
 402         DEVICE_NOT_FOUND,
 403         @SerializedName("10")
 404         MISSING_ARGUMENTS,
 405         @SerializedName("13")
 406         OPERATION_FORBIDDEN,
 407         @SerializedName("19")
 408         IP_NOT_FOUND,
 409         @SerializedName("21")
 410         INVALID_ARGUMENT,
 411         @SerializedName("22")
 412         APPLICATION_NOT_FOUND,
 413         @SerializedName("23")
 414         USER_NOT_FOUND,
 415         @SerializedName("25")
 416         INVALID_DATE,
 417         @SerializedName("26")
 418         MAXIMUM_USAGE_REACHED,
 419         @SerializedName("30")
 420         INVALID_REFRESH_TOKEN,
 421         @SerializedName("31")
 422         METHOD_NOT_FOUND,
 423         @SerializedName("35")
 424         UNABLE_TO_EXECUTE,
 425         @SerializedName("36")
 426         PROHIBITED_STRING,
 427         @SerializedName("37")
 428         NO_MORE_SPACE_AVAILABLE_ON_THE_CAMERA,
 429         @SerializedName("40")
 430         JSON_GIVEN_HAS_AN_INVALID_ENCODING,
 431         @SerializedName("41")
 432         DEVICE_IS_UNREACHABLE
 433     }
 434
 435     public enum HomeStatusError {
 436         @SerializedName("1")
 437         UNKNOWN_ERROR("homestatus-unknown-error"),
 438         @SerializedName("2")
 439         INTERNAL_ERROR("homestatus-internal-error"),
 440         @SerializedName("3")
 441         PARSER_ERROR("homestatus-parser-error"),
 442         @SerializedName("4")
 443         COMMAND_UNKNOWN_NODE_MODULE_ERROR("homestatus-command-unknown"),
 444         @SerializedName("5")
 445         COMMAND_INVALID_PARAMS("homestatus-invalid-params"),
 446         @SerializedName("6")
 447         UNREACHABLE("device-not-connected"),
 448         UNKNOWN("deserialization-unknown");
 449
 450         // Associated error message that can be found in properties files
 451         public final String message;
 452
 453         HomeStatusError(String message) {
 454             this.message = message;
 455         }
 456     }
 457 }