Defines configuration options of a VDA 5050 client, including MQTT transport options.

Hierarchy

  • ClientOptions

Properties

interfaceName: string

Name of the used interface (required).

The interface name defines a common namespace for communication among clients of a driverless transport system. Communication messages are only routed between clients specifying a common interface name. The interface name is part of the underlying MQTT topics and used to isolate different transport systems sharing the same MQTT infrastructure.

Remarks

As this property is used as a topic level of an MQTT topic, it must not include the characters NULL (U+0000), # (U+0023), + (U+002B), and / (U+002F).

This property may also be an empty string according to VDA 5050 specification.

topicObjectValidation?: {
    inbound: boolean;
    outbound: boolean;
}

Determines whether runtime validation checks of VDA 5050 communication topic-objects should be performed for inbound and/or outbound messages (optional).

Validation passes if the message payload object structure conforms to the VDA 5050 communication topic. For example, if an "order" topic is given, the object's properties must satisfy the structure and constraints of a VDA 5050 Order as defined by its JSON schema.

By default, validation checks are enabled for both inbound and outbound messages. Thus, if not specified, value defaults to { inbound: true, outbound: true }.

Remarks

An object may include additional properties which are not defined in the corresponding JSON schema. These properties are ignored, i.e. not validated.

If your MQTT broker supports VDA 5050 conformant topic-payload validation of published messages and the client connections are secured, you may turn off client-side validation completely by setting this property to { inbound: false, outbound: false }.

Type declaration

  • inbound: boolean
  • outbound: boolean

MQTT-specific transport options for a VDA 5050 client (required).

vdaVersion: VdaVersion

Represents the selected VDA5050 version (required).

Generated using TypeDoc