com.sitewhere.spi.device

Interface IDevice

All Superinterfaces:

IMetadataProvider, IMetadataProviderEntity, ISiteWhereEntity

All Known Implementing Classes:

Device

public interface IDevice
extends IMetadataProviderEntity

Interface for a SiteWhere device.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAssignmentToken() Get the current device assignment token if assigned.
java.lang.String	getComments() Get device comments.
java.util.List<IDeviceElementMapping>	getDeviceElementMappings() Gets mappings of IDeviceElementSchema paths to hardware ids for nested devices.
java.lang.String	getHardwareId() Get the unique hardware id of the device.
java.lang.String	getParentHardwareId() If contained by a parent device, returns the parent hardware id.
java.lang.String	getSiteToken() Get token for associated site.
java.lang.String	getSpecificationToken() Get token for device specification.
DeviceStatus	getStatus() Get most recent device status.

Methods inherited from interface com.sitewhere.spi.common.IMetadataProvider

addOrReplaceMetadata, clearMetadata, getMetadata, getMetadata, removeMetadata

Methods inherited from interface com.sitewhere.spi.common.ISiteWhereEntity

getCreatedBy, getCreatedDate, getUpdatedBy, getUpdatedDate, isDeleted

Method Detail

getHardwareId

java.lang.String getHardwareId()

Get the unique hardware id of the device.

Returns:

getSiteToken

java.lang.String getSiteToken()

Get token for associated site.

Returns:

getSpecificationToken

java.lang.String getSpecificationToken()

Get token for device specification.

Returns:

getParentHardwareId

java.lang.String getParentHardwareId()

If contained by a parent device, returns the parent hardware id.

Returns:

getDeviceElementMappings

java.util.List<IDeviceElementMapping> getDeviceElementMappings()

Gets mappings of IDeviceElementSchema paths to hardware ids for nested devices.

Returns:

getComments

java.lang.String getComments()

Get device comments.

Returns:

getStatus

DeviceStatus getStatus()

Get most recent device status.

Returns:

getAssignmentToken

java.lang.String getAssignmentToken()

Get the current device assignment token if assigned.

Returns: