Basics of basic syntax (RT Unified)

Basics of basic syntax

Characteristics

The basic syntax has the following characteristics:

Simple text-based syntax without JSON parts.
Only commands for individual objects, e.g. write access to a single tag.
Object names may not include special characters or space characters.
No cookies.

Structure of a request

<Command> <Object> <Value>

Command: Command name, e.g. "WriteTagValue"
Object: Name of the object for which the command is called, e.g. "Tag1"
Value: Input value, e.g. "True"

Structure of a response

OnSuccess:

Notify<Command> <Object> <Value1…ValueN>

Command: Command name, e.g. "ReadTagValue"
Object: Name of the object for which the command was called, e.g. "Tag1"
Value1…ValueN: For example, value and quality of the read tags

OnError:

Error<Command> <Object> <Error text>

Command: Command name, e.g. "ReadTagValue"
Object: Name of the object for which the command was called, e.g. "Tag1"
Error text: Detailed error description

Overview of the commands of the simple syntax

Command	OnSuccess	OnError	Description
`SubscribeTagValue <Tag>`	`NotifySubscribeTagValue <Tag> <Quality> <Value>`	`ErrorSubscribeTagValue <Tag> <Error text>` `ErrorNotifyTagValue <Tag> <Error text>`	Subscribe tag for monitoring. `Quality`={good, bad, uncertain}
`UnsubscribeTagValue <Tag>`	`NotifyUnsubscribeTagValue <Tag>`	`ErrorUnsubscribeTagValue <Tag> <Error text>`	Unsubscribe tag from monitoring.
`ReadTagValue <Tag>`	`NotifyReadTagValue <Tag> <Quality> <Value>`	`ErrorReadTagValue <Tag> <Error text>`	Reads the value of the tags from the system.
`WriteTagValue <Tag> <Value>`	`NotifyWriteTagValue <Tag>`	`ErrorWriteTagValue <Tag> <Error text>`	Writes the value to the tag.
`SetCharSet <Value>`	`NotifySetCharSet <Value>`	`ErrorSetCharSet <Value> <Error text>`	Changes to a different character coding.
`ReadConfig <Parameter>`	`NotifyReadConfig <Parameter> <Value>`	`ErrorReadConfig <Error text>`	Reads a setting configured for the general browse behavior.
`WriteConfig <Parameter>`	`NotifyWriteConfig <Parameter> <Value>`	`ErrorWriteConfig <Error text>`	Sets a setting for the general browse behavior.
`BrowseTags`: Initial request: `BrowseTags <System> <Page size> --filter <Filter>` Next request: `BrowseTags --next`	`NotifyBrowseTags <System>::<Tag> ... <System>::<Tag>`	`ErrorBrowseTags <Error text>`	Returns the names of the tags of the local system or all systems communicating via runtime collaboration.
`BrowseConfiguredAlarms`: Initial request: `BrowseConfiguredAlarms <System> <Page size> --filter <Filter>` Next request: `BrowseConfiguredAlarms --next`	`NotifyBrowseConfiguredAlarms <System>::<Alarm> ... <System>::<Alarm>`	`ErrorBrowseConfiguredAlarms <Error text>`	Returns the names of the configured alarms of the local system or all systems communicating via Runtime Collaboration.
`BrowseAlarmClasses <System>`	`NotifyBrowseAlarmClasses <System>::<Alarm class> ... <System>::<Alarm class>`	`ErrorBrowseConfiguredAlarms <Error text>`	Returns the alarm classes of the local system or all systems communicating via Runtime Collaboration.

Errors and error texts

This help only provides a selection of possible error messages. The error texts can also differ from the texts in your projects.

Basics of basic syntax (RT Unified) - WinCC Unified

WinCC Unified Open Pipe (RT Unified)