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

   1 /**
   2  * Copyright (c) 2010-2021 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.systeminfo.internal;
  14
  15 import org.eclipse.jdt.annotation.NonNullByDefault;
  16 import org.openhab.core.thing.ThingTypeUID;
  17
  18 /**
  19  * The {@link SysteminfoBindingConstants} class defines common constants, which are
  20  * used across the whole binding.
  21  *
  22  * @author Svilen Valkanov - Initial contribution
  23  */
  24 @NonNullByDefault
  25 public class SysteminfoBindingConstants {
  26
  27     public static final String BINDING_ID = "systeminfo";
  28
  29     public static final ThingTypeUID THING_TYPE_COMPUTER = new ThingTypeUID(BINDING_ID, "computer");
  30
  31     // Thing properties
  32     /**
  33      * Number of CPU logical cores
  34      */
  35     public static final String PROPERTY_CPU_LOGICAL_CORES = "CPU Logical Cores";
  36
  37     /**
  38      * Number of CPU physical cores
  39      */
  40     public static final String PROPERTY_CPU_PHYSICAL_CORES = "CPU Physical Cores";
  41
  42     /**
  43      * Contains information about the family /Windows, Linux, OS X etc/ of the operation system
  44      */
  45     public static final String PROPERTY_OS_FAMILY = "OS Family";
  46
  47     /**
  48      * Name of the manufacturer of the operation system
  49      */
  50     public static final String PROPERTY_OS_MANUFACTURER = "OS Manufacturer";
  51
  52     /**
  53      * Version of the operation system
  54      */
  55     public static final String PROPERTY_OS_VERSION = "OS Version";
  56
  57     // List of all Channel IDs
  58
  59     /**
  60      * Size of the available memory
  61      */
  62     public static final String CHANNEL_MEMORY_AVAILABLE = "memory#available";
  63
  64     /**
  65      * Size of the used memory
  66      */
  67     public static final String CHANNEL_MEMORY_USED = "memory#used";
  68
  69     /**
  70      * Total size of the memory
  71      */
  72     public static final String CHANNEL_MEMORY_TOTAL = "memory#total";
  73
  74     /**
  75      * Percents of the available memory
  76      */
  77     public static final String CHANNEL_MEMORY_AVAILABLE_PERCENT = "memory#availablePercent";
  78
  79     /**
  80      * Percents of the used memory
  81      */
  82     public static final String CHANNEL_MEMORY_USED_PERCENT = "memory#usedPercent";
  83
  84     /**
  85      * Percents of the used heap
  86      */
  87     public static final String CHANNEL_MEMORY_USED_HEAP_PERCENT = "memory#usedHeapPercent";
  88
  89     /**
  90      * Bytes used in the heap
  91      */
  92     public static final String CHANNEL_MEMORY_HEAP_AVAILABLE = "memory#availableHeap";
  93
  94     /**
  95      * Total size of swap memory
  96      */
  97     public static final String CHANNEL_SWAP_TOTAL = "swap#total";
  98
  99     /**
 100      * Size of the available swap memory
 101      */
 102     public static final String CHANNEL_SWAP_AVAILABLE = "swap#available";
 103
 104     /**
 105      * Size of the used swap memory
 106      */
 107     public static final String CHANNEL_SWAP_USED = "swap#used";
 108
 109     /**
 110      * Percents of the available swap memory
 111      */
 112     public static final String CHANNEL_SWAP_AVAILABLE_PERCENT = "swap#availablePercent";
 113
 114     /**
 115      * Percents of the used swap memory
 116      */
 117     public static final String CHANNEL_SWAP_USED_PERCENT = "swap#usedPercent";
 118
 119     /**
 120      * Physical storage drive name
 121      */
 122     public static final String CHANNEL_DRIVE_NAME = "drive#name";
 123
 124     /**
 125      * Physical storage drive model
 126      */
 127     public static final String CHANNEL_DRIVE_MODEL = "drive#model";
 128
 129     /**
 130      * Physical storage drive serial number
 131      */
 132     public static final String CHANNEL_DRIVE_SERIAL = "drive#serial";
 133
 134     /**
 135      * Name of the logical volume storage
 136      */
 137     public static final String CHANNEL_STORAGE_NAME = "storage#name";
 138
 139     /**
 140      * Logical storage volume type -(e.g. NTFS, FAT32 ..)
 141      */
 142     public static final String CHANNEL_STORAGE_TYPE = "storage#type";
 143
 144     /**
 145      * Description of the logical volume storage
 146      */
 147     public static final String CHANNEL_STORAGE_DESCRIPTION = "storage#description";
 148
 149     /**
 150      * Size of the available storage space
 151      */
 152     public static final String CHANNEL_STORAGE_AVAILABLE = "storage#available";
 153
 154     /**
 155      * Size of the used storage space
 156      */
 157     public static final String CHANNEL_STORAGE_USED = "storage#used";
 158
 159     /**
 160      * Total storage space
 161      */
 162     public static final String CHANNEL_STORAGE_TOTAL = "storage#total";
 163
 164     /**
 165      * Percents of the available storage space
 166      */
 167     public static final String CHANNEL_STORAGE_AVAILABLE_PERCENT = "storage#availablePercent";
 168
 169     /**
 170      * Percents of the used storage space
 171      */
 172     public static final String CHANNEL_STORAGE_USED_PERCENT = "storage#usedPercent";
 173
 174     /**
 175      * Temperature of the CPU measured from the sensors.
 176      */
 177     public static final String CHANNEL_SENSORS_CPU_TEMPERATURE = "sensors#cpuTemp";
 178
 179     /**
 180      * Voltage of the CPU core.
 181      */
 182     public static final String CHANNEL_SENOSRS_CPU_VOLTAGE = "sensors#cpuVoltage";
 183
 184     /**
 185      * Fan speed
 186      */
 187     public static final String CHANNEL_SENSORS_FAN_SPEED = "sensors#fanSpeed";
 188
 189     /**
 190      * Name of the battery
 191      */
 192     public static final String CHANNEL_BATTERY_NAME = "battery#name";
 193
 194     /**
 195      * Remaining capacity of the battery.
 196      */
 197     public static final String CHANNEL_BATTERY_REMAINING_CAPACITY = "battery#remainingCapacity";
 198
 199     /**
 200      * Estimated remaining time of the battery
 201      */
 202     public static final String CHANNEL_BATTERY_REMAINING_TIME = "battery#remainingTime";
 203
 204     /**
 205      * Detailed description about the CPU
 206      */
 207     public static final String CHANNEL_CPU_DESCRIPTION = "cpu#description";
 208
 209     /**
 210      * Average recent CPU load
 211      */
 212     public static final String CHANNEL_CPU_LOAD = "cpu#load";
 213
 214     /**
 215      * Average CPU load for the last minute
 216      */
 217     public static final String CHANNEL_CPU_LOAD_1 = "cpu#load1";
 218
 219     /**
 220      * Average CPU load for the last 5 minutes
 221      */
 222     public static final String CHANNEL_CPU_LOAD_5 = "cpu#load5";
 223
 224     /**
 225      * Average CPU load for the last 15 minutes
 226      */
 227     public static final String CHANNEL_CPU_LOAD_15 = "cpu#load15";
 228
 229     /**
 230      * CPU name
 231      */
 232     public static final String CHANNEL_CPU_NAME = "cpu#name";
 233
 234     /**
 235      * CPU uptime in minutes
 236      */
 237     public static final String CHANNEL_CPU_UPTIME = "cpu#uptime";
 238
 239     /**
 240      * CPU running threads count
 241      */
 242     public static final String CHANNEL_CPU_THREADS = "cpu#threads";
 243
 244     /**
 245      * Information about the display device
 246      */
 247     public static final String CHANNEL_DISPLAY_INFORMATION = "display#information";
 248
 249     /**
 250      * Host IP address of the network
 251      */
 252     public static final String CHANNEL_NETWORK_IP = "network#ip";
 253
 254     /**
 255      * Network display name
 256      */
 257     public static final String CHANNEL_NETWORK_ADAPTER_NAME = "network#networkName";
 258
 259     /**
 260      * Network data sent
 261      */
 262     public static final String CHANNEL_NETWORK_DATA_SENT = "network#dataSent";
 263
 264     /**
 265      * Network data received
 266      */
 267     public static final String CHANNEL_NETWORK_DATA_RECEIVED = "network#dataReceived";
 268
 269     /**
 270      * Network packets sent
 271      */
 272     public static final String CHANNEL_NETWORK_PACKETS_SENT = "network#packetsSent";
 273
 274     /**
 275      * Network packets received
 276      */
 277     public static final String CHANNEL_NETWORK_PACKETS_RECEIVED = "network#packetsReceived";
 278
 279     /**
 280      * Network name
 281      */
 282     public static final String CHANNEL_NETWORK_NAME = "network#networkDisplayName";
 283
 284     /**
 285      * Network mac address
 286      */
 287     public static final String CHANNEL_NETWORK_MAC = "network#mac";
 288
 289     /**
 290      * Name of the channel group for process information
 291      */
 292     public static final String CHANNEL_GROUP_PROCESS = "process";
 293
 294     /**
 295      * CPU load used from a process
 296      */
 297
 298     public static final String CHANNEL_PROCESS_LOAD = "process#load";
 299
 300     /**
 301      * Size of memory used from a process in MB
 302      */
 303     public static final String CHANNEL_PROCESS_MEMORY = "process#used";
 304
 305     /**
 306      * Name of the process
 307      */
 308     public static final String CHANNEL_PROCESS_NAME = "process#name";
 309
 310     /**
 311      * Number of threads, used form the process
 312      */
 313     public static final String CHANNEL_PROCESS_THREADS = "process#threads";
 314
 315     /**
 316      * The full path of the process
 317      */
 318     public static final String CHANNEL_PROCESS_PATH = "process#path";
 319
 320     // Thing configuraion
 321     /**
 322      * Name of the configuration parameter of the thing that defines refresh time for High priority channels
 323      */
 324     public static final String HIGH_PRIORITY_REFRESH_TIME = "interval_high";
 325
 326     /**
 327      * Name of the configuration parameter of the thing that defines refresh time for Medium priority channels
 328      */
 329     public static final String MEDIUM_PRIORITY_REFRESH_TIME = "interval_medium";
 330
 331     // Channel configuration
 332
 333     /**
 334      * Name of the channel configuration parameter priority
 335      */
 336     public static final String PRIOIRITY_PARAM = "priority";
 337
 338     /**
 339      * Name of the channel configuration parameter pid
 340      *
 341      */
 342     public static final String PID_PARAM = "pid";
 343 }