io.relayr.java.model.models

Class DeviceModel

java.lang.Object

io.relayr.java.model.models.DeviceModel

All Implemented Interfaces:

java.io.Serializable

public class DeviceModel
extends java.lang.Object
implements java.io.Serializable

Main object that defines every device supported on Relayr platrofm.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DeviceModel()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getDescription()
java.util.Map<java.lang.String,DeviceFirmware>	getFirmware() Returns a map with all available firmwares.
DeviceFirmware	getFirmwareByVersion(java.lang.String version)
java.util.List<java.lang.String>	getFirmwareVersions() Returns all available firmware versions
java.lang.String	getId()
DeviceFirmware	getLatestFirmware()
DeviceManufacturer	getManufacturer()
java.lang.String	getName()
java.lang.String	getOwner() If device io.relayr.java.model is not defined by Relayr this field represent model owner.
java.lang.String	getProductNumber()
java.util.List<DeviceResource>	getResources() Return device resources.
java.lang.String	getWebsite()
int	hashCode()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DeviceModel

public DeviceModel()

Method Detail

getId

public java.lang.String getId()

getOwner

public java.lang.String getOwner()

If device io.relayr.java.model is not defined by Relayr this field represent model owner.

getName

public java.lang.String getName()

Returns:

io.relayr.java.model name

getProductNumber

public java.lang.String getProductNumber()

Returns:

product number (product version)

getDescription

public java.lang.String getDescription()

getWebsite

public java.lang.String getWebsite()

getManufacturer

public DeviceManufacturer getManufacturer()

Returns:

details about device manufacturer

getResources

public java.util.List<DeviceResource> getResources()

Return device resources.

Returns:

list of DeviceResource

getFirmware

public java.util.Map<java.lang.String,DeviceFirmware> getFirmware()

Returns a map with all available firmwares. Map key is Version number. Check available firmwares using getFirmwareVersions()

Returns:

Map where key is version number

getFirmwareVersions

public java.util.List<java.lang.String> getFirmwareVersions()

Returns all available firmware versions

Returns:

List of firmware versions

getFirmwareByVersion

public DeviceFirmware getFirmwareByVersion(java.lang.String version)
                                    throws DeviceModelsFirmwareException

Parameters:

version - of firmware

Returns:

DeviceFirmware for specified version

Throws:

DeviceModelsFirmwareException - if firmware is not found

getLatestFirmware

public DeviceFirmware getLatestFirmware()
                                 throws DeviceModelsFirmwareException

Returns:

latest version of firmware. Use only if firmware for the device can not be matched.

Throws:

DeviceModelsFirmwareException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object