TcHmiSrv.Core Namespace

Contains the core types of the TwinCAT HMI server extension API.

Classes

 

Class

Description

TcHmiSrv.Core Namespace 1:

Alarm

Represents an alarm.

TcHmiSrv.Core Namespace 2:

Command

Represents a command to execute a symbol of the TwinCAT HMI server or a TwinCAT HMI server extension.

TcHmiSrv.Core Namespace 3:

CommandGroup

Represents a group of Commands.

TcHmiSrv.Core Namespace 4:

Context

Represents the context of an invoked method or symbol.

TcHmiSrv.Core Namespace 5:

DateTimeRange

Provides the smallest and largest possible value of DateTime that the TwinCAT HMI server can handle.

TcHmiSrv.Core Namespace 6:

Event

Represents an event.

TcHmiSrv.Core Namespace 7:

Message

Represents a message

TcHmiSrv.Core Namespace 8:

Session

Represents a session that contains information about an active user.

TcHmiSrv.Core Namespace 9:

SteadyTime

Provides a property to access the steady clock of the TwinCAT HMI server.

TcHmiSrv.Core Namespace 10:

UnixTime

Provides the zero DateTime value that represents the default DateTime value of the TwinCAT HMI server.

TcHmiSrv.Core Namespace 11:

Value

Represents a value of any ValueType.

Interfaces

 

Interface

Description

TcHmiSrv.Core Namespace 12:

ILocalizable

Provides an interface for a localizable object that contains a language variable and parameters.

TcHmiSrv.Core Namespace 13:

ITcHmiSrvExtAsyncDebugHost

Provides an interface to wait for a debugger to be attached to the current process.
The provided methods only wait for a debugger to be attached to the current process if DebugConfigurationEnabled is true, which is the default when building TwinCAT HMI server extensions with the Debug configuration.
To enable the Debug configuration at runtime, call EnableDebugConfiguration, otherwise the other methods have no effect.

TcHmiSrv.Core Namespace 14:

ITcHmiSrvExtAsyncHost

Provides an interface to synchronously and asynchronously communicate with the TwinCAT HMI server.
All methods that do not end with Async are executed synchronously and block until the specific request has been sent to the TwinCAT HMI server and a corresponding response has been received.
The other methods that end with Async are executed asynchronously and do not block. Instead, they return a Task or TaskTResult that represents the asynchronous operation.

TcHmiSrv.Core Namespace 15:

ITcHmiSrvExtAsyncTimeoutHost

Provides an interface to get and set the request timeout between the TwinCAT HMI extension container and remote TwinCAT HMI server.

TcHmiSrv.Core Namespace 16:

ITcHmiSrvExtHost

Provides an interface to communicate with the TwinCAT HMI server.
Obsolete

Enumerations

 

Enumeration

Description

TcHmiSrv.Core Namespace 17:

Access

 

TcHmiSrv.Core Namespace 18:

AlarmChangeType

 

TcHmiSrv.Core Namespace 19:

AlarmConfirmationState

 

TcHmiSrv.Core Namespace 20:

AlarmState

 

TcHmiSrv.Core Namespace 21:

CommandOption

Options that clients can set only in configuration requests:
- Add
- Replace
- Delete
- Transaction
- Import

Options that clients can set in all requests
- SendWriteValue
- SendErrorMessage
- Poll
- Offline
- UniqueHash
- ValidateRead
- ProcessTimingAsTimespan

Options set by the server or extension:
- PagingHandled

TcHmiSrv.Core Namespace 22:

ConfigChangeType

 

TcHmiSrv.Core Namespace 23:

EndpointInfo

 

TcHmiSrv.Core Namespace 24:

ErrorValue

 

TcHmiSrv.Core Namespace 25:

EventLifetime

 

TcHmiSrv.Core Namespace 26:

EventType

 

TcHmiSrv.Core Namespace 27:

ListenerType

 

TcHmiSrv.Core Namespace 28:

RequestType

 

TcHmiSrv.Core Namespace 29:

Severity

 

TcHmiSrv.Core Namespace 30:

ValueType

 

Copyright © Beckhoff Automation GmbH & Co. KG