FSR HuddleVU User Manual

Page 29

Advertising
background image

29

Huddle-VU

REQUEST/RESPONSE FORMAT

All requests and responses are entirely in ASCII. The requests can be in either upper or lower case.

All requests/responses have a type fi eld followed by the data required for that specifi c request/response. All
requests are terminated with a carriage return (0Dh), which is referred to in this document as <cr> or with
a semi-colon character (;). The semi-colon permits the user to enter multiple commands in a single line of
ASCII text. All responses are terminated with a carriage return <cr> and a line feed (0Ah) which will be
referred as <lf>.

Field Separators
Fields are separated by white space, that is, any number of spaces or tabs as long as the entire command is
less than 256 characters. A <cr> terminates the command. Below is an example describing a command.

EX 05 <cr>

So the actual message would look like this:

EX 05<cr>

COMMAND REQUEST SYNTAX:

This document uses the following notation when describing the syntax of a command request:

BOLD – identifi es the command
lower case – identifi es data to be entered which is described in the text following the syntax

description

" " - entry defi ned within double quotes is to be entered exactly as shown
< > - entry defi ned within these brackets is required
[ ] - entry defi ned within these brackets is optional
{ } - entry defi ned within curly brackets must be entered at least once
| - a vertical bar denotes a logical choice of entry
* - an asterisk following either [ ] brackets or curly brackets { } above denotes that data within either

brackets or curly brackets may be entered multiple times.

COMMAND REQUEST COMMENT FIELDS

The ASCII syntax of the request protocol accommodates the ability to optionally insert comments into the
Command Request. .Comments must be enclosed within the # character. The comments are ignored by the
Huddle-VU.

Example:
Below is an example of uncommented connection commands.
CON 1<cr>
LOCK 4<cr>
The above could have comments added as follows:
CON 1 # Laptop 1# <cr>
LOCK 4 #Limited access# <cr>

Advertising
This manual is related to the following products: