Omron IPC Machine Controller Industrial Panel PC / Industrial Box PC. Software User’s Manual (Industrial PC Platform NY-series) - page 18
Appendices
Range of
Variable name
Meaning
Function
Data type
Reference
values
_EIP_EstbTargetSta
Normal Target Node
NY-series Controller: Gives a list of nodes
ARRAY
TRUE or
page A-88
[255]
Information
that have normally established Ether-
[0..255] OF
FALSE
Net/IP connections for CIP communica-
BOOL
tions 1.
Array[x] is TRUE:
The connection to the node with a target
node ID of x was established normally.
Array[x] is FALSE:
The connection to the node with a tar-
get node ID of x was not established, or
an error occurred.
_EIP_TargetPLC-
Target PLC Operat-
NY-series Controller: Shows the operating
ARRAY
TRUE or
page A-88
ModeSta [255]
ing Mode
status of the target node Controllers that
[0..255] OF
FALSE
are connected for CIP communications 1,
BOOL
with the built-in EtherNet/IP port as the
originator.
The array elements are valid only when
the corresponding Normal Target Node
Information is TRUE. If the corresponding
Normal Target Node Information is
FALSE, the Target Node Controller Oper-
ating Information indicates the previous
operating status.
Array[x] is TRUE:
This is the operating state of the target
Controller with a node address of x.
Array[x] is FALSE:
Other than the above.
_EIP_TargetPLCErr
Target PLC Error
NY-series Controller: Shows the error sta-
ARRAY
TRUE or
page A-88
[255]
Information
tus (logical OR of fatal and non-fatal
[0..255] OF
FALSE
errors) of the target node Controllers that
BOOL
are connected for CIP communications 1,
with the built-in EtherNet/IP ports as the
originator. The array elements are valid
only when the corresponding Normal Tar-
get Node Information is TRUE. The imme-
diately preceding value is retained if this
variable is FALSE.
Array[x] is TRUE:
A fatal or non-fatal error occurred in the
target Controller with a target node ID
of x.
Array[x] is FALSE:
Other than the above.
A-48
Appendices
Range of
Variable name
Meaning
Function
Data type
Reference
values
_EIP_TargetNodeErr
Target Node Error
NY-series Controller: Indicates that the
ARRAY
TRUE or
page A-89
[255]
Information
connection for the Registered Target
[0..255] OF
FALSE
Node Information for CIP communications
BOOL
1 was not established or that an error
occurred in the target Controller.
The array elements are valid only when
the Registered Target Node Information is
TRUE.
Array[x] is TRUE:
A connection was not normally estab-
lished with the target node for a target
node ID of x
(the Registered Target Node Informa-
tion is TRUE and the Normal Target
Node Information is FALSE),
or a connection was established with
the target node but an error occurred in
A
the target Controller.
Array[x] is FALSE:
The target node is not registered for a
target node ID of x (the Registered Tar-
get Node Information is FALSE), or a
connection was normally established
with the target node (the Registered
Target Node Information is TRUE and
the Normal Target Node Information is
TRUE).
An error occurred in the target Control-
ler (the Target PLC Error Information is
TRUE).
_EIP_NTPResult
NTP Operation Infor-
---
_sNTP_
page A-89
mation
RESULT
.ExecTime
NTP Last Operation
NY-series Controller: No change from the
DATE_AND_
Depends on
page A-89
Time
initial value.
TIME
data type.
.ExecNormal
NTP Operation Result
NY-series Controller: No change from the
BOOL
TRUE or
page A-89
initial value.
FALSE
A-49
Appendices
Additional Information
Communications Status with Target Node
The communications status with the target node of an NY-series Controller is shown by the com-
bination of the values of four system-defined variables.
•
_EIP_RegTargetSta (Registered Target Node Information)
•
_EIP_EstbTargetSta (Normal Target Node Information)
•
_EIP_TargetPLCErr (Target PLC Error Information)
•
_EIP_TargetNodeErr (Target Node Error Information)
Value of
Value of
Value of
Value of
Communications status with target
_EIP_RegTarget-
_EIP_EstbTar-
_EIP_Target-
_EIP_Target-
node
Sta
getSta
PLCErr
NodeErr
TRUE
TRUE
FALSE
FALSE
A connection with the target node was
established normally and there is no error
in the target PLC.
TRUE
TRUE
A connection with the target node was
established but there is an error in the
target PLC.
FALSE
Disabled
TRUE
A connection with the target node was
not established normally.
FALSE
Disabled
Disabled
Disabled
The information is not valid because the
target node is not registered.
z Functional Classification: EtherNet/IP Communications Switches
Range of
Variable name
Meaning
Function
Data type
Reference
values
_EIP_TDLinkStart-
Tag Data Link Com-
NY-series Controller: Change this variable
BOOL
TRUE or
page A-90
Cmd
munications Start
to TRUE to start tag data links for CIP
FALSE
Switch
communications 1.
It automatically changes back to FALSE
after tag data link operation starts.
Note Do not force this switch to change
to FALSE from the user program or
from the Sysmac Studio. It changes
to FALSE automatically.
_EIP_TDLinkStop-
Tag Data Link Com-
NY-series Controller: Change this variable
BOOL
TRUE or
page A-90
Cmd
munications Stop
to TRUE to stop tag data links for CIP
FALSE
Switch
communications 1.
It automatically changes back to FALSE
after tag data link operation stops.
Note Do not force this switch to change
to FALSE from the user program or
from the Sysmac Studio. It changes
to FALSE automatically.
A-50
Appendices
A-3-6
Meanings of Error Status Bits
The meanings of the individual bits in the following error status are the same.
•
_ErrSta (Controller Error Status)
•
_PLC_ErrSta (PLC Function Module Error Status)
•
_MC_ErrSta (Motion Control Function Module Error Status)
•
_MC_ComErrSta (MC Common Error Status)
•
_MC_AX_ErrSta (Axis Error Status)
•
_MC_GRP_ErrSta (Axes Group Error Status)
•
_EC_ErrSta (Built-in EtherCAT Error)
•
_EC_PortErr (Communications Port Error)
•
_EC_MstrErr (Master Error)
•
_EC_SlavErr (Slave Error)
A
•
_EC_SlavErrTbl (Slave Error Table)
•
_EIP_ErrSta (Built-in EtherNet/IP Error)
• EIP_PortErr (Communications Port Error), _EIP1_PortErr (Communications Port1 Error)
•
_EIP_CipErr (CIP Communications Error)
•
_EIP_TcpAppErr (TCP Application Communications Error)
The meaning of the bits are shown in the following table.
However, do not use the following variables in the user program:_ErrSta (Controller Error Status).
There may be a delay in updating them and concurrency problems in relation to the error status of the
function module.
Use these variables only to access status through communications from an external device.
Bit:
15
14
13
12
11
10
9
8
7
6
5
4
3
2
1
0
WORD
Bit
Meaning
15
Reserved.
14
Collective slave error status: This bit indicates if a Controller error was detected for levels (e.g., a Unit, slave,
axis, or axes group) that are lower than the event source (i.e., for a function module).
TRUE: A Controller error has occurred at a lower level.
FALSE: A Controller error has not occurred at a lower level.
(Valid for _MC_ErrSta, and _EC_ErrSta.)
8 to 13
Reserved.
7
This bit indicates whether a major fault level Controller error has occurred.
TRUE: A major fault level Controller error has occurred.
FALSE: A major fault level Controller error has not occurred.
6
This bit indicates whether a partial fault level Controller error has occurred.
TRUE: A partial fault level Controller error has occurred.
FALSE: A partial fault level Controller error has not occurred.
5
This bit indicates whether a minor fault level Controller error has occurred.
TRUE: A minor fault level Controller error has occurred.
FALSE: A minor fault level Controller error has not occurred.
4
This bit indicates whether an observation level Controller error has occurred.
TRUE: An observation level Controller error has occurred.
FALSE: An observation level Controller error has not occurred.
0 to 3
Reserved.
A-51
Appendices
A-4
Specifications for Individual System-
defined Variables
The specifications for each system-defined variable are given as described below.
Variable name
This is the system-defined variable name. The prefix
Members (for
The member names are given for
gives the category name.
structures)
structure only.
Meaning
This is the meaning of the variable.
Global/local
Global: Global variable, Local: Local
variable
Function
The function of the variable is described.
Data type
The data type of the variable is given.
Range of values
The range of values that the vari-
able can take is given.
R/W access
R: Read only,
Retained
The Retain attri-
Network Publish
The Network Publish attribute of the
RW: Read/write
bute of the vari-
variable is given.
able is given.
Usage in user program
Whether you
Related instruc-
The instructions that are related to the variable are given.
can use the vari-
tions
If you cannot use the variable directly in the user program, the instructions
able directly in
that access the variable are given.
the user pro-
gram is speci-
fied.
A-52
Appendices
A-4-1
System-defined Variables for the Overall NY-series Controller (No
Category)
z Functional Classification: Clock
Variable name
_CurrentTime
Meaning
System Time
Global/local
Global
Function
This variable contains the Controller’s internal clock data.
Data type
DATE_AND_TIME
Range of values
DT#2000-01-01-00:00:00 to
DT#2099-12-31-23:59:59
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Clock instructions
tions
A
z Functional Classification: Tasks
Variable name
_TaskName_Active
Meaning
Task Active Flag
Global/local
Global
Function
TRUE during task execution.
FALSE when task execution is not in progress.
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
ActEventTask
tions
You can access this variable from the user program only with the following
instruction.
• Task_IsActive
Variable name
_TaskName_LastExecTime
Meaning
Last Task Execution Time
Global/local
Global
Function
Contains the task execution time the last time the task was executed (unit: 0.1 μs).
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
TIME
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
A-53
Appendices
Variable name
_TaskName_MaxExecTime
Meaning
Maximum Task Execution Time
Global/local
Global
Function
Contains the maximum value of the task execution time (unit: 0.1 μs).
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
TIME
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not supported.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
Variable name
_TaskName_MinExecTime
Meaning
Minimum Task Execution Time
Global/local
Global
Function
Contains the minimum value of the task execution time (unit: 0.1 μs).
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
TIME
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
Variable name
_TaskName_ExecCount
Meaning
Task Execution Count
Global/local
Global
Function
Contains the number of executions of the task.
If 4294967295 is exceeded, the value returns to 0 and counting is continued.
Note You cannot use these system-defined variables in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
UDINT
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
Variable name
_TaskName_Exceeded
Meaning
Task Period Exceeded Flag
Global/local
Global
Function
TRUE if the task period was exceeded.
FALSE if task execution was completed within the task period.
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
A-54
Appendices
Variable name
_TaskName_ExceedCount
Meaning
Task Period Exceeded Count
Global/local
Global
Function
Contains the number of times that the period was exceeded.
If the present value exceeds the maximum value of the data type, the present value returns to 0 and the count is
continued.
If 4294967295 is exceeded, the value returns to 0 and counting is continued.
Note You cannot use this system-defined variable in the user program. It is used only to access task status for
data tracing from the Sysmac Studio.
Data type
UDINT
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetMyTaskStatus
z Functional Classification: Errors
A
Variable name
_ErrSta
Meaning
Controller Error Status
Global/local
Global
Function
TRUE if there is a Controller error.
FALSE if there is no Controller error.
Note Do not use this variable in the user program. There may be a delay in updating it and concurrency prob-
lems in relation to the status of the function module. Use this variable only to access status through com-
munications from an external device. Refer to A-3-6 Meanings of Error Status Bits for the meanings of the
error status bits.
Data type
WORD
Range of values
16#0000 to 16#C0F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
• ResetPLCError
tions
• ResetECError
• ResetMCError
• MC_Reset
• MC_GroupReset
You can access this variable from the user program only with the following
instructions.
• GetPLCError
• GetECError
• GetMCError
• GetEIPError
Variable name
_AlarmFlag
Meaning
User-defined Error Status
Global/local
Global
Function
The bit corresponding to the event level is TRUE while there is a user-defined error.
Bits 00 to 07 correspond to user fault levels 1 to 8.
This variable contains 0000 hex when there is no user-defined error.
Data type
WORD
Range of values
16#0000 to 16#00FF
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• SetAlarm
tions
• ResetAlarm
• GetAlarm
A-55
Appendices
z Functional Classification: SD Memory Card
Variable name
_Card1Ready
Meaning
SD Memory Card Ready Flag
Global/local
Global
Function
TRUE when the Virtual SD Memory Card is recognized in an NY-series Controller.
FALSE when an SD Memory Card is not recognized.
TRUE: The Card can be used.
FALSE: The Card cannot be used.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_Card1Protect
Meaning
SD Memory Card Write Protected Flag
Global/local
Global
Function
The NY-series Controller does not use this variable.
The value is always FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_Card1Err
Meaning
SD Memory Card Error Flag
Global/local
Global
Function
The NY-series Controller does not use this variable.
The value is always FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_Card1Access
Meaning
SD Memory Card Access Flag
Global/local
Global
Function
The NY-series Controller does not use this variable.
The value is always FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_Card1Deteriorated
Meaning
SD Memory Card Life Warning Flag
Global/local
Global
Function
The NY-series Controller does not use this variable.
The value is always FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
A-56
Appendices
Variable name
_Card1PowerFail
Meaning
SD Memory Card Power Interruption Flag
Global/local
Global
Function
TRUE when the power supply to the Controller was interrupted during access to the Virtual SD Memory Card.
TRUE: Power was interrupted during Virtual SD Memory Card access.
FALSE: Normal.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
RW
Retained
Retained.*1
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
*1
This system-defined variable is not applicable for the data backup function even with a Retain attribute.
Variable name
_Card1Capacity*1
Meaning
SD Memory Card Storage Capacity
Global/local
Global
Function
Show the total capacity of the Virtual SD Memory Card.
A
The unit of capacity is MiB (1 MiB=1,048,576 bytes).
The value is updated every 60 seconds.
If the Virtual SD Memory Card is disabled, the value is “0”.
Data type
UDINT
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
*1
This system-defined variable was added for unit version 1.21 of the Controller.
Variable name
_Card1Used*1
Meaning
SD Memory Card Storage Usage
Global/local
Global
Function
Show the usage of the Virtual SD Memory Card.
The unit of capacity is MiB (1 MiB=1,048,576 bytes).
The value is updated every 60 seconds.
If the Virtual SD Memory Card is disabled, the value is “0”.
Data type
UDINT
Range of values
Depends on data type.
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
*1
This system-defined variable was added for unit version 1.21 of the Controller.
Variable name
_Card1BkupCmd
Member name
.ExecBkup
Meaning
Execute Backup Flag
Global/local
Global
Function
Change this variable to TRUE to back up Controller data to a Virtual SD Memory Card.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
when sending a command from an HMI or host computer.
Data type
Structure: _sBKUP_CMD, Member: BOOL
Range of values
TRUE or FALSE
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
A-57
Appendices
Variable name
_Card1BkupCmd
Member name
.CancelBkup
Meaning
Cancel Backup Flag
Global/local
Global
Function
Change this variable to TRUE to cancel backing up data to a Virtual SD Memory Card.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
when sending a command from an HMI or host computer.
Data type
Structure: _sBKUP_CMD, Member: BOOL
Range of values
TRUE or FALSE
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
Member name
.ExecVefy
_Card1BkupCmd
Meaning
Execute Verify Flag
Global/local
Global
Function
Change this variable to TRUE to compare the Controller data to a backup file in the Virtual SD Memory Card.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
when sending a command from an HMI or host computer.
Data type
Structure: _sBKUP_CMD, Member: BOOL
Range of values
TRUE or FALSE
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1BkupCmd
Member name
.CancelVefy
Meaning
Cancel Verify Flag
Global/local
Global
Function
Change this variable to TRUE to cancel comparing the Controller data to a backup file in the Virtual SD Memory
Card.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
when sending a command from an HMI or host computer.
Data type
Structure: _sBKUP_CMD, Member: BOOL
Range of values
TRUE or FALSE
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1BkupCmd
Member name
.DirName
Meaning
Directory Name
Global/local
Global
Function
Used to specify the directory name in the Virtual SD Memory Card for which to back up data.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
when sending a command from an HMI or host computer.
Data type
Structure: _sBKUP_CMD, Member: STRING(64)
Range of values
Depends on data type.
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1BkupSta
Member name
.Done
Meaning
Done Flag
Global/local
Global
Function
TRUE when a backup is completed.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sBKUP_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
A-58
Appendices
Variable name
_Card1BkupSta
Member name
.Active
Meaning
Active Flag
Global/local
Global
Function
TRUE when a backup is in progress.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sBKUP_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
Member name
.Err
_Card1BkupSta
Meaning
Error Flag
Global/local
Global
Function
TRUE when processing a backup ended in an error.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
A
to read the status from an HMI or host computer.
Data type
Structure: _sBKUP_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1VefySta
Member name
.Done
Meaning
Done Flag
Global/local
Global
Function
TRUE when a verification is completed.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sVEFY_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1VefySta
Member name
.Active
Meaning
Active Flag
Global/local
Global
Function
TRUE when a verification is in progress.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sVEFY_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
Variable name
_Card1VefySta
Member name
.VefyRslt
Meaning
Verify Result Flag
Global/local
Global
Function
TRUE if the data was the same. FALSE if differences were found.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sVEFY_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
A-59
Appendices
Variable name
_Card1VefySta
Member name
.Err
Meaning
Error Flag
Global/local
Global
Function
TRUE when processing a verification ended in an error.
Note You cannot use this system-defined variable in the user program. Use it in CIP message communications
to read the status from an HMI or host computer.
Data type
Structure: _sVEFY_STA, Member: BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Not possible.
Related instruc-
---
tions
z Functional Classification: Backup
Variable name
_BackupBusy
Meaning
Backup Function Busy Flag
Global/local
Global
Function
TRUE when a backup, restoration, or verification is in progress.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
Read
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
z Functional Classification: Power Supply
Variable name
_PowerOnHour
Meaning
Total Power ON Time
Global/local
Global
Function
Contains the total time that the power has been ON.
Contains the total time that the Controller has been ON in 1-hour increments.
To reset this value, overwrite the current value with 0.
The value is not updated after it reaches 4294967295.
This variable is not initialized at startup.
Data type
UDINT
Range of values
0 to 4294967295
R/W access
RW
Retained
Retained.*1
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
*1
This system-defined variable is not applicable for the data backup function even with a Retain attribute.
Variable name
_PowerOnCount
Meaning
Power Interruption Count
Global/local
Global
Function
Contains the number of times that the power supply has been interrupted.
The value is incremented by 1 each time the power supply is interrupted after the first time that the power was
turned ON.
To reset this value, overwrite the current value with 0.
The value is not updated after it reaches 4294967295.
This variable is not initialized at startup.
Data type
UDINT
Range of values
0 to 4294967295
R/W access
R/W
Retained
Retained.*1
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
*1
This system-defined variable is not applicable for the data backup function even with a Retain attribute.
A-60
Appendices
Variable name
_RetainFail
Meaning
Retention Failure Flag
Global/local
Global
Function
TRUE at the following times (failure of retention during power interruptions).
• When an error is detected by checking the battery-backup memory or non-volatile memory at power ON.
FALSE at the following times (no failure of retention during power interruptions).
• When no error is detected by checking the battery-backup memory or non-volatile memory at power ON.
• When the user program is downloaded.
• When the Clear All Memory operation is performed.
Note When the encoder home offset data is not retained, the status is given in the error status of the axis vari-
able, and not in this flag.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
A
Variable name
_SelfTest_UPSSignal
Meaning
UPS Signal Detection Flag
Global/local
Global
Function
TRUE when a temporary power interruption signal from UPS is detected.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• IPC_EnableShutdown
tions
Variable name
_RequestShutdown
Meaning
Request Shutdown Flag
Global/local
Global
Function
TRUE when the power supply button is pressed while running.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• IPC_EnableShutdown
tions
A-61
Appendices
z Functional Classification: OS (Windows)
Variable name
_OSRunning
Meaning
OS Running Flag
Global/local
Global
Function
TRUE when the Controller observes that OS (Windows) is running.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• IPC_GetOSStatus
tions
• IPC_ShutdownOS
• IPC_RebootOS
Variable name
_OSHalted
Meaning
OS Halted Flag
Global/local
Global
Function
TRUE when the Controller observes that OS (Windows) is stopped.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• IPC_GetOSStatus
tions
• IPC_ShutdownOS
• IPC_RebootOS
Variable name
_OSErrorState
Meaning
OS Error State Flag
Global/local
Global
Function
TRUE when the Controller determines that an error occurred in OS (Windows).
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• IPC_GetOSStatus
tions
• IPC_ShutdownOS
• IPC_RebootOS
z Functional Classification: Programming
Variable name
P_On
Meaning
Always TRUE Flag
Global/local
Global
Function
This flag is always TRUE.
Data type
BOOL
Range of values
TRUE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
P_Off
Meaning
Always FALSE Flag
Global/local
Global
Function
This flag is always FALSE.
Data type
BOOL
Range of values
FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
A-62
Appendices
Variable name
P_CY
Meaning
Carry Flag
Global/local
Local
Function
This flag is updated by some instructions.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
P_First_RunMode
Meaning
First RUN Period Flag
Global/local
Local
Function
This flag is TRUE for only one task period after the operating mode of the Controller is changed from PROGRAM
mode to RUN mode if execution of the program is in progress.
This flag remains FALSE if execution of the program is not in progress.
Use this flag to perform initial processing when the Controller begins operation.
Note You cannot use this system-defined variable inside functions.
A
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
P_First_Run
Meaning
First Program Period Flag
Global/local
Local
Function
This flag is TRUE for one task period after execution of the program starts.
Use this flag to perform initial processing when execution of a program starts.
Note You cannot use this system-defined variable inside functions.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
P_PRGER
Meaning
Instruction Error Flag
Global/local
Local
Function
This flag changes to and remains TRUE when an instruction error occurs in the program or in a function/function
block called from the program. After this flag changes to TRUE, it stays TRUE until the user program changes it
back to FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
RW
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Possible.
Related instruc-
---
tions
A-63
Appendices
z Functional Classification: Version
Variable name
_UnitVersion
Meaning
Unit Version
Global/local
Global
Function
The unit version of the Controller is stored.
The integer part of the unit version is stored in element number 0.
The fractional part of the unit version is stored in element number 1.
Example 1) If the unit version is 1.08, “1” is stored in element number 0 and “8” is stored in element number 1.
Example 2) If the unit version is 1.10, “1” is stored in element number 0 and “10” is stored in element number 1.
Data type
ARRAY[0..1] OF USINT
Range of values
0 to 99
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_HardwareRevision
Meaning
Hardware Revision
Global/local
Global
Function
The hardware revision of the Controller is stored.
Contains - if the hardware revision is in blank, and A to Z for other cases.
Data type
STRING[2]
Range of values
- or A to Z
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
z Functional Classification: Self-diagnosis
Variable name
_SelfTest_HighTemperature
Meaning
CPU Unit High Temperature Flag
Global/local
Global
Function
TRUE when the internal temperature of the Controller is too high.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
Variable name
_SelfTest_LowBattery
Meaning
Low Battery Flag
Global/local
Global
Function
TRUE when the battery is disconnected or the battery voltage is dropped.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
Variable name
_SelfTest_LowFanRevolution
Meaning
Low FAN Revolution Flag
Global/local
Global
Function
TRUE when the fan is disconnected or the rotation speed of a fan is decreased.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
A-64
Appendices
z Functional Classification: PLC Built-in
Variable name
_DeviceOutHoldCfg*1
Meaning
Device Output Hold Configuration
Global/local
Global
Function
It is 16#A5A5 if you retain the target device output when the operating mode is changed or when downloaded.
In the case other than 16#A5A5, the target device output is initialized when the operating mode is changed or when
downloaded.
Data type
WORD
Range of values
16#0000 to 16#FFFF
R/W access
RW
Retained
Retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
*1
This system-defined variable was added for unit version 1.14 of the Controller.
Variable name
_DeviceOutHoldStatus*1
Meaning
Device Output Hold Status
Global/local
Global
Function
It is TRUE if the target device output is retained when the operating mode is changed or when downloaded.
A
When the device output hold configuration is other than 16#A5A5, or when a major fault level Controller error
occurs, the target device output is initialized and changes to FALSE.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
*1
This system-defined variable was added for unit version 1.14 of the Controller.
A-65
Appendices
A-4-2
PLC Function Module, Category Name: _PLC
z Functional Classification: Debugging
Variable name
_PLC_TraceSta[0..3]
Members
.IsStart
Meaning
Trace Busy Flag
Global/local
Global
Function
TRUE when a trace starts.
Note You cannot use these system-defined variables in the user program. It is used only to monitor the status of
data tracing from the Sysmac Studio.
Data type
Structure: _sTRACE_STA, Members: BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
• TraceTrig
tions
• TraceSamp
You can access this variable from the user program only with the following
instruction.
• GetTraceStatus
Variable name
_PLC_TraceSta[0..3]
Members
.IsComplete
Meaning
Trace Completed Flag
Global/local
Global
Function
TRUE when a trace is completed.
Note You cannot use this system-defined variable in the user program. It is used only to monitor the status of
data tracing from the Sysmac Studio.
Data type
Structure: _sTRACE_STA, Members: BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
• TraceTrig
tions
• TraceSamp
You can access this variable from the user program only with the following
instruction.
• GetTraceStatus
Variable name
_PLC_TraceSta[0..3]
Members
.IsTrigger
Meaning
Trace Trigger Monitor Flag
Global/local
Global
Function
TRUE when the trigger condition is met.
FALSE when the next trace starts.
Note You cannot use these system-defined variables in the user program. It is used only to monitor the status of
data tracing from the Sysmac Studio.
Data type
Structure: _sTRACE_STA, Members: BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
• TraceTrig
tions
• TraceSamp
You can access this variable from the user program only with the following
instruction.
• GetTraceStatus
A-66
Appendices
Variable name
_PLC_TraceSta[0..3]
Members
.ParamErr
Meaning
Trace Parameter Error Flag
Global/local
Global
Function
TRUE when a trace starts, but there is an error in the trace settings.
FALSE when the settings are normal.
Note You cannot use these system-defined variables in the user program. It is used only to monitor the status of
data tracing from the Sysmac Studio.
Data type
Structure: _sTRACE_STA, Members: BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Not published.
Usage in user program
Not possible.
Related instruc-
You can access this variable from the user program only with the following
tions
instruction.
• GetTraceStatus
z Functional Classification: Errors
Variable name
_PLC_ErrSta
A
Meaning
PLC Function Module Error Status
Global/local
Global
Function
TRUE when there is a Controller error that involves the PLC Function Module.
FALSE when there is no Controller error that involves the PLC Function Module.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• GetPLCError
tions
You can use the following instruction to clear this variable.
• ResetPLCError
A-67
Appendices
A-4-3
Motion Control Function Module, Category Name: _MC
z Functional Classification: Motion Control Functions
Variable name
_MC_ErrSta
Meaning
Motion Control Function Module Error Status
Global/local
Global
Function
Shows the status of errors that are detected in the Motion Control Function Module.
You can use this variable directly in the user program.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#40F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• GetMCError
tions
• ResetMCError
• MC_Reset
• MC_GroupReset
Variable name
_MC_ComErrSta
Meaning
Common Error Status
Global/local
Global
Function
Shows the status of errors that are detected in common processing for motion control.
You can use this variable directly in the user program.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• GetMCError
tions
• ResetMCError
Variable name
_MC_AX_ErrSta
Meaning
Axis Error Status
Global/local
Global
Function
Shows the error status for each axis. The status of up to 64 axes is shown.
You can use this variable directly in the user program. Refer to A-3-6 Meanings of Error Status Bits for the mean-
ings of the error status bits.
Data type
ARRAY [0..63] OF WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• GetMCError
tions
• ResetMCError
• MC_Reset
Variable name
_MC_GRP_ErrSta
Meaning
Axes Group Error Status
Global/local
Global
Function
Shows the error status for each axes group. The error status for up to 32 axes groups is shown.
You can use this variable directly in the user program. Refer to A-3-6 Meanings of Error Status Bits for the mean-
ings of the error status bits.
Data type
ARRAY [0..31] OF WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
• GetMCError
tions
• ResetMCError
• MC_GroupReset
A-68
Appendices
Variable name
_MC_COM
Meaning
Common Variable
Global/local
Global
Function
Shows the status that is common to the Motion Control Function Module.
Refer to the NY-series Motion Control Instructions Reference Manual (Cat. No. W561) for details on structure
members.
Data type
_sCOMMON_REF
Range of values
---
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_MC_GRP
Meaning
Axes Group Variables
Global/local
Global
Function
NY-series Controller: Used to specify axes groups and shows multiaxes coordinated control status, and multiaxes
coordinated control settings for motion control instructions.
A
When you create an axes group on the System Studio, a user-defined axes group variable with a different name
is created.
Normally, you use an Axes Group Variable with a different name.
Refer to the NY-series Motion Control Instructions Reference Manual (Cat. No. W561) for details on structure
members.
Data type
ARRAY[0..31] OF _sGROUP_REF
Range of values
---
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_MC_AX
Meaning
Axis Variables
Global/local
Global
Function
NY-series Controller: Used to specify axes and shows single-axis control status, and single-axis control settings for
motion control instructions.
When you create an axis on the System Studio, a user-defined axis variable with a different name is created.
Normally, you use an Axis Variable with a different name.
Refer to the NY-series Motion Control Instructions Reference Manual (Cat. No. W561) for details on structure
members.
Data type
ARRAY[0..63] OF _sAXIS_REF
Range of values
---
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
A-69
Appendices
A-4-4
EtherCAT Master Function Module, Category Name: _EC
z Functional Classification: EtherCAT Communications Errors
Variable name
_EC_ErrSta
Meaning
Built-in EtherCAT Error
Global/local
Global
Function
This system-defined variable provides the collective status of errors in the EtherCAT Master Function Module.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#40F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Get EtherCAT Error Status
tions
• GetECError
Reset EtherCAT Controller Error
• ResetECError
Variable name
_EC_PortErr
Meaning
Communications Port Error
Global/local
Global
Function
This system-defined variable provides the collective status of errors in the communications ports for the EtherCAT
master.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Get EtherCAT Error Status
tions
• GetECError
Reset EtherCAT Controller Error
• ResetECError
Variable name
_EC_MstrErr
Meaning
Master Error
Global/local
Global
Function
This system-defined variable provides the collective status of EtherCAT master errors and slave errors detected
by the EtherCAT master.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Get EtherCAT Error Status
tions
• GetECError
Reset EtherCAT Controller Error
• ResetECError
Variable name
_EC_SlavErr
Meaning
Slave Error
Global/local
Global
Function
This system-defined variable provides the collective status of all the error status for EtherCAT slaves.
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Get EtherCAT Error Status
tions
• GetECError
Reset EtherCAT Controller Error
• ResetECError
A-70
Appendices
Variable name
_EC_SlavErrTbl
Meaning
Slave Error Table
Global/local
Global
Function
This system-defined variable gives the error status for each EtherCAT slave.
The error status is given for each slave in the actual system configuration.
This variable array indicates slaves in which there are errors. Status is provided for each EtherCAT slave node
address (1 to 512).
Refer to A-3-6 Meanings of Error Status Bits for the meanings of the error status bits.
Data type
Array [1..512] OF WORD
Range of values
16#0000 to 16#00F0
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Get EtherCAT Error Status
tions
• GetECError
Reset EtherCAT Controller Error
• ResetECError
A
Variable name
_EC_MacAdrErr
Meaning
MAC Address Error
Global/local
Global
Function
TRUE if the MAC Address Error (14400000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_LanHwErr
Meaning
Communications Controller Error
Global/local
Global
Function
TRUE if the Communications Controller Error (047C0000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_LinkOffErr
Meaning
Link OFF Error
Global/local
Global
Function
TRUE if the Link OFF Error (84200000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_NetCfgErr
Meaning
Network Configuration Information Error
Global/local
Global
Function
TRUE if the Network Configuration Information Error (34400000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
A-71
Appendices
Variable name
_EC_NetCfgCmpErr
Meaning
Network Configuration Verification Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• Network Configuration Verification Error (84220000 hex)
• Network Configuration Verification Error (Slave Unconnected) (84380000 hex)
• Network Configuration Verification Error (Incorrect Wiring) (84320003 hex)
• Network Configuration Verification Error (Mismatched Slave) (84330004 hex)
• Network Configuration Verification Error (Incorrect Ring Wiring) (843A0000 hex)
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_NetTopologyErr
Meaning
Network Configuration Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• Network Configuration Error (84210000 hex)
• Incorrect Wiring Detected (843C0000 hex)
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_PDCommErr
Meaning
Process Data Communications Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• Process Data Communications Error (842C0000 hex)
• Illegal Slave Disconnection Detected (84310002 hex)
• Slave PDI WDT Error Detected (84340000 hex)
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_PDTimeoutErr
Meaning
Process Data Reception Timeout Error
Global/local
Global
Function
TRUE if the Process Data Reception Timeout (842B0000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_PDSendErr
Meaning
Process Data Transmission Error
Global/local
Global
Function
TRUE if the Process Data Transmission Error (84290000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
A-72
Appendices
Variable name
_EC_SlavAdrDupErr
Meaning
Slave Node Address Duplicated Error
Global/local
Global
Function
TRUE if the Slave Node Address Duplicated (24200000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_SlavInitErr
Meaning
Slave Initialization Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• Slave Initialization Error (84230000 hex)
• Slave State Transition Failed (84300001 hex)
Data type
BOOL
Range of values
TRUE or FALSE
A
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_SlavAppErr
Meaning
Slave Application Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• Slave Application Error (84280000 hex)
• Slave AL Status Error Detected (84360000 hex)
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_MsgErr
Meaning
EtherCAT Message Error
Global/local
Global
Function
TRUE if one of the following events occurred.
• EtherCAT Message Error (842D0000 hex)
• Illegal Mailbox Received (84350000 hex)
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
CoE messages (Read CoE SDO)
tions
• EC_CoESDORead
CoE messages (Write CoE SDO)
• EC_CoESDOWrite
A-73
Appendices
Variable name
_EC_SlavEmergErr
Meaning
Emergency Message Detected
Global/local
Global
Function
TRUE if the Emergency Message Detected (64200000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Variable name
_EC_IndataInvalidErr*1
Meaning
Input Process Data Invalid Error
Global/local
Global
Function
TRUE if the Input Process Data Invalid Error (842F0000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
Reset EtherCAT Controller Error
gram
tions
• ResetECError
*1
This system-defined variable was added for unit version 1.14 of the Controller.
Variable name
_EC_CommErrTbl
Meaning
Communications Error Slave Table
Global/local
Global
Function
Slaves are given in the table in the order of slave node addresses.
The corresponding slave element is TRUE if the master detected an error for the slave.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Reset EtherCAT Controller Error
tions
• ResetECError
Note The values of all system-defined variables that are related to errors in EtherCAT communications do not change until the
cause of the error is removed and then the error in the Controller is reset with the troubleshooting functions of the Sys-
mac Studio or the ResetECError instruction.
Variable name
_EC_CycleExceeded
Meaning
EtherCAT Communications Cycle Exceeded
Global/local
Global
Function
TRUE if the EtherCAT Communications Cycle Exceeded (34410000 hex) event occurred.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
A-74
Appendices
z Functional Classification: EtherCAT Communications Status
Variable name
_EC_RegSlavTbl
Meaning
Registered Slave Table
Global/local
Global
Function
This table indicates the slaves that are registered in the network configuration information.
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if the corresponding slave is registered.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_EntrySlavTbl
Meaning
Network Connected Slave Table
Global/local
Global
Function
This table indicates which slaves are connected to the network.
A
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if the corresponding slave has entered the network.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_MBXSlavTbl
Meaning
Message Communications Enabled Slave Table
Global/local
Global
Function
This table indicates the slaves that can perform message communications.
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if message communications are enabled for it (pre-operational, safe-operation,
or operational state).
Note Use this variable to confirm that message communications are possible for the relevant slave before you
execute message communications with an EtherCAT slave.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Disconnect EtherCAT Slave
tions
• EC_DisconnectSlave
Connect EtherCAT Slave
• EC_ConnectSlave
A-75
Appendices
Variable name
_EC_PDSlavTbl
Meaning
Process Data Communicating Slave Table
Global/local
Global
Function
This is a table that indicates the slaves that are performing process data communications.
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if process data of the corresponding slave is enabled (operational) for both slave
inputs and outputs.
Note Use this variable to confirm that the data for the relevant slave is valid before controlling an EtherCAT
slave.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Disconnect EtherCAT Slave
tions
• EC_DisconnectSlave
Connect EtherCAT Slave
• EC_ConnectSlave
Variable name
_EC_DisconnSlavTbl
Meaning
Disconnected Slave Table
Global/local
Global
Function
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if the corresponding slave was disconnected.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Disconnect EtherCAT Slave
tions
• EC_DisconnectSlave
Connect EtherCAT Slave
• EC_ConnectSlave
Variable name
_EC_DisableSlavTbl
Meaning
Disabled Slave Table
Global/local
Global
Function
Slaves are given in the table in the order of slave node addresses.
The element for a slave is TRUE if the corresponding slave is disabled.
Data type
Array [1..512] OF BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_PDActive
Meaning
Process Data Communications Status
Global/local
Global
Function
TRUE when process data communications are performed with all slaves*.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Disconnect EtherCAT Slave
tions
• EC_DisconnectSlave
Connect EtherCAT Slave
• EC_ConnectSlave
* Disabled slaves are not included.
A-76
Appendices
Variable name
_EC_PktMonStop
Meaning
Packet Monitoring Stopped
Global/local
Global
Function
TRUE when packet monitoring is stopped.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Stop Packet Monitor
tions
• EC_StopMon
Start Packet Monitor
• EC_StartMon
Variable name
_EC_LinkStatus
Meaning
Link Status
Global/local
Global
Function
TRUE if the communications controller link status is Link ON.
Data type
BOOL
Range of values
TRUE or FALSE
A
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Variable name
_EC_PktSaving
Meaning
Saving Packet Data File
Global/local
Global
Function
Shows whether a packet data file is being saved.
TRUE: Packet data file being saved.
FALSE: Packet data file not being saved.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
Saving Packet Data File
tions
• EC_SaveMon
Variable name
_EC_InDataInvalid
Meaning
Input Data Invalid
Global/local
Global
Function
TRUE when process data communications performed in the primary periodic task are not normal and the input
data is not valid.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user program
Possible.
Related instruc-
---
tions
Note 1
All system-defined variables that are related to the status of EtherCAT communications give the current status.
2
The variable temporarily changes to TRUE if the EC_DisconnectSlave (Disconnect EtherCAT Slave) instruction,
EC_ConnectSlave (Connect EtherCAT Slave) instruction, or EC_ChangeEnableSetting (Enable/Disable EtherCAT
Slave) instruction is executed.
Variable name
_EC_InData1Invalid
Meaning
Input Data1 Invalid
Global/local
Global
Function
TRUE when process data communications performed in the primary periodic task are not normal and the input data
is not valid.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related instruc-
---
gram
tions
Note 1
All system-defined variables that are related to the status of EtherCAT communications give the current status.
2
The variable temporarily changes to TRUE if the EC_DisconnectSlave (Disconnect EtherCAT Slave) instruction,
EC_ConnectSlave (Connect EtherCAT Slave) instruction, or EC_ChangeEnableSetting (Enable/Disable EtherCAT
Slave) instruction is executed.
A-77
Appendices
z Functional Classification: EtherCAT Communications Diagnosis/Statistics
Log
Variable name
_EC_StatisticsLogEnable
Meaning
Diagnosis/Statistics Log Enable
Global/local
Global
Function
Changes to TRUE when the diagnosis/statistics log is started.
Changes to FALSE when the diagnosis/statistics log is ended.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
Variable name
_EC_StatisticsLogCycleSec
Meaning
Diagnosis/Statistics Log Cycle
Global/local
Global
Function
Specifies the interval to write the diagnostic and statistical information of the diagnosis/statistics log in units of sec-
onds.
When 0 is specified, the diagnostic and statistical information is written only once when the diagnosis/statistics log
is ended.
Note The write interval does not change even if you change the value of this system-defined variable while the
diagnosis/statistics log operation is in progress.
Data type
UINT
Range of values
0, or 30 to 1800
R/W access
R/W
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
Variable name
_EC_StatisticsLogBusy
Meaning
Diagnosis/Statistics Log Busy
Global/local
Global
Function
TRUE while the diagnosis/statistics log operation is in progress.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
Variable name
_EC_StatisticsLogErr
Meaning
Diagnosis/Statistics Log Error
Global/local
Global
Function
TRUE when the diagnosis/statistics log failed to start or it is impossible to write into the log.
The value of this flag is determined when _EC_StatisticsLogBusy (Diagnosis/Statistics Log Busy) changes to
FALSE after the diagnosis/statistics log operation is started.
The error end is caused by the following.
• Another records cannot be added in the log file because the capacity of the Virtual SD Memory Card is fully used.
• There is no Virtual SD Memory Card.
• The function cannot be started because the value specified for _EC_StatisticsLogCycleSec (Diagnosis/Statistics
Log Cycle) is invalid.
Data type
BOOL
Range of values
TRUE or FALSE
R/W access
R
Retained
Not retained.
Network Publish
Published.
Usage in user pro-
Possible.
Related
---
gram
instructions
A-78