Server

[ Class ]

Provides functions for communication with the TwinCAT HMI Server.

Static functions

Name	Description
getWebsocketReadyState	Returns the current value of the web socket state.
isWebsocketReady	Returns the communication state of the web socket.
writeSymbol	Writes one or more values to a TwinCAT HMI server symbol.
writeSymbolEx	Writes one or more values to a TwinCAT HMI server symbol.
readSymbol	Reads one or more values from a TwinCAT HMI server symbol.
readSymbolEx	Reads one or more values from a TwinCAT HMI server symbol.
request	Sends a user-defined request to the TwinCAT HMI server.
requestEx	Sends a user-defined request to the TwinCAT HMI server.
releaseRequest	Releases the resources relating to a request to the TwinCAT HMI server.
subscribe	Registers a subscription on a list of commands.
subscribeEx	Registers a subscription on a list of commands.
unsubscribe	Cancels an existing subscription.
unsubscribeEx	Cancels an existing subscription.
getCurrentUser	Returns the name of the current user as string or null.
getGroupsOfCurrentUser	Returns the names of the groups to which the current user is assigned as a string array.
getCurrentUserConfig	Returns the current user configuration.
login	Logs in a new user.
loginEx	Logs in a new user.
loginEx2	Logs in a new user.
logout	Logs out the current user.
logoutEx	Logs out the current user.
logoutEx2	Logs out the current user.
forceLogout	Logs out any user if the appropriate user privileges are available.
forceLogoutEx	Logs out any user if the appropriate user privileges are available.

Name	Description
Events	Provides functions for monitoring alarms and server events.
Historize	Provides functions for managing configuration settings of the SqliteHistorize server extension.
UserManagement	Provides functions for user management.
RecipeManagement	Provides functions for managing recipes using the RecipeManagement server extension.
ADS	Provides functions of the ADS server extension.
Domains	Provides functions for monitoring domains / extensions of the server.

Name	Description
userConfigState	Information about the state of the current user configuration.
ACCESS	Access rights within the server.

Name	Description
IResultObject	This interface extends TcHmi.IResultObject. Contains information about the success of the request and return values, if applicable.
IValueResultObject	Describes the return value plus error information for a specific symbol from a request to the TwinCAT HMI server, if applicable.
ICommand	Describes a command object in a TwinCAT HMI server request or response.
ICommandError	Describes an error within a command object of a TwinCAT HMI server request or response.
IError	Describes an error within a TwinCAT HMI server request or response.
IDomainError
userConfigOnServer	Describes a TwinCAT HMI server user configuration.
IMessage	Describes a TwinCAT HMI server request or response.
IMessageBase	Base class for all server requests or responses.
IReadWriteMessage	Describes a TwinCAT HMI server ReadWrite request or response.
ISubscriptionMessage	Describes a TwinCAT HMI server subscription request or response.
IEventMessage	Describes a TwinCAT HMI server event request or response.