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.miio.internal;
  14
  15 import java.io.File;
  16 import java.util.Collections;
  17 import java.util.Set;
  18 import java.util.stream.Collectors;
  19 import java.util.stream.Stream;
  20
  21 import org.eclipse.jdt.annotation.NonNullByDefault;
  22 import org.openhab.core.OpenHAB;
  23 import org.openhab.core.thing.ThingTypeUID;
  24
  25 /**
  26  * The {@link MiIoBindingConstants} class defines common constants, which are
  27  * used across the whole binding.
  28  *
  29  * @author Marcel Verpaalen - Initial contribution
  30  */
  31 @NonNullByDefault
  32 public final class MiIoBindingConstants {
  33
  34     public static final String BINDING_ID = "miio";
  35
  36     // List of all Thing Type UIDs
  37     public static final ThingTypeUID THING_TYPE_MIIO = new ThingTypeUID(BINDING_ID, "generic");
  38     public static final ThingTypeUID THING_TYPE_BASIC = new ThingTypeUID(BINDING_ID, "basic");
  39     public static final ThingTypeUID THING_TYPE_LUMI = new ThingTypeUID(BINDING_ID, "lumi");
  40     public static final ThingTypeUID THING_TYPE_GATEWAY = new ThingTypeUID(BINDING_ID, "gateway");
  41     public static final ThingTypeUID THING_TYPE_VACUUM = new ThingTypeUID(BINDING_ID, "vacuum");
  42     public static final ThingTypeUID THING_TYPE_UNSUPPORTED = new ThingTypeUID(BINDING_ID, "unsupported");
  43
  44     public static final Set<ThingTypeUID> SUPPORTED_THING_TYPES_UIDS = Collections
  45             .unmodifiableSet(Stream.of(THING_TYPE_MIIO, THING_TYPE_BASIC, THING_TYPE_LUMI, THING_TYPE_GATEWAY,
  46                     THING_TYPE_VACUUM, THING_TYPE_UNSUPPORTED).collect(Collectors.toSet()));
  47
  48     public static final Set<ThingTypeUID> NONGENERIC_THING_TYPES_UIDS = Collections.unmodifiableSet(
  49             Stream.of(THING_TYPE_BASIC, THING_TYPE_LUMI, THING_TYPE_GATEWAY, THING_TYPE_VACUUM, THING_TYPE_UNSUPPORTED)
  50                     .collect(Collectors.toSet()));
  51
  52     // List of all Channel IDs
  53     public static final String CHANNEL_BATTERY = "status#battery";
  54     public static final String CHANNEL_CLEAN_AREA = "status#clean_area";
  55     public static final String CHANNEL_CLEAN_TIME = "status#clean_time";
  56     public static final String CHANNEL_DND_ENABLED = "status#dnd_enabled";
  57     public static final String CHANNEL_ERROR_CODE = "status#error_code";
  58     public static final String CHANNEL_ERROR_ID = "status#error_id";
  59     public static final String CHANNEL_FAN_POWER = "status#fan_power";
  60     public static final String CHANNEL_IN_CLEANING = "status#in_cleaning";
  61     public static final String CHANNEL_MAP_PRESENT = "status#map_present";
  62     public static final String CHANNEL_STATE = "status#state";
  63     public static final String CHANNEL_STATE_ID = "status#state_id";
  64     public static final String CHANNEL_DOCK_STATE = "status#dock_state";
  65     public static final String CHANNEL_DOCK_STATE_ID = "status#dock_state_id";
  66
  67     public static final String CHANNEL_CONTROL = "actions#control";
  68     public static final String CHANNEL_COMMAND = "actions#commands";
  69     public static final String CHANNEL_RPC = "actions#rpc";
  70     public static final String CHANNEL_VACUUM = "actions#vacuum";
  71     public static final String CHANNEL_FAN_CONTROL = "actions#fan";
  72     public static final String CHANNEL_TESTCOMMANDS = "actions#testcommands";
  73     public static final String CHANNEL_TESTMIOT = "actions#testmiot";
  74     public static final String CHANNEL_POWER = "actions#power";
  75
  76     public static final String CHANNEL_SSID = "network#ssid";
  77     public static final String CHANNEL_BSSID = "network#bssid";
  78     public static final String CHANNEL_RSSI = "network#rssi";
  79     public static final String CHANNEL_LIFE = "network#life";
  80
  81     public static final String CHANNEL_CONSUMABLE_MAIN_PERC = "consumables#main_brush_percent";
  82     public static final String CHANNEL_CONSUMABLE_SIDE_PERC = "consumables#side_brush_percent";
  83     public static final String CHANNEL_CONSUMABLE_FILTER_PERC = "consumables#filter_percent";
  84     public static final String CHANNEL_CONSUMABLE_SENSOR_PERC = "consumables#sensor_dirt_percent";
  85     public static final String CHANNEL_CONSUMABLE_MAIN_TIME = "consumables#main_brush_time";
  86     public static final String CHANNEL_CONSUMABLE_SIDE_TIME = "consumables#side_brush_time";
  87     public static final String CHANNEL_CONSUMABLE_FILTER_TIME = "consumables#filter_time";
  88     public static final String CHANNEL_CONSUMABLE_SENSOR_TIME = "consumables#sensor_dirt_time";
  89     public static final String CHANNEL_CONSUMABLE_RESET = "consumables#consumable_reset";
  90
  91     public static final String CHANNEL_DND_FUNCTION = "dnd#dnd_function";
  92     public static final String CHANNEL_DND_START = "dnd#dnd_start";
  93     public static final String CHANNEL_DND_END = "dnd#dnd_end";
  94
  95     public static final String CHANNEL_HISTORY_TOTALTIME = "history#total_clean_time";
  96     public static final String CHANNEL_HISTORY_TOTALAREA = "history#total_clean_area";
  97     public static final String CHANNEL_HISTORY_COUNT = "history#total_clean_count";
  98
  99     public static final String CHANNEL_MOP_TOTALDRYTIME = "status#mop_drying_time";
 100
 101     public static final String CHANNEL_HISTORY_START_TIME = "cleaning#last_clean_start_time";
 102     public static final String CHANNEL_HISTORY_END_TIME = "cleaning#last_clean_end_time";
 103     public static final String CHANNEL_HISTORY_AREA = "cleaning#last_clean_area";
 104     public static final String CHANNEL_HISTORY_DURATION = "cleaning#last_clean_duration";
 105     public static final String CHANNEL_HISTORY_ERROR = "cleaning#last_clean_error";
 106     public static final String CHANNEL_HISTORY_FINISH = "cleaning#last_clean_finish";
 107     public static final String CHANNEL_HISTORY_FINISHREASON = "cleaning#last_clean_finish_reason";
 108     public static final String CHANNEL_HISTORY_DUSTCOLLECTION = "cleaning#last_clean_dustcollection_status";
 109     public static final String CHANNEL_HISTORY_RECORD = "cleaning#last_clean_record";
 110     public static final String CHANNEL_VACUUM_MAP = "cleaning#map";
 111
 112     public static final String PROPERTY_HOST_IP = "host";
 113     public static final String PROPERTY_DID = "deviceId";
 114     public static final String PROPERTY_TOKEN = "token";
 115     public static final String PROPERTY_MODEL = "model";
 116     public static final String PROPERTY_REFRESH_INTERVAL = "refreshInterval";
 117     public static final String PROPERTY_TIMEOUT = "timeout";
 118     public static final String PROPERTY_CLOUDSERVER = "cloudServer";
 119
 120     public static final Set<String> PERSISTENT_CHANNELS = Collections.unmodifiableSet(
 121             Stream.of(CHANNEL_COMMAND, CHANNEL_RPC, CHANNEL_SSID, CHANNEL_BSSID, CHANNEL_RSSI, CHANNEL_LIFE)
 122                     .collect(Collectors.toSet()));
 123
 124     public static final byte[] DISCOVER_STRING = org.openhab.binding.miio.internal.Utils
 125             .hexStringToByteArray("21310020ffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
 126     public static final int PORT = 54321;
 127     public static final Set<String> IGNORED_TOKENS = Collections.unmodifiableSet(Stream
 128             .of("FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF", "00000000000000000000000000000000").collect(Collectors.toSet()));
 129
 130     public static final String DATABASE_PATH = "database/";
 131     public static final String BINDING_DATABASE_PATH = OpenHAB.getConfigFolder() + File.separator + "misc"
 132             + File.separator + BINDING_ID;
 133     public static final String BINDING_USERDATA_PATH = OpenHAB.getUserDataFolder() + File.separator
 134             + MiIoBindingConstants.BINDING_ID;
 135
 136     public static final String I18N_THING_PREFIX = "thing.";
 137     public static final String I18N_CHANNEL_PREFIX = "ch.";
 138     public static final String I18N_OPTION_PREFIX = "option.";
 139 }