Grid eXchange Fabric Documentation

  Fix This Page

UpdateFirmware

Description

Request for a device to download and install new firmware. The request contains a URL defining the location of the new firmware image. The device should download the firmware from that location.

Response communicates status.

Message definitions

message UpdateFirmwareRequest {
    required string firmwareDomain = 1; // [(nanopb).max_size = 100]; // Servername
    required string firmwareUrl = 2; // [(nanopb).max_size = 255]; // /firmware/TSTMAN/TSTMOD/RXX
}

message UpdateFirmwareResponse {
    required Status status = 1;
}

Data types

enum Status {
    OK = 0;
    FAILURE = 1; // general failure
    REJECTED = 2; // request received in wrong state
}

Example

Soap requests and responses sent to and from platform:


   
       LianderNetManagement
       liander gebruiker
       WEB_NET_MANAGEMENT
   
      
      
         
         device-01
         
         TSTMAN/TSTMOD/SSLD-V17         
            
   



   
      
      
                  
            LianderNetManagement|||device-01|||20160104145959438
            device-01            
                  
            
   



   
   LianderNetManagement
   liander gebruiker
   WEB_NET_MANAGEMENT
   
   
      
         
            
            LianderNetManagement|||device-01|||20160104145959438
            
            device-01
         
      
   



   
   
      
         OK
      
   

OSLP UpdateFirmwareRequest sent to 'device-01' to update firmware:

updateFirmwareRequest {
  firmwareDomain: "flexovltest.cloudapp.net"
  firmwareUrl: "/firmware/TSTMAN/TSTMOD/SSLD-V17.hex"
}

OSLP UpdateFirmwareResponse sent to the platform:

updateFirmwareResponse {
  status: OK
}