com.ardic.android.iotignite.things

Class Thing

java.lang.Object

com.ardic.android.iotignite.connection.ServiceInstance

com.ardic.android.iotignite.things.Thing

All Implemented Interfaces:

IThing, ThingListener

public final class Thing
extends ServiceInstance
implements IThing, ThingListener

End point objects of IotIgnite. Things are configurable and virtual object to communicate with ArCloud

See Also:

IotIgniteManager, Node, ThingManager

Field Summary

Fields inherited from class com.ardic.android.iotignite.connection.ServiceInstance

agentService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Thing(android.content.Context context, android.hardware.Sensor androidSensor, ThingListener listener, ThingManager mThingManager) Thing constructor for android sensors.
protected	Thing(android.content.Context context, java.lang.String thingID, ThingType thingType, ThingCategory thingCategory, boolean isActuator, ThingListener listener, ThingManager mThingManager, java.lang.String uniqueID) General thing constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
android.hardware.Sensor	getAndroidBuiltInSensor() Get the wrapped Sensor.
boolean	getIsActuator() Gets Thing's state which actuator or not.
java.lang.String	getNodeID() Return NodeId thing belongs to
ThingCategory	getThingCategory() Get category of Thing .
ThingConfiguration	getThingConfiguration() Gets Thing's configuration.
android.content.Context	getThingContext()
ThingData	getThingData() Last data of Thing object.
java.lang.String	getThingID() Get Thing's specified ID
ThingListener	getThingListener() Return thing's listener object.
java.lang.String	getThingName() Get Thing's human readable name.
ThingType	getThingType() Get specified type of ThingType .
java.lang.String	getUniqueID() Get Thing's unique ID
int	hashCode()
boolean	isConnected() Get last connection info of Thing.
boolean	isRegistered() Checks Thing object is registered or not.
void	onActionReceived(java.lang.String nodeID, java.lang.String thingID, ThingActionData thingData) If Thing set as an actuator, action callback going to be handled here.
void	onConfigurationReceived(Thing newThing) Return new configured Thing object.
void	onThingUnregistered(java.lang.String nodeID, java.lang.String thingID) If Thing is unregistered, callback method notifies the application.
boolean	register() Register Thing to assigned Node.
boolean	sendData(ThingData data) Send ThingData to cloud.
protected void	setAndroidSensor(android.hardware.Sensor androidSensor)
void	setConnected(boolean connected, java.lang.String description) Set connection state of Thing.
void	setIsActuator(boolean isActuator) Sets Thing object can/can't receive action message.
void	setThingCategory(ThingCategory thingCategory) Set category of Thing to ThingCategory.BUILTIN or ThingCategory.EXTERNAL.
void	setThingConfiguration(ThingConfiguration config) Sets ThingConfiguration of your Thing.
void	setThingContext(android.content.Context context) Sets Context of Thing.
void	setThingData(ThingData thingData) Set or update Thing
void	setThingID(java.lang.String thingID) Set Thing's ID.
void	setThingListener(ThingListener listener) Sets ThingListener for actuator and ThingConfiguration callbacks.
protected void	setThingManager(ThingManager manager)
void	setThingName(java.lang.String thingName) Set human readable name to specified Thing.
void	setThingType(ThingType thingType) Set specific ThingType for Thing object.
void	setUniqueID(java.lang.String uniqueID) Set Thing's uniqueID.
java.lang.String	toString()
boolean	unregister() Unregister Thing to assigned Node.

Methods inherited from class java.lang.Object

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

Constructor Detail

Thing

protected Thing(@NonNull
                android.content.Context context,
                @NonNull
                java.lang.String thingID,
                @NonNull
                ThingType thingType,
                @NonNull
                ThingCategory thingCategory,
                boolean isActuator,
                ThingListener listener,
                ThingManager mThingManager,
                java.lang.String uniqueID)

General thing constructor.

Parameters:

context - : Context of your application.

thingID - : Id of your thing.

thingType - : Type of your thing.

thingCategory - : Category of your thing.

isActuator - : Is this thing gonna be used as an actuator or not.

listener - : Thing listener for actuator and configuration callbacks.

uniqueID - : Unique id of your thing.

Thing

protected Thing(@NonNull
                android.content.Context context,
                @NonNull
                android.hardware.Sensor androidSensor,
                ThingListener listener,
                ThingManager mThingManager)

Thing constructor for android sensors.

Parameters:

context - :Context of your application.

androidSensor - : Android sensor object.

listener - : Thing listener for actuator and configuration callbacks.

Method Detail

setAndroidSensor

protected void setAndroidSensor(android.hardware.Sensor androidSensor)

setThingManager

protected void setThingManager(ThingManager manager)

getThingID

public java.lang.String getThingID()

Description copied from interface: IThing

Get Thing's specified ID

Specified by:

getThingID in interface IThing

Returns:

thingID

setThingID

public void setThingID(java.lang.String thingID)

Description copied from interface: IThing

Set Thing's ID. Every node must has unique things.

Specified by:

setThingID in interface IThing

Parameters:

thingID - thingID of Thing

getThingName

public java.lang.String getThingName()

Description copied from interface: IThing

Get Thing's human readable name.

Specified by:

getThingName in interface IThing

Returns:

thingName

setThingName

public void setThingName(java.lang.String thingName)

Description copied from interface: IThing

Set human readable name to specified Thing.

Specified by:

setThingName in interface IThing

Parameters:

thingName - name of the thing

getThingData

public ThingData getThingData()

Description copied from interface: IThing

Last data of Thing object.

Specified by:

getThingData in interface IThing

Returns:

ThingData : Last assigned data. Data could be null.

setThingData

public void setThingData(ThingData thingData)

Description copied from interface: IThing

Set or update Thing

Specified by:

setThingData in interface IThing

Parameters:

thingData - : Specified ThingData of thing.

See Also:

data of the thing

getAndroidBuiltInSensor

public android.hardware.Sensor getAndroidBuiltInSensor()

Description copied from interface: IThing

Get the wrapped Sensor. If you're not using built-in Sensor you can ignore this function. NOTE: If you are not using Android Sensor this function returns NULL.

Specified by:

getAndroidBuiltInSensor in interface IThing

Returns:

Sensor: Android Sensor object.

See Also:

ThingData

getThingType

public ThingType getThingType()

Description copied from interface: IThing

Get specified type of ThingType .

Specified by:

getThingType in interface IThing

Returns:

ThingType object. You can use getThingType() to use String data of ThingType object.

See Also:

Sensor

setThingType

public void setThingType(ThingType thingType)

Description copied from interface: IThing

Set specific ThingType for Thing object.

Specified by:

setThingType in interface IThing

Parameters:

thingType - type of the Thing

See Also:

ThingType

getThingCategory

public ThingCategory getThingCategory()

Description copied from interface: IThing

Get category of Thing . It has two categories :

ThingCategory.BUILTIN ThingCategory.EXTERNAL

Specified by:

getThingCategory in interface IThing

Returns:

ThingCategory object.

See Also:

ThingCategory

setThingCategory

public void setThingCategory(ThingCategory thingCategory)

Description copied from interface: IThing

Set category of Thing to ThingCategory.BUILTIN

or ThingCategory.EXTERNAL.