FirmwareService¶

Method	LWM2M request	Description
getState	GET /firmware/state	Get state
getUpdateResult	GET /firmware/update-result	Get firmware update result
postCrcCheck	POST /firmware/crc-check	Check CRC
postPackage	POST /firmware/package	Firmware package
postUpdate	POST /firmware/update	Update

getState¶

FirmwareState getState()

Get state

Example¶

Typescript

let myService = new FirmwareService();

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

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


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

Parameters¶

This endpoint does not need any parameter.

Return type¶

FirmwareState

Authorization¶

No authorization required

getUpdateResult¶

FirmwareUpdateResult getUpdateResult()

Get firmware update result

Example¶

Typescript

let myService = new FirmwareService();

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

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


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

Parameters¶

This endpoint does not need any parameter.

Return type¶

FirmwareUpdateResult

Authorization¶

No authorization required

postCrcCheck¶

Integer postCrcCheck(address, size, crcExpected)

Check CRC

Compare le CRC attendu au CRC de la zone référencée. Modifie le Update Result (resource /5//5) à 1 si OK ou 5 si NG.

Example¶

Typescript

let myService = new FirmwareService();
let address = 56; // Integer | 
let size = 56; // Integer | 
let crcExpected = 56; // Integer | 

try{
    let call = myService.postCrcCheck(address, size, crcExpected);
    let value = (await call).body();
    console.log(`postCrcCheck: ${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.FirmwareService;

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


Integer address = 56; // Integer | 
Integer size = 56; // Integer | 
Integer crcExpected = 56; // Integer | 
try {
    Call<Integer> call = myService.postCrcCheck(address, size, crcExpected);
    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 FirmwareService#postCrcCheck");
    e.printStackTrace();
}

Parameters¶

Name	Type	Description	Notes
address	Integer
size	Integer
crcExpected	Integer

Return type¶

Integer

Authorization¶

No authorization required

postPackage¶

postPackage()

Firmware package

Firmware package : actif uniquement en mode update. Permet de transférer les données à programmer en flash pour l'update firmware.

Example¶

Typescript

let myService = new FirmwareService();

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

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


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

Parameters¶

This endpoint does not need any parameter.

Return type¶

null (empty response body)

Authorization¶

No authorization required

postUpdate¶

postUpdate()

Update

Contrôle de l'update: passage en mode update/updater/normal. Param: état futur souhaité. Actif uniquement si loggé en admin. (plus autres contraintes à définir: CRC check fait, etc.) Peut nécessiter un Reset du module

Example¶

Typescript

let myService = new FirmwareService();

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

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


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

Parameters¶

This endpoint does not need any parameter.

Return type¶

null (empty response body)

Authorization¶

No authorization required