Table of Contents
This defines the IP protocol used for communication between different modules of Rivendell and the ripcd(8) daemon.
Connection to ripcd is by means of a TCP SOCK_STREAM connection to TCP
port 5006. The format of a message is as follows:
cmd-code [arg] [...]!
cmd-code
A two letter command code, describing the generic action to be performed
arg
Zero or more arguments, delimited by spaces or, if the last argument, by ! (see below)
The ASCII character 33, indicating the end of the command sequence.
No authentication is required to execute these.
A connection must be authenticated before these can be executed.
Request the LOGIN_NAME of the user currently logged in.
RU!
ripcd(8) will respond with
RU .
user-name!
user-nameThe LOGIN_NAME of the user currently logged in.
Login in a user.
SU
user-name!
ripcd(8) will respond with
RU .
user-name!
user-nameThe LOGIN_NAME of the user to log in.
Send an RML command to a specified host.
MS
ip-addr
echo
rml!
ip-addrIPv4 address of the destination, indotted-quad notation.
echo
1 = Request echo,
0 = Request no echo.
rmlThe RML command to send.
Echo an RML command to a specified host.
ME
ip-addr
echo
rml!
ip-addrIPv4 address of the destination, indotted-quad notation.
echo
1 = Request echo,
0 = Request no echo.
rmlThe RML command to send.
Return current GPI line cart numbers.
GC
matrix!
Request the list of macro carts currently assigned for
matrix. The following record will
be returned for each line in the matrix:
GC
matrix
gpi-line
off-cart-num
on-cart-num!
matrixThe specified matrix number.
gpi-lineThe GPI line number.
off-cart-num
The number for the cart to be activated when
gpi-line transitions to an OFF
state. 0 indicates that no
cart is currently set.
on-cart-num
The number for the cart to be activated when
gpi-line transitions to an ON
state. 0 indicates that no
cart is currently set.
Return current GPO line cart numbers.
GD
matrix!
Request the list of macro carts currently assigned for
matrix. The following record will
be returned for each line in the matrix:
GC
matrix
gpo-line
off-cart-num
on-cart-num!
matrixThe specified matrix number.
gpo-lineThe GPO line number.
off-cart-num
The number for the cart to be activated when
gpo-line transitions to an OFF
state. 0 indicates that no
cart is currently set.
on-cart-num
The number for the cart to be activated when
gpo-line transitions to an ON
state. 0 indicates that no
cart is currently set.
Return current GPI states.
GI
matrix!
Request the list of current GPI states for
matrix. The following record will
be returned for each line in the matrix:
GI
matrix
gpi-line
state
mask!
matrixThe specified matrix number.
gpi-lineThe GPI line number.
state
1 = GPI is ON,
0 = GPI is OFF.
mask
1 = GPI is ENABLED,
0 = GPI is DISABLED.
Return current GPO states.
GO
matrix!
Request the list of current GPO states for
matrix. The following record will
be returned for each line in the matrix:
GI
matrix
gpo-line
state
mask!
matrixThe specified matrix number.
gpo-lineThe GPO line number.
state
1 = GPO is ON,
0 = GPO is OFF.
mask
1 = GPO is ENABLED,
0 = GPO is DISABLED.
Return current GPI mask states.
GI
matrix!
Request the list of current GPI mask states for
matrix. The following record will
be returned for each line in the matrix:
GI
matrix
gpi-line
mask!
matrixThe specified matrix number.
gpi-lineThe GPI line number.
mask
1 = GPI is ENABLED,
0 = GPI is DISABLED.
Verify the TCP network connection.
HB!
Request a heartbeat response from the ripcd(8).
ripcd(8) will respond with
HB!.
Return current GPO mask states.
GM
matrix!
Request the list of current GPO mask states for
matrix. The following record will
be returned for each line in the matrix:
GN
matrix
gpo-line
mask!
matrixThe specified matrix number.
gpo-lineThe GPO line number.
mask
1 = GPO is ENABLED,
0 = GPO is DISABLED.
Request the state of the OnAir flag.
TA!
The following record will be returned:
TA
state!
state
1 = Active,
0 = Disabled.