com.ardic.android.iotignite.interfaces

Interface INode

All Known Implementing Classes:

Node

public interface INode

The INode interface is for the Node which is parent of Things. You can group your Things with specified Nodes to easily control them. Every Node in device must have an unique id.

See Also:

Thing, ThingManager, IotIgniteManager

Method Summary

Modifier and Type	Method and Description
Thing	createThing(android.hardware.Sensor androidSensor, ThingListener listener) Create Thing object which is an Android Sensor.
Thing	createThing(java.lang.String thingID, ThingType thingType, ThingCategory thingCategory, boolean isActuator, ThingListener listener, java.lang.String uniqueID) Creates Thing object and assigns to Node.
android.content.Context	getContext() Get Context of Node.
java.util.List<Thing>	getEveryThing() Get list of registered Things in IotIgnite.
java.lang.String	getNodeID() Get id of Node.
NodeListener	getNodeListener() Return node's listener object.
java.lang.String	getNodeName() Get human readable Node name.
java.lang.String	getPackageName() Package name of Node object.
Thing	getThingByID(java.lang.String thingID) Get Thing object by thingID in registered Node.
java.util.List<Thing>	getThingByName(java.lang.String name) Get list of registered Things with same name in IotIgnite.
java.lang.String	getUniqueID() Get unique id of Node.
boolean	isConnected() Get connection status of Node.
boolean	isRegistered() Check a Thing object registered on IotIgnite or not.
boolean	register() Register Node to IotIgnite.
void	setConnected(boolean connected, java.lang.String description) Set connection status of Node.
void	setContext(android.content.Context context) Set Context of Node.
void	setNodeID(java.lang.String nodeID) Set an id to Node.
void	setNodeListener(NodeListener listener) Sets NodeListener for callbacks.
void	setNodeName(java.lang.String nodeName) Set human readable name to Node.
void	setUniqueID(java.lang.String uniqueID) Set an uniqueID to Node.
boolean	unregister() Unregister Node from IotIgnite.

Method Detail

getNodeName

java.lang.String getNodeName()

Get human readable Node name.

Returns:

nodeName : Human readable name of Node.

setNodeName

void setNodeName(java.lang.String nodeName)

Set human readable name to Node.

Parameters:

nodeName - : Name of Node.

getUniqueID

java.lang.String getUniqueID()

Get unique id of Node.

Returns:

nodeID : unique ID of Node.

setUniqueID

void setUniqueID(java.lang.String uniqueID)

Set an uniqueID to Node. ID must be UNIQUE.

Parameters:

uniqueID - unique of the Node

getNodeID

java.lang.String getNodeID()

Get id of Node.

Returns:

nodeID : node ID of Node.

setNodeID

void setNodeID(java.lang.String nodeID)

Set an id to Node. ID must be UNIQUE.

Parameters:

nodeID - id of the Node

isConnected

boolean isConnected()

Get connection status of Node.

Returns:

nodeName : Human readable name of Node.

setConnected

void setConnected(boolean connected,
                  java.lang.String description)

Set connection status of Node.

Parameters:

connected - : Status of connection.

description - : Description about connection state.

getPackageName

java.lang.String getPackageName()

Package name of Node object.

Returns:

packageName : String

getContext

android.content.Context getContext()

Get Context of Node.

Returns:

Context

setContext

void setContext(android.content.Context context)

Set Context of Node.

Parameters:

context - Context of the Application

register

boolean register()

Register Node to IotIgnite. To register Node, nodeID must be unique on this device.

Returns:

true or false success state.

unregister

boolean unregister()

Unregister Node from IotIgnite. Application can only unregister its own Nodes. Nodes registered by different application are not accessable.

Returns:

true or false success state.

See Also:

IotIgniteManager, Thing

createThing

Thing createThing(java.lang.String thingID,
                  ThingType thingType,
                  ThingCategory thingCategory,
                  boolean isActuator,
                  ThingListener listener,
                  java.lang.String uniqueID)

Creates Thing object and assigns to Node. To create Thing object the application must be authorized in IotIgnite platform. After that it can create Node and Node assigned Thing objects. thingID must follow the rules which are defined with the Regex below: ^[a-zA-Z0-9]+([ ]?[a-zA-Z0-9-.:@]+)*$

Parameters:

thingID - Set Thing's ID. Every node must has unique thingId.

thingType - thingType type of the Thing

thingCategory - Could be ThingCategory.BUILTIN or ThingCategory.EXTERNAL

isActuator - Actuator state of Thing object

listener - ThingListener object.

uniqueID - uniqueID of Thing

Returns:

Thing : The created Thing object.

See Also:

ThingManager, Thing, ThingType, ThingListener, ThingCategory

createThing

Thing createThing(android.hardware.Sensor androidSensor,
                  ThingListener listener)

Create Thing object which is an Android Sensor. It wraps Android Sensor to Thing object. Creating Thing objects from builtin Android Sensor has fewer parameters than generic Thing object. It only needs Android Sensor and ThingListener. Other parameters such as thingID, thingType, vendor has already provided in Sensor.

Android Sensors can not act as an actuator so by default this parameter is false. Application cannot change it.

Parameters:

androidSensor - Sensor of the Android

listener - ThingListener object.

Returns:

Thing : Thing object.

See Also:

ThingManager, Thing, Sensor, ThingListener

getEveryThing

java.util.List<Thing> getEveryThing()

Get list of registered Things in IotIgnite. If no such a Thing is registered, Node returns empty list.

Returns:

List<Thing>: List of Thing's registered on IotIgnite.

getThingByID

Thing getThingByID(java.lang.String thingID)

Get Thing object by thingID in registered Node. If no such Thing is registered thingID returns null object.

Parameters:

thingID - : Unique thingID of object.

Returns:

Thing : Returns null if no such a thing in that id.

getThingByName

java.util.List<Thing> getThingByName(java.lang.String name)

Get list of registered Things with same name in IotIgnite. If no such Thing is registered, Node returns empty list.

Parameters:

name - Name of the Thing

Returns:

List<Thing>: List of Things with same thingNames registered on IotIgnite.

isRegistered

boolean isRegistered()

Check a Thing object registered on IotIgnite or not.

Returns:

true or false : Thing registration state on IotIgnite.

setNodeListener

void setNodeListener(NodeListener listener)

Sets NodeListener for callbacks.

Parameters:

listener - : NodeListener object.

See Also:

NodeListener

getNodeListener

NodeListener getNodeListener()

Return node's listener object.

Returns:

NodeListener : Node listener object.

See Also:

NodeListener