DataLogService¶

Method	LWM2M request	Description
dequeueOnePacket	GET /datalog/dequeue-packet	Dequeue one packet
flush	POST /datalog/flush	Flush data log packets
getMaxPacketCount	GET /datalog/max-packet-count	Get the maximum number of packet
getOptions	GET /datalog/options	Get data log options
getPacketCount	GET /datalog/packet-count	Get number of pending datalog packet
putCryptoKey	PUT /datalog/crypto-key	Write data log crypto key
putOptions	PUT /datalog/options	Write data log option
run	POST /datalog/run	Run datalog acquisition
stop	POST /datalog/stop	Stop datalog acquisition

dequeueOnePacket¶

byte[] dequeueOnePacket()

Dequeue one packet

Dequeue one packet in the FIFO list (Firt In First Out) of datalog packets

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.dequeueOnePacket();
    let value = (await call).body();
    console.log(`dequeueOnePacket: ${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.DataLogService;

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


try {
    Call<byte[]> call = myService.dequeueOnePacket();
    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 DataLogService#dequeueOnePacket");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

byte[]

Authorization¶

No authorization required

flush¶

flush()

Flush data log packets

Reinitialisation : efface tous les paquets de la mémoire de l'IoTize. Seulement en état Stop ? Stop implicite avant le flush ? Run implicite après le flush ?

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.flush();
    let value = (await call).body();
    console.log(`flush: ${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.DataLogService;

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


try {
    Call<Void> call = myService.flush();
    Response<Void> 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 DataLogService#flush");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

null (empty response body)

Authorization¶

No authorization required

getMaxPacketCount¶

Integer getMaxPacketCount()

Get the maximum number of packet

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.getMaxPacketCount();
    let value = (await call).body();
    console.log(`getMaxPacketCount: ${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.DataLogService;

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


try {
    Call<Integer> call = myService.getMaxPacketCount();
    Response<Integer> 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 DataLogService#getMaxPacketCount");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

Integer

Authorization¶

No authorization required

getOptions¶

DataLogOption getOptions()

Get data log options

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.getOptions();
    let value = (await call).body();
    console.log(`getOptions: ${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.DataLogService;

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


try {
    Call<DataLogOption> call = myService.getOptions();
    Response<DataLogOption> 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 DataLogService#getOptions");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

DataLogOption

Authorization¶

No authorization required

getPacketCount¶

Integer getPacketCount()

Get number of pending datalog packet

Get the number of data log packet available

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.getPacketCount();
    let value = (await call).body();
    console.log(`getPacketCount: ${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.DataLogService;

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


try {
    Call<Integer> call = myService.getPacketCount();
    Response<Integer> 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 DataLogService#getPacketCount");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

Integer

Authorization¶

No authorization required

putCryptoKey¶

putCryptoKey(value)

Write data log crypto key

Hash du password DataLoggin. Utilisé (combiné à d'autres choses) pour crypter le paquet avant de le stocker dans l'OutBox.

Example¶

Typescript

let myService = new DataLogService();
let value = BINARY_DATA_HERE; // byte[] | 

try{
    let call = myService.putCryptoKey(value);
    let value = (await call).body();
    console.log(`putCryptoKey: ${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.DataLogService;

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


byte[] value = BINARY_DATA_HERE; // byte[] | 
try {
    Call<Void> call = myService.putCryptoKey(value);
    Response<Void> 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 DataLogService#putCryptoKey");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
value	byte[](byte[].md)

Return type¶

null (empty response body)

Authorization¶

No authorization required

putOptions¶

putOptions(value)

Write data log option

Example¶

Typescript

let myService = new DataLogService();
let value = new DataLogOption(); // DataLogOption | 

try{
    let call = myService.putOptions(value);
    let value = (await call).body();
    console.log(`putOptions: ${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.DataLogService;

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


DataLogOption value = new DataLogOption(); // DataLogOption | 
try {
    Call<Void> call = myService.putOptions(value);
    Response<Void> 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 DataLogService#putOptions");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
value	DataLogOption(DataLogOption.md)

Return type¶

null (empty response body)

Authorization¶

No authorization required

run¶

run()

Run datalog acquisition

Start data log packet acquisition

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.run();
    let value = (await call).body();
    console.log(`run: ${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.DataLogService;

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


try {
    Call<Void> call = myService.run();
    Response<Void> 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 DataLogService#run");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

null (empty response body)

Authorization¶

No authorization required

stop¶

stop()

Stop datalog acquisition

Stop data log packet acquisition

Example¶

Typescript

let myService = new DataLogService();

try{
    let call = myService.stop();
    let value = (await call).body();
    console.log(`stop: ${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.DataLogService;

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


try {
    Call<Void> call = myService.stop();
    Response<Void> 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 DataLogService#stop");
    e.printStackTrace();
}

Parameters¶

This endpoint does not need any parameter.

Return type¶

null (empty response body)

Authorization¶

No authorization required