EEBUS HDM Device Class Mapping

The EEBUS Spine Protocol Adapter API exports device class interfaces in three packages:

Standard Device Classes
SmartEnergy Device Classes
WhiteGoods Device Classes

Third parties can provide support for new EEBUS SPINE features and new device classes via the pluggable model for DeviceClassObject providers.

The EEBUS SPINE adapter implementation provides default implementation for the following Standard, SmartEnergy and WhiteGoods device classes:

Class Type	Classes Package	Classes
Standard Device Classes	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Bill com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.DeviceConfiguration com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.DeviceDiagnosis com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.ElectricalConnection com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.ElectricalConnections com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Identification com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.IncentiveTable com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.LoadControlLimit com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.LoadControlLimits com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Measurement com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Measurements com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.TimeSeries
SmartEnergy Device Classes	com.prosyst.mbs.services.spine.hdm.deviceclasses.smartenergy	com.prosyst.mbs.services.spine.hdm.deviceclasses.smartenergy.SmartEnergyManagementPs
WhiteGoods Device Classes	com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods	com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.Dishwasher com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.TumbleDryer com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.WashingMachine com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.ProgrammableAppliance com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.WhiteGoodAppliance com.prosyst.mbs.services.spine.hdm.deviceclasses.whitegoods.StartStopActuator

EEBUS Features Mapping

The protocol driver com.prosyst.mbs.services.spine.SPINEFeature instances are mapped to DeviceClassObject implementations by SPINE feature type.
The possible feature types are listed as values in the enum com.prosyst.mbs.services.spine.types.enums.FeatureTypeEnumType.
Each individual feature type holds a set of supported SPINE feature functions used for communication.
All supported features are contained in the enum com.prosyst.mbs.services.spine.types.enums.FunctionTypeEnumType.

The following table represents the mapping between the SPINE feature type, their related functions and the device classes, if any presented.

SPINE Feature Type	SPINE Function Type --> Device Class Property/Operation	Device Class
Bill	billListData -> PROPERTY_DATA billConstraintsListData -> PROPERTY_CONSTRAINTS billDescriptionListData -> PROPERTY_DESCRIPTION	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Bill
DeviceConfiguration	deviceConfigurationKeyValueListData -> PROPERTY_KEY_VALUES deviceConfigurationKeyValueDescriptionListData -> PROPERTY_KEY_VALUE_DESCRIPTIONS	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.DeviceConfiguration
DeviceDiagnosis	deviceDiagnosisStateData -> PROPERTY_STATE deviceDiagnosisServiceData -> PROPERTY_SERVICE deviceDiagnosisHeartbeatData -> PROPERTY_HEARTBEAT	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.DeviceDiagnosis
ElectricalConnection	electricalConnectionStateListData -> PROPERTY_STATE electricalConnectionDescriptionListData -> PROPERTY_DESCRIPTION electricalConnectionParameterDescriptionListData -> PROPERTY_PARAMETER_DESCRIPTIONS	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.ElectricalConnection
Identification	identificationListData -> PROPERTY_DATA	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Indentification
IncentiveTable	incentiveTableData -> PROPERTY_DATA incentiveTableConstraintsData -> PROPERTY_CONSTRAINTS incentiveTableDescriptionData -> PROPERTY_DESCRIPTION	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.IncentiveTable
LoadControl	loadControlLimitListData -> PROPERTY_DATA loadControlLimitConstraintsListData -> PROPERTY_CONSTRAINTS loadControlLimitDescriptionListData -> PROPERTY_DESCRIPTION	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.LoadControlLimit
Measurement	measurementListData -> PROPERTY_DATA measurementConstraintsListData -> PROPERTY_CONSTRAINTS measurementDescriptionListData -> PROPERTY_DESCRIPTION	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Measurement
TimeSeries	timeSeriesListData -> PROPERTY_DATA timeSeriesConstraintsListData -> PROPERTY_CONSTRAINTS timeSeriesDescriptionListData -> PROPERTY_DESCRIPTION	com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.TimeSeries
SmartEnergyManagementPs	SmartEnergyManagementPsData -> set of multiple properties and operations in the mapped device class interface	com.prosyst.mbs.services.spine.hdm.deviceclasses.smartenergy.SmartEnergyManagementPs

Notes

The DeviceClassification feature if it is presented in the entities of the SPINE device and if it supports the DeviceClassificationManufacturerData function, then the manufacturer data is read and mapped as device properties of the corresponding HomeDeviceSpi object.
There are several standard device classes that aggregate in a collection of the same type of existing device class that represents a single feature:
- com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.ElectricalConnections
- com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.LoadControlLimits
- com.prosyst.mbs.services.spine.hdm.deviceclasses.standardclasses.Measurements
The DeviceClassObject providers are allowed to provide such features in both ways.