System

This module implements system wide operations

Handwritten Documentation

This module implements system wide operations.

Currently this includes the following commands:

  • Log Uploads

  • Firmware Updates

  • Setting of System time

Corresponding variables signal the state of Log Uploads and Firmware Updates.

Integration in EVerest

This module provides implementation for the system interface. It does not require any other modules.

Connect the optional store requirement to a persistent key-value store to preserve the boot reason across resets: FirmwareUpdate for both signed and unsigned firmware updates, ScheduledReset for a reset with scheduled set (OCPP OnIdle, after the transactions ended) and RemoteReset for any other reset. Without a store, the boot reason is always PowerUp. Post-boot Installed reporting applies only to signed firmware updates. With ResetAfterUpdate enabled and a store connected, System publishes InstallRebooting before resetting and Installed with the original request ID when the stack starts again. Without a store, it publishes only Installed before resetting. With ResetAfterUpdate disabled, it publishes Installed without resetting.

Whether an update takes the connectors out of service is controlled per update through firmware_update_metadata.disable_connectors_during_install; the OCPP side is described in Control Connector Availability During a Firmware Update. System reads the flag from the update itself:

  • Unsigned update: append the flag as a fragment to the firmware location the CSMS sends, for example https://updates.example.com/images.pnx#disable_connectors_during_install=false. System strips the fragment before downloading and attaches the flag to every status of that update.

  • Signed update: put the flag in the package’s metadata block. System runs signed_firmware_metadata_parser.sh on the downloaded file, which prints the lines between ===== BEGIN METADATA ===== and ===== END METADATA =====, one key=value per line:

    ===== BEGIN METADATA =====
    disable_connectors_during_install=false
    ===== END METADATA =====
    

    The parsed flag is attached to the SignatureVerified status.

System reports InstallScheduled only for a signed update whose installDateTime lies in the future, without the flag, and it does not wait for allow_firmware_installation: its installer scripts are placeholders for a real update mechanism, so the module is meant for software-in-the-loop setups rather than production.

Auto-Generated Reference

Module Configuration

DefaultRetries: number <optional>
default: 1
Specifies how many times Charge Point tries to upload or download files on previous failure.
DefaultRetryInterval: number <optional>
default: 1
Specifies in seconds after which time a retry of an upload or download on previous failure may be attempted.
ResetDelay: integer <optional>
default: 0
When receiving a reset request, then the actual execution can be delayed by this amount of time (given in seconds). This might be necessary, for example, when the reset request arrives via the network and the call acknowledgement should be given some time to travel the return path to the caller. Defaults to zero, which means that the reset is executed directly without delay.
ResetAfterUpdate: boolean <optional>
default: True
Whether the System module triggers a device reset after a firmware update has been installed. Defaults to true. Set to false to keep the device running after install (e.g. for updates that keep connectors available and must not interrupt ongoing sessions).

Provides

main: system
Implements the system interface

Requirements

store: kvs 0..1

Metadata

Authors

Piet Gömpel

License