com.whizzosoftware.hobson.api.variable

Class VariableConstants

java.lang.Object

com.whizzosoftware.hobson.api.variable.VariableConstants

public class VariableConstants
extends java.lang.Object

A class the defines static constants for common device variable names.

Author:

Dan Noguerol

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	APPARENT_POWER_VA Indicates apparent power in volt-amperes.
static java.lang.String	ARMED Indicates whether the device is armed (e.g.
static java.lang.String	BAROMETRIC_PRESSURE_INHG Indicates barometric pressure in inches of mercury.
static java.lang.String	BATTERY Indicates current battery level (0-100 representing a percent).
static java.lang.String	CO2_PPM Indicates carbon dioxide in parts per million.
static java.lang.String	COLOR Indicates a color (e.g.
static java.lang.String	DEW_PT_C Indicates dew point in degrees Celsius.
static java.lang.String	DEW_PT_F Indicates dew point in degrees Fahrenheit.
static java.lang.String	DIFFERENTIAL_PRESSURE_PSI Indicates differential pressure in pounds per square inch.
static java.lang.String	ENERGY_CONSUMPTION_KWH Indicates energy consumption in watts.
static java.lang.String	ENERGY_CONSUMPTION_WATTS Indicates energy consumption in watts.
static java.lang.String	FIRMWARE_VERSION Indicates the firmware version of a device.
static java.lang.String	IMAGE_STATUS_URL Indicates a URL for an image.
static java.lang.String	INDOOR_RELATIVE_HUMIDITY Indicates an indoor relative humidity.
static java.lang.String	INDOOR_TEMP_C Indicates an indoor temperature in degrees Celsius.
static java.lang.String	INDOOR_TEMP_F Indicates an indoor temperature in degrees Fahrenheit.
static java.lang.String	LEVEL Indicates the current device level (e.g.
static java.lang.String	LX_LUX Indicates a light intensity in lux.
static java.lang.String	ON Indicates whether a device is on/off.
static java.lang.String	OUTDOOR_RELATIVE_HUMIDITY Indicates an outdoor relative humidity.
static java.lang.String	OUTDOOR_TEMP_C Indicates an outdoor temperature in degrees Celsius.
static java.lang.String	OUTDOOR_TEMP_F Indicates an outdoor temperature in degrees Fahrenheit.
static java.lang.String	POWER_FACTOR Indicates power factor (a dimensionless unit from -1..1).
static java.lang.String	REACTIVE_POWER_VAR Indicates reactive power in volt-amperes reactive.
static java.lang.String	RELATIVE_HUMIDITY Indicates relative humidity.
static java.lang.String	TARGET_COOL_TEMP_C Indicates a target cooling temperature in degrees Celsius.
static java.lang.String	TARGET_COOL_TEMP_F Indicates a target cooling temperature in degrees Fahrenheit.
static java.lang.String	TARGET_HEAT_TEMP_C Indicates a target heating temperature in degrees Celsius.
static java.lang.String	TARGET_HEAT_TEMP_F Indicates a target heating temperature in degrees Fahrenheit.
static java.lang.String	TARGET_TEMP_C Indicates a target temperature in degrees Celsius (e.g.
static java.lang.String	TARGET_TEMP_F Indicates a target temperature in degrees Fahrenheit (e.g.
static java.lang.String	TEMP_C Indicates a temperature in degrees Celsius.
static java.lang.String	TEMP_F Indicates a temperature in degrees Fahrenheit.
static java.lang.String	TIME Indicates the time a device is reporting.
static java.lang.String	TSTAT_FAN_MODE Indicates the current thermostat fan mode (e.g.
static java.lang.String	TSTAT_MODE Indicates the current thermostat mode (e.g.
static java.lang.String	VIDEO_STATUS_URL Indicates the URL of a video stream (e.g.
static java.lang.String	WIND_DIRECTION_DEGREES Indicates the wind direction in degrees (0-360).
static java.lang.String	WIND_GUST_KMH Indicates the wind speed in kilometers per hour.
static java.lang.String	WIND_GUST_MPH Indicates the wind speed in miles per hour.
static java.lang.String	WIND_SPEED_KMH Indicates the wind speed in kilometers per hour.
static java.lang.String	WIND_SPEED_MPH Indicates the wind speed in miles per hour.

Constructor Summary

Constructors

Constructor and Description
VariableConstants()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

APPARENT_POWER_VA

public static final java.lang.String APPARENT_POWER_VA

Indicates apparent power in volt-amperes.

See Also:

Constant Field Values

ARMED

public static final java.lang.String ARMED

Indicates whether the device is armed (e.g. security panels).

See Also:

Constant Field Values

BAROMETRIC_PRESSURE_INHG

public static final java.lang.String BAROMETRIC_PRESSURE_INHG

Indicates barometric pressure in inches of mercury.

See Also:

Constant Field Values

BATTERY

public static final java.lang.String BATTERY

Indicates current battery level (0-100 representing a percent).

See Also:

Constant Field Values

CO2_PPM

public static final java.lang.String CO2_PPM

Indicates carbon dioxide in parts per million.

See Also:

Constant Field Values

COLOR

public static final java.lang.String COLOR

Indicates a color (e.g. a color LED bulb).

See Also:

Constant Field Values

DEW_PT_C

public static final java.lang.String DEW_PT_C

Indicates dew point in degrees Celsius.

See Also:

Constant Field Values

DEW_PT_F

public static final java.lang.String DEW_PT_F

Indicates dew point in degrees Fahrenheit.

See Also:

Constant Field Values

DIFFERENTIAL_PRESSURE_PSI

public static final java.lang.String DIFFERENTIAL_PRESSURE_PSI

Indicates differential pressure in pounds per square inch.

See Also:

Constant Field Values

ENERGY_CONSUMPTION_WATTS

public static final java.lang.String ENERGY_CONSUMPTION_WATTS

Indicates energy consumption in watts.

See Also:

Constant Field Values

ENERGY_CONSUMPTION_KWH

public static final java.lang.String ENERGY_CONSUMPTION_KWH

Indicates energy consumption in watts.

See Also:

Constant Field Values

FIRMWARE_VERSION

public static final java.lang.String FIRMWARE_VERSION

Indicates the firmware version of a device.

See Also:

Constant Field Values

INDOOR_RELATIVE_HUMIDITY

public static final java.lang.String INDOOR_RELATIVE_HUMIDITY

Indicates an indoor relative humidity.

See Also:

Constant Field Values

INDOOR_TEMP_C

public static final java.lang.String INDOOR_TEMP_C

Indicates an indoor temperature in degrees Celsius.

See Also:

Constant Field Values

INDOOR_TEMP_F

public static final java.lang.String INDOOR_TEMP_F

Indicates an indoor temperature in degrees Fahrenheit.

See Also:

Constant Field Values

IMAGE_STATUS_URL

public static final java.lang.String IMAGE_STATUS_URL

Indicates a URL for an image.

See Also:

Constant Field Values

LEVEL

public static final java.lang.String LEVEL

Indicates the current device level (e.g. a dimmer switch).

See Also:

Constant Field Values

LX_LUX

public static final java.lang.String LX_LUX

Indicates a light intensity in lux.

See Also:

Constant Field Values

OUTDOOR_RELATIVE_HUMIDITY

public static final java.lang.String OUTDOOR_RELATIVE_HUMIDITY

Indicates an outdoor relative humidity.

See Also:

Constant Field Values

OUTDOOR_TEMP_C

public static final java.lang.String OUTDOOR_TEMP_C

Indicates an outdoor temperature in degrees Celsius.

See Also:

Constant Field Values

OUTDOOR_TEMP_F

public static final java.lang.String OUTDOOR_TEMP_F

Indicates an outdoor temperature in degrees Fahrenheit.

See Also:

Constant Field Values

ON

public static final java.lang.String ON

Indicates whether a device is on/off.

See Also:

Constant Field Values

POWER_FACTOR

public static final java.lang.String POWER_FACTOR

Indicates power factor (a dimensionless unit from -1..1).

See Also:

Constant Field Values

REACTIVE_POWER_VAR

public static final java.lang.String REACTIVE_POWER_VAR

Indicates reactive power in volt-amperes reactive.

See Also:

Constant Field Values

RELATIVE_HUMIDITY

public static final java.lang.String RELATIVE_HUMIDITY

Indicates relative humidity.

See Also:

Constant Field Values

TARGET_TEMP_C

public static final java.lang.String TARGET_TEMP_C

Indicates a target temperature in degrees Celsius (e.g. a thermostat).

See Also:

Constant Field Values

TARGET_TEMP_F

public static final java.lang.String TARGET_TEMP_F

Indicates a target temperature in degrees Fahrenheit (e.g. a thermostat).

See Also:

Constant Field Values

TARGET_HEAT_TEMP_C

public static final java.lang.String TARGET_HEAT_TEMP_C

Indicates a target heating temperature in degrees Celsius.

See Also:

Constant Field Values

TARGET_HEAT_TEMP_F

public static final java.lang.String TARGET_HEAT_TEMP_F

Indicates a target heating temperature in degrees Fahrenheit.

See Also:

Constant Field Values

TARGET_COOL_TEMP_C

public static final java.lang.String TARGET_COOL_TEMP_C

Indicates a target cooling temperature in degrees Celsius.

See Also:

Constant Field Values

TARGET_COOL_TEMP_F

public static final java.lang.String TARGET_COOL_TEMP_F

Indicates a target cooling temperature in degrees Fahrenheit.

See Also:

Constant Field Values

TEMP_F

public static final java.lang.String TEMP_F

Indicates a temperature in degrees Fahrenheit.

See Also:

Constant Field Values

TEMP_C

public static final java.lang.String TEMP_C

Indicates a temperature in degrees Celsius.

See Also:

Constant Field Values

TIME

public static final java.lang.String TIME

Indicates the time a device is reporting.

See Also:

Constant Field Values

TSTAT_FAN_MODE

public static final java.lang.String TSTAT_FAN_MODE

Indicates the current thermostat fan mode (e.g. on, off or auto).

See Also:

Constant Field Values

TSTAT_MODE

public static final java.lang.String TSTAT_MODE

Indicates the current thermostat mode (e.g. heat or cool).

See Also:

Constant Field Values

VIDEO_STATUS_URL

public static final java.lang.String VIDEO_STATUS_URL

Indicates the URL of a video stream (e.g. a camera).

See Also:

Constant Field Values

WIND_DIRECTION_DEGREES

public static final java.lang.String WIND_DIRECTION_DEGREES

Indicates the wind direction in degrees (0-360).

See Also:

Constant Field Values

WIND_GUST_MPH

public static final java.lang.String WIND_GUST_MPH

Indicates the wind speed in miles per hour.

See Also:

Constant Field Values

WIND_GUST_KMH

public static final java.lang.String WIND_GUST_KMH

Indicates the wind speed in kilometers per hour.

See Also:

Constant Field Values

WIND_SPEED_MPH

public static final java.lang.String WIND_SPEED_MPH

Indicates the wind speed in miles per hour.

See Also:

Constant Field Values

WIND_SPEED_KMH

public static final java.lang.String WIND_SPEED_KMH

Indicates the wind speed in kilometers per hour.

See Also:

Constant Field Values

Constructor Detail

VariableConstants

public VariableConstants()