io.relayr.java.model

Class Device

java.lang.Object

io.relayr.java.model.Device

All Implemented Interfaces:

java.io.Serializable

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

The Device class is a representation of the device entity. A device entity is any external entity capable of gathering measurements or one which is capable of receiving information from the relayr platform. Examples would be a thermometer, a gyroscope or an infrared sensor.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Device(java.lang.String id, java.lang.String owner, java.lang.String modelId, java.lang.String name)
Device(java.lang.String id, java.lang.String owner, java.lang.String modelId, java.lang.String name, java.lang.String description)
Device(java.lang.String id, java.lang.String modelId, java.lang.String name, java.lang.String description, java.lang.String owner, java.lang.String firmwareVersion, java.lang.String externalId, boolean isPublic, java.lang.String accountType)

Method Summary

Modifier and Type	Method and Description
rx.Observable<java.lang.Void>	deleteStateMetadata(java.lang.String key)
boolean	equals(java.lang.Object o)
AggregatedDataHelper	getAggregatedDataHelper() Returns device specific AggregatedDataHelper object.
java.util.Date	getCreated()
java.lang.String	getDescription()
rx.Observable<DeviceModel>	getDeviceModel() Returns DeviceModel that defines readings, commands and configurations for specific device depending on device firmware version.
java.lang.String	getExternalId()
java.lang.String	getFirmwareVersion()
java.lang.String	getId()
java.lang.String	getIntegrationType()
java.lang.String	getModelId() Returns ID of DeviceModel that defines readings, commands and configurations
java.lang.String	getName()
java.lang.String	getOwner()
RawDataHelper	getRawDataHelper() Returns device specific AggregatedDataHelper object.
rx.Observable<StateReadings>	getReadings() Returns all latest readings saved in the device state.
rx.Observable<StateReadings>	getReadings(java.lang.String path, java.lang.String meaning) Returns latest readings saved in device state optionally filtered with path and meaning
java.lang.String	getSecret()
rx.Observable<State>	getState() Returns whole state with all latest readings, configurations, commands and metadata for device.
rx.Observable<StateCommands>	getStateCommands() Returns all latest commands saved in device state.
rx.Observable<StateCommands>	getStateCommands(java.lang.String path, java.lang.String name) Returns latest commands saved in device state optionally filtered with path and meaning
rx.Observable<StateConfigurations>	getStateConfigurations() Returns all latest configurations saved in device state.
rx.Observable<StateConfigurations>	getStateConfigurations(java.lang.String path, java.lang.String name) Returns latest configurations saved in device state optionally filtered with path and meaning
rx.Observable<StateMetadata>	getStateMetadata(java.lang.String key) Returns metadata saved in device state.
rx.Observable<ValueSchema>	getValueSchema(java.lang.String meaning, java.lang.String path) Returns ValueSchema for specified meaning and path from received Reading object.
int	hashCode()
boolean	isShared()
void	recycle() Clears device's helper objects
rx.Observable<java.lang.Void>	saveStateMetadata(java.lang.String key, java.lang.Object object) Saves object with corresponding key into device metadata.
rx.Observable<java.lang.Void>	sendCommand(Command command) Sends a command to the this device.
rx.Observable<java.lang.Void>	sendConfiguration(Configuration configuration) Sends a configuration to device.
void	setDescription(java.lang.String description)
void	setName(java.lang.String name)
rx.Observable<Reading>	subscribeToCloudReadings() Subscribes an app to a device channel.
java.lang.String	toString()
TransmitterDevice	toTransmitterDevice() Used only for Wunderbar devices.
void	unSubscribeToCloudReadings() Unsubscribes an app from a device channel, stopping and cleaning up the connection.

Methods inherited from class java.lang.Object

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

Constructor Detail

Device

public Device(java.lang.String id,
              java.lang.String owner,
              java.lang.String modelId,
              java.lang.String name)

Device

public Device(java.lang.String id,
              java.lang.String owner,
              java.lang.String modelId,
              java.lang.String name,
              java.lang.String description)

Device

public Device(java.lang.String id,
              java.lang.String modelId,
              java.lang.String name,
              java.lang.String description,
              java.lang.String owner,
              java.lang.String firmwareVersion,
              java.lang.String externalId,
              boolean isPublic,
              java.lang.String accountType)

Method Detail

getName

public java.lang.String getName()

getDescription

public java.lang.String getDescription()

getId

public java.lang.String getId()

Returns:

unique device UUID

getCreated

public java.util.Date getCreated()

Returns:

null if created timestamp doesn't exist or if there is a ParseException

getFirmwareVersion

public java.lang.String getFirmwareVersion()

Returns:

return device's firmware version unless device is a prototype and it doesn't have a model and firmwareVersion yet

getSecret

public java.lang.String getSecret()

getExternalId

public java.lang.String getExternalId()

Returns:

return device's id if device is originaly owned by another platform

isShared

public boolean isShared()

getOwner

public java.lang.String getOwner()

getIntegrationType

public java.lang.String getIntegrationType()

setName

public void setName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

subscribeToCloudReadings

public rx.Observable<Reading> subscribeToCloudReadings()

Subscribes an app to a device channel. Enables the app to receive data from the device.

Returns:

Reading

unSubscribeToCloudReadings

public void unSubscribeToCloudReadings()

Unsubscribes an app from a device channel, stopping and cleaning up the connection.

getState

public rx.Observable<State> getState()

Returns whole state with all latest readings, configurations, commands and metadata for device. Readings, commands and configurations are persisted automatically when received on the server.

Returns:

State

getReadings

public rx.Observable<StateReadings> getReadings()

Returns all latest readings saved in the device state. For filtering readings use getReadings(String, String)

Returns:

StateReadings

getReadings

public rx.Observable<StateReadings> getReadings(java.lang.String path,
                                                java.lang.String meaning)

Returns latest readings saved in device state optionally filtered with path and meaning

Parameters:

path - see DeviceReading.path in DeviceModel for more details

meaning - see DeviceReading.meaning in DeviceModel for more details

Returns:

StateReadings

Throws:

java.lang.NullPointerException - if meaning is NULL

sendConfiguration

public rx.Observable<java.lang.Void> sendConfiguration(Configuration configuration)

Sends a configuration to device. Configuration will be automatically saved in device state and can be fetched with getStateConfigurations()

Parameters:

configuration - - check possible configuration in DeviceModel

Returns:

empty Observable

Throws:

java.lang.NullPointerException - if configuration is NULL

getStateConfigurations

public rx.Observable<StateConfigurations> getStateConfigurations()

Returns all latest configurations saved in device state. For filtering configurations use getStateConfigurations(String, String)

Returns:

StateConfigurations

getStateConfigurations

public rx.Observable<StateConfigurations> getStateConfigurations(java.lang.String path,
                                                                 java.lang.String name)

Returns latest configurations saved in device state optionally filtered with path and meaning

Parameters:

path - see DeviceConfiguration.path in DeviceModel for more details

name - see DeviceConfiguration.name in DeviceModel for more details

Returns:

StateConfigurations

sendCommand

public rx.Observable<java.lang.Void> sendCommand(Command command)

Sends a command to the this device. Command will be automatically saved in device state and can be fetched with getStateCommands()

Parameters:

command - - check possible commands in DeviceModel

Returns:

empty Observable

Throws:

java.lang.NullPointerException - if command is NULL

getStateCommands

public rx.Observable<StateCommands> getStateCommands()

Returns all latest commands saved in device state. For filtering readings use getStateCommands(String, String)

Returns:

StateCommands

getStateCommands

public rx.Observable<StateCommands> getStateCommands(java.lang.String path,
                                                     java.lang.String name)

Returns latest commands saved in device state optionally filtered with path and meaning

Parameters:

path - see DeviceCommand.path in DeviceModel for more details

name - see DeviceCommand.name in DeviceModel for more details

Returns:

StateCommands

getStateMetadata

public rx.Observable<StateMetadata> getStateMetadata(java.lang.String key)

Returns metadata saved in device state.

Parameters:

key - if null whole metadata is returned, otherwise object with specified key is returned (if one exists)

Returns:

StateMetadata

deleteStateMetadata

public rx.Observable<java.lang.Void> deleteStateMetadata(java.lang.String key)

Parameters:

key - if null nothing is deleted, otherwise object with specified key is deleted (if one exists)

Returns:

in onNext if data is deleted

saveStateMetadata

public rx.Observable<java.lang.Void> saveStateMetadata(java.lang.String key,
                                                       java.lang.Object object)

Saves object with corresponding key into device metadata.

Parameters:

key - separated with dots '.' to create nicer dictionary structure for easier navigation.

object - object to save under specified key

Returns:

empty Observable

getAggregatedDataHelper

public AggregatedDataHelper getAggregatedDataHelper()

Returns device specific AggregatedDataHelper object. Use to get device history data.

getRawDataHelper

public RawDataHelper getRawDataHelper()

Returns device specific AggregatedDataHelper object. Use to get device history data.

getModelId

public java.lang.String getModelId()

Returns ID of DeviceModel that defines readings, commands and configurations

Returns:

modelId

getDeviceModel

public rx.Observable<DeviceModel> getDeviceModel()

Returns DeviceModel that defines readings, commands and configurations for specific device depending on device firmware version. Use if RelayrJavaSdk.getDeviceModelsCache() is initialized.

Returns:

DeviceModel

getValueSchema

public rx.Observable<ValueSchema> getValueSchema(java.lang.String meaning,
                                                 java.lang.String path)

Returns ValueSchema for specified meaning and path from received Reading object. ValueSchema defines received data and a way to parse it.

Parameters:

path - defined by DeviceReading.getPath() in DeviceModel

meaning - defined by DeviceReading.getMeaning() in DeviceModel

Returns:

ValueSchema

toTransmitterDevice

public TransmitterDevice toTransmitterDevice()

Used only for Wunderbar devices.

Returns:

TransmitterDevice

recycle

public void recycle()

Clears device's helper objects

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object