Log Status Notification

Source: OCPP 2.0.1 Part 2 — Specification (Edition 2, 2022-12-15) — Section 1.31 (Messages); Use Case N01 — Retrieve Log Information (Functional Block N. Diagnostics)

Overview

The Charging Station sends LogStatusNotificationRequest to inform the CSMS about the progress of a log file upload that was started by GetLogRequest. The CS sends one or more notifications during the upload — typically Uploading when the transfer begins, then Uploaded on success or one of the failure values otherwise.

Every LogStatusNotificationRequest for a specific upload SHALL contain the same requestId as the originating GetLogRequest. requestId is mandatory unless the message was triggered by TriggerMessageRequest AND there is no log upload ongoing — in that case the CS sends status = Idle without a requestId.

Sequence Diagram

Charging Station  ──── LogStatusNotificationRequest ────▶  CSMS
                       (status, requestId?)
Charging Station  ◀─── LogStatusNotificationResponse ────  CSMS

Initiator

Charging Station → CSMS

Fields

UploadLogStatusEnumType values

• BadMessage — A badly formatted packet or other protocol incompatibility was detected.
• Idle — No log upload ongoing. SHALL only be used when triggered by TriggerMessage.
• NotSupportedOperation — The server does not support the operation.
• PermissionDenied — Insufficient permissions to perform the operation.
• Uploaded — File has been uploaded successfully.
• UploadFailure — Failed to upload the requested file.
• Uploading — File is being uploaded.
• AcceptedCanceled — Accepted but canceled an ongoing upload.

Examples

{
  "status": "Uploading",
  "requestId": 123
}

{
  "status": "Idle"
}

{}

Schema

Source: schemas/LogStatusNotificationRequest.json, schemas/LogStatusNotificationResponse.json (OCPP 2.0.1 FINAL)