vda-5050-cli/schema/v2.0/connection.schema.json

Command line interface for developing VDA 5050 clients

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://vda-5050-schema.org/v2.0/connection.schema.json",
    "title": "connection",
    "description": "AGV connection state reported as a last will message. Has to be sent with retain flag.\nOnce the AGV comes online, it has to send this message on its connect topic, with the connectionState enum set to \"ONLINE\".\n The last will message is to be configured with the connection state set to \"CONNECTIONBROKEN\".\nThus, if the AGV disconnects from the broker, master control gets notified via the topic \"connection\".\nIf the AGV is disconnecting in an orderly fashion (e.g. shutting down, sleeping), the AGV is to publish a message on this topic with the connectionState set to \"OFFLINE\".",
    "documentVersion": "2.0, November 2023",
    "subtopic": "/connection",
    "type": "object",
    "allOf": [
        {
            "$ref": "http://vda-5050-schema.org/v2.0/common.schema.json#/definitions/header"
        },
        {
            "properties": {
                "connectionState": {
                    "type": "string",
                    "description": "Connection state.\nONLINE: connection between AGV and broker is active.\nOFFLINE: connection between AGV and broker has gone offline in a coordinated way.\nCONNECTIONBROKEN: The connection between AGV and broker has unexpectedly ended.",
                    "enum": [
                        "ONLINE",
                        "OFFLINE",
                        "CONNECTIONBROKEN"
                    ]
                }
            },
            "required": [
                "connectionState"
            ]
        }
    ]
}