Standard VTAP action JSON response

This JSON response format is used by the VTAP PRO readers, to trigger user feedback, control relays or send messages to other interfaces, typically in response to a tap payload. It may be sent as a response from a custom integration with VTAP Cloud, or sent to the VTAP PRO reader's BLE GATT server.

Copy

{ 
    "action": { 
        "beep": "?beep 100,50,2",
        "led": "?led 00FF00,100,50,2",
        "message": "User Authorised",
        "controls": [
            {
                "control": "?relay 0 on delay=100 off" 
            }, 
            { 
                "control": "?relay 1,timed,6000" 
            }
        ],
        "outputs": [
            { 
                "output": ">k:A:POS barcode output via USB keyboard" 
            },
            { 
                "output": ">c:A:Output to USB COM port" 
            }
        ]
    }
}

Standard VTAP action JSON response schema
Item	Definition
beep	Can be used to send simple buzzer tones or complex sequences / play tunes. For more refer to the `?beepr` command and under Buzzer control settings. The example `"beep": "100,50,2"` sets two 100ms beeps, spaced by 50ms, at default frequency.
led	Can be used to send simple RGB colours or complex serial LED sequences. For more refer to the `?ledr` command under LED control settings. The example `"led": "00FF00,100,50,2"` sets two 100ms green LED flashes, spaced by 50ms.
message	For readers connected to VTAP Cloud only: This message will appear in the 'Last tap response' field on the Readers page in VTAP Cloud UI. Select the blue button next to a reader to view reader activity - Last tap response.
controls	An array of one or more control commands, allows independent timed switching of relays. For more refer to the `?relay` command.
outputs	An array of one or more output commands, allows messages or payloads to be sent to any of the VTAP reader interfaces. For more refer to the `>` command.