2019-01-08 Fred Gleason <fredg@paravelsystems.com>

* Removed the 'Configuring Now & Next Parameters' subsection from
	'Configuring RDAirPlay' in the Operations Guide.
	* Added a 'Managing PyPAD Instances' subsection to the 'Configuring
	RDAirPlay section in the Operations Guide.
This commit is contained in:
Fred Gleason
2019-01-08 17:42:45 -05:00
parent 399a6c678f
commit 4d135e4270
8 changed files with 71 additions and 63 deletions

View File

@@ -1313,69 +1313,6 @@
</para>
</note>
</sect3>
<sect3 xml:id="rdadmin.manage_hosts.configuring_now___next_parameters">
<title>Configuring Now &amp; Next Parameters</title>
<para>
Transmission of program associated data (PAD) (also known as
<emphasis>Now &amp; Next</emphasis> in Rivendell) can be configured
by touching the
<computeroutput>Configure Now &amp; Next Parameters</computeroutput>
button, bringing up the Edit Now &amp; Next Data Dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.rdairplay_edit_now___next_data_dialog.png" scale="60"/>
</imageobject>
<caption>
<para>The Edit Now &amp; Next Data Dialog</para>
</caption>
</mediaobject>
</para>
<note>
<para>
Now &amp; Next data for Rivendell was originally transmitted by
means of an integrated UDP packet transmitter. While currently
still supported, this method has been deprecated in favor of the
<emphasis>Rivendell Loadable Modules</emphasis> (RLMs), a far more
powerful method that involves the use of plug-in code modules. RLM
is the only method that is documented here.
</para>
</note>
<para>
RLMs can be added by touching the
<computeroutput>Add</computeroutput> button to bring up the
Edit Plugin Dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.rdairplay_edit_plugin_dialog.png" scale="60"/>
</imageobject>
<caption>
<para>The Edit Plugin Dialog</para>
</caption>
</mediaobject>
</para>
<para>
The <computeroutput>Plugin Path:</computeroutput> field should
contain the full path to the RLM plug-in binary. For all RLMs
provided as part of stock Rivendell, the
<computeroutput>Argument:</computeroutput> field should contain
the full path to the configuration file for the plug-in, samples of
which can be found in the Rivendell docuementation directory.
</para>
<warning>
<para>
When configuring a new plug-in, be sure to make a <emphasis>copy
</emphasis> of the configuration file to the
<userinput>/etc</userinput> directory
and use it, rather than pointing to the original. Otherwise, any
changes made to the file may be overwritten next time Rivendell
is upgraded on the system!
</para>
</warning>
</sect3>
</sect2>
<sect2 xml:id="sect.rdadmin.manage_hosts.configuring_rdpanel">
<title>Configuring RDPanel</title>
@@ -2263,6 +2200,69 @@
<xref linkend="sect.rml.disconnect_jack_ports__jd_" />.
</para>
</sect2>
<sect2 xml:id="sect.rdadmin.managing_pypad_instances">
<title>Managing PyPAD Instances</title>
<para>
PyPAD is a system that is built into Rivendell that
allows processing and transmission of Program Associated Data [PAD]
by means of scripts written in the popular Python programming
language. To see the list of PyPAD scripts configured to run on
the selected host, touch the
<computeroutput>PyPAD Instances</computeroutput> button to open
the PyPAD Instances dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.pypad_instances_dialog.png" scale="60"/>
</imageobject>
<caption>
<para>The PyPAD Instances Dialog</para>
</caption>
</mediaobject>
</para>
<para>
To add a new PyPAD instance, touch the
<computeroutput>Add</computeroutput> button to open the Select PyPAD
Script dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.select_pypad_script_dialog.png" scale="60"/>
</imageobject>
<caption>
<para>The Select PyPAD Script Dialog</para>
</caption>
</mediaobject>
</para>
<para>
Select a script from the list and then touch the
<computeroutput>Open</computeroutput> button to open the Edit PyPAD
Instance dialog.
</para>
<para>
<mediaobject>
<imageobject>
<imagedata align="center" fileref="rdadmin.edit_pypad_instance_dialog.png" scale="60"/>
</imageobject>
<caption>
<para>The Select PyPAD Script Dialog</para>
</caption>
</mediaobject>
</para>
<para>
The <computeroutput>Configuration</computeroutput> box contains lines of
text that control the behavior of the script that's been selected.
Lines that begin with a semicolon character [;] are comments; the rest
are directives to the script.
</para>
<para>
When finished editing the configuration, touch the
<computeroutput>OK</computeroutput> button to save the configuration
and start the script running.
</para>
</sect2>
</sect1>
<sect1 xml:id="sect.rdadmin.manage_system_settings">
<title>Managing System Settings</title>