TapNLinkSys

```
public interface TapNLinkSys
```
Main interface for TapNLink system functions. In order to use these, simply declare a TapNLinkSys variable within the main class of the java program (no constructor involved)
```
 Example:
      TapNLinkSys system;
      int time = system.getTimeMsSinceReset();
 
```

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BYTECODEVERSION`
`static int`	`DELETE`
`static int`	`GET`
`static int`	`MAXVERSION`
`static int`	`MINVERSION`
`static int`	`MQTT_MSG_IN`
`static int`	`POST`
`static int`	`PUT`
`static int`	`TAPVERSION`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`int`	`connectMQTT(java.lang.String subscribedTopic)` Deprecated.
`int[]`	`convertTime(long timestamp)` Convert time stamp to standard C tm set of values.
`int`	`engineCommand(int cmd, int obj, int instance, int resource, byte[] payload)` Sends a command to the tap, using its object based resource API.
`int`	`engineCommand(int cmd, int obj, int instance, int resource, java.lang.Integer length, byte[] payloadin, byte[] payloadout)`
`int`	`getFreeHeap()` Determine the amount of available memory Version: +1.97
`double`	`getRandom()` Build a random number
`int`	`getSleepDelay()` Returns the current period of time in second for the low power mode (duration of the timeout to leave the Low Power mode).
`int`	`getTimeMsSinceReset()` Returns time since last boot of the Tap, in milliseconds.
`long`	`getTimeStamp()` Returns time since 1st January 1970, in seconds.
`int`	`getVersion(int ver)` Returns version numbers of the Tap or the JVM.
`int`	`initLoRaWAN(int active_region, int default_class, boolean adr_enable, int default_datarate, int ping_periodicity)` Init for LoRaWAN communications (LoRa Tap only) Version: +1.116
`int`	`joinLoRaWAN_ABP(byte[] DevAddr, byte[] AppSKey, byte[] NwkSKey)` Join LoRaWAN network using ABP method Version: +2.10
`int`	`joinLoRaWAN_OTAA(byte[] JoinEUI, byte[] AppKey, byte[] NwkKey)` Join LoRaWAN network using OTAA method Version: +1.116
`void`	`log(java.lang.String msg, int mode)` Log information so it can be retrieved by IoTize Studio, or custom apps.
`void`	`pause(int ms)` Pause the Java thread for a given amount of time.
`java.lang.String`	`readMQTTMessage()` Deprecated. Read a recently received MQTT message. A message is available when the check() function has been notified with the id TapNLinkSys.MQTT_MSG_IN (-2).
`void`	`resetJVM()` Reset the Java Virtual Machine without resetting the Tap Version: +1.114
`void`	`resetLoRa()` Reset the LoRa without resetting the Tap Version: +2.10
`int`	`sendLoRaWANMessage(int port, byte[] msg, int len)` Send a LoRaWAN message (LoRa Tap only) Version: +1.114
`int`	`sendMQTTMessage(java.lang.String topic, java.lang.String msg, int qos)` Deprecated.
`void`	`setHeapSize(int size)` Specify the size of the dynamic heap.
`void`	`setSleepDelay(int newdelay)` Set the current period of time in second for the low power mode (duration of the timeout to leave the Low Power mode).
`void`	`setTimeStamp(long timestamp)` Set time (since 1st January 1970, in seconds).
`int`	`startBLE()` Starts the BLE of the Tap.
`int`	`startWifi()` Starts the Wifi of the Tap.
`int`	`stopBLE()` Stops the BLE of the Tap.
`int`	`stopWifi()` Stops the Wifi of the Tap.
`int`	`subscribeMQTT(java.lang.String subscribedTopic)` Deprecated.

- Field Detail
  - GET
```
static final int GET
```
    See Also:
    
    Constant Field Values
  - POST
```
static final int POST
```
    See Also:
    
    Constant Field Values
  - PUT
```
static final int PUT
```
    See Also:
    
    Constant Field Values
  - DELETE
```
static final int DELETE
```
    See Also:
    
    Constant Field Values
  - TAPVERSION
```
static final int TAPVERSION
```
    See Also:
    
    Constant Field Values
  - BYTECODEVERSION
```
static final int BYTECODEVERSION
```
    See Also:
    
    Constant Field Values
  - MINVERSION
```
static final int MINVERSION
```
    See Also:
    
    Constant Field Values
  - MAXVERSION
```
static final int MAXVERSION
```
    See Also:
    
    Constant Field Values
  - MQTT_MSG_IN
```
static final int MQTT_MSG_IN
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getTimeMsSinceReset
```
int getTimeMsSinceReset()
```
    Returns time since last boot of the Tap, in milliseconds.
    
    Returns:
    
    time since last boot
  - getTimeStamp
```
long getTimeStamp()
```
    Returns time since 1st January 1970, in seconds.
    
    Returns:
    
    time since last boot
  - setTimeStamp
```
void setTimeStamp(long timestamp)
```
    Set time (since 1st January 1970, in seconds). Managed by SNTP when SNTP is running.
  - convertTime
```
int[] convertTime(long timestamp)
```
    Convert time stamp to standard C tm set of values. int0: tm_sec seconds after the minute 0-60 int1: tm_min minutes after the hour 0-59 int2: tm_hour hours since midnight 0-23 int3: tm_mday day of the month 1-31 int4: tm_mon months since January 0-11 int5: tm_year years since 1900 int6: tm_wday days since Sunday 0-6 int7: tm_yday days since January 1 0-365 int8: tm_isdst Daylight Saving Time flag
    
    Returns:
    
    time since last boot
  - pause
```
void pause(int ms)
```
    Pause the Java thread for a given amount of time. Calling this method will stop all Java code execution. It will only resume after the given time has passed. Other Tap features are still available during this time.
    
    Parameters:
    
    ms - the amount of time the thread of the JVM will NOT be called (in milliseconds).
  - connectMQTT
```
@Deprecated
int connectMQTT(java.lang.String subscribedTopic)
```
    Deprecated.
    
    Connect to the auxiliary 'Cloud' broker. If this function is not called, sendMQTTMessage will use the primary 'Relay' broker. The subscribedTopic is optional and must be used when we need to be notified that a potential incoming command exists. Keep subscribedTopic as NULL if you don"t intend to receive command.
    
    Parameters:
    
    topic - the MQTT topic to subscribe to
    
    Returns:
    
    1 if connected, other values when not.
  - subscribeMQTT
```
@Deprecated
int subscribeMQTT(java.lang.String subscribedTopic)
```
    Deprecated.
    
    Subscribe to a specific topic. If this function is not called, sendMQTTMessage will use the primary 'Relay' broker. The subscribedTopic is optional and must be used when we need to be notified that a potential incoming command exists. Keep subscribedTopic as NULL if you don"t intend to receive command.
    
    Parameters:
    
    topic - the MQTT topic to subscribe to
    
    Returns:
    
    1 if ok, other values when not.
  - sendMQTTMessage
```
@Deprecated
int sendMQTTMessage(java.lang.String topic,
                                 java.lang.String msg,
                                 int qos)
```
    Deprecated.
    Publishes a new MQTT message on the given topic. The tap needs to be configured with proper MQTT broker and credentials. The Quality of Service corresponds to the MQTT standard QoS codes:
    - At most once (0)
    - At least once (1)
    - Exactly once (2)
    Note that if the Tap is not connected to the broker, messages with QoS equal to 0 will be dropped. Messages with QoS of 1 or 2 will be enqueued until the Tap connects to the MQTT broker.
    Parameters:
    
    topic - the MQTT topic to publish to
    
    msg - the message to be published
    
    qos - the quality of service required for the message (0, 1 or 2)
    
    Returns:
    
    0 on success, -1 on failure
  - readMQTTMessage
```
@Deprecated
java.lang.String readMQTTMessage()
```
    Deprecated. Read a recently received MQTT message. A message is available when the check() function has been notified with the id TapNLinkSys.MQTT_MSG_IN (-2).
    
    Returns:
    
    last received string
  - engineCommand
```
int engineCommand(int cmd,
                  int obj,
                  int instance,
                  int resource,
                  byte[] payload)
```
    Sends a command to the tap, using its object based resource API. Resources can be accessed through LWM2M-like requests, with:
    - a request method: GET, POST, PUT or CREATE
    - an object id: 3 for the "device" object, 1029 for the "variable" object, etc
    - an instance id: the variable id on "variable" object, bundle id on "bundle", etc. 0 otherwise
    - the resource id
    Incoming and outcoming data are passed through the payload byte array. This returns a one byte result code, corresponding to the request status or its error code. You will find every available command and every result code on the IoTize Application Development Center.
    Parameters:
    
    cmd - the method of the command
    
    obj - the id of the object
    
    instance - the id of the instance
    
    resource - the id of the resource
    
    payload - the single I/O buffer (either for GET or PUT)
    
    length - the length of the answer buffer
    
    payloadin - the Input buffer (used when GET required parameters)
    
    payloadout - the answer buffer
    
    Returns:
    
    the result code of the method
    
    See Also:
    
    IoTize Application Development Center
  - engineCommand
```
int engineCommand(int cmd,
                  int obj,
                  int instance,
                  int resource,
                  java.lang.Integer length,
                  byte[] payloadin,
                  byte[] payloadout)
```
  - getVersion
```
int getVersion(int ver)
```
    Returns version numbers of the Tap or the JVM. The version number that is retrieved depends on the value given as@parameter:
    - TapNLinkSys.TAPVERSION: Returns the firmware version of the current tap
    - TapNLinkSys.BYTECODEVERSION: Returns the version of the current bytecode
    - TapNLinkSys.MINVERSION: Returns the minimum version of the Tap required by the current code
    - TapNLinkSys.MAXVERSION:
    Parameters:
    
    ver - the id of the version to get
    
    Returns:
    
    the specified version
  - getSleepDelay
```
int getSleepDelay()
```
    Returns the current period of time in second for the low power mode (duration of the timeout to leave the Low Power mode).
    
    Returns:
    
    duration in second
  - setSleepDelay
```
void setSleepDelay(int newdelay)
```
    Set the current period of time in second for the low power mode (duration of the timeout to leave the Low Power mode). The duration will NOT be store in no volatile memory and lost at the next reset (wake up).
    
    Parameters:
    
    newdelay - delay to be specified in seconds
  - setHeapSize
```
void setHeapSize(int size)
```
    Specify the size of the dynamic heap. This method must be called ONLY FROM THE CONSTRUCTOR. It will be inoperant while executing check(). Default value is 4096 bytes. Version: +1.97
    
    Parameters:
    
    size - size in bytes
  - getFreeHeap
```
int getFreeHeap()
```
    Determine the amount of available memory Version: +1.97
    
    Returns:
    
    size in bytes
  - sendLoRaWANMessage
```
int sendLoRaWANMessage(int port,
                       byte[] msg,
                       int len)
```
    Send a LoRaWAN message (LoRa Tap only) Version: +1.114
    
    Parameters:
    
    port - LoRaWAN FPort to send the payload to.
    
    msg - Payload to send.
    
    len - Size of the payload (bytes).
    
    Returns:
    
    0 when no error, error code else
  - initLoRaWAN
```
int initLoRaWAN(int active_region,
                int default_class,
                boolean adr_enable,
                int default_datarate,
                int ping_periodicity)
```
    Init for LoRaWAN communications (LoRa Tap only) Version: +1.116
    
    Parameters:
    
    active_region - Active Region - For now, only EU868 and US815 are available [AS923 = 0, AU915 = 1, CN470 = 2, CN779 = 3, EU433 = 4, EU868 = 5, KR920 = 6, IN865 = 7, US915 = 8, RU864 = 9]
    
    default_class - Default Class [CLASS_A = 0x00, CLASS_B = 0x01, CLASS_C = 0x02]
    
    adr_enable - Holds the ADR state
    
    default_datarate - Uplink datarate, when adr_enable is OFF
    
    ping_periodicity - Periodicity of the ping slots
    
    Returns:
    
    0 when no error, error code else
  - joinLoRaWAN_OTAA
```
int joinLoRaWAN_OTAA(byte[] JoinEUI,
                     byte[] AppKey,
                     byte[] NwkKey)
```
    Join LoRaWAN network using OTAA method Version: +1.116
    
    Parameters:
    
    JoinEUI - LORAWAN_JOIN_EUI/8 bytes (LORAWAN_APP_EUI for LoRaWAN 1.0.x)
    
    AppKey - LORAWAN_APP_KEY/16 bytes (N/A for LoRaWAN 1.0.x)
    
    NwkKey - LORAWAN_NWK_KEY/16 bytes (LORAWAN_APP_KEY for LoRaWAN 1.0.x)
    
    Returns:
    
    0 when no error, error code else
  - joinLoRaWAN_ABP
```
int joinLoRaWAN_ABP(byte[] DevAddr,
                    byte[] AppSKey,
                    byte[] NwkSKey)
```
    Join LoRaWAN network using ABP method Version: +2.10
    
    Parameters:
    
    DevAddr - Device Address/4 bytes
    
    AppSKey - LORAWAN_APP_S_KEY/16 bytes (LORAWAN_APP_S_KEY for LoRaWAN 1.0.x)
    
    NwkSKey - LORAWAN_NWK_S_KEY/16 bytes for LoRaWAN 1.0.x (LORAWAN_F_NWK_S_INT_KEY/LORAWAN_S_NWK_S_INT_KEY/LORAWAN_NWK_S_ENC_KEY for LoRaWAN 1.1.x)
    
    Returns:
    
    0 when no error, error code else
  - resetLoRa
```
void resetLoRa()
```
    Reset the LoRa without resetting the Tap Version: +2.10
  - resetJVM
```
void resetJVM()
```
    Reset the Java Virtual Machine without resetting the Tap Version: +1.114
  - startWifi
```
int startWifi()
```
    Starts the Wifi of the Tap. Use in conjunction with stopWifi to control the Wifi signal (e.g. due to RF emissions or energy consumption). Version: +2.10
  - stopWifi
```
int stopWifi()
```
    Stops the Wifi of the Tap. Use in conjunction with startWifi to control the Wifi signal (e.g. due to RF emissions or energy consumption). Version: +2.10
  - startBLE
```
int startBLE()
```
    Starts the BLE of the Tap. Use in conjunction with stopWifi to control the BLE signal (e.g. due to RF emissions or energy consumption). Version: +2.10
  - stopBLE
```
int stopBLE()
```
    Stops the BLE of the Tap. Use in conjunction with startWifi to control the BLE signal (e.g. due to RF emissions or energy consumption). Version: +2.10
  - log
```
void log(java.lang.String msg,
         int mode)
```
    Log information so it can be retrieved by IoTize Studio, or custom apps.
    
    Parameters:
    
    msg - The String to log (up to 200 chars)
    
    mode - 0 to add to th current logged message, 1 to replace it
  - getRandom
```
double getRandom()
```
    Build a random number
    
    Returns:
    
    random number in the range [ 0, 1.0 [

Interface TapNLinkSys

Field Summary

Method Summary

Field Detail

GET

POST

PUT

DELETE

TAPVERSION

BYTECODEVERSION

MINVERSION

MAXVERSION

MQTT_MSG_IN

Method Detail

getTimeMsSinceReset

getTimeStamp

setTimeStamp

convertTime

pause

connectMQTT

subscribeMQTT

sendMQTTMessage

readMQTTMessage

engineCommand

engineCommand

getVersion

getSleepDelay

setSleepDelay

setHeapSize

getFreeHeap

sendLoRaWANMessage

initLoRaWAN

joinLoRaWAN_OTAA

joinLoRaWAN_ABP

resetLoRa

resetJVM

startWifi

stopWifi

startBLE

stopBLE

log

getRandom