7.10.1 Device driver keyword reference

The following table lists the keywords recognized in a device driver specification file in alphabetical order. When viewing this table online you may use the hyper-links in the description column to jump to the place where this keyword is explained in the manual.

= Part of the syntax of a SET or BITSET statement.
ALARM The ALARM statement defines a faults flag.
AT Within an INPUT statement, the AT clause moves the read cursor to a certain position in the received data.
BIGENDIAN Specifies that a WRITE or READ statement shall treat multibyte integer numbers in big endian (MSB first) byte order.
BIT Reads a single bit from an integer number within an INPUT statement.
BITMERGE Should no longer be used.
BITS Specifies to write or read a number of bits with in a certain byte in a WRITE or a READ statement.
BITSET The BITSET statement isolates a single bit from a numeric variable and assigns it to another one.
BITSPLIT Should no longer be used.
BOOL Defines a variable to be a boolean flag in a VAR statement.
CALL The CALL statement calls a procedure as a subroutine.
CBER Interprets a two character string as a bit error rate within an INPUT statement.
CHOICE Defines a variable to be a choice list in a VAR statement.
CHOICES Modifies a choice list variable with the RANGESET statement.
CLASS The CLASS statement defines the Java class which does the real work. Customer supplied device drivers do not require this statement.
COMMENT The COMMENT statement defines an identification for the driver which is reported to the user interface.
COPY The COPY statement copies a single parameter or a complete device setup from one device to another.
CUT Cuts a number of characters in the INPUT statement.
CYCLE Defines the refresh cycle for a variable in the VAR statement.
DELAY The DELAY statement pauses the driver execution for a certain time.
DISABLED Marks a variable to be initially disabled in a VAR statement or disables a variable with the RANGESET statement.
DRATE The DRATE statement computes an interface data rate from a symbol rate and modulation/encoding parameters.
ENABLED Enables a variable with the RANGESET statement.
FLOAT Defines a variable to be a floating point number in a VAR statement.
FLOAT16 Writes or reads a 16 bit floating point number with a WRITE or READ statement.
FLOAT32 Writes or reads a 32 bit floating point number with a WRITE or READ statement.
FLOAT64 Writes or reads a 64 bit floating point number with a WRITE or READ statement.
FMT Formats a number to a string in the PRINT statement.
GET Marks a procedure to be a GET-type one in the PROC statement.
GOTO The GOTO statement jumps to a label in a procedure.
HEX Interprets a string as a hexadecimal number in an INPUT statement or defines a variable to be a hexadecimal number in a VAR statement.
IF The IF statement conditionally executes the following statement.
INCLUDE The INCLUDE statement reads another source file.
INIT Tells the driver to initialize a variable at power up with a certain value in the VAR statement.
INPUT The INPUT statement reads a message from the device and parses the reply as text.
INT16 Writes or reads a 16 bit integer number with a WRITE or READ statement.
INT32 Writes or reads a 32 bit integer number with a WRITE or READ statement.
INT64 Writes or reads a 64 bit integer number with a WRITE or READ statement.
INT8 Writes or reads an 8 bit integer number with a WRITE or READ statement.
INTEGER Defines a variable to be an integer number in a VAR statement.
INVALIDATE The INVALIDATE statement marks a variable to be re-read in this or the next driver cycle.
LOG The LOG statement writes a message into the event log.
MAX Modifies the upper range limit of a numeric variable with the RANGESET statement.
MIN Modifies the lower range limit of a numeric variable with the RANGESET statement.
OBJECT Defines a variable to be a 'object' in a VAR statement.
OFFSET Adds an offset to as value in a PRINT or an INPUT statement.
PRINT The PRINT statement composes a text message/command and sends this to the device.
PROC The PROC keyword starts a procedure definition.
PROTOCOL The PROTOCOL statement defines the (preferred) communication protocol a driver is designed to use.
PROTOCOLPARAMETER The PROTOCOLPARAMETER statement defines parameters to be passed to the communication protocol.
PUT Marks a procedure to be a PUT-type one in the PROC statement.
PUTPRIORITY Defines that the driver shall use the put priority execution scheme for PUT/GET procedures. See Topic Tweaking the processing sequence for details.
RAISECOMMFAULT The RAISECOMMFAULT statement makes the driver to raise a communication fault.
RANGESET The RANGESET statement modifies range properties of a variable during runtime.
READ The READ statement gets a message from the device and parses the data as a binary data structure.
READHEX The READHEX reads a message from the device and formats the data as a hex dump string.
READONLY Marks a variable to be read only in a VAR statement or makes the variable read only with the RANGESET statement.
READWRITE Makes a variable writable with the RANGESET statement.
SAVE Tells the driver do save a variable's value on disk in the VAR statement.
SCALE Multiplies a value with a scale factor in a PRINT or an INPUT statement.
SEND The SEND statement sends a parameter message to another device.
SET The SET statement assigns a value to a variable.
SETUP Makes a variable appear in the setup menu for the device VAR statement.
SKIP Skips whitespace characters in the INPUT statement.
SRATE The SRATE statement computes a symbol rate from a data rate and modulation/encoding parameters.
SUBROUTINE Marks a procedure to be a subroutine when following the PROC keyword.
SUBSCRIBE Marks a procedure to be called if the value of a variable changes when following the PROC keyword.
SYNC Syncs a variable, updates the value to be commanded with the value recently read back from the device.
TABLE The TABLE statement defines a translation table.
TEXT Defines a variable to be plain text in a VAR statement.
TRM Cuts a string up to a given termination character in the INPUT statement.
VAR The VAR statement defines a driver variable.
WATCH Binds a procedure to one or more variables with the PROC statement.
WRITE The WRITE statement composes a binary message/command and sends this to the device.
WRITEHEX The WRITEHEX statement converts a hex dump string to a binary message, sends this to the device.
XLT Translates a character string through a table in a PRINT or an INPUT statement.