Package org.openmuc.eebus.spine.api
Interface Device
-
- All Superinterfaces:
EntityParent
public interface Device extends EntityParent
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description void
deviceDetected(java.lang.String address)
Starts the detailed discovery process if enabledorg.eebus.docs.spine.xsd.v1.DeviceAddressType
getAddress()
static DeviceBuilder
getBuilder()
org.eebus.docs.spine.xsd.v1.NetworkManagementFeatureSetType
getCommunicationMode()
ConnectionHandler
getConnectionHandler()
java.lang.String
getDescription()
Feature
getFeature(org.eebus.docs.spine.xsd.v1.FeatureAddressType featureAddress)
Returns the feature with the address given or throws a SpineException if the requested feature does not exist.java.lang.String
getLabel()
NodeManagement
getNodeManagement()
Returns the node management feature instance associated to this device.org.eebus.docs.spine.xsd.v1.SpecificationVersionDataType
getSpecificationVersion()
org.eebus.docs.spine.xsd.v1.DeviceTypeEnumType
getType()
boolean
hasDescription()
boolean
hasLabel()
void
parseDatagram(org.eebus.docs.spine.xsd.v1.DatagramType datagram)
Forwards the given datagram to the receiving feature for processing-
Methods inherited from interface org.openmuc.eebus.spine.api.EntityParent
addEntity, deleteEntity, getDevice, getEntities, getEntity, getParent, isDevice
-
-
-
-
Method Detail
-
getBuilder
static DeviceBuilder getBuilder()
- Returns:
- a new
DeviceBuilder
object to create a new SPINE device
-
getNodeManagement
NodeManagement getNodeManagement()
Returns the node management feature instance associated to this device.- Returns:
- the node management feature instance
-
getConnectionHandler
ConnectionHandler getConnectionHandler()
- Returns:
- the connection handler instance
-
getAddress
org.eebus.docs.spine.xsd.v1.DeviceAddressType getAddress()
- Returns:
- the device address
-
deviceDetected
void deviceDetected(java.lang.String address)
Starts the detailed discovery process if enabled- Parameters:
address
- The address on which the new device was detected
-
parseDatagram
void parseDatagram(org.eebus.docs.spine.xsd.v1.DatagramType datagram)
Forwards the given datagram to the receiving feature for processing- Parameters:
datagram
- filled SPINE datagram
-
getSpecificationVersion
org.eebus.docs.spine.xsd.v1.SpecificationVersionDataType getSpecificationVersion()
- Returns:
- the latest SPINE specification version this device supports
-
getType
org.eebus.docs.spine.xsd.v1.DeviceTypeEnumType getType()
- Returns:
- the type of this device
-
hasDescription
boolean hasDescription()
- Returns:
- true if this device has a description set and false otherwise
-
hasLabel
boolean hasLabel()
- Returns:
- true if this device has a label set and false otherwise
-
getFeature
Feature getFeature(org.eebus.docs.spine.xsd.v1.FeatureAddressType featureAddress) throws SpineException
Returns the feature with the address given or throws a SpineException if the requested feature does not exist.- Parameters:
featureAddress
- the address of the requested feature including the entity address parts- Returns:
- the feature with the given address
- Throws:
SpineException
- when no feature at the given address exists
-
getLabel
java.lang.String getLabel()
- Returns:
- the label set or the empty string if no label was set
-
getDescription
java.lang.String getDescription()
- Returns:
- the description set or the empty string if no label was set
-
getCommunicationMode
org.eebus.docs.spine.xsd.v1.NetworkManagementFeatureSetType getCommunicationMode()
- Returns:
- the communication mode this device supports (every value other than SIMPLE means enhanced communication mode)
-
-