com.iotize.android.device.webapp.onnotifyapi

Class AsyncOnNotifyAPI

java.lang.Object

com.iotize.android.device.webapp.onnotifyapi.AsyncOnNotifyAPI

All Implemented Interfaces:

IAsyncOnNotifyAPI

public class AsyncOnNotifyAPI
extends java.lang.Object
implements IAsyncOnNotifyAPI

First verion of Tap Manager Javascript API

Expose method getX() and result will be available in a global callback method called onNotifyGetX()

Constructor Summary

Constructors

Constructor and Description
AsyncOnNotifyAPI(IIoTizeWebView webView, IoTizeDevice device) Instantiate the interface and set the context

Method Summary

Modifier and Type	Method and Description
void	ClearLastErrorMsg() Clear the last error message.
int	ConnectTarget() Open the communication between IoTize and target board.
int	DatalogRun()
int	DatalogStop()
int	DisconnectTarget() Close the communication between IoTize and target board.
int	GetCurrentHostProtocol() Get the current protocol communication between smartphone and IoTize.
int	GetCurrentProfileID() Get current profile ID
int	GetCurrentTargetProtocol() Get the current protocol communication between target and IoTize.
int	GetHostProtocols() Retrieve the IoTize host protocols capabilities.
int	GetIoTizeDatalogIsRunning()
int	GetIoTizeErrorCode() Get the IoTized saved error code.
int	GetIoTizeFirmwareVersion() Retrieve the IoTize firmware version.
int	GetIoTizeLocalPublicPwd()
int	GetIoTizeMemoryFree() Retrieve the IoTize memory free size.
int	GetIoTizeModuleManufacturer() Retrieve the IoTize module manufacturer.
int	GetIoTizeModuleType() Retrieve the IoTize module type.
int	GetIoTizeSerialNumber() Retrieve the IoTize Serial Number.
java.lang.String	GetLastErrorMsg() Get the last error message encountered.
int	GetProfileName(int ID)
int	GetTargetConfigVersion() Retrieve the target configuration version.
int	GetTargetFirmwareVersion() Retrieve the target firmware version.
int	GetTargetName() Retrieve the configured target name.
int	GetTargetProtocols() Retrieve the IoTize target protocols capabilities.
int	GetVar(java.lang.String name) Request for a variable value.
int	IsConnected() Check if IoTize connected to smartphone.
boolean	IsFatalError() Is the last error a fatal error ?
int	Login(java.lang.String login, java.lang.String pwd) User Login
int	Logout() Logout command to IoTize.
void	notifyCommandResult(Command command, Response result, BodyConverter decoder, java.lang.String methodName, java.lang.String variableHMIName)
void	notifyError(java.lang.String cmd, int ret)
int	RegisterComVar(int ID, int format, int number, int freq) Register a communication variable.
int	RegisterVar(java.lang.String varName, int ID, int index) Register a variable.
int	ResetIoTize() Reboot the IoTize module.
int	ResetIoTizeErrorCode() Reset the IoTize saved error code.
int	ResetTarget() Reset the target board.
int	SetArrayVar(int ID, java.lang.String[] value) Write a array type variable to the target.
void	setContext(android.content.Context mContext)
int	SetVar(int ID, byte[] value)
int	SetVar(int ID, java.lang.Integer value) Write a variable to the target.
int	SetVar(int ID, java.lang.Integer[] value)
int	SetVar(int ID, java.lang.String value) Write a variable to the target.
int	ShowToast(java.lang.String toast) Show a toast from the web page.
void	startMonitoring() Start monitoring (this will start refresh and variable acquisition)
int	StartRefresh() Enables the data refresh.
void	stopMonitoring() Stop monitoring (this will stop refresh and variable acquisition)
int	StopRefresh() Disables the data refresh.
int	UnRegisterAll() UnRegister all communication and HMI variables.
int	UnRegisterComVar(int ID) UnRegister a communication variable.
int	UnRegisterVar(java.lang.String varName) UnRegister a variable.

Methods inherited from class java.lang.Object

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

Constructor Detail

AsyncOnNotifyAPI

public AsyncOnNotifyAPI(IIoTizeWebView webView,
                        IoTizeDevice device)

Instantiate the interface and set the context

Parameters:

webView - iotize webview

device - iotize device object

Method Detail

stopMonitoring

public void stopMonitoring()

Description copied from interface: IAsyncOnNotifyAPI

Stop monitoring (this will stop refresh and variable acquisition)

Specified by:

stopMonitoring in interface IAsyncOnNotifyAPI

startMonitoring

public void startMonitoring()

Description copied from interface: IAsyncOnNotifyAPI

Start monitoring (this will start refresh and variable acquisition)

Specified by:

startMonitoring in interface IAsyncOnNotifyAPI

ShowToast

public int ShowToast(java.lang.String toast)

Description copied from interface: IAsyncOnNotifyAPI

Show a toast from the web page.

Specified by:

ShowToast in interface IAsyncOnNotifyAPI

Parameters:

toast - String to display.

Returns:

NO-ERROR if OK, error code else.

setContext

public void setContext(android.content.Context mContext)

IsConnected

public int IsConnected()

Description copied from interface: IAsyncOnNotifyAPI

Check if IoTize connected to smartphone.

Specified by:

IsConnected in interface IAsyncOnNotifyAPI

Returns:

1 if connected, else 0.

GetLastErrorMsg

public java.lang.String GetLastErrorMsg()

Description copied from interface: IAsyncOnNotifyAPI

Get the last error message encountered.

Specified by:

GetLastErrorMsg in interface IAsyncOnNotifyAPI

Returns:

String as last error message

ClearLastErrorMsg

public void ClearLastErrorMsg()

Description copied from interface: IAsyncOnNotifyAPI

Clear the last error message.

Specified by:

ClearLastErrorMsg in interface IAsyncOnNotifyAPI

IsFatalError

public boolean IsFatalError()

Is the last error a fatal error ?

Specified by:

IsFatalError in interface IAsyncOnNotifyAPI

Returns:

true if fatal error

Login

public int Login(java.lang.String login,
                 java.lang.String pwd)

User Login

Specified by:

Login in interface IAsyncOnNotifyAPI

Parameters:

login - : user identifier

pwd - : user password

Returns:

NO-ERROR if OK, error code else.

Logout

public int Logout()

Description copied from interface: IAsyncOnNotifyAPI

Logout command to IoTize.

Specified by:

Logout in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetCurrentProfileID

public int GetCurrentProfileID()

Get current profile ID

Specified by:

GetCurrentProfileID in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetProfileName

public int GetProfileName(int ID)

Specified by:

GetProfileName in interface IAsyncOnNotifyAPI

StartRefresh

public int StartRefresh()

Enables the data refresh.

Specified by:

StartRefresh in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

StopRefresh

public int StopRefresh()

Disables the data refresh.

Specified by:

StopRefresh in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

RegisterComVar

public int RegisterComVar(int ID,
                          int format,
                          int number,
                          int freq)

Description copied from interface: IAsyncOnNotifyAPI

Register a communication variable.

Specified by:

RegisterComVar in interface IAsyncOnNotifyAPI

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

format - : type of variable ( 1= byte, 2 = 16 bits half word, 3 = 32 bits word).

number - : number of variable (variable is an array if number greater than 1).

freq - : acquisition frequency (0 = no acquisition, 1 = every time, else frequency in 100 ms).

Returns:

NO-ERROR if OK, error code else.

UnRegisterComVar

public int UnRegisterComVar(int ID)

UnRegister a communication variable.

Specified by:

UnRegisterComVar in interface IAsyncOnNotifyAPI

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

Returns:

NO-ERROR if OK, error code else.

UnRegisterAll

public int UnRegisterAll()

UnRegister all communication and HMI variables.

Specified by:

UnRegisterAll in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

RegisterVar

public int RegisterVar(java.lang.String varName,
                       int ID,
                       int index)

Register a variable.

Specified by:

RegisterVar in interface IAsyncOnNotifyAPI

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

index - : index of the HMI variable in the IoTize variable: 0 if only one variable, i if one item of an array, -1 if all the array.

varName - : name of the variable.

Returns:

NO-ERROR if OK, error code else.

UnRegisterVar

public int UnRegisterVar(java.lang.String varName)

UnRegister a variable.

Specified by:

UnRegisterVar in interface IAsyncOnNotifyAPI

Parameters:

varName - : name of the variable.

Returns:

IOTIZE_NO_ERROR if OK, error code else.

SetVar

public int SetVar(int ID,
                  byte[] value)

SetVar

public int SetVar(int ID,
                  java.lang.Integer[] value)

SetVar

public int SetVar(int ID,
                  java.lang.Integer value)

Write a variable to the target.

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

value - : value to be written.

Returns:

iotize error code

SetVar

public int SetVar(int ID,
                  java.lang.String value)

Description copied from interface: IAsyncOnNotifyAPI

Write a variable to the target.

Specified by:

SetVar in interface IAsyncOnNotifyAPI

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

value - : value to be written.

Returns:

NO-ERROR if OK, error code else.

SetArrayVar

public int SetArrayVar(int ID,
                       java.lang.String[] value)

Write a array type variable to the target.

Specified by:

SetArrayVar in interface IAsyncOnNotifyAPI

Parameters:

ID - : IoTize variable identifier as defined by the configuration.

value - : value to be written.

Returns:

NO-ERROR if OK, error code else.

GetVar

public int GetVar(java.lang.String name)

Description copied from interface: IAsyncOnNotifyAPI

Request for a variable value.

Specified by:

GetVar in interface IAsyncOnNotifyAPI

Parameters:

name - : name of the variable.

Returns:

NO-ERROR if OK, error code else.

GetCurrentHostProtocol

public int GetCurrentHostProtocol()

Get the current protocol communication between smartphone and IoTize.

Specified by:

GetCurrentHostProtocol in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetHostProtocols

public int GetHostProtocols()

Retrieve the IoTize host protocols capabilities.

Specified by:

GetHostProtocols in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetTargetProtocols

public int GetTargetProtocols()

Retrieve the IoTize target protocols capabilities.

Specified by:

GetTargetProtocols in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetCurrentTargetProtocol

public int GetCurrentTargetProtocol()

Get the current protocol communication between target and IoTize.

Specified by:

GetCurrentTargetProtocol in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

ConnectTarget

public int ConnectTarget()

Open the communication between IoTize and target board.

Specified by:

ConnectTarget in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

DisconnectTarget

public int DisconnectTarget()

Close the communication between IoTize and target board.

Specified by:

DisconnectTarget in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

ResetTarget

public int ResetTarget()

Description copied from interface: IAsyncOnNotifyAPI

Reset the target board.

Specified by:

ResetTarget in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetTargetName

public int GetTargetName()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the configured target name.

Specified by:

GetTargetName in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetTargetConfigVersion

public int GetTargetConfigVersion()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the target configuration version.

Specified by:

GetTargetConfigVersion in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetTargetFirmwareVersion

public int GetTargetFirmwareVersion()

Retrieve the target firmware version.

Specified by:

GetTargetFirmwareVersion in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

ResetIoTize

public int ResetIoTize()

Description copied from interface: IAsyncOnNotifyAPI

Reboot the IoTize module.

Specified by:

ResetIoTize in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

DatalogRun

public int DatalogRun()

Specified by:

DatalogRun in interface IAsyncOnNotifyAPI

DatalogStop

public int DatalogStop()

Specified by:

DatalogStop in interface IAsyncOnNotifyAPI

GetIoTizeDatalogIsRunning

public int GetIoTizeDatalogIsRunning()

Specified by:

GetIoTizeDatalogIsRunning in interface IAsyncOnNotifyAPI

GetIoTizeErrorCode

public int GetIoTizeErrorCode()

Description copied from interface: IAsyncOnNotifyAPI

Get the IoTized saved error code.

Specified by:

GetIoTizeErrorCode in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

ResetIoTizeErrorCode

public int ResetIoTizeErrorCode()

Description copied from interface: IAsyncOnNotifyAPI

Reset the IoTize saved error code.

Specified by:

ResetIoTizeErrorCode in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetIoTizeSerialNumber

public int GetIoTizeSerialNumber()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the IoTize Serial Number.

Specified by:

GetIoTizeSerialNumber in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetIoTizeLocalPublicPwd

public int GetIoTizeLocalPublicPwd()

Specified by:

GetIoTizeLocalPublicPwd in interface IAsyncOnNotifyAPI

GetIoTizeModuleType

public int GetIoTizeModuleType()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the IoTize module type.

Specified by:

GetIoTizeModuleType in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetIoTizeModuleManufacturer

public int GetIoTizeModuleManufacturer()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the IoTize module manufacturer.

Specified by:

GetIoTizeModuleManufacturer in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetIoTizeFirmwareVersion

public int GetIoTizeFirmwareVersion()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the IoTize firmware version.

Specified by:

GetIoTizeFirmwareVersion in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

GetIoTizeMemoryFree

public int GetIoTizeMemoryFree()

Description copied from interface: IAsyncOnNotifyAPI

Retrieve the IoTize memory free size.

Specified by:

GetIoTizeMemoryFree in interface IAsyncOnNotifyAPI

Returns:

NO-ERROR if OK, error code else.

notifyError

public void notifyError(java.lang.String cmd,
                        int ret)

notifyCommandResult

public void notifyCommandResult(@NonNull
                                Command command,
                                @NonNull
                                Response result,
                                @Nullable
                                BodyConverter decoder,
                                @NonNull
                                java.lang.String methodName,
                                @Nullable
                                java.lang.String variableHMIName)