User guide

Chapter 3 - RATC2
28 Version 1.7.2.0 March 27, 2015
.
Commands in detail
help Command
Command
help
Shortcut
h
Arguments
none
Availability
always
Purpose
displays a list of commands
Notes
The number of line/commands to expect is given in the first
line
Response
a list of the available commands
Usage example
help\r
or
h\r
Response
RATCv2.0 Help 15
h help : display this help list
li logIn name password : log in with a password
sg statusGet : report status
ka keepAlive seconds : disconnect if no activity in n seconds
qme quietModeEnable : suppress responses from non-query commands
qmd quietModeDisable : allow responses from all commands
cl controlList : get the list of available Controls
cg controlGet control : get a Controls value
cs controlSet control value : set a Controls value
cps controlPositionSet control value : set a Controls position
(0.00-1.00)
cgca changeGroupControlAdd [group] control : add a Control to a Change
Group
cgcr changeGroupControlRemove [group] control : remove a Control from
a Change Group
cgg changeGroupGet [group] : get changed values from a Change Group
cgc changeGroupClear [group] : clear a Change Group (of changed values)
cgs changeGroupSchedule [group] seconds : schedule recurring Change
Group gets
Note: Parsing of the help and list command responses by a software-based client is strongly
discouraged since the formats are subject to change.