Custom String

With a Custom String, a variable of the type BOOL can be described with the value TRUE in the PLC. In this way it is possible to release triggers or to activate scenes.

Syntax description

A Custom String is an ordered quantity of pre-defined parameters/value pairs. A Custom String begins with “<” (left angle bracket) and ends with “>” (right angle bracket). Each parameter is followed by “=” (equals signs) followed by the value. The individual parameters/value pairs are separated from each other by “|” (vertical line).

Custom String 1:

Parameter and values description

Parameter

Description

ADSDevice

ADS device route. Used in the TwinCAT Bang & Olufsen server to assign Custom Strings to a controller (see Configuration).

VarName

Variable name of the variable to be described.

IdxGroup

Index Group

IdxOffset

Index Offset

Custom String 2:

ADSDevice / VarName convention:

  • Letters and numbers
  • Upper/lower case is ignored
  • No special characters or umlauts, except “_” (underscore) and “.” (dot)
  • Minimum length 1 character
  • Maximum length 80 characters
Custom String 3:

IndexGroup / IndexOffset convention:

  • Can be specified in hexadecimal or decimal notation.
  • In the case of hexadecimal notation, the prefix (0x) must be placed before the value.
  • If the prefix is not set, the value is taken to be a decimal value.

Examples

Custom String 4:

Describing a global variable by name

<ADSDevice=CX_123456|VarName=.LampGroupOff>
<ADSDevice=CX_123456|VarName=.LampGroupOn>

Describing a variable within the flag range by IndexGroup \ IndexOffset

<ADSDevice=CX_123456|IdxGroup=0x4020|IdxOffset=0x00>
<ADSDevice=CX_123456|IdxGroup=0x4020|IdxOffset=0x01>

Download Bang & Olufsen Masterlink-Gateway Custom String configuration example as a CSV file