Class Controller
- Namespace
- L5Sharp.Components
- Assembly
- L5Sharp.dll
A logix Controller
component. Contains the properties that comprise the L5X Controller element.
public class Controller : LogixComponent<Controller>, ILogixSerializable
- Inheritance
-
Controller
- Implements
- Inherited Members
Remarks
A controller component may or may not contains various properties depending on if the exported L5X file
was a full project file or just a component export file. This is indicated in the L5X by the property
ContainsContext
, which if true, means the controller element exists simply to contain other components that
are needed by the TargetName
for successful re-imports of the content, and therefore will typically only have
a name, revision, and processor type.
Observe these guidelines when defining a controller:
• All declarations must be ordered in the prescribed syntax.
• The maximum number of tasks vary by the controller type.
• There can be only one continuous task.
• Programs can be scheduled under only one task.
• There can be a maximum of 1000 programs under a task.
• Scheduled programs must be defined.
Constructors
Controller()
Creates a new Controller with default values.
public Controller()
Controller(XElement)
Creates a new Controller initialized with the provided XElement.
public Controller(XElement element)
Parameters
Exceptions
- ArgumentNullException
element
is null.
Properties
CanUseRPIFromProducer
Specify whether the consumed tags in the controller can connect to the producer with an RPI provided by the producer (true or false)
public bool? CanUseRPIFromProducer { get; set; }
Property Value
- bool?
CommDriver
Specify the type of communication driver. This is the name of the selected driver in RSLinx® software. This is exported only if you select manual configuration of the communication driver in RSLinx® software.
public string? CommDriver { get; set; }
Property Value
CommPath
Specify the devices in the communication path. The communication path ends with the controller (\Backplane\1). This is exported only if you select manual configuration of the communication path in RSLinx® software.
public string? CommPath { get; set; }
Property Value
ControllerLanguage
Specify the controller project language for a project document at on project.
public string? ControllerLanguage { get; set; }
Property Value
CurrentProjectLanguage
Specify the current project language for a project documentation project.
public string? CurrentProjectLanguage { get; set; }
Property Value
DefaultProjectLanguage
Specify the default project language for a project document at on project.
public string? DefaultProjectLanguage { get; set; }
Property Value
DownloadCustomProperties
Indicates the download custom properties configuration setting of the project. Only applies if the project is already configured to DownloadProjectDocumentation
public bool? DownloadCustomProperties { get; set; }
Property Value
- bool?
Remarks
Rockwell Automation® recommends setting this attribute to false only during startup testing to improve download speeds during commissioning testing. It should be set to true for the normal operating state of a system.
DownloadProjectDocumentationAndExtendedProperties
Indicates the download project documentation configuration setting of the project.
public bool? DownloadProjectDocumentationAndExtendedProperties { get; set; }
Property Value
- bool?
EtherNetIPMode
The EtherNet/IP™ Mode describes the relationship between the CIP™ EtherNet/IP™ ports and the physical Ethernet ports. The CIP™ EtherNet/IP™ port can be configured as one of two modes: Dual-IP, Linear/DLR
public string? EtherNetIPMode { get; set; }
Property Value
InhibitAutomaticFirmwareUpdate
Specify whether to inhibit the automatic update of controller firmware.
public bool? InhibitAutomaticFirmwareUpdate { get; set; }
Property Value
- bool?
LastModifiedDate
The date/time the current project was last modified.
public DateTime LastModifiedDate { get; set; }
Property Value
MajorFaultProgram
Name of the program to be executed when a major fault occurs.
public string? MajorFaultProgram { get; set; }
Property Value
MatchProjectToController
Specify whether to be sure that the project matches the controller or not.
public bool? MatchProjectToController { get; set; }
Property Value
- bool?
PassThroughConfiguration
Indicates the pass through state of documentation for the project.
public PassThroughOption? PassThroughConfiguration { get; set; }
Property Value
- PassThroughOption
A PassThroughOption representing the configured value.
PowerLossProgram
Name of the program to be executed upon restart after a power loss.
public string? PowerLossProgram { get; set; }
Property Value
ProcessorType
The catalog number representing the processor of the controller component.
public string? ProcessorType { get; set; }
Property Value
ProjectCreationDate
The date/time the current project was created.
public DateTime ProjectCreationDate { get; set; }
Property Value
ProjectSN
Specify the serial number of the controller. If a serial number is specified, it is imported into the project regardless of the MatchProjectToController setting. Type a 32-bit, hexadecimal number with the 16# prefix, such as 16#0012_E2BC.
public string? ProjectSN { get; set; }
Property Value
RedundancyInfo
The RedundancyInfo object that specifies the redundancy configuration of the controller.
public RedundancyInfo? RedundancyInfo { get; set; }
Property Value
Revision
The revision or hardware version of the controller.
public Revision? Revision { get; set; }
Property Value
SFCExecutionControl
Specify whether the SFC executes the current active steps before returning control (CurrentActive) or whether the SFC executes all threads until reaching a false transition (UntilFalse).
public SFCExecutionControl? SFCExecutionControl { get; set; }
Property Value
SFCLastScan
Specify how the SFC manages its state on a last scan. Select AutomaticReset, ProgrammaticReset, or DontScan.
public SFCLastScan? SFCLastScan { get; set; }
Property Value
SFCRestartPosition
Specify whether the SFC restarts at the most recently executed step (MostRecent) or at the initial step (InitialStep).
public SFCRestartPosition? SFCRestartPosition { get; set; }
Property Value
SafetyInfo
The SafetyInfo object that specifies the safety configuration of the controller.
public SafetyInfo? SafetyInfo { get; set; }
Property Value
Security
The Security object that specifies the security configuration of the controller.
public Security? Security { get; set; }
Property Value
ShareUnusedTimeSlice
Specify whether to share an unused TimeSlice or not.
public bool? ShareUnusedTimeSlice { get; set; }
Property Value
- bool?
TimeSlice
Percentage of available CPU time (10...90) that is assigned to communication.
public string? TimeSlice { get; set; }