buzz.getcoco.iot

Class Device

java.lang.Object

buzz.getcoco.iot.Device

All Implemented Interfaces:

java.lang.Iterable<Resource>

public class Device
extends java.lang.Object
implements java.lang.Iterable<Resource>

Device model class is a structure of the device present in the Network.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Device.AddResource This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending add resource commands.
static interface	Device.AddResourceListener Listener used to listen updates of: addTuyaResource(String, List, long, AddResourceListener); addZigbeeResource(String, String, List, long, AddResourceListener); addZwaveResource(String, List, long, AddResourceListener). .
static class	Device.CommandId CommandId aids in generation of Command to be sent using sendDeviceManagementCommand(Command, DeviceManagementStatusListener).
static class	Device.ConfigureWiFi This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending configure Wi-Fi commands.
static interface	Device.DeviceManagementStatusListener Listener responsible to update developer with status of sendDeviceManagementCommand(Command, DeviceManagementStatusListener).
static class	Device.DiscoverResource This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending discover commands.
static interface	Device.DiscoverResourceListener Listener used to listen updates of: discoverResources(RadioProtocol, long, DiscoverResourceListener).
static class	Device.ForceRemoveResource This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending force remove resource commands.
static interface	Device.InfoRequestListener Listener responsible to trigger with NativeCallbacks.infoRequestCallback(java.lang.String, long, long, long, long, java.lang.String, java.lang.Object, java.lang.Object).
static interface	Device.InfoRequestStatusListener Listener used to listen status of: sendInfoRequest(InfoRequest, InfoRequestStatusListener).
static interface	Device.InfoResponseStatusListener Listener used to listen status of sendInfoResponse(InfoResponse, InfoResponseStatusListener).
static interface	Device.MessageListener Listener responsible to trigger with NativeCallbacks.messageCallback(java.lang.String, java.lang.String, int, java.lang.Object, java.lang.Object).
static class	Device.RemoveResource This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending remove resource commands.
static interface	Device.RemoveResourceListener Listener used to listen updates of removeResource(Resource, List, long, RemoveResourceListener).
static class	Device.SetResourceMetadata This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending set resource metadata commands.
static class	Device.SetResourceName This class can be sent as an argument to sendDeviceManagementCommand(buzz.getcoco.iot.Command<buzz.getcoco.iot.Device.CommandId>, buzz.getcoco.iot.Device.DeviceManagementStatusListener) while sending set resource name commands.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Device(long deviceNodeId, Network parent)

Method Summary

Modifier and Type	Method and Description
void	addTuyaResource(java.lang.String metadata, java.util.List<Parameter<InfoResponse.Value>> parameters, long timeout, Device.AddResourceListener listener) This function is used to add the discovered resources to the resource list.
void	addZigbeeResource(java.lang.String resourceEui, java.lang.String metadata, java.util.List<Parameter<InfoResponse.Value>> parameters, long timeout, Device.AddResourceListener listener) This function is used to add the discovered resources to the resource list.
void	addZwaveResource(java.lang.String metadata, java.util.List<Parameter<InfoResponse.Value>> parameters, long timeout, Device.AddResourceListener listener) This function is used to add the discovered resources to the resource list.
void	configureWiFi(java.lang.String ssid, java.lang.String password, Device.DeviceManagementStatusListener listener) Change the connected Wi-Fi of the device.
boolean	containsResource(java.lang.String resourceEui) This function checks membership of resource in resource map.
void	discoverResources(RadioProtocol protocol, Device.DiscoverResourceListener listener) This function is used to discover resources of the given device which are present.
void	discoverResources(RadioProtocol protocol, long timeout, Device.DiscoverResourceListener listener) This function is used to discover resources of the given device which are present.
void	forceRemoveResource(Resource resource, Device.RemoveResourceListener listener) FORCE Remove the resource from the device.
int[]	getAvailableChannelPorts(int portCount) A function to get free ports to talk to this device.
java.lang.String	getDevicePsn() A function to get the PSN of the device.
java.lang.String	getFirmwareVersion() A function to get the version of firmware the device is running.
long	getId() This function is used to get the unique identifier of the device.
java.lang.String	getMake() A function to get the Manufacturer name of the device.
java.lang.String	getModel() A function to get the model name of the device.
java.lang.String	getName() This function is used to get the Name of the device.
Network	getParent() This function is used to get the parent Network of the given device.
PowerSource	getPowerSource() A function to get the PowerSource on which the device is running on.
java.lang.String	getProductName() A function to get the product name of the device.
ReceiverType	getReceiverType() A function to get the ReceiverType of the device.
<T extends Resource> T	getResource(java.lang.String resourceEui) This function is used to get the resource with the given EUI.
java.util.Map<java.lang.String,Resource>	getResourceMap() This function is used to return the HashMap that the sdk uses to map the resourceEuis to the Resource Objects.
java.util.List<RadioProtocol>	getSupportedProtocols() A getter of list of supported radio protocols.
int	hashCode()
protected void	internalAddResource(Resource resource)
protected void	internalRemoveDevice()
protected void	internalRemoveResource(java.lang.String resourceEui)
protected void	internalSetDevicePsn(java.lang.String devicePsn)
protected void	internalSetExtendable(boolean extendable)
protected void	internalSetFirmwareVersion(java.lang.String firmwareVersion)
protected void	internalSetMake(java.lang.String make)
protected void	internalSetModel(java.lang.String model)
protected void	internalSetName(java.lang.String deviceName)
protected void	internalSetParent(Network parent)
protected void	internalSetPowerSource(PowerSource powerSource)
protected void	internalSetProductName(java.lang.String productName)
protected void	internalSetProtocolSupported(int[] supportedProtocols)
protected void	internalSetReady(boolean ready)
protected void	internalSetReceiverType(ReceiverType receiverType)
boolean	isExtendable() This function is used to indicate that the device is extendable or not.
boolean	isReady() A function suggesting if the device is made from NativeCallbacks.deviceInfoCallback(boolean, boolean, java.lang.String, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, int, boolean, int[], java.lang.String[], java.lang.Object) or because of state retrieval.
java.util.Iterator<Resource>	iterator()
void	reboot(Device.DeviceManagementStatusListener listener)
void	removeResource(Resource resource, java.util.List<Parameter<InfoResponse.Value>> parameters, long timeout, Device.RemoveResourceListener listener) This function is used to remove the previously added resources.
void	sendDeviceManagementCommand(Command<Device.CommandId> command, Device.DeviceManagementStatusListener listener) A function to send commands to device.
void	sendInfoRequest(InfoRequest infoRequest, Device.InfoRequestStatusListener listener) A function to send InfoRequest to a device.
void	sendInfoResponse(InfoResponse infoResponse, Device.InfoResponseStatusListener listener) A call to respond to the commandInfoRequest.
protected void	setResourceMetadata(Resource resource, java.lang.String metadata, Device.DeviceManagementStatusListener listener)
protected void	setResourceName(Resource resource, java.lang.String name, Device.DeviceManagementStatusListener listener)
boolean	supportsProtocol(RadioProtocol radioProtocol) This function offers an easy check if the Device in interest supports any of RadioProtocol.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

Device

protected Device(long deviceNodeId,
                 Network parent)

Method Detail

sendDeviceManagementCommand

public void sendDeviceManagementCommand(Command<Device.CommandId> command,
                                        Device.DeviceManagementStatusListener listener)

A function to send commands to device.

Parameters:

command - Command to be sent to Device.

listener - The listener which will be triggered after the callback

reboot

public void reboot(Device.DeviceManagementStatusListener listener)

setResourceName

protected void setResourceName(Resource resource,
                               java.lang.String name,
                               Device.DeviceManagementStatusListener listener)

setResourceMetadata

protected void setResourceMetadata(Resource resource,
                                   java.lang.String metadata,
                                   Device.DeviceManagementStatusListener listener)

getId

public final long getId()

This function is used to get the unique identifier of the device.

Returns:

long: The unique number that identifies the Devices of the given network.

getName

public java.lang.String getName()

This function is used to get the Name of the device.

Returns:

String: The name of the device.

isExtendable

public boolean isExtendable()

This function is used to indicate that the device is extendable or not.

Returns:

boolean: This is a flag that is used to identify extendable devices from non-extendable

getParent

public final Network getParent()

This function is used to get the parent Network of the given device.

Returns:

Network: The parent Network of the given device.

getResourceMap

public java.util.Map<java.lang.String,Resource> getResourceMap()

This function is used to return the HashMap that the sdk uses to map the resourceEuis to the Resource Objects. This function can be used to databind the sdk to the application.

Returns:

The key being the resourceEui and the value being the Resource Object. NOTE: This hashmap is for read-only any misuse may cause the program to misbehave and even crash.

getResource

public final <T extends Resource> T getResource(java.lang.String resourceEui)

This function is used to get the resource with the given EUI.

Returns:

The Resource

isReady

public boolean isReady()

A function suggesting if the device is made from NativeCallbacks.deviceInfoCallback(boolean, boolean, java.lang.String, long, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, int, int, boolean, int[], java.lang.String[], java.lang.Object) or because of state retrieval.

Returns:

boolean: state if the device is dummy or not.

discoverResources

public void discoverResources(RadioProtocol protocol,
                              Device.DiscoverResourceListener listener)

This function is used to discover resources of the given device which are present.

Parameters:

protocol - The protocol which will be used

listener - The listener which will be triggered after the callback

discoverResources

public void discoverResources(RadioProtocol protocol,
                              long timeout,
                              Device.DiscoverResourceListener listener)

This function is used to discover resources of the given device which are present.

Parameters:

protocol - The protocol which will be used

timeout - The timeout for this command

listener - The listener which will be triggered after the callback

addZwaveResource

public void addZwaveResource(java.lang.String metadata,
                             java.util.List<Parameter<InfoResponse.Value>> parameters,
                             long timeout,
                             Device.AddResourceListener listener)

This function is used to add the discovered resources to the resource list.

Parameters:

metadata - The metadata that has to be set on this resource

parameters - The parameters to be passed while adding

timeout - The timeout for this command

listener - The listener which will be triggered after the callback

addZigbeeResource

public void addZigbeeResource(java.lang.String resourceEui,
                              java.lang.String metadata,
                              java.util.List<Parameter<InfoResponse.Value>> parameters,
                              long timeout,
                              Device.AddResourceListener listener)

This function is used to add the discovered resources to the resource list.

Parameters:

resourceEui - The ID of the resource to be added.

metadata - The metadata that has to be set on this resource

parameters - The parameters to be passed while adding

timeout - The timeout for this command

listener - The listener which will be triggered after the callback

Throws:

java.lang.RuntimeException - Throws exception on communication failures etc..,

addTuyaResource

public void addTuyaResource(java.lang.String metadata,
                            java.util.List<Parameter<InfoResponse.Value>> parameters,
                            long timeout,
                            Device.AddResourceListener listener)

This function is used to add the discovered resources to the resource list.

Parameters:

metadata - The metadata that has to be set on this resource

parameters - The parameters to be passed while adding

timeout - The timeout for this command

listener - The listener which will be triggered after the callback

Throws:

java.lang.RuntimeException - Throws exception on communication failures etc..,

removeResource

public void removeResource(Resource resource,
                           java.util.List<Parameter<InfoResponse.Value>> parameters,
                           long timeout,
                           Device.RemoveResourceListener listener)

This function is used to remove the previously added resources.

Parameters:

resource - The resource to be removed.

parameters - The parameters to be passed while adding

listener - The listener which will be triggered after the callback

Throws:

java.lang.RuntimeException - Throws an exception on communication failures and other cases like removing resources which haven't been added.

forceRemoveResource

public void forceRemoveResource(Resource resource,
                                Device.RemoveResourceListener listener)

FORCE Remove the resource from the device. This function is used to remove the previously added resources. NOTE: this should be performed on resources which are lost.

Parameters:

resource - The resource to be removed.

listener - The listener which will be triggered after the callback

Throws:

java.lang.RuntimeException - Throws an exception on communication failures and other cases like removing resources which haven't been added.

configureWiFi

public void configureWiFi(java.lang.String ssid,
                          java.lang.String password,
                          Device.DeviceManagementStatusListener listener)

Change the connected Wi-Fi of the device.

Parameters:

ssid - SSID of the Wi-Fi to connect

password - PASSWORD of the Wi-Fi to connect

listener - The listener which will be triggered after the callback

Throws:

java.lang.RuntimeException - Throws an exception on communication failures and other cases like removing resources which haven't been added.

sendInfoResponse

public void sendInfoResponse(InfoResponse infoResponse,
                             Device.InfoResponseStatusListener listener)

A call to respond to the commandInfoRequest. This function is primarily designed to send some additional information during the addResource process.

Parameters:

infoResponse - The response object to be sent.

listener - The listener which will be triggered after the callback

sendInfoRequest

public void sendInfoRequest(InfoRequest infoRequest,
                            Device.InfoRequestStatusListener listener)

A function to send InfoRequest to a device. The InfoResponse will be returned in CallbacksInterface.infoResponseCallback(buzz.getcoco.iot.InfoRequest, buzz.getcoco.iot.InfoResponse).

Parameters:

infoRequest - The infoRequest object which will contain info to be queried on device

listener - The listener which will be triggered with CallbacksInterface.infoResponseCallback(buzz.getcoco.iot.InfoRequest, buzz.getcoco.iot.InfoResponse)

getDevicePsn

public java.lang.String getDevicePsn()

A function to get the PSN of the device.

Returns:

String: the PSN of the device

getProductName

public java.lang.String getProductName()

A function to get the product name of the device.

Returns:

String: The name of the product

getMake

public java.lang.String getMake()

A function to get the Manufacturer name of the device.

Returns:

String: The name of the manufacturer

getModel

public java.lang.String getModel()

A function to get the model name of the device.

Returns:

String: The model name of the device

getFirmwareVersion

public java.lang.String getFirmwareVersion()

A function to get the version of firmware the device is running.

Returns:

String: The Firmware version

getPowerSource

public PowerSource getPowerSource()

A function to get the PowerSource on which the device is running on.

Returns:

PowerSource: The PowerSource of the device

getReceiverType

public ReceiverType getReceiverType()

A function to get the ReceiverType of the device.

Returns:

ReceiverType: The type of the receiver on the device

getAvailableChannelPorts

public int[] getAvailableChannelPorts(int portCount)

A function to get free ports to talk to this device.

Returns:

int[]: The ports over which communication can take place

supportsProtocol

public boolean supportsProtocol(RadioProtocol radioProtocol)

This function offers an easy check if the Device in interest supports any of RadioProtocol.

Parameters:

radioProtocol - An enum with possible values of protocols for communication. Ex: Zigbee

Returns:

True if device supports protocol entered.

internalSetProtocolSupported

protected void internalSetProtocolSupported(int[] supportedProtocols)

getSupportedProtocols

public java.util.List<RadioProtocol> getSupportedProtocols()

A getter of list of supported radio protocols.

Returns:

The supported protocols in RadioProtocol

internalRemoveDevice

protected void internalRemoveDevice()

internalSetName

protected void internalSetName(java.lang.String deviceName)

internalSetDevicePsn

protected void internalSetDevicePsn(java.lang.String devicePsn)

internalSetProductName

protected void internalSetProductName(java.lang.String productName)

internalSetMake

protected void internalSetMake(java.lang.String make)

internalSetModel

protected void internalSetModel(java.lang.String model)

internalSetFirmwareVersion

protected void internalSetFirmwareVersion(java.lang.String firmwareVersion)

internalSetPowerSource

protected void internalSetPowerSource(PowerSource powerSource)

internalSetReceiverType

protected void internalSetReceiverType(ReceiverType receiverType)

internalSetExtendable

protected void internalSetExtendable(boolean extendable)

internalSetParent

protected void internalSetParent(Network parent)

internalSetReady

protected void internalSetReady(boolean ready)

containsResource

public boolean containsResource(java.lang.String resourceEui)

This function checks membership of resource in resource map.

Parameters:

resourceEui - The ID of the resource

Returns:

True if the resource exists in the resource map

internalAddResource

protected void internalAddResource(Resource resource)

internalRemoveResource

protected void internalRemoveResource(java.lang.String resourceEui)

hashCode

public final int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

iterator

public java.util.Iterator<Resource> iterator()

Specified by:

iterator in interface java.lang.Iterable<Resource>