Supported platforms: CODESYS 3.5, CODESYS 3.5 SAFETY
Enumeration for software download state and possible errors.
|
Name of the Member |
Value |
Description |
|
Idle |
0 |
Idle |
|
Processing |
1 |
Processing |
|
LoginFailed |
-1 |
Login failed |
|
FileHandlingFailed |
-2 |
File handling failed |
|
DownloadFailed |
-3 |
Download failed |
|
StartFailed |
-4 |
Start failed |
|
StopFailed |
-5 |
Stop failed |
|
FlashFailed |
-6 |
Flash failed |
|
SendingFileFailed |
-7 |
Sending file failed |
|
ReceivingFileFailed |
-8 |
Receiving file failed |
|
LogoutFailed |
-9 |
Logout failed |
|
Timeout |
-10 |
Timeout |
|
CheckLoginReplyFailed |
-11 |
Check login reply failed |
|
CheckDownloadReplyFailed |
-12 |
Check download reply failed |
|
CheckFlashReplyFailed |
-13 |
Check flash reply failed |
|
CheckFileTxReplyFailed |
-14 |
Check file sending failed |
|
CheckFileRxReplyFailed |
-15 |
Check file receiving failed |
|
CheckLogoutReplyFailed |
-16 |
Check logout reply failed |
|
SDOChannelReserveFailed |
-17 |
SDO channel reserve failed |
|
SDOChannelReleaseFailed |
-18 |
SDO channel release failed |
|
GenericError |
-19 |
Generic error |
|
ClearFailed |
-20 |
Clear failed |
Enumeration for actions.
Positive values are used as recipe table indexes.
|
Name of the Member |
Value |
Description |
|
Idle |
0 |
Idle |
|
Login |
1 |
Login |
|
Logout |
2 |
Logout |
|
Start |
3 |
Start |
|
Stop |
4 |
Stop |
|
Check |
5 |
Check last action |
|
Tx_C23App |
6 |
Send CODESYS 2.x application to node |
|
Tx_5050App |
7 |
Send CODESYS 2.3 PRG-file to 5050 |
|
Tx_5050Chk |
8 |
Send CODESYS 2.3 CHK-file to 5050 |
|
Tx_5050FW |
9 |
Send firmware to 5050 |
|
Flash |
10 |
Write sent data to flash |
|
Tx_File |
11 |
Send file |
|
Rx_File |
12 |
Receive file NOT IMPLEMENTED YET! |
|
Tx_SSeriesApp |
13 |
Send Application to S Series |
|
Tx_SSeriesFW |
14 |
Send Firmware to S Series |
|
Tx_SSerieseTPU |
15 |
Send eTPU to S Series |
|
Tx_GSeriesApp |
16 |
Send Application to G Series |
|
Tx_GSeriesFW |
17 |
Send Firmware to G Series |
|
Tx_GSerieseTPU |
18 |
Send eTPU to G Series |
|
ProgramControl_1_Stop |
19 |
1F51hsub1 program control stop |
|
ProgramControl_1_Start |
20 |
1F51hsub1 program control start |
|
ProgramControl_1_Clear |
21 |
1F51hsub1 program control clear |
|
ProgramControl_2_Stop |
22 |
1F51hsub2 program control stop |
|
ProgramControl_2_Start |
23 |
1F51hsub2 program control start |
|
ProgramControl_2_Clear |
24 |
1F51hsub2 program control clear |
|
ReadFile |
-1 |
Read data from file to buffer |
|
WriteFile |
-2 |
Write data from buffer to file |
Recipe structure includes all data to perform selected action.
|
Name of the Member |
Type |
Description |
|
b0 |
BYTE |
Set data of DataBuffer's byte 0 |
|
b1 |
BYTE |
Set data of DataBuffer's byte 1 |
|
size |
DWORD |
number of bytes transferred |
|
index |
DWORD |
CANopen index and sub index, e.g. 16#102501 equals index 0x1025, sub 1 |
|
write |
BOOL |
TRUE = Write, FALSE = Read |
|
timeout |
TIME |
Timeout value |
|
error |
ApplicationState |
Returned error number in case of error |
|
check |
ApplicationState |
Returned error number in case of error in checking |
Library internal enumeration for CODESYS commands. Values below are used for recipe table.
|
Name of the Member |
Value |
Description |
|
LOGIN |
1 |
Login |
|
LOGOUT |
2 |
Logout |
|
START |
3 |
Start |
|
STOP |
4 |
Stop |
|
FILE_WRITE_START |
47 |
Start file transfer |
|
FILE_WRITE_CONT |
48 |
Continue file transfer |
|
FLASH |
131 |
Write to flash |
Library internal enumeration for CiA 302 1F51h program control index commands.
Values below are used for recipe table.
|
Name of the Member |
Value |
Description |
|
Stop |
0 |
Stop command |
|
Start |
1 |
Start command |
|
Reset |
2 |
Reset command |
|
Clear |
3 |
Clear command |
States for software protection unlock functionality.
When state is “Unlocked”, software download can be started.
|
Name of the Member |
Value |
Description |
|
Idle |
0 |
Idle |
|
Processing |
1 |
Software protection unlocking is ongoing |
|
Unlocked |
2 |
Software protection was unlocked and update is possible |
|
WrongPassword |
-1 |
Password was rejected and protection is locked |
|
Timeout |
-2 |
SDO timeout error |
|
StatusReadFailed |
-3 |
Error when reading password protection status |
|
PasswordWriteFailed |
-4 |
Error when writing unlock password |
|
NullPointer |
-5 |
Null pointer in inputs |
|
GenericError |
-6 |
Generic error in e.g. CSDO |
Enumeration for target unit codesys environment version. Used for units that can be programmed with either codesys version.
|
Name of the Member |
Value |
Description |
|
V2_3 |
23 |
CODESYS 2.3 |
|
V3_5 |
35 |
CODESYS 3.5 |
Defines the used software download method/platform.
|
Name of the Member |
Value |
Description |
|
NotDefined |
0 |
Default value, download sequence not defined |
|
Platform_2000 |
1 |
4G / 2000 series control unit |
|
Platform_3000 |
2 |
3000/4000 series control units |
|
Platform_5000 |
3 |
5000 series control units |
|
Platform_6000 |
4 |
6000 series units |
|
Platform_SSeries |
5 |
S Series control units |
|
Platform_GSeriesSlave |
6 |
G Series slave control units |
|
Platform_GSeriesCODESYS |
7 |
G Series programmable control units |
|
Platform_SL8XSeries |
8 |
SL8X series control units |
Data structure for a node to be updated with LoadAllUnits function block.
|
Name of the Member |
Type |
Description |
|
CANNumber |
BYTE |
CAN connection number, starting from 1. |
|
FW_Update |
BOOL |
Runtime is to be updated. |
|
FW_UpdateDone |
BOOL |
Runtime update finished successfully. |
|
FW_UpdateFailed |
BOOL |
Runtime update failed. |
|
FW_UpdateError |
EPEC_CANopen.Errors |
Runtime update error code. |
|
FW_Progress |
BYTE |
Progress-% of FW update. |
|
FW_File |
STRING(255) |
Name of runtime binary file, with path. |
|
FW_ConfFile |
STRING(255) |
Name of runtime configuration file, with path. |
|
FW_Version |
STRING(80) |
Current firmware version string. |
|
FW_PacketVersion |
STRING(80) |
Packet firmware version string. |
|
SW_Update |
BOOL |
Application is to be updated. |
|
SW_UpdateDone |
BOOL |
Application update finished successfully. |
|
SW_UpdateFailed |
BOOL |
Application update failed. |
|
SW_UpdateError |
EPEC_CANopen.Errors |
Application update error code. |
|
SW_Progress |
BYTE |
Progress-% of application update. |
|
SW_File |
STRING(255) |
Name of application binary file, with path. |
|
SW_ConfFile |
STRING(255) |
Name of application configuration file, with path. |
|
SW_Version |
STRING(80) |
Current application version string. |
|
SW_PacketVersion |
STRING(80) |
Packet application version string. |
|
NextBootDelayed |
BOOL |
Unit’s next boot will be delayed due to firmware installation operation, with safety control unit this means reboot again. |
|
ProductCode |
DWORD |
Unit product code, e.g. 5050. |
|
ProtectionState |
ProtectionState |
S Series unit protection state. |
|
Password |
STRING(20) |
S Series unit protection password. |
|
CODESYSVersion |
CODESYSVersions |
Unit's CODESYS version, 23 = CODESYS 2.3, 35 = CODESYS 3.5. |
|
CODESYSNodeID |
BYTE |
Unit's CODESYS node-ID is used for SW/FW updating |
|
Name |
STRING(80) |
Unit name for GUI. |
|
Sequence |
Sequences |
Defines used software download method/platform |
Data structure for status.csv file.
|
Name of the Member |
Type |
Description |
|
CANNumber |
BYTE |
CAN connection number, starting from 1. |
|
NodeID |
BYTE |
Unit application node-ID. |
|
UnitName |
STRING |
Unit name given in Multitool Creator. |
|
CODESYSVersion |
STRING |
CODESYS version: 2.3 or 3.5. |
|
FW_Version |
STRING |
Runtime version string. |
|
SW_Version |
STRING |
Application version string. |
|
SWPVersion |
STRING |
Application packet version string. |
|
FW_Status |
INT |
Runtime update status. |
|
SW_Status |
INT |
Application update status. |
Data structure for versions.csv file.
|
Name of the Member |
Type |
Description |
|
CANNumber |
BYTE |
CAN connection number, starting from 1. |
|
FileType |
STRING |
Type of the file. |
|
FileName |
STRING |
Name of the file. |
|
Version |
STRING |
FW/SW version of the file. |
|
UnitType |
DWORD |
Target unit type. |
|
UnitName |
STRING |
Target unit name given in Multitool Creator. |
|
NodeID |
BYTE |
Target unit application node-ID. |
|
CODESYSNodeID |
BYTE |
Target unit CODESYS node-ID is used for SW/FW updating. |
System wide name and version.
|
Name of the Member |
Type |
Description |
|
Name |
STRING |
System name for GUI. |
|
Version |
STRING |
System version string. |
Source file topic100464.htm
Last updated 21-Feb-2025