Skip to content
Model-driven PLC Application Development
Project
Initializing search
Bitbucket
UP
UPstudio
UPact
ServiceUI
Updates
Addon Development
Model-driven PLC Application Development
Bitbucket
UP
UP
Getting Started
Getting Started
Setup project with wizard
Create first controller
Setting up a target project
Setting up a target project
Setup BR project
Setup BR project
Setup BR project
Create linked target folder
Setup Beckhoff project
Setup Beckhoff project
Setup Beckhoff project
Reduce git conflicts
Setup TIA project
Parent - Child Relation
Reference
Reference
ChildIterator
CodeSnippet Editor
CodeSnippet Editor
CodeSnippet Editor
CodeSnippet (c-syntax)
CodeSnippet Text Token
Command
Common Methods
Common Methods
Base Lib
Child
Child iterator
Controller
Logger
Message
Project
Project
Table of contents
project."method"
getUPVersion
State Machine
Type Cast
Variable Reference
loogbook
Config
Config
Config
ConfigOptions
MessageInit
MessageOptions
PlatformConfig_BR
PlatformConfig_BR
PlatformConfig_BR
UserObjectConfig
LibraryConfig
LibraryConfig
LibraryConfig
OverwriteBaseLibrary
UserLibraryDefinition
IgnoreBaseLibrary
OpcUaConfig
LoggerConfig
PlatformConfig_S7Tia
PlatformConfig_S7Tia
PlatformConfig_S7Tia
OBDefinitions
Controller Tree
Controller Tree
Controller Tree
Child Instance
Level
Interlock Instance
ControllerTree Cluster
Controller
Controller
Controller
Child
ControllerActions
ControllerInstance
ControllerInterface
ControllerInterface
ControllerInterface
Input - Output
PassThroughParameter
Unit
InterfaceLocal
InterfaceLocal
InterfaceLocal
ControllerMethod
MessageDefinition
ReferenceLocalVariable
InterLock
Statemachine
Statemachine
Statemachine
StatemachineExtension
StatemachineExtension
StatemachineExtension
StateExtension
StateOverride
JunctionExtension
Junction
DynamicChild
Custom Namespace
DatatypeLibrary
DatatypeLibrary
DatatypeLibrary
AFieldSelector
ClassType
ModelConstant
ModelType
ClassType vs FunctionBlock
Deprecated Elements
FunctionLibrary
FunctionLibrary
FunctionLibrary
Function
FunctionInterface
Help system
Logger
Message handling
ModelConfig
ModelConfig
suppressDeprecatedWarning
PrefixDefinition
datatypeValidation
textToken
Remanent handling
String
Text handling
Text handling
NativeTextList
TextManager
TIA Message TextList and TextListEntry
Unit System
UPstudio
UPstudio
UPact
UPact
Getting Started
Reference
Reference
UPact
SetActionCommonControllerContext
SetActionCommonModelContext
SetActionIO
SetActionLocalVariable
SetActionSpecific
SuiteInstance
TestAction
TestAwaitAction
TestCaseInstance
TestCaseVariable
TestCase
TestController
TestControllerInterface
TestDefinitionSetUp
TestDefinitionTearDown
TestDefinition
TestSuite
TestTargetConfig
TestTarget
TimeAction
Modelling Tests
Setup Test Runner
Setup Test Runner
UPact in UPstudio
UPact Headless
UPact in ServiceUi
ServiceUI
ServiceUI
Getting Started
Getting Started
getting started
Installation (B&R)
Installation (Beckhoff TwinCAT with UP)
Installation (Beckhoff TwinCAT with BasePLC)
Installation (S7 Tia)
Access from host to virtual machine
Access from mobile devices
MQTT connection
Reference
Reference
Authentication and Authorization
Controller Tree (Service UI)
Input Output
Messages
Animation
Import Export
Configuration
Generic page
Logger
FAQ
FAQ
PLC connection
PLC connection
PLC connection
Beckhoff ADS
S7
Back-end
Front-end and browser
Miscellaneous
Miscellaneous
Data management
Front-end back-end interface
Logger component
Logger component
Logger persistence
Log file
Logger data import-export
Messages
MQTT ClassType methods
OPC-UA
PLC definition know-how
User management
Generic View
Updates
Updates
New Features and Milestones
Release Notes UP
Release Notes UP
4.3.x
4.3.x
4.3.3
4.4.x
4.4.x
4.4.0
4.4.1
4.4.2
4.4.3
4.4.4
4.4.5
4.5.x
4.5.x
4.5.0
4.5.1
4.5.2
4.5.3
4.5.4
4.5.5
4.5.6
4.5.7
5.0.x
5.0.x
5.0.0
5.0.1
5.0.2
5.1.x
5.1.x
5.1.0
6.0.x
6.0.x
6.0.0
6.0.1
6.0.2
6.0.3
6.1.x
6.1.x
6.1.0
6.1.1
6.1.2
6.1.3
6.1.4
Release Notes UPconnect
Release Notes UPconnect
UPconnect V2.0.5
UPconnect V2.0.4
UPconnect V2.0.3
UPconnect V2.0.2
UPconnect V2.0.1
UPconnect V2.0.0
UPconnect V1.9.2
UPconnect V1.9.1
UPconnect V1.9.0
UPconnect V1.8.0
UPconnect V1.7.6
Release Notes Archive
Downloads
Addon Development
Addon Development
API
API
AConstant
AInterfaceData
ASubFieldSelector
ATextSource
AbstractMessageReaction
AbstractValue
Controller
ControllerInstanceWrapper
ControllerInterface
ControllerTree
DataLimitLiteral
InputOutput
InputOutputDecorationWrapper
InterfaceDataDecorationWrapper
MessageWrapperLiteral
Resource
TypePathLiteral
Unit
Variable
Metamodel
Metamodel
Diagrams
Diagrams
Diagram_Config
Diagram_LibrariesConfig
Diagram_Logbooks
Diagram_LoggerConfig
Diagram_MessageHandler
Diagram_PlatformConfig_BR
Diagram_PlatformConfig_Siemens
Diagram_UserObjectConfig
Diagram_Child
Diagram_Controller
Diagram_ControllerInterface
Diagram_ControllerLogbook
Diagram_FunctionBlock
Diagram_InterfaceLocal
Diagram_LocalVariable
Diagram_Message
Diagram_MessageReaction
Diagram_Statemachine
Diagram_Unit
Diagram_UserTaskLink
Diagram_ControllerInstance
Diagram_ControllerTree
Diagram_InterlockInstance
Diagram_DatatypeLibrary
Diagram_Diagram_RootDatatypeLibrary
Diagram_Diagram_Types
Diagram_Field_Selector
Diagram_FunctionLibrary
Diagram_GlobalVariableLibrary
Diagram_UPact
Diagram_Text_Manager
Diagram_UPoo
Diagram_Model_Config
Diagram_Prefix
Diagram_Unit_Manager
Diagram_Deprecated_Elements
Classes
Classes
AAction
AActionWithParameter
AArgument
AAutoPrefix
ABaseLibraryDefinition
ACallingBaseElement
ACommonControllerArgument
ACommonMethodArgument
ACommonModelArgument
AComperator
AComperatorArgument
AConstant
AControl
AControllerDescription
AControllerLocalAccessibleCluster
AControllerMethod
AControllerScopeCodesnippetImplementation
ACsvColumnElement
ADeprecated
AExchangeToolConfig
AFieldComplex
AFieldSelector
AFileClientStateLog
AFunction
AFunctionBlock
AFunctionBlockCall
AFunctionBlockInterfaceMapping
AFunctionModel
AHardwareConfigS7Tia
AInterfaceData
AInterfaceSpecific
AJunctionExtension
AJunctionProperty
ALibraryConfig
ALibraryConfigDefinition
ALibraryDefinition
AMainVariable
AMessageCluster
AMethodArgument
AMethodLocalVariable
AMethodParameter
ANotAvailableOnBeckhoff_Property
ANotAvailableOnS7Tia
ANotAvailableOnS7Tia_Property
AObDefinition
AOmitFromFieldbusOwner
AOoDomain
AOoDomainRoot
AOoExtendable
AOoOverride
AOverrideableObject
AOverrider
APassThroughConnection
APlatformConfig
APlatformUserObject
APrefixedResource
AReferenceVariable
AResourceWithType
AReturnType
AServiceConfig
ASetAction
ASetActionMethod
ASmDecorator
AStandardFunction
AState
AStateExtension
AStatemachine
AStatemachineStart
AStructureType
ASubFieldSelector
ATaskGroup
ATaskGroupConfig
ATestAction
ATestController
ATestDefinition
ATestSuite
ATextSourceProperty
ATextTokenElement
ATwinCATLibrary
ATypeExtension
AUnitType
AUserObject
AUserObjectDefinition
AUserObjectInterface
AValue
AValue
AVariable
AVariableLibrary
AbstractChild
AbstractCodeSnippet
AbstractContext
AbstractDefaultData
AbstractInterlock
AbstractMessageClusterDefinition
AbstractMessageDefinition
AbstractMessageGroupDefinition
AbstractMessageLevel
AbstractMessageReaction
AbstractMessageReactionFunctions
AbstractTreeElementInstanceSelector
ActionWithArgumentParameter
ActionWithCommonParameter
ActionWithTestValueParameter
Analog_Interlock
AnnotableComment
ArrayIndex
ArrayIndex
ArrayPrefixDefinition
ArrayType
ArrayType
ArrayVariable
AspecificationMetaUnit
BR_Config
BaseArrayVariable
BaseControllerInstanceInteraction
BaseControllerTree
BaseDataVariable
BaseFunctionBlock
BaseInputPort
BaseInstanceConfig
BaseInstanceIterationConfig
BaseLibraryDefinition
BaseLogger
BaseOutputPort
BaseTreeElementInstance
BaseValue
Child
ChildInstance
ChildIterator
ChildIteratorData
ChildOverrideable
ClassType
Cluster
ClusterInstance
CodeSnippet
CodeSnippetFieldSelector
Command
Comment
Commentable
CommonArgument_deprecated
CompEQU
CompGEQ
CompGRT
CompNEQ
CompanyList
Complex
ComplexFieldSelector
Config
ConfigOptions
Constant
Controller
ControllerActions
ControllerInstance
ControllerInstanceAttributeInit
ControllerInstanceAttributes
ControllerInstancePassThroughConnection
ControllerInterface
ControllerLogbook
ControllerLogbookSelect
ControllerMethodCodesnippet
ControllerTree
CustomDataGroup
DataTypeInput
DataTypeIoType
DataTypeOutput
DataValue
DataValue
DatatypeLibrary
DatatypeLibraryExtension
DatatypeLibraryOwner
Decorator
DefaultUnits
DeprecatedInstanceConfig
DeprecatedInstanceGroup
DigitalInput
DigitalOutput
DigitalType
Digital_Interlock
DomainDiagram
DynamicChild
EnumType
EnumType
EnumTypePrefixDefinition
ExtendedLogFileConfig
ExtensionFunctionNameExpression
Field
FieldComplex
FieldComplex
FieldComplexMember
FieldSelector
FieldUnit
FileClient
FileClientBaseLog
FileClientDataLog
FileClientMessageLog
FileClientStateLog
FileCommentOptions
FileHandler
FileHandler_deprecated
Function
Function
FunctionBlock
FunctionBlockExpression
FunctionBlockModel
FunctionBlockPrefixDefinition
FunctionBlockRef
FunctionBlockType
FunctionImpl
FunctionInterface
FunctionLibrary
FunctionParameter
FunctionTextToken
FunctionVariablePrefixDefinition
GeneralTextToken
GlobalVariable
GlobalVariableLibrary
GroupSelection
GuardOverrideable
GuardTextToken
HardwareConfig
History
IDatatypeLibraryProvider
IfaceState
IgnoreBaseLibrary
InOutVariablePrefixDefinition
IndexValue
InputOutput
InstanceControllerConfig
InstanceGroup
InstanceableClusterDefinition
InterLock
IntercomTask
InterfaceArrayVariable
InterfaceData
InterfaceLocal
InterfaceOptions
InterfaceSpecific
InterlockInstance
InterlockRef
Junction
JunctionExtension
LanguageDefinition
Level
LibraryConfig
LibraryConfig
Library_deprecated
ListChildParentElement
LocalVariable
LogElement
LogFileConfig
Logbook
LogbookConfig
LogbookStorage
Logbooks
LogbooksConfig
LoggerConfig
LoggerUsage
MainVariable
ManualArgument
MessageArgument_deprecated
MessageClusterDefinition
MessageClusterDefinitionInstanceable
MessageClusterInstance
MessageClusterInstanceList
MessageClusterInstances
MessageClusterLevel
MessageClusterReaction
MessageDefinition
MessageDefinitionOverride
MessageGlobalDefinition
MessageGlobalLevel
MessageGlobalReaction
MessageHandler
MessageHandlerCustomConfig
MessageInit
MessageLogger
MessageOptions
MessageProperties
MessageReactionFunctionImpl
MessageReactionFunctions
MessageUsage
MethodModel
ModelConfig
ModelConfigControllerInterface
ModelConstant
ModelType
ModelTypeValue
NamedResource
NativeTextList
NativeTextResource
NotExistBehaviour
OBDefinition
OBDefinitions
OBSelect
OverrideableObjects
OverwriteBaseLibrary
PassThroughParameter
PlatformAttributes_S7Tia
PlatformConfig
PlatformConfig_BR
PlatformConfig_Beckhoff
PlatformConfig_S7TIA
PrefixDefinition
ProgramTyp
RangeChildFieldRef
RecordType
RecordType
RecordTypeExtension
RecordTypePrefixDefinition
Resource
RootResource
RootVariableLibrary
RootVariableName
S7Tia_Config
S7Tia_TaskTypes
ScaledSpecification
SetActionCommonControllerContext
SetActionCommonModelContext
SetActionCommon_deprecated
SetActionIO
SetActionLocalVariable
SetActionManual
SetActionSpecific
SharedFunction
SharedFunction
SharedFunctionOverrideable
Simulation
StandardFunctionGroup
StandardFunction_deprecated
StandardType
StandardType
StandardTypePrefixDefinition
State
StateBase
StateExtension
StateLogger
StateOverride
Statemachine
StatemachineExtension
StringConstant
SuiteInstance
SuiteSelect
SuiteValue
SuperState
SuperState_WithBusyFinal
SuppressDeprecatedWarning
TargetState
TaskGroupConfig_S7Tia
TaskGroup_S7Tia
TestAction
TestAwaitAction
TestCase
TestCaseInstance
TestCaseVariable
TestController
TestControllerInterface
TestDefinition
TestDefinitionSetUp
TestDefinitionTearDown
TestSuite
TestTargetConfig
TextElement
TextManager
TextTable
TextTokenLibrary
TimeAction
Transition
TransitionExtend
TransitionOverwrite
Translation
TreeElementInstanceSelector
Type
Type
UPact
UPconnectTestTargetDriver
Unit
UnitDecorator
UnitManager
UnitScale_deprecated
UnitSystem
UnitSystemConversion
UnitType
UserLibraryDefinition
UserObject
UserObjectConfig
UserObjectConfig_BR
UserObjectInterface
UserObjectInterfaceVariable
UserObjectLink
UserObjectLinkInstance
UserObjectWrapper
ValidatableType
Variable
VariableCsvElement
VariableGroup
VariableInitInterface
VariableInitTask
VariableLibrary
WebLogConfig
Table of contents
project."method"
getUPVersion
Project
project."method"
getUPVersion
RETURN TYPE:
STRING
Return:
STRING