Merge pull request #115 from iolinkcommunity/feature/device-fw-update

Feature/device fw update
iolinkcommunity · Nov 20, 2023 · 124743e · 124743e
2 parents 9e2a3f7 + 681d8ce
commit 124743e
Showing 1 changed file with 102 additions and 0 deletions.
diff --git a/JSON_for_IO-Link.yaml b/JSON_for_IO-Link.yaml
@@ -2884,6 +2884,55 @@ paths:
         "500":
           $ref: "#/components/responses/HTTP_500"
 
+  "/devices/{deviceAlias}/fwupdate":
+    get:
+      operationId: GetDevicesDeviceAliasFirmwareUpdateStatus
+      tags:
+        - devices
+      description: Gives the stage and progress of a running firmware update. The active property shows if an update is currently in progress.
+      summary: Gives the stage and progress of a running firmware update. The active property shows if an update is currently in progress.
+      responses:
+        "200":
+          description: >-
+            Gives the stage and progress of a running firmware update. The active property shows if an update is currently in progress.
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/deviceFirmwareUpdateStatusGet"
+        "400": # code 305, 306
+          $ref: "#/components/responses/HTTP_400"
+        "403":
+          $ref: "#/components/responses/HTTP_403"
+        "404":
+          $ref: "#/components/responses/HTTP_404"
+        "500":
+          $ref: "#/components/responses/HTTP_500"
+    post:
+      operationId: PostDevicesDeviceAliasFirmwareUpdate
+      tags:
+        - devices
+      summary: Perform a firmware update for a specific Device with an iolfw-file according to specification IOL-Profile_Firmware-Update_V11_10082_Sep19.
+      description: Perform a firmware update for a specific Device with an iolfw-file according to specification IOL-Profile_Firmware-Update_V11_10082_Sep19.
+      responses:
+        "204":
+          description: >-
+            Successful operation. Device firmware has been updated.
+        "400": # code 107
+          $ref: "#/components/responses/HTTP_400"
+        "403":
+          $ref: "#/components/responses/HTTP_403"
+        "404":
+          $ref: "#/components/responses/HTTP_404"
+        "500":
+          $ref: "#/components/responses/HTTP_500"
+      requestBody:
+        required: true
+        description: The firmware update file in iolfw format. The file must be provided as a multipart/form-data request including the `filename` as header parameter (see RFC7578).
+        content:
+          multipart/form-data:
+            schema:
+              $ref: "#/components/schemas/deviceFirmwareUpdatePost"
+
 components:
   schemas:
     artifact:
@@ -3357,6 +3406,52 @@ components:
                 $ref: "#/components/schemas/deviceParameterValueGetPost"
               iolinkError:
                 $ref: "#/components/schemas/iolinkErrorObject"
+    deviceFirmwareUpdatePost:
+      type: object
+      properties:
+        password:
+          type: string
+          description: password for updating the device if required
+        iolfwfile:
+          type: string
+          format: binary
+          description: IOLFW File for the device
+      required:
+        - iolfwfile
+    deviceFirmwareUpdateStatusGet:
+      type: object
+      properties:
+        active:
+          type: boolean
+          description: >-
+            Indicates if a firmware update is currently in progress.
+        stage:
+          type: string
+          description: >-
+            Indicates the current stage of the firmware update.
+          enum:
+            - PREPARATION
+            - DOWNLOAD
+            - VALIDATION
+            - UPDATE
+            - FINISHED
+        message:
+          type: string
+          description: >-
+            Status message according to BLOB Transfer & Firmware Update Specification Version 1.1 September 2019  (Table 19 – Error displays of FW-Update tools).
+          example: Selected file is not a firmware update file
+        action:
+          type: string
+          description: >-
+            Indicates the action to be taken by the user according to BLOB Transfer & Firmware Update Specification Version 1.1 September 2019  (Table 19 – Error displays of FW-Update tools).
+          example: Look for a file with extension .iolfw
+        progress:
+          type: number
+          description: >-
+            Indicates the progress of the firmware update in percent.
+          minimum: 0
+          maximum: 100
+
     deviceEventsGet:
       type: array
       items:
@@ -5219,6 +5314,11 @@ components:
               value:
                 code: 104
                 message: Action locked by another client
+            "107":
+              description: Error during device firmware update
+              value:
+                code: 107
+                message: Read /devices/{deviceAlias}/fwupdate to get more information about the status.
             "201":
               description: Error while parsing the incoming JSON object
               value:
@@ -5417,6 +5517,7 @@ components:
               value:
                 code: 106
                 message: MQTT feature not supported
+
     HTTP_503:
       description: Service unavailable
       content:
@@ -5529,3 +5630,4 @@ components:
               "2477": false
               "2478": false                    
 
+