4-58 Subject to Export Control, see Cover Page for details.
4-11-5. GENERAL SCRIPTING COMMANDS
In Scripting, all RCI commands start with a “:” (colon). There are a few special commands that start
with a “*” (star). In addition, all Lua commands must end with a “;” (semicolon) when writing scripts.
COMMAND DESCRIPTION
:scripting:dialog:create Opens a dialog box. Old screen data is not
saved so when the dialog box is closed, the
script must ensure the dialog box is set to a
valid screen. The screen may also need to be
set to defaults before the screen is displayed
properly.
:scripting:dialog:close Closes a previously opened dialog box.
:scripting:softkey:label < 1 to 5 >, “string” Prints the described quoted string in the desired
soft key position.
:scripting:softkey:clear Blanks all soft key positions.
:scripting:log:print “string” Provides a way to print diagnostic messages to
the console via PPC RS-232. The PPC RS-232
uses a fixed setting of 115200N81.
:scripting:screen:print X_VAL,Y_VAL, “string” Prints the given string to the given x,y
coordinates on the dialog box.
:scripting:screen Returns to the Scripts Screen.
:scripting:exit Signals the end of a running script so that other
scripts may then be run. This command does
not automatically return the user to the Scripts
Screen.
:scripting:event:enable < 1 - 5 > “Lua command” Sets the event for the given soft key to be the
given Lua command. The command can be any
available scripting or Lua command.
:scripting:event:idle Provides a waiting mechanism so the script
blocks waiting for some user keypad action.
When this command completes, the dialog block,
if open, closes.
:scripting:sleep <ms> Causes the script interpreter to pause for the
supplied number of milliseconds (ms). For time
>1 minute, the sleep is truncated to 1 minute.
:scripting:alarm <ms> Causes the 3500 / 3500A enunciator to sound
for 0 to 1000 milliseconds (ms).
:scripting:entry:idle xpos, ypos, size Create a box on a dialog screen for the user to
input data and creates two soft keys (“ESC” and
"DONE"). "ESC" returns an empty string.
"DONE" returns the inputted data. Size is the
number of characters to be read (1 to 16). The
xpos and ypos are screen coordinates that
denotes the top left corner of the entry box.
:scripting:meter:clear “RCI screen command” Causes the script to fill the find screen path and
resets the custom.ini file.
Example: screen_transmitter_test
To Next Page
Loading...
