Controller
Quick Facts
| Property | Value |
|---|---|
| Class | CENPyOlpController |
| Module | cenpylib.CENPyOlpController |
| Package | cenpylib |
| Release | R2025.2.4 |
| Methods | 39 |
Quick Start
# Boilerplate Example
controller = ... # obtained from the runtime context
result = controller.GetName()Lifecycle
| Method | Returns | Summary |
|---|---|---|
CreateProgram | CENPyOlpProgram | Creates a new controller program and sets it active. |
Query Methods
| Method | Returns | Summary |
|---|---|---|
GetName | str | Get the controller name. |
GetControllerType | int | Get the controller type. |
GetManufacturer | str | Get the controller manufacturer. |
GetSeries | str | Get the controller series. |
GetModel | str | Get the controller model. |
GetActors | list[CENPyOlpActor] | Returns the attached actors of specified type. |
GetSensors | list[CENPyOlpSensor] | Gets all sensors which are on a controlled item. |
GetSignalNumber | int | Searches for the first signal with the given name, found on a controller signal connection for this controller, |
GetUuId | str | Gets the controller’s unique ID. |
GetActiveToolFrameIndex | int | Gets the index of the active tool frame. |
GetActiveBaseFrameIndex | int | Gets the index of the active base frame. |
GetActiveToolFrameMatrix | CENPyOlpMatrix | Gets the matrix of the active tool frame. |
GetActiveBaseFrameMatrix | CENPyOlpMatrix | Gets the matrix of the active base frame. |
GetActiveToolFrameName | str | Get the tool frame name of the active tool. |
GetActiveToolResourceName | str | Get the resource name of the active tool. |
GetResources | list[CENPyOlpResource] | Gets resources that are controlled by this controller. |
GetMainResourcesMaxTCPFeedrate | float | Returns the max TCP feedrate of main resource of the controller. |
IsTeamController | bool | Returns whether the controller is a team controller. |
GetTeamController | CENPyOlpController | Returns the team controller current controller is connected to. |
GetControllers | list[CENPyOlpController] | Returns all controllers connected to this controller. |
GetProgramNames | list | Returns a list of program names on this controller. |
GetLogicPortByName | CENPyOlpPort | Returns the first logic port found on the current controller with the given name. |
GetOutputDirectory | str | Returns the download output directory of the program. |
GetEtwoLanguage | str | Returns the language setting of E2 as a String (de-DE, en-US, fr-FR, ja-JP, zh-CN). |
GetAttributeByName | CENPyOlpAttribute | Gets a user-defined attribute by the given name. |
GetAttributeIntegerByName | CENPyOlpAttributeInt | Gets the Integer attribute by the given name. |
GetAttributeDoubleByName | CENPyOlpAttributeDouble | Gets the Double attribute by the given name. |
GetAttributeStringByName | CENPyOlpAttributeString | Gets the String attribute by the given name. |
GetAttributeBoolByName | CENPyOlpAttributeBool | Gets the Bool attribute by the given name. |
GetLastGeneratedFilePathsFromDownload | list | Gets the absolute file paths generated during the last download. |
GetLastSelectedFilePathsFromUpload | list | Gets the absolute file paths selected during the last upload. |
GetWeldingDataSetsFromDataBase | list | Get defined welding data sets from weld database of the active controller |
GetActiveProgram | CENPyOlpProgram | Get active controller program. |
GetPrograms | list[CENPyOlpProgram] | Returns a list of programs on this controller. |
Mutation Methods
| Method | Returns | Summary |
|---|---|---|
SetActiveProgram | int | Get active controller program. |
Execution & Actions
| Method | Returns | Summary |
|---|---|---|
DownloadProgramByName | int | Downloads the program specified by its name from the current controller. |
CalculateTotalTimeForSequenceBalance | int | Method to calculate the total time for all components from active program of the current controller |
CalculateTimeForOperationInSequenceBalance | int | Method to start calculate the time for given operation |
Related Types
- Matrix
- Program
- Port
- Attribute
- Attribute Int
- Attribute Double
- Attribute String
- Attribute Bool
- Operation
Changes in R2025.2.4
Compared to R2025.1:
-
Method count increased from 34 to 39
-
[NEW]
GetActiveProgram: New method added -
[NEW]
GetPrograms: New method added -
[NEW]
SetActiveProgram: New method added -
[NEW]
CalculateTotalTimeForSequenceBalance: New method added -
[NEW]
CalculateTimeForOperationInSequenceBalance: New method added
Version Notes
This class is documented as of release R2025.2.4.
Was this page helpful?