|
|
|
|
|
The General Attributes (com.prosyst.mbs.services.da.attributes.Attributes) are grouped into four groups.
The key of the first group of attributes must be Attributes.ATTRIBUTE_QUANTITY, which represents the quantity that the item uses. For example Sensor might be com.prosyst.mbs.services.units.quantity.Temperature. The value of this attribute must be a string that is equal to the fully qualified class name of the quantity. For example com.prosyst.mbs.services.units.quantity.Temperature.
The key of the second group of attributes must be Attributes.ATTRIBUTE_OPERATES, which represents the equipment operated by the item. The value of this attribute must be one of the following constants:
Attributes.OPERATES_LIGHTS – used when the operated equipment is lights.Attributes.OPERATES_BARRIER – used when the operated equipment is a barrier as in something that restricts access.Attributes.OPERATES_FAN – used when the operated equipment is a fan.Attributes.OPERATES_VALVE – used when the operated equipment is a valve.Attributes.OPERATES_WASHER – used when the operated equipment is a washer.Attributes.OPERATES_COFFEE_MAKER – used when the operated equipment is a coffee-maker.Attributes.OPERATES_DISHWASHER – used when the operated equipment is a dishwasher.Attributes.OPERATES_DRYER – used when the operated equipment is a dryer.Attributes.OPERATES_OVEN – used when the operated equipment is a oven.Attributes.OPERATES_FRIDGE_FREEZER – used when the operated equipment is a fridge-freezer.Attributes.OPERATES_FRIDGE – used when the operated equipment is a fridge.Attributes.OPERATES_FREEZER – used when the operated equipment is a freezer.Attributes.OPERATES_SUPER_MODE – used when the operated equipment is in super-mode.The key of the third group of attributes must be Attributes.ATTRIBUTE_CHARACTERISTIC, which define some property of the measured value. For example when it comes to Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Time there is not real medium to be measured but the value itself may represent different things like remaining time of a program or elapsed time of a timer. Another example might be a smart grid where the produced and consumed power are measured separately, with the need for the SensorAttributes.ATTRIBUTE_MEDIUM to clarify that the unit measures electricity and the value of this attribute shows whether it is produced/exported or consumed/imported. The value of this attribute must be one of the following constants:
Attributes.CHARACTERISTIC_PRODUCTION – indicates the measured value is internally produced or exported to the grid. For example the electricity that is produced by a rooftop photo-voltaic installation.Attributes.CHARACTERISTIC_CONSUMPTION – indicates the measured value is consumed from an external source. For example the electricity that is consumed from the grid.Attributes.CHARACTERISTIC_REMAINING – the value might be used in conjunction with Attributes.ATTRIBUTE_QUANTITY=com.prosyst.mbs.services.units.quantity.Time to indicate that the measured value is the remaining time of an operation.Attributes.CHARACTERISTIC_ATMOSPHERIC – indicates that the Device Item has something to do with atmosphere.Attributes.CHARACTERISTIC_BAROMETRIC – indicates that the Device Item has something to do with barometers.Attributes.CHARACTERISTIC_BODY – indicates that the Device Item has something to do with the human body. Used in medical devices like blood pressure monitor.Attributes.CHARACTERISTIC_BOILER – indicates that the Device Item has something to do with a boiler. For example a sensor that measures the water temperature in a boiler.Attributes.CHARACTERISTIC_DIASTOLIC – used to denote that the sensor measures the diastolic blood pressure.Attributes.CHARACTERISTIC_IMPEDANCE – used to denote that the sensor measures the impedance.Attributes.CHARACTERISTIC_METABOLIC_RATE – used with medical devices.Attributes.CHARACTERISTIC_RELATIVE – indicates that the Device Item measures or sets relative value.Attributes.CHARACTERISTIC_RESPIRATORY – used with medical devices.Attributes.CHARACTERISTIC_SOLAR – indicates that the Device Item represent something related to the sun.Attributes.CHARACTERISTIC_SYSTOLIC – used to denote that the sensor measures the systolic blood pressures.Attributes.CHARACTERISTIC_TARGETAttributes.CHARACTERISTIC_VOLUMETRIC – indicates that the measured value is volumetric.Attributes.CHARACTERISTIC_X_AXIS – denotes that the Sensor detects X axis changes or the Actuator controls X axis.Attributes.CHARACTERISTIC_Y_AXIS – denotes that the Sensor detects Y axis changes or the Actuator controls Y axis.Attributes.CHARACTERISTIC_Z_AXIS – denotes that the Sensor detects Z axis changes or the Actuator controls Z axis.Attributes.CHARACTERISTIC_WATER_ACTIVITY – example sensor that detects water activity.Attribtues.CHARACTERISTIC_DOMESTIC – used for Z- Wave sensor.Attributes.CHARACTERISTIC_ENERY_SAVE – indicates that a Setpoint is for energy saving mode.Attributes.CHARACTERISTIC_AWAY – indicates that a Setpoint is for away mode.Attributes.CHARACTERISTIC_ELAPSEDAttributes.CHARACTERISTIC_INTERNAL – indicates that a sensor in measuring internal property of the device.Attributes.CHARACTERISTIC_GAUGE – used in conjunction with com.prosyst.mbs.services.units.quantity.Pressure.Attributes.CHARACTERISTIC_ABSOLUTE – used in conjunction with com.prosyst.mbs.services.units.quantity.Pressure.Attributes.CHARACTERISTIC_DETECTIONAttributes.CHARACTERISTIC_CLEAR_DETECTIONThe key of the fourth group attributes must be Attributes.ATTRIBUTE_EQUIPMENT which represents the Device Item configures. The value can be one of the following constants:
Attributes.EQUIPMENT_HVAC – indicates that the configured equipment has heating, ventilation, and air condition function.Attributes.EQUIPMENT_VALVE – indicates that the configured equipment is some kind of valve or has function limiting the rate at which a substance passed through it.Attributes.EQUIPMENT_LIGHTS – indicates that the configured equipment has lighting functions. For example Setpoint might control the lighting level at some future point in time.Attributes.EQUIPMENT_DOOR – indicates that the configured equipment is a door.Attributes.EQUIPMENT_FRIDGE – indicates that the configured equipment is a fridge.Attributes.EQUIPMENT_FREEZER – indicates that the configured equipment is a freezer.