IOF_SER_DRIVE_BackupEx

VAR_INPUT

VAR_INPUT
    bCheck          : BOOL;
    bBackup         : BOOL;
    bRestore        : BOOL;
    bCRCEnable      : BOOL;
    bStdBackupList  : BOOL     := TRUE;
    bUserBackupList : BOOL;
    sNetId          : T_AmsNetId;
    nPort           : UINT;
    sComment        : T_MaxString;
    ePath           : E_OpenPath := PATH_BOOTPATH;
    sPathName       : T_MaxString := 'DRIVEPAR.BIN';
    tTimeout        : TIME := DEFAULT_ADS_TIMEOUT;
    bIgnoreParamErr : BOOL;
END_VAR

bCheck: The check by CRC and checksum is activated by a rising edge at this input. CRC and checksum are saved persistently and in the IDN142 parameter after a backup or a restore. bCheckOK is set to TRUE if the value from the IDN142 parameter matches the persistent data, otherwise bCheckOK is set to FALSE.

bBackup: the backup is activated by a rising edge at this input.

bRestore: the restore is activated by a rising edge at this input.

bCRCEnable: The CRC16-CCITT and the 16-bit checksum are activated via bCRCEnable = TRUE. The CRC and the checksum are saved in the IDN142 parameter if bCRCEnable = TRUE.

bStdBackupList: determines which parameter list is used for the backup. By default IDN192 (bStdBackupList = TRUE) is used for the backup. If bStdBackupList = FALSE, the list of all parameters, IDN017, is used. Restore requires a backup file created with the IDN192 list.

bUserBackupList: Determines whether a user-defined parameter list, arrList, is used for the backup. By default IDN192 (bStdBackupList = TRUE) is used for the backup. arrList is used if bStdBackupList = FALSE and bUserBackupList = TRUE. Restore requires a backup file created with the IDN192 list or a user-defined parameter list.

sNetId: The network address of the TwinCAT computer on which the ADS command is to be executed can be entered here (type: T_AmsNetId). If it is to be run on the local computer, an empty string can be entered.

nIDN: contains the Sercos parameter number to be accessed for writing. nIDN must lie between 0 and 32767 for S-parameters and between 32768 and 65535 for P-parameters.

nPort: The port number nPort is assigned by the TwinCAT system during the hardware configuration.

sComment: A comment that is written in the file header of the backup file (type: T_MaxString).

ePath: Determines the path of the backup file (type: E_OpenPath). If ePath = PATH_BOOTPATH, the TwinCAT boot path is taken. If ePath = PATH_GENERIC, the path specified in sPathName is taken.

sPathName: Contains the file name (if using the boot path) or the complete path and file name if using the generic path (type: T_MaxString).

tTimeout: States the length of the timeout that may not be exceeded during execution of the command.

bIgnoreParamErr: Determines whether the backup/restore is to be continued or cancelled in case of parameter reading or writing errors. By default the process is cancelled in case of error (bIgnoreParamErr = FALSE). If ignoring of errors is activated (bIgnoreParamErr = TRUE), the parameter number and the error numbers are saved in the list of skipped parameters, arrSkippedList.

VAR_IN_OUT

VAR_IN_OUT
    arrList        : ST_SercosParamList;
    arrSkippedList : ST_SercosParamErrList;
END_VAR

arrList: In case of a standard backup via IDN192 (bStdBackupList = TRUE), this list contains the backup parameters from IDN192 after the backup. In case of a user-defined backup (bUserBackupList = TRUE and bStdBackupList = FALSE), this list must contain the list of parameters to be backed up before the backup. If the backup takes place by means of IDN 17 (bStdBackupList = FALSE and bStdBackupList = FALSE), all the parameters listed in IDN 17 will be backed up in arrList. (Typ: ST_SercosParamList).

arrSkippedList: Contains a list of the skipped parameters (the parameter number and the error numbers, type: ST_SercosParamErrList).

See structure definitions below.

VAR_OUTPUT

VAR_OUTPUT
    bBusy          : BOOL;
    bError         : BOOL;
    nErrId         : UDINT;
    bCheckOK       : BOOL;
    iSkippedParams : UINT;
    iHandledParams : UINT;
END_VAR

bBusy: When the function block is activated this output is set. It remains set until a feedback is received.

bError: If an error should occur during the transfer of the command, then this output is set once the bBusy output was reset.

nErrId: Returns the ADS error number or the specific function block error number if the ERR output is set.

bCheckOk: TRUE if the checksum test was successful.

iSkippedParams: Contains the number of skipped parameters (see arrSkippedList) if ignoring of parameter errors was active (bIgnoreParamErr = TRUE).

iHandledParams: Contains the number of the successfully backed up/restored parameters.

Requirements