vda-5050-cli/schema/v3.0/instant-actions.schema.json

Command line interface for developing VDA 5050 clients

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "instantActions",
    "description": "JSON Schema for publishing instantActions that the mobile robot is to execute as soon as they arrive.",
    "required": [
        "headerId",
        "timestamp",
        "version",
        "manufacturer",
        "serialNumber",
        "actions"
    ],
    "subtopic": "/instantActions",
    "type": "object",
    "properties": {
        "headerId": {
            "title": "headerId",
            "type": "integer",
            "description": "headerId of the message. The headerId is defined per topic and incremented by 1 with each sent (but not necessarily received) message."
        },
        "timestamp": {
            "title": "timestamp",
            "type": "string",
            "format": "date-time",
            "description": "Timestamp in ISO8601 format (YYYY-MM-DDTHH:mm:ss.fffZ).",
            "examples": [
                "1991-03-11T11:40:03.123Z"
            ]
        },
        "version": {
            "title": "Version",
            "type": "string",
            "description": "Version of the protocol [Major].[Minor].[Patch]",
            "examples": [
                "1.3.2"
            ]
        },
        "manufacturer": {
            "type": "string",
            "description": "Manufacturer of the mobile robot"
        },
        "serialNumber": {
            "type": "string",
            "description": "Serial number of the mobile robot."
        },
        "actions": {
            "type": "array",
            "items": {
                "type": "object",
                "description": "Describes an action that the mobile robot can perform.",
                "required": [
                    "actionId",
                    "actionType",
                    "blockingType"
                ],
                "properties": {
                    "actionType": {
                        "type": "string",
                        "description": "Name of action. Identifies the function of the action."
                    },
                    "actionId": {
                        "type": "string",
                        "description": "Unique ID to identify the action and map them to the actionState in the state. Suggestion: Use UUID."
                    },
                    "actionDescriptor": {
                        "type": "string",
                        "description": "Additional information on the action."
                    },
                    "blockingType": {
                        "type": "string",
                        "description": "The blocking type of an instant action is always NONE: action can happen in parallel with others, including movement.",
                        "enum": [
                            "NONE"
                        ]
                    },
                    "actionParameters": {
                        "type": "array",
                        "description": "Action parameters for the indicated action, e.g., deviceId, loadId, external Triggers.",
                        "items": {
                            "title": "actionParameter",
                            "type": "object",
                            "required": [
                                "key",
                                "value"
                            ],
                            "properties": {
                                "key": {
                                    "type": "string",
                                    "description": "The key of the action parameter.",
                                    "examples": [
                                        "duration",
                                        "direction",
                                        "signal"
                                    ]
                                },
                                "value": {
                                    "type": [
                                        "array",
                                        "boolean",
                                        "number",
                                        "integer",
                                        "string",
                                        "object"
                                    ],
                                    "description": "The value of the action parameter",
                                    "examples": [
                                        103.2,
                                        "left",
                                        true,
                                        [
                                            "arrays",
                                            "are",
                                            "also",
                                            "valid"
                                        ],
                                        {
                                            "objects": "as",
                                            "well": true
                                        }
                                    ]
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "$id": "http://vda-5050-schema.org/v3.0/instant-actions.schema.json"
}