SinglePacketService¶

Method	LWM2M request	Description
bspe	POST /single-packet/bspe	Execute (after validation) a big Single Packet previously sent to the TAP using BSPP.
getInfo	GET /single-packet-store/info	Get information concerning Single Packet Store Status
writePartialSinglePacket	POST /single-packet/part	Send a partial Single Packet to the TAP.
writeSmallSinglePacket	POST /single-packet/write	Send a complete Small Single Packet to the TAP. Size of the packet < 120 bytes

bspe¶

byte[] bspe(data)

Execute (after validation) a big Single Packet previously sent to the TAP using BSPP.

Execute (after validation) a big Single Packet previously sent to the TAP using BSPP. Stored packet is erased after packet is executed. (even if failed to execute) This command contains some control information (size, hash, CRC, salt, etc.) TBD

Example¶

Typescript

let myService = new SinglePacketService();
let data = BINARY_DATA_HERE; // byte[] | 

try{
    let call = myService.bspe(data);
    let value = (await call).body();
    console.log(`bspe: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

Java

import com.iotize.android.device.device.api.service.definition.SinglePacketService;

ServiceFactory serviceFactory = ...;
SinglePacketService myService = serviceFactory.create(SinglePacketService.class);


byte[] data = BINARY_DATA_HERE; // byte[] | 
try {
    Call<byte[]> call = myService.bspe(data);
    Response<byte[]> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling SinglePacketService#bspe");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
data	byte[](byte[].md)		[optional]

Return type¶

byte[]

Authorization¶

No authorization required

getInfo¶

byte[] getInfo()

Get information concerning Single Packet Store Status

Get information concerning Single Packet Store Status : Does this TAP provide the Single Packet Store ? (SPS) Is the store empty, full or halfway ? Details about the the execution of the last executes SP ?

Example¶

Typescript

let myService = new SinglePacketService();

try{
    let call = myService.getInfo();
    let value = (await call).body();
    console.log(`getInfo: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

Java

import com.iotize.android.device.device.api.service.definition.SinglePacketService;

ServiceFactory serviceFactory = ...;
SinglePacketService myService = serviceFactory.create(SinglePacketService.class);


try {
    Call<byte[]> call = myService.getInfo();
    Response<byte[]> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling SinglePacketService#getInfo");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

byte[]

Authorization¶

No authorization required

writePartialSinglePacket¶

byte[] writePartialSinglePacket(data)

Send a partial Single Packet to the TAP.

Size of the packet = 130 bytes : 2 bytes offset, 128 bytes packet part. Stored packet is erased when packet part 0 is received.

Example¶

Typescript

let myService = new SinglePacketService();
let data = BINARY_DATA_HERE; // byte[] | 

try{
    let call = myService.writePartialSinglePacket(data);
    let value = (await call).body();
    console.log(`writePartialSinglePacket: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

Java

import com.iotize.android.device.device.api.service.definition.SinglePacketService;

ServiceFactory serviceFactory = ...;
SinglePacketService myService = serviceFactory.create(SinglePacketService.class);


byte[] data = BINARY_DATA_HERE; // byte[] | 
try {
    Call<byte[]> call = myService.writePartialSinglePacket(data);
    Response<byte[]> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling SinglePacketService#writePartialSinglePacket");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
data	byte[](byte[].md)		[optional]

Return type¶

byte[]

Authorization¶

No authorization required

writeSmallSinglePacket¶

byte[] writeSmallSinglePacket(data)

Send a complete Small Single Packet to the TAP. Size of the packet < 120 bytes

Example¶

Typescript

let myService = new SinglePacketService();
let data = BINARY_DATA_HERE; // byte[] | 

try{
    let call = myService.writeSmallSinglePacket(data);
    let value = (await call).body();
    console.log(`writeSmallSinglePacket: ${value}`);
}
catch (ex){
    // No response from device / response error (ie: device is not connected or request timeout)
    console.error(ex);
}

Java

import com.iotize.android.device.device.api.service.definition.SinglePacketService;

ServiceFactory serviceFactory = ...;
SinglePacketService myService = serviceFactory.create(SinglePacketService.class);


byte[] data = BINARY_DATA_HERE; // byte[] | 
try {
    Call<byte[]> call = myService.writeSmallSinglePacket(data);
    Response<byte[]> response = call.execute();
    if (response.isSuccessful()){
        System.out.println(response.body());
    }
    else{
        System.out.println(DeviceResponseError.createErrorMessage(response));
    }
} catch (ApiException e) {
    System.err.println("Exception when calling SinglePacketService#writeSmallSinglePacket");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
data	byte[](byte[].md)		[optional]

Return type¶

byte[]

Authorization¶

No authorization required