Supported platforms: CODESYS 3.5, CODESYS 3.5 SAFETY
Enumeration for parameter CSV column headers.
Name of the Member |
Value |
Description |
CSV_GROUP1 |
0 |
Parameter classification level 1, used for UI grouping |
CSV_GROUP2 |
1 |
Parameter classification level 2, used for UI grouping |
CSV_GROUP3 |
2 |
Parameter classification level 3, used for UI grouping |
CSV_GROUP4 |
3 |
Parameter classification level 4, used for UI grouping |
CSV_LOWLIMIT |
4 |
Minimum value |
CSV_DEFAULT |
5 |
Default value |
CSV_HIGHLIMIT |
6 |
Maximum value |
CSV_UNIT |
7 |
Unit (for example "bar") |
CSV_INFOTEXT |
8 |
Additional information text |
CSV_NODEID |
9 |
Control unit bus identification |
CSV_INDEX |
10 |
SDO object index |
CSV_SUBINDEX |
11 |
SDO objects sub-index |
CSV_BIT |
12 |
In case of a bit or byte parameter, it tells which bit has the information |
CSV_DATATYPE |
13 |
Parameter type |
CSV_STEPS |
14 |
Step size in parameter adjusting |
CSV_DECIMALS |
15 |
Number of decimals to print |
CSV_VALUETEXTS |
16 |
Strings for values |
CSV_INDEXTYPE |
17 |
Method of saving index. Parameter, Retain or RetainPersistent |
CSV_READACCESS |
18 |
Level of valid parameter read access |
CSV_WRITEACCESS |
19 |
Level of valid parameter write access |
CSV_VARIABLE |
20 |
Same as the variable name defined in OD |
CSV_EXTRAS |
21 |
User defined Extra columns, data provided to application by interface |
Structure for parameter CSV information.
Name of the Member |
Data Type |
Description |
GroupX |
ARRAY [0..3] OF STRING[G_PARAMETERS_GROUP_SIZE] |
Parameter classification levels 1 - 4 |
Variable |
STRING[G_PARAMETERS_VARIABLE_SIZE] |
Variable name string |
LowLimit |
DINT |
Minimum value for parameter |
DefaultValue |
DINT |
Default value |
HighLimit |
DINT |
Maximum value for parameter |
Unit |
STRING[G_PARAMETERS_UNIT_SIZE] |
Unit GUI text |
InfoText |
STRING[G_PARAMETERS_INFO_SIZE] |
Additional info text |
Node |
BYTE |
Control unit's NodeID |
Index |
WORD |
SDO object index |
SubIndex |
BYTE |
SDO sub-index |
StartBit |
BYTE |
In case of a bit parameter, it tells which bit has the information (0..31) |
ParameterType |
CSVType |
Parameter type |
Steps |
DINT |
Step size in parameter adjusting |
Decimals |
BYTE |
Number of decimals to GUI |
ValueTexts |
STRING[G_PARAMETERS_VALUETEXT_SIZE] |
Strings for values |
ReadAccess |
INT |
User level of for reading access |
WriteAccess |
INT |
User level of for writing access |
IndexType |
STRING[G_PARAMETERS_INDEXTYPE_SIZE] |
Indexes saving method. Parameter, Retain or RetainPersistent |
DefaultValueReal |
REAL |
Default value for REAL type parameter. |
LowLimitReal |
REAL |
Minimum value for real type parameter. |
HighLimitReal |
REAL |
Maximum value for real type parameter. |
Enumeration for parameter CSV errors.
Name of the Member |
Value |
Description |
NoError |
0 |
No error |
MaxParamCountExceed |
-1 |
CSV contains too many parameters |
MinMaxLimitMixed |
-2 |
Parameters max limit < min limit |
MinMaxOutOfLimit |
-3 |
Min or max value out of data type limits. for example: byte parameter max limit > 255 |
MaxLineLengthExceed |
-4 |
Line length too long (>G_PARAMETERS_MAX_LINE_LENGTH) |
Enumeration for parameter CSV's supported data types.
Enumeration is used as index for G_PARAMETERS_TYPES array.
Name of the Member |
Value |
Description |
CSV_BOOL |
0 |
One bit |
CSV_SINT |
1 |
8 bits, signed |
CSV_USINT |
2 |
8 bits, unsigned |
CSV_BYTE |
3 |
8 bits, unsigned |
CSV_INT |
4 |
16 bits, signed |
CSV_UINT |
5 |
16 bits, unsigned |
CSV_WORD |
6 |
16 bits, unsigned |
CSV_DINT |
7 |
32 bits, signed |
CSV_UDINT |
8 |
32 bits, unsigned |
CSV_DWORD |
9 |
32 bits, unsigned |
CSV_REAL |
10 |
32 bits, floating point |
Enumeration for possible error when editing the value.
Name of the Member |
Value |
Description |
NoError |
0 |
No error |
LimitExceeded |
-1 |
Value exceeds the given limits (i_Min, i_Max) |
NullPointer |
-2 |
Pointer to the parameter value is NULL |
SDOChannelReserveFailed |
-3 |
SDO channel reserve failed |
SDOChannelReleaseFailed |
-4 |
SDO channel release failed |
WriteNotAllowed |
-5 |
Write not allowed. Read must succeed first |
AbortCodeReceived |
-6 |
Received abort code |
StartBitOutOfRange |
-7 |
Start bit is out of range |
ODLineNotFound |
-8 |
OD line not found from unit's own OD |
ODIndexNotFound |
-9 |
OD index/subindex not found from unit's own OD |
Enumeration for parameter edit function block's state.
Name of the Member |
Value |
Description |
Idle |
0 |
Idle |
Reading |
1 |
Reading data from the control unit |
Writing |
2 |
Writing data to the control unit |
Enumeration for safety parameter authentication function block's state.
Name of the Member |
Value |
Description |
Idle |
0 |
Do nothing |
Processing |
1 |
Sequence in progress |
Authenticated |
2 |
Authentication sequence succeeded |
WrongKey |
-1 |
Authentication failed, wrong project key |
Timeout |
-2 |
SDO protocol timeout |
StatusReadFailed |
-3 |
Status index SDO read aborted |
ChallengeCodeReadFailed |
-4 |
Challenge code index SDO read aborted |
CalculateResponseError |
-5 |
CRC calculation error |
ResponseWriteFailed |
-6 |
Response index SDO write aborted |
NullPointer |
-7 |
Null pointer in parameters/inputs |
GenericError |
-8 |
Generic error in e.g. CSDO |
Enumeration is used by several POUs related to safety parameter adjustment sequence.
Name of the Member |
Value |
Description |
Idle |
0 |
Do nothing |
Processing |
1 |
Sequence in progress |
Timeout |
-1 |
SDO protocol timeout |
ReadFailed |
-2 |
Index SDO read aborted |
WriteFailed |
-3 |
Index SDO write aborted |
NullPointer |
-4 |
Null pointer in parameters/inputs |
InvalidIndex |
-5 |
Index is not safety parameter |
DataError |
-6 |
Error in parameter / input data |
InitError |
-7 |
Handler Init method has not been executed |
GenericError |
-8 |
Generic error in e.g. CSDO |
Enumeration for parameters save function block's state.
Name of the Member |
Value |
Description |
Idle |
0 |
Do nothing |
Processing |
1 |
Sequence in progress |
SaveOK |
2 |
Save sequence succeeded |
CRCError |
-1 |
Configuration valid index is invalid due to wrong crc |
SaveStatusError |
-2 |
Save error reported by control unit |
Timeout |
-3 |
SDO protocol timeout |
CfgValidWriteFailed |
-4 |
Configuration valid index SDO write aborted |
CfgValidReadFailed |
-5 |
Configuration valid index SDO read aborted |
SaveWriteFailed |
-6 |
Save command index SDO write aborted |
StatusReadFailed |
-7 |
Save status index SDO read aborted |
NullPointer |
-8 |
Null pointer in parameters/inputs |
GenericError |
-9 |
Generic error in e.g. CSDO |
Enumeration for parameters csv unique ID function block's state.
"Single node" refers to the output of GetNodeState method.
"Handler" refers to o_State of the function block.
Name of the Member |
Value |
Description |
Idle |
0 |
Do nothing |
Processing |
1 |
Sequence in progress |
NodeOK |
2 |
Single node: calculated unique ID matches with control unit |
AllNodesOK |
3 |
Handler: All nodes status is NodeOK |
Mismatch |
-1 |
Single node: Unique ID does not match, Handler: At least one node status is Mismatch |
AllNodesMismatch |
-2 |
Handler: All of the node statuses are Mismatch |
Timeout |
-3 |
SDO protocol timeout |
ReadError |
-4 |
Unique ID index SDO read aborted |
NullPointer |
-5 |
Null pointer in parameters/inputs |
DataError |
-6 |
Handler error: CSV data or CRC calculation fault |
InitError |
-7 |
Handler Init method has not been executed |
GenericError |
-8 |
Error in e.g. CSDO |
Source file topic100411.htm
Last updated 13-Jun-2024