IAsyncOnNotifyAPI (iotize-device - Version unspecified)

All Known Implementing Classes:

AsyncOnNotifyAPI
```
public interface IAsyncOnNotifyAPI
```

Method Summary

All Methods Instance Methods Abstract Methods
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 the ID of the current profile.
`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 ID, java.lang.String Pwd)` Login command to IoTize.
`int`	`Logout()` Logout command to IoTize.
`int`	`RegisterComVar(int ID, int format, int number, int freq)` Register a communication variable.
`int`	`RegisterVar(java.lang.String name, 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.
`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 name)` UnRegister a variable.

- Method Detail
  - GetIoTizeLocalPublicPwd
```
int GetIoTizeLocalPublicPwd()
```
  - GetProfileName
```
int GetProfileName(int ID)
```
  - DatalogRun
```
int DatalogRun()
```
  - DatalogStop
```
int DatalogStop()
```
  - GetIoTizeDatalogIsRunning
```
int GetIoTizeDatalogIsRunning()
```
  - stopMonitoring
```
void stopMonitoring()
```
    Stop monitoring (this will stop refresh and variable acquisition)
  - startMonitoring
```
void startMonitoring()
```
    Start monitoring (this will start refresh and variable acquisition)
  - ShowToast
```
int ShowToast(java.lang.String toast)
```
    Show a toast from the web page.
    
    Parameters:
    
    toast - String to display.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - IsConnected
```
int IsConnected()
```
    Check if IoTize connected to smartphone.
    
    Returns:
    
    1 if connected, else 0.
  - GetLastErrorMsg
```
java.lang.String GetLastErrorMsg()
```
    Get the last error message encountered.
    
    Returns:
    
    String as last error message
  - ClearLastErrorMsg
```
void ClearLastErrorMsg()
```
    Clear the last error message.
  - IsFatalError
```
boolean IsFatalError()
```
    Is the last error a fatal error ?
    
    Returns:
    
    true if fatal error
  - Login
```
int Login(java.lang.String ID,
          java.lang.String Pwd)
```
    Login command to IoTize.
    
    Parameters:
    
    ID - : user identifier.
    
    Pwd - : user password.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - Logout
```
int Logout()
```
    Logout command to IoTize.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetCurrentProfileID
```
int GetCurrentProfileID()
```
    Get the ID of the current profile.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - StartRefresh
```
int StartRefresh()
```
    Enables the data refresh.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - StopRefresh
```
int StopRefresh()
```
    Disables the data refresh.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - RegisterComVar
```
int RegisterComVar(int ID,
                   int format,
                   int number,
                   int freq)
```
    Register a communication variable.
    
    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
```
int UnRegisterComVar(int ID)
```
    UnRegister a communication variable.
    
    Parameters:
    
    ID - : IoTize variable identifier as defined by the configuration.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - UnRegisterAll
```
int UnRegisterAll()
```
    UnRegister all communication and HMI variables.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - RegisterVar
```
int RegisterVar(java.lang.String name,
                int ID,
                int index)
```
    Register a variable.
    
    Parameters:
    
    name - : name of the variable.
    
    ID - : IoTize variable identifier as defined by the configuration.
    
    index - : index of the HMI variable in the IoTize variable.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - UnRegisterVar
```
int UnRegisterVar(java.lang.String name)
```
    UnRegister a variable.
    
    Parameters:
    
    name - : name of the variable.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - SetVar
```
int SetVar(int ID,
           java.lang.String value)
```
    Write a variable to the target.
    
    Parameters:
    
    ID - : IoTize variable identifier as defined by the configuration.
    
    value - : value to be written.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - SetArrayVar
```
int SetArrayVar(int ID,
                java.lang.String[] value)
```
    Write a array type variable to the target.
    
    Parameters:
    
    ID - : IoTize variable identifier as defined by the configuration.
    
    value - : values array to be written.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetVar
```
int GetVar(java.lang.String name)
```
    Request for a variable value.
    
    Parameters:
    
    name - : name of the variable.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetCurrentHostProtocol
```
int GetCurrentHostProtocol()
```
    Get the current protocol communication between smartphone and IoTize.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetHostProtocols
```
int GetHostProtocols()
```
    Retrieve the IoTize host protocols capabilities.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetTargetProtocols
```
int GetTargetProtocols()
```
    Retrieve the IoTize target protocols capabilities.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetCurrentTargetProtocol
```
int GetCurrentTargetProtocol()
```
    Get the current protocol communication between target and IoTize.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - ConnectTarget
```
int ConnectTarget()
```
    Open the communication between IoTize and target board.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - DisconnectTarget
```
int DisconnectTarget()
```
    Close the communication between IoTize and target board.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - ResetTarget
```
int ResetTarget()
```
    Reset the target board.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetTargetName
```
int GetTargetName()
```
    Retrieve the configured target name.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetTargetConfigVersion
```
int GetTargetConfigVersion()
```
    Retrieve the target configuration version.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetTargetFirmwareVersion
```
int GetTargetFirmwareVersion()
```
    Retrieve the target firmware version.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - ResetIoTize
```
int ResetIoTize()
```
    Reboot the IoTize module.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeErrorCode
```
int GetIoTizeErrorCode()
```
    Get the IoTized saved error code.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - ResetIoTizeErrorCode
```
int ResetIoTizeErrorCode()
```
    Reset the IoTize saved error code.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeSerialNumber
```
int GetIoTizeSerialNumber()
```
    Retrieve the IoTize Serial Number.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeModuleType
```
int GetIoTizeModuleType()
```
    Retrieve the IoTize module type.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeModuleManufacturer
```
int GetIoTizeModuleManufacturer()
```
    Retrieve the IoTize module manufacturer.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeFirmwareVersion
```
int GetIoTizeFirmwareVersion()
```
    Retrieve the IoTize firmware version.
    
    Returns:
    
    NO-ERROR if OK, error code else.
  - GetIoTizeMemoryFree
```
int GetIoTizeMemoryFree()
```
    Retrieve the IoTize memory free size.
    
    Returns:
    
    NO-ERROR if OK, error code else.

Interface IAsyncOnNotifyAPI

Method Summary

Method Detail

GetIoTizeLocalPublicPwd

GetProfileName

DatalogRun

DatalogStop

GetIoTizeDatalogIsRunning

stopMonitoring

startMonitoring

ShowToast

IsConnected

GetLastErrorMsg

ClearLastErrorMsg

IsFatalError

Login

Logout

GetCurrentProfileID

StartRefresh

StopRefresh

RegisterComVar

UnRegisterComVar

UnRegisterAll

RegisterVar

UnRegisterVar

SetVar

SetArrayVar

GetVar

GetCurrentHostProtocol

GetHostProtocols

GetTargetProtocols

GetCurrentTargetProtocol

ConnectTarget

DisconnectTarget

ResetTarget

GetTargetName

GetTargetConfigVersion

GetTargetFirmwareVersion

ResetIoTize

GetIoTizeErrorCode

ResetIoTizeErrorCode

GetIoTizeSerialNumber

GetIoTizeModuleType

GetIoTizeModuleManufacturer

GetIoTizeFirmwareVersion

GetIoTizeMemoryFree