com.iotize.android.device.device.impl

Class IoTizeDevice

java.lang.Object

com.iotize.android.device.device.impl.IoTizeDevice

Direct Known Subclasses:

Tap

public class IoTizeDevice
extends java.lang.Object

IoTize Device model

Connect to IoTize device and execute commands

You can setup different communication protocol @see ComProtocol

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IoTizeDevice.Meta

Field Summary

Fields

Modifier and Type	Field and Description
IoTizeDeviceServices	service

Method Summary

Modifier and Type	Method and Description
void	addAuthStateListener(DeviceAuth.AuthStateListener listener)
IoTizeDevice	addConnectionStateChangeListener(ComProtocol.OnConnectionStatusChangeListener onConnectionStatusChangeListener, boolean noDuplicate) Add a listener on the connection state
<any>	commands(Call<?>... calls)
void	configure(TapConfigurator<IoTizeDevice> configurator)
void	connect()
void	connectAsync()
void	disconnect()
void	disconnectAsync()
void	enableEncryption(boolean enabled) Enable or disable frame encryption If a session key already exists, it will be used.
static IoTizeDevice	fromClient(IoTizeClient client) Create a new device instance from a Client
static IoTizeDevice	fromProtocol(ComProtocol protocol) Create a new device instance from a communication protocol
java.lang.String	getAppName()
java.lang.String	getAppPath()
DeviceAuth.AuthState	getAuthState()
IoTizeClient	getClient()
java.util.Collection<ComProtocol>	getComProtocols()
java.lang.String	getConfigVersion()
ConnectionState	getConnectionStatus()
ComProtocol	getCurrentProtocol()
java.lang.String	getIoTizeFirmwareVersion()
<T> T	getMeta(Call<T> call)
<T> T	getMeta(java.lang.String metaId)
java.lang.String	getSerialNumber()
java.lang.String	getTag()
BundleManager	getTargetBundles()
VariableManager	getTargetVariables()
boolean	isConfigured()
boolean	isConnected()
boolean	isEncryptionEnabled()
boolean	isUnwantedDisconnection()
LoginAuthTask	login(java.lang.String username, java.lang.String password)
LogoutAuthTask	logout()
<ServiceType> ServiceType	service(java.lang.Class<ServiceType> clazz)
void	setAuthState(DeviceAuth.AuthState authState) Change com.iotize.android.device.api.device.auth.DeviceAuth.AuthState It will notify listeners
<T> T	setMeta(Call<T> call)
<T> void	setMeta(java.lang.String metaId, T body) Set meta data
IoTizeDevice	setService(IoTizeDeviceServices service)
IoTizeDevice	setServiceFactory(ServiceFactory serviceFactory)
void	setSessionKey(byte[] sessionKey)
void	setTag(java.lang.String tag)
java.lang.String	toString()
void	useComProtocol(HostProtocol protocol)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

service

@NonNull
public IoTizeDeviceServices service

Method Detail

setMeta

public <T> void setMeta(java.lang.String metaId,
                        T body)

Set meta data

Type Parameters:

T - value type

Parameters:

metaId - identifier

body - value

getMeta

public <T> T getMeta(java.lang.String metaId)

getMeta

public <T> T getMeta(Call<T> call)
              throws java.lang.Exception

Throws:

java.lang.Exception

fromProtocol

public static IoTizeDevice fromProtocol(ComProtocol protocol)

Create a new device instance from a communication protocol

Parameters:

protocol - the communication protocol to use

Returns:

the new instance

fromClient

public static IoTizeDevice fromClient(IoTizeClient client)

Create a new device instance from a Client

Parameters:

client - the client to use

Returns:

the new instance

setService

@NonNull
public IoTizeDevice setService(@NonNull
                                         IoTizeDeviceServices service)

setServiceFactory

public IoTizeDevice setServiceFactory(ServiceFactory serviceFactory)

service

public <ServiceType> ServiceType service(java.lang.Class<ServiceType> clazz)
                                  throws java.lang.IllegalArgumentException

Throws:

java.lang.IllegalArgumentException

disconnect

public void disconnect()
                throws java.lang.Exception

Throws:

java.lang.Exception

connect

public void connect()
             throws java.lang.Exception

Throws:

java.lang.Exception

addAuthStateListener

public void addAuthStateListener(DeviceAuth.AuthStateListener listener)

setTag

public void setTag(java.lang.String tag)

getClient

@NonNull
public IoTizeClient getClient()

getTag

public java.lang.String getTag()

getAppName

public java.lang.String getAppName()

getSerialNumber

public java.lang.String getSerialNumber()

getAppPath

public java.lang.String getAppPath()

getIoTizeFirmwareVersion

public java.lang.String getIoTizeFirmwareVersion()

getConfigVersion

public java.lang.String getConfigVersion()

setMeta

public <T> T setMeta(Call<T> call)
              throws java.lang.Exception

Throws:

java.lang.Exception

getCurrentProtocol

public ComProtocol getCurrentProtocol()

getComProtocols

@NonNull
public java.util.Collection<ComProtocol> getComProtocols()

useComProtocol

public void useComProtocol(HostProtocol protocol)

getConnectionStatus

public ConnectionState getConnectionStatus()

login

@NonNull
public LoginAuthTask login(java.lang.String username,
                                     java.lang.String password)

logout

@NonNull
public LogoutAuthTask logout()

getTargetVariables

@NonNull
public VariableManager getTargetVariables()

getTargetBundles

@NonNull
public BundleManager getTargetBundles()

configure

public void configure(@NonNull
                      TapConfigurator<IoTizeDevice> configurator)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isConnected

public boolean isConnected()

connectAsync

public void connectAsync()

disconnectAsync

public void disconnectAsync()

isEncryptionEnabled

public boolean isEncryptionEnabled()

enableEncryption

public void enableEncryption(boolean enabled)
                      throws java.lang.Exception

Enable or disable frame encryption

If a session key already exists, it will be used. To make sure to start a new session, you can first force session key to null with setSessionKey(byte[])

Parameters:

enabled - true to enable

Throws:

java.lang.Exception - if encryption cannot enable or disable

getAuthState

@NonNull
public DeviceAuth.AuthState getAuthState()

setAuthState

public void setAuthState(@NonNull
                         DeviceAuth.AuthState authState)

Change com.iotize.android.device.api.device.auth.DeviceAuth.AuthState It will notify listeners

Parameters:

authState - the new auth state

addConnectionStateChangeListener

@NonNull
public IoTizeDevice addConnectionStateChangeListener(ComProtocol.OnConnectionStatusChangeListener onConnectionStatusChangeListener,
                                                               boolean noDuplicate)

Add a listener on the connection state

Parameters:

onConnectionStatusChangeListener - the listener

noDuplicate - true if we only add the listener ONCE at max. (You should implement equals method in the listener)

Returns:

this

setSessionKey

public void setSessionKey(@Nullable
                          byte[] sessionKey)

commands

public <any> commands(Call<?>... calls)
               throws java.lang.Exception

Throws:

java.lang.Exception

isUnwantedDisconnection

public boolean isUnwantedDisconnection()

isConfigured

public boolean isConfigured()

Returns:

true if tap is configured