Package org.osgi.service.dal.functions

Interface Types

public interface Types
Shares common constants for all functions defined in this package. The defined function types are mapped as follow: The mapping is not mandatory. The function can use custom defined types.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    COLD
    The function type is applicable to: Meter - indicates that the Meter measures thermal energy provided by a source. This type can be specified as a value of Function.SERVICE_TYPE.
    static final String
    CONTACT
    The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect contact.
    static final String
    DOOR
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the door position.
    static final String
    FIRE
    The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect fire.
    static final String
    FLOW
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the flow level.
    static final String
    GAS
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the gas level.
    static final String
    HEAT
    The function type is applicable to: Meter - indicates that the Meter measures thermal energy provided by a source. This type can be specified as a value of Function.SERVICE_TYPE.
    static final String
    HUMIDITY
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the humidity level.
    static final String
    LIGHT
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control light devices.
    static final String
    LIQUID
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the liquid level.
    static final String
    MOTION
    The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect motion.
    static final String
    NOISINESS
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the noise level.
    static final String
    OCCUPANCY
    The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect presence.
    static final String
    POWER
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the power level.
    static final String
    PRESSURE
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the pressure level.
    static final String
    RAIN
    The function type is applicable to: MultiLevelSensor - indicates that the MultiLevelSensor can monitor the rain rate.
    static final String
    SMOKE
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the smoke level.
    static final String
    TEMPERATURE
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control temperature devices.
    static final String
    WATER
    The function type is applicable to: BooleanSensor - indicates that the BooleanSensor can detect water leak.
    static final String
    WINDOW
    The function type is applicable to: MultiLevelControl - indicates that the MultiLevelControl can control the window position.

  • Field Details

    • LIGHT

      static final String LIGHT
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control light devices. Usually, such devices are called dimmable. MultiLevelControl minimum value can switch off the device and MultiLevelControl maximum value can increase the device light to the maximum possible value.
      • MultiLevelSensor - indicates that the sensor can monitor the light level.
      • BooleanSensor - indicates that the BooleanSensor can detected light. true state means that there is light. false state means that there is no light.
      • BooleanControl - indicates that there is a light device control. true state means that the light device will be turned on. false state means that the light device will be turned off.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • TEMPERATURE

      static final String TEMPERATURE
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control temperature devices. For example, such device can be thermostat. MultiLevelControl minimum value is the lowest supported temperature. MultiLevelControl maximum value is the highest supported temperature.
      • MultiLevelSensor - indicates that the sensor can monitor the temperature.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • FLOW

      static final String FLOW
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the flow level. MultiLevelControl minimum value is the minimum supported flow level. MultiLevelControl maximum value is the maximum supported flow level.
      • MultiLevelSensor - indicates that the sensor can monitor the flow level.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • PRESSURE

      static final String PRESSURE
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the pressure level. MultiLevelControl minimum value is the lowest supported pressure level. MultiLevelControl maximum value is the highest supported pressure level.
      • MultiLevelSensor - indicates that the sensor can monitor the pressure level.
      • Meter - Indicates that the Meter measures pressure.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • HUMIDITY

      static final String HUMIDITY
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the humidity level. It's typical functionality for HVAC (heating, ventilation, and air conditioning) devices. MultiLevelControl minimum value is the lowest supported humidity level. MultiLevelControl maximum value is the highest supported humidity level.
      • MultiLevelSensor - indicates that the sensor can monitor the humidity level.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • GAS

      static final String GAS
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the gas level. MultiLevelControl minimum value is the lowest supported gas level. MultiLevelControl maximum value is the highest supported gas level.
      • MultiLevelSensor - indicates that the sensor can monitor the gas level.
      • BooleanSensor - indicates that the BooleanSensor supports gas detection. true state means there is gas. false state means that there is no gas.
      • Meter - indicates that the Meter measures the gas consumption.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • SMOKE

      static final String SMOKE
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the smoke level. MultiLevelControl minimum value is the lowest supported smoke level. MultiLevelControl maximum value is the highest supported smoke level.
      • MultiLevelSensor - indicates that the sensor can monitor the smoke level.
      • BooleanSensor - indicates that the BooleanSensor can detect smoke. true state means that there is smoke. false state means that there is no smoke.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • DOOR

      static final String DOOR
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the door position. MultiLevelControl minimum value can completely close the door. MultiLevelControl maximum value can open the door to the maximum allowed position.
      • MultiLevelSensor - indicates that the sensor can monitor the door position.
      • BooleanSensor - indicates that the BooleanSensor can detect the door state. true state means that the door is opened. false state means that the door is closed.
      • BooleanControl - indicates that there is a door position control. true state means that the door will be opened. false state means that the door will be closed.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • WINDOW

      static final String WINDOW
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the window position. MultiLevelControl minimum value can completely close the window. MultiLevelControl maximum value can open the window to the maximum allowed position.
      • MultiLevelSensor - indicates that the sensor can monitor the window position.
      • BooleanSensor - indicates that the BooleanSensor can window state. true state means that the window is opened. false state means that the window is closed.
      • BooleanControl - indicates that there is a window position control. true state means that the window will be opened. false state means that the window will be closed.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • LIQUID

      static final String LIQUID
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the liquid level. MultiLevelControl minimum value is the lowest supported liquid level. MultiLevelControl maximum value is the highest supported liquid level.
      • MultiLevelSensor - indicates that the sensor can monitor the liquid level.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • POWER

      static final String POWER
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the power level. MultiLevelControl minimum value is the lowest supported power level. MultiLevelControl maximum value is the highest supported power level.
      • MultiLevelSensor - indicates that the sensor can monitor the power level.
      • BooleanSensor - indicates that the BooleanSensor can detect power/no power. true state means that there is power. false state means that there is no power.
      • BooleanControl - indicates that there is electricity control. true state means that the power will be restored. false state means that the power will be cut.
      • Meter - indicates that the Meter measures the power consumption.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • NOISINESS

      static final String NOISINESS
      The function type is applicable to:
      • MultiLevelControl - indicates that the MultiLevelControl can control the noise level. MultiLevelControl minimum value is the lowest supported noise level. MultiLevelControl maximum value is the highest supported noise level.
      • MultiLevelSensor - indicates that the sensor can monitor the noise level.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • RAIN

      static final String RAIN
      The function type is applicable to:
      • MultiLevelSensor - indicates that the MultiLevelSensor can monitor the rain rate. It's not applicable to MultiLevelControl.
      • BooleanSensor - indicates that the BooleanSensor can detect rain. true state means that there is rain. false state means that there is no rain.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • CONTACT

      static final String CONTACT
      The function type is applicable to:
      • BooleanSensor - indicates that the BooleanSensor can detect contact. true state means that there is contact. false state means that there is no contact.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • FIRE

      static final String FIRE
      The function type is applicable to:
      • BooleanSensor - indicates that the BooleanSensor can detect fire. true state means that there is fire. false state means that there is no fire.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • OCCUPANCY

      static final String OCCUPANCY
      The function type is applicable to:
      • BooleanSensor - indicates that the BooleanSensor can detect presence. true state means that someone is detected. false state means that nobody is detected.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • WATER

      static final String WATER
      The function type is applicable to:
      • BooleanSensor - indicates that the BooleanSensor can detect water leak. true state means that there is water leak. false state means that there is no water leak.
      • Meter - indicates that the Meter measures water consumption.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • MOTION

      static final String MOTION
      The function type is applicable to:
      • BooleanSensor - indicates that the BooleanSensor can detect motion. true state means that there is motion detection. false state means that there is no motion detection.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • HEAT

      static final String HEAT
      The function type is applicable to:
      • Meter - indicates that the Meter measures thermal energy provided by a source.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also:

    • COLD

      static final String COLD
      The function type is applicable to:
      • Meter - indicates that the Meter measures thermal energy provided by a source.
      This type can be specified as a value of Function.SERVICE_TYPE.
      See Also: