Remote management commands
This section lists the valid remote management commands to send over a Command Interface, either a virtual COM port or serial port, using a program such as TeraTerm or PuTTY-nd for instance. You may also want to use commands in Data request commands and Dynamic configuration commands.
This section includes commands to directly change the config.txt file or to start a file transfer files from the VTAP file system via ZModem.
Note: End any command sent with a <CR> or <LF>, but not both.
A <setting> refers to one of those listed in config.txt settings .
The @... commands are similar to VTAP ?... commands, but allow the VTAP interfaces to control functionality provided by the VTAP PRO expansion board [only a VTAP100-PRO-BW in Local mode], for example Bluetooth related functions.
Settings below:
$setting | !filename | ?reformat | @BLEBeacon | @BTHostScan | @BTHostStopScan | @BTHostUnpair
Definition:
Set any setting that could be included in the config.txt file. (Note: The mass storage device will be temporarily dismounted after this action, to refresh operation of the VTAP.)
API level: 0
Options:
Multiple settings (up to 10) can be made in a single line command, by separating each setting with the <tab> character.
It is not recommended that you use this setting too frequently as it can impact flash memory life. If you require frequent changes in behaviour, use dynamic commands.
Example value: $TagLED=FF00FF,300
Definition:
This instructs the VTAP to send a copy of its file. Having sent this command to the VTAP you need to run zmodem receive in the client to collect this file. It will continue being sent until a zmodem acknowledgement is received.
API level: 0
Options:
In the example a copy of the file boot.txt will be sent over zmodem.
Example value: !boot.txt
Definition:
To reformat the VTAP file system over any serial command interface, and then remount the USB and read in the configuration.
Intended for use in event of file system corruption. There is the option to backup files then restore them, after reformatting.
Always test or load your config.txt after reformatting, then reboot.
API level: 0
Options:
?reformat preserve will copy any config.txt and serial.txt files to RAM before reformatting the VTAP reader file system, then write those saved files back to the VTAP reader.
?reformat empty will simply reformat the VTAP reader file system and leave you to add the necessary files afterwards.
Example value: ?reformat preserve
Definition:
Enables the BLE advertisement beacon on VTAP100-PRO-BW for use with any BLE beacon detecting application. BLE beacons can be used to provide location notifications, similar to GPS, but which will work where GPS will not, such as for indoor locations. One application is to trigger location notifications associated with Apple Wallet passes. When issuing a pass, a pass provider may set a location value that could comprise GPS coordinates or a BLE beacon UUID, with optional major and minor values.
API level: 0
Options:
The syntax used is
BLEBeacon i,<name_for_logging>,<uuid>,<major>,<minor>
<name_for_logging> is an optional setting, up to 15 characters long, to allocate a name to this BLE beacon that may be reported. An example use would be a VTAP PRO reader in Cloud mode returning this name, as part of the tap information sent to a customer application, to indicate which beacon was being advertised at the time of the tap.
<uuid> is the UUID (unique identifier) of the beacon to advertise. You can use any value. If intended for use with Apple Wallet passes, the UUID must match that entered in the location field of the pass.
<major> and <minor> are decimal values (0 to 65535) that must be specified as part of the BLE beacon advertisement. A beacon detecting application can be configured to trigger when a specific UUID, and optionally specific major and/or minor numbers match those being advertised. For example, an Apple Wallet pass might use wildcard values to match any major or minor values with a specific UUID, or it might be set to only trigger when a specific UUID and major number is detected. This allows, for instance, detection of all branches of a franchise, or only those in specific regions (based on a matching major), or individual locations (based on matching major and minor).
Example value:
@BLEBeacon i,loyaltybeacon,4CE2EF69-4414-469D-9D55-3EC7FCC31234,1,1
Definition:
Starts a Bluetooth scan. The VTAP PRO reader will begin scanning to find a barcode/QR scanner it can pair with. When paired scanning for new devices stops.
API level: 0
Example value: @BTHostScan
Definition:
Stops any ongoing Bluetooth scan.
API level: 0
Example value: @BTHostStopScan
Definition:
Unpairs all previously paired Bluetooth scanner devices, or a specific Bluetooth scanner device, associated with the VTAP PRO reader.
API level: 0
Options:
The syntax used is @BTHostUnpair [<device_name_or_address>].
Without the optional <device_name_or_address> all Bluetooth scanner devices will be unpaired.
<device_name_or_address> can optionally refer to one of the currently paired scanner devices. (The number of paired scanner devices and the name of the first one can be found in VCBOOT.TXT, updated on boot. A device address is 6 bytes (12 hex characters).
Example value:
@BTHostUnpair
@BTHostUnpair C barcode scanner
