Autres/Rivendellaudio
1
0
Fork 0
mirror of https://github.com/ElvishArtisan/rivendell.git synced 2025-06-01 16:42:34 +02:00
Code Issues Projects Releases Wiki Activity

2017-11-06 Fred Gleason <fredg@paravelsystems.com>

Browse Source 
* Moved the contents of 'docs/ripc.txt' to 'docs/apis/ripc.xml.'
This commit is contained in:
Fred Gleason 2017-11-06 14:04:43 -05:00
parent c15dd802eb
commit b48b2de8a6
6 changed files with 620 additions and 88 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ChangeLog
View File

@ -16266,3 +16266,5 @@
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/MESSAGE_BOX.txt' to the
Operation Guide.
2017-11-06 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/ripc.txt' to 'docs/apis/ripc.xml.'

1
docs/Makefile.am
View File

@ -37,7 +37,6 @@ EXTRA_DIST = ALSA.txt\
PODCASTING.txt\
RDMONITOR.txt\
reports.txt\
ripc.txt\
RIVENDELL_FILTER.txt\
SAGE_ENDEC.txt\
scheduler_formats.ods\

5
docs/apis/Makefile.am
View File

@ -35,6 +35,8 @@ all-local: cae.html\
cae.pdf\
catchd.html\
catchd.pdf\
ripc.html\
ripc.pdf\
web_api.html\
web_api.pdf
@ -44,6 +46,9 @@ EXTRA_DIST = cae.html\
catchd.html\
catchd.pdf\
catchd.xml\
ripc.html\
ripc.pdf\
ripc.xml\
web_api.html\
web_api.pdf\
web_api.xml

613
docs/apis/ripc.xml Normal file
View File

@ -0,0 +1,613 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<article xmlns="http://docbook.org/ns/docbook" version="5.0">
<info>
<title>Rivendell Interprocess Communication Protocol</title>
<author>
<personname>
<firstname>Fred</firstname>
<surname>Gleason</surname>
<email>fredg@paravelsystems.com</email>
</personname>
</author>
</info>
<sect1 xml:id="overview">
<title>Overview</title>
<para>
This defines the IP protocol used for communication between different
modules of Rivendell and the
<command>ripcd</command><manvolnum>8</manvolnum> daemon.
</para>
<para>
Connection to ripcd is by means of a TCP SOCK_STREAM connection to TCP
port <userinput>5006</userinput>. The format of a message is as follows:
</para>
<para>
<replaceable>cmd-code</replaceable> [<replaceable>arg</replaceable>] [<replaceable>...</replaceable>]!
</para>
<variablelist>
<varlistentry>
<term>
<replaceable>cmd-code</replaceable>
</term>
<listitem>
<para>
A two letter command code, describing the generic action to be
performed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<replaceable>arg</replaceable>
</term>
<listitem>
<para>
Zero or more arguments, delimited by spaces or, if the last
argument, by ! (see below)
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
!
</term>
<listitem>
<para>
The ASCII character 33, indicating the end of the command sequence.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 xml:id="sect.unprivileged_commands">
<title>Unprivileged Commands</title>
<para>
No authentication is required to execute these.
</para>
<sect2 xml:id="sect.unprivileged_commands.drop_connection">
<title>Drop Connection</title>
<para>
End the session and drop the TCP connection.
</para>
<para>
<userinput>DC!</userinput>
</para>
</sect2>
<sect2 xml:id="sect.unprivileged_commands.send_password">
<title>Send Password</title>
<para>
Send a password to the server for authentication.
</para>
<para>
<userinput>PW <replaceable>passwd</replaceable>!</userinput>
</para>
<variablelist>
<varlistentry>
<term>
<replaceable>passwd</replaceable>
</term>
<listitem>
A password to be supplied before granting the client access.
</listitem>
</varlistentry>
</variablelist>
<para>
<command>ripcd</command><manvolnum>8</manvolnum> will respond
with <computeroutput>PW +!</computeroutput> or
<computeroutput>PW -!</computeroutput>, indicating the success or
failure of the authentication.
</para>
</sect2>
</sect1>
<sect1 xml:id="sect.privileged_commands">
<title>Privileged Commands</title>
<para>
A connection must be authenticated before these can be executed.
</para>
<sect2 xml:id="privileged_commands.request_user">
<title>Request User</title>
<para>
Request the LOGIN_NAME of the user currently logged in.
</para>
<para>
<userinput>RU!</userinput>
</para>
<para>
<command>ripcd</command><manvolnum>8</manvolnum> will respond with
<computeroutput>RU <replaceable>user-name</replaceable>!</computeroutput>.
</para>
<variablelist>
<varlistentry>
<term><replaceable>user-name</replaceable></term>
<listitem>
<para>
The LOGIN_NAME of the user currently logged in.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.set_user">
<title>Set User</title>
<para>
Login in a user.
</para>
<para>
<userinput>SU <replaceable>user-name</replaceable>!</userinput>
</para>
<para>
<command>ripcd</command><manvolnum>8</manvolnum> will respond with
<computeroutput>RU <replaceable>user-name</replaceable>!</computeroutput>.
</para>
<variablelist>
<varlistentry>
<term><replaceable>user-name</replaceable></term>
<listitem>
<para>
The LOGIN_NAME of the user to log in.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.rml_send">
<title>RML Send</title>
<para>
Send an RML command to a specified host.
</para>
<para>
<userinput>MS <replaceable>ip-addr</replaceable>
<replaceable>echo</replaceable>
<replaceable>rml</replaceable>!</userinput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>ip-addr</replaceable></term>
<listitem>
<para>
IPv4 address of the destination, indotted-quad notation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>echo</replaceable></term>
<listitem>
<para>
<userinput>1</userinput> = Request echo,
<userinput>0</userinput> = Request no echo.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>rml</replaceable></term>
<listitem>
<para>
The RML command to send.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.rml_echo">
<title>RML Echo</title>
<para>
Echo an RML command to a specified host.
</para>
<para>
<userinput>ME <replaceable>ip-addr</replaceable>
<replaceable>echo</replaceable>
<replaceable>rml</replaceable>!</userinput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>ip-addr</replaceable></term>
<listitem>
<para>
IPv4 address of the destination, indotted-quad notation.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>echo</replaceable></term>
<listitem>
<para>
<userinput>1</userinput> = Request echo,
<userinput>0</userinput> = Request no echo.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>rml</replaceable></term>
<listitem>
<para>
The RML command to send.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpi_carts">
<title>Get GPI Carts</title>
<para>
Return current GPI line cart numbers.
</para>
<para>
<userinput>GC <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of macro carts currently assigned for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GC
<replaceable>matrix</replaceable>
<replaceable>gpi-line</replaceable>
<replaceable>off-cart-num</replaceable>
<replaceable>on-cart-num</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpi-line</replaceable></term>
<listitem>
<para>
The GPI line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>off-cart-num</replaceable></term>
<listitem>
<para>
The number for the cart to be activated when
<replaceable>gpi-line</replaceable> transitions to an OFF
state. <computeroutput>0</computeroutput> indicates that no
cart is currently set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>on-cart-num</replaceable></term>
<listitem>
<para>
The number for the cart to be activated when
<replaceable>gpi-line</replaceable> transitions to an ON
state. <computeroutput>0</computeroutput> indicates that no
cart is currently set.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpo_carts">
<title>Get GPO Carts</title>
<para>
Return current GPO line cart numbers.
</para>
<para>
<userinput>GD <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of macro carts currently assigned for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GC
<replaceable>matrix</replaceable>
<replaceable>gpo-line</replaceable>
<replaceable>off-cart-num</replaceable>
<replaceable>on-cart-num</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpo-line</replaceable></term>
<listitem>
<para>
The GPO line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>off-cart-num</replaceable></term>
<listitem>
<para>
The number for the cart to be activated when
<replaceable>gpo-line</replaceable> transitions to an OFF
state. <computeroutput>0</computeroutput> indicates that no
cart is currently set.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>on-cart-num</replaceable></term>
<listitem>
<para>
The number for the cart to be activated when
<replaceable>gpo-line</replaceable> transitions to an ON
state. <computeroutput>0</computeroutput> indicates that no
cart is currently set.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpi_states">
<title>Get GPI States</title>
<para>
Return current GPI states.
</para>
<para>
<userinput>GI <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of current GPI states for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GI
<replaceable>matrix</replaceable>
<replaceable>gpi-line</replaceable>
<replaceable>state</replaceable>
<replaceable>mask</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpi-line</replaceable></term>
<listitem>
<para>
The GPI line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>state</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPI is ON,
<computeroutput>0</computeroutput> = GPI is OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mask</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPI is ENABLED,
<computeroutput>0</computeroutput> = GPI is DISABLED.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpo_states">
<title>Get GPO States</title>
<para>
Return current GPO states.
</para>
<para>
<userinput>GO <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of current GPO states for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GI
<replaceable>matrix</replaceable>
<replaceable>gpo-line</replaceable>
<replaceable>state</replaceable>
<replaceable>mask</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpo-line</replaceable></term>
<listitem>
<para>
The GPO line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>state</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPO is ON,
<computeroutput>0</computeroutput> = GPO is OFF.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mask</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPO is ENABLED,
<computeroutput>0</computeroutput> = GPO is DISABLED.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpi_mask_states">
<title>Get GPI Mask States</title>
<para>
Return current GPI mask states.
</para>
<para>
<userinput>GM <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of current GPI mask states for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GI
<replaceable>matrix</replaceable>
<replaceable>gpi-line</replaceable>
<replaceable>mask</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpi-line</replaceable></term>
<listitem>
<para>
The GPI line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mask</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPI is ENABLED,
<computeroutput>0</computeroutput> = GPI is DISABLED.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.get_gpo_mask_states">
<title>Get GPO Mask States</title>
<para>
Return current GPO mask states.
</para>
<para>
<userinput>GM <replaceable>matrix</replaceable>!</userinput>
</para>
<para>
Request the list of current GPO mask states for
<replaceable>matrix</replaceable>. The following record will
be returned for each line in the matrix:
</para>
<para>
<computeroutput>GN
<replaceable>matrix</replaceable>
<replaceable>gpo-line</replaceable>
<replaceable>mask</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>matrix</replaceable></term>
<listitem>
<para>
The specified matrix number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>gpo-line</replaceable></term>
<listitem>
<para>
The GPO line number.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable>mask</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = GPO is ENABLED,
<computeroutput>0</computeroutput> = GPO is DISABLED.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 xml:id="privileged_commands.reload_gpi_table">
<title>Reload GPI Table</title>
<para>
Reload the GPI table in <command>ripcd</command><manvolnum>8</manvolnum>.
</para>
<para>
<userinput>RG!</userinput>
</para>
</sect2>
<sect2 xml:id="privileged_commands.get_onair_flag">
<title>Get OnAir Flag</title>
<para>
Request the state of the OnAir flag.
</para>
<para>
<userinput>TA!</userinput>
</para>
<para>
The following record will be returned:
</para>
<para>
<computeroutput>TA<replaceable>state</replaceable>!</computeroutput>
</para>
<variablelist>
<varlistentry>
<term><replaceable>state</replaceable></term>
<listitem>
<para>
<computeroutput>1</computeroutput> = Active,
<computeroutput>0</computeroutput> = Disabled.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
</article>

86
docs/ripc.txt
View File

@ -1,86 +0,0 @@
Rivendell Interprocess Communication Protocol
This defines the IP protocol used for communication between different
modules of Rivendell and the 'ripcd' 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>[<arg>][...]!
where:
<cmd> is a two-letter code indicating the nature of the message.
<arg> is zero or more arguments.
! is an ASCII character 0x21.
UNPRIVILEDGED COMMANDS -- no authentication is required to execute these.
DC! -- DROP CONNECTION
End the session and drop the TCP connection.
PW <passwd>! -- SEND PASSWORD
Send a password to authenticate the connection. Ripcd will respond
with 'PW +!' or 'PW -!', indicating the success or failure of the
authentication.
PRIVILEDGED - a connection must be authenticated before these can be
executed.
RU! -- Request User
Request the LOGIN_NAME of the user currently logged in.
Ripcd will respond with RU <user>!.
SU <user>! -- SET USER
Log <user> in. Ripcd will respond with RU <user>!
MS <ip-addr> <echo> <rml-cmd>!
Send an RML command to the specified destination.
ME <ip-addr> <echo> <rml-echo>!
Send an RML echo to the specified destination.
GC <matrix>!
Return the current GPI line cart numbers for matrix <matrix>.
Return for each line:
GC <matrix> <gpi-line> <off-cart-num> <on-cart-num>!
Indicates a change in a GPI line cart number (receive only).
GD <matrix>!
Return the current GPO line cart numbers for matrix <matrix>.
Return for each line:
GD <matrix> <gpo-line> <off-cart-num> <on-cart-num>!
Indicates a change in a GPO line cart number (receive only).
GI <matrix>!
Return the current GPI line states for matrix <matrix>.
Return for each line:
GI <matrix> <gpi-line> <gpi-state> <mask-state>!
Indicates a change in a GPI line status (receive only).
GO <matrix>!
Return the current GPO line states for matrix <matrix>.
Return for each line:
GO <matrix> <gpo-line> <gpo-state> <mask-state>!
Indicates a change in a GPO line status (receive only).
GM <matrix>!
Return the current GPI line mask states for matrix <matrix>.
Return for each line:
GM <matrix> <gpi-line> <state>!
Indicates a change in a GPI line mask status (receive only).
GN <matrix>!
Return the current GPO line mask states for matrix <matrix>.
Return for each line:
GN <matrix> <gpo-line> <state>!
Indicates a change in a GPO line mask status (receive only).
RG!
Reload the GPI table.
TA!
Request the current state of the On Air flag.
Ripcd will respond with TA 0|1!, with 0 = Off and 1 = On.

1
rivendell.spec.in
View File

@ -380,7 +380,6 @@ rm -rf $RPM_BUILD_ROOT
%doc conf/my.cnf-master
%doc conf/my.cnf-standby
%doc docs/colors
%doc docs/ripc.txt
%doc docs/pam_rd.txt
%doc docs/tables/audio_perms.txt
%doc docs/tables/audio_ports.txt