It is possible to load wrong or corrupted firmware binary to target unit. This library does not validate the binary.

Output o_State should change to Processing when i_Enable is set TRUE. When process is finished (i.e. o_Progress reaches 100%), the o_State output changes back to Idle.

If calling of function block is stopped before o_State changes to Idle, it may lead to missing or faulty target firmware.

Firmware consists of FW binary (FW file) and eTPU binary (eTPU file). The loaded pair must match with each other before they are written to flash memory.

SW protection needs to be unlocked before loading binaries by using UnlockProtectionSSeries (FB).

Control unit reboot is required after FW update. See also Updating Firmware.

Input variable name

Data type

Range

Description

i_Enable

BOOL

Action trigger.

i_pDevice

POINTER TO EPEC_CANopen.Device

Used CANopen device

(e.g. ADR(G_CANopen_CAN1.Device)).

i_NodeID

BYTE

1..127

CODESYS (Runtime) Node ID of target unit.

i_FWFile

STRING(255)

File name and path of firmware file.

i_eTPUFile

STRING(255)

File name and path of eTPU file.

i_UseBlockTransfer

BOOL

Use SDO block transfer which is faster than normal SDO download.

Output variable name

Data type

Range

Description

o_State

ApplicationState

Process state.

o_AbortCode

DWORD

CANopen abort code.

o_Progress

BYTE

0..100

Progress indication value.

Definitions:

VAR

loaderSC52FW: EPEC_SWD.LoadFirmwareSSeries;

fwLoadTrigger: BOOL;

codesysNodeID: BYTE := BYTE#127;

fw_file: STRING(80) := '/opt/user/userapp/FIRMWARE.BIN';

etpu_file: STRING(80) := '/opt/user/userapp/ETPU.BIN';

useBlockTransfer: BOOL := TRUE;

loadingstate: EPEC_SWD.ApplicationState;

abortCode: DWORD;

progress:BYTE;

END_VAR

Code:

loaderSC52FW(

i_Enable := fwLoadTrigger,

i_pDevice := ADR(G_CANopen_CAN1.Device), // From code template

i_NodeID := codesysNodeID,

i_FWFile := fw_file,

i_eTPUFile := etpu_file,

i_UseBlockTransfer := useBlockTransfer,

o_State => loadingstate,

o_AbortCode => abortCode,

o_Progress => progress

);