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

* Moved the contents of 'docs/GPIO.txt' to the Operations Guide.
This commit is contained in:
Fred Gleason 2017-11-03 08:05:32 -04:00
parent a8336a3a60
commit e0a86cbd83
6 changed files with 235 additions and 190 deletions

View File

@ -16231,3 +16231,5 @@
* Added a screenshot for RMLSend to the Operations Guide.
2017-11-02 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/SWITCHERS.txt' to the Operations Guide.
2017-11-03 Fred Gleason <fredg@paravelsystems.com>
* Moved the contents of 'docs/GPIO.txt' to the Operations Guide.

View File

@ -1,185 +0,0 @@
GPIO Notes for Rivendell
Rivendell supports the following General Purpose Input/Output (GPIO)
devices:
Gameport Joystick Buttons
USB Joystick Buttons
Measurement Computing PCI-PDIS08 Board
Measurement Computing PCI-PDIS16 Board
Measurement Computing PCI-DIO24 Board
Several supported switcher devices feature GPIO capabiities as well,
see the file 'SWITCHERS.txt' for more info.
JOYSTICK DEVICES
Joystick support utilizes the Linux Input Device subsystem. Inputs
are active-low, and should be wired as follows:
02: Input 1
04: Ground
07: Input 2
05: Ground
10: Input 3
12: Ground
14: Input 4
12: Ground
In addition, you will need to connect 47 kohm resistors between the
following pins: 1-3, 6-8, 9-11 and 13-15. While not strictly needed
for the GPI portion of the interface to work, the kernel's analog
joystick driver will refuse to initialize the port if these resistors
(or a real joystick) are not present.
The device name of the joystick will be one of the /dev/input/event<n>
devices.
NOTE: There have been reports that some port models do not internally
connect pin 12 to ground. The symptom of this situation will be that
Inputs 1 and 2 work, but not Inputs 3 and 4. If this is the case,
connecting the ground for Inputs 3 and 4 to pins 04 or 05 should remedy
the problem.
MEASUREMENT COMPUTER GPIO BOARDS
To configure one of the supported MeasurementComputing GPIO boards,
proceed as follows:
1) Install the card(s) in the computer. In the case of the PCI-DIO24,
two cards may be necessary, as each seperate card is entirely
utilized as either inputs or outputs.
2) Test it out. Two programs exist for this purpose: 'gpitest' tests
GPI inputs, and 'gpotest' tests GPO outputs. These programs come
with the 'libradio' package.
3) Define a GPIO device in RDAdmin->Stations->Switcher/GPIO. Use
a device type of 'Local GPIO'.
-----------------------------------------------------------------------------
GPIO BOARD-SPECIFIC NOTES
The Measurement Computing PCI-PDIS08 and PCI-PDIS16 boards feature
floating, opto-isolated inputs. The inputs are not polarity sensitive
and may be driven by either AC or DC. The outputs are electro-mechanical
relays with dry contacts. Connector pinouts are as follows:
PCI-PDIS08 -- DB37 Male Connector
PCI-PDIS16 -- DB37 Male Connector (using C50F-37F Cable)
Pin Signal
----------------
1 Input 8/16
20 Input 8/16
2 Input 7/15
21 Input 7/15
3 Input 6/14
22 Input 6/14
4 Input 5/13
23 Input 5/13
5 Input 4/12
24 Input 4/12
6 Input 3/11
25 Input 3/11
7 Input 2/10
26 Input 2/10
8 Input 1/9
27 Input 1/9
9 Output 8/16 C
28 Output 8/16 N/O
10 Output 7/15 C
29 Output 7/15 N/O
11 Output 6/14 C
30 Output 6/14 N/O
12 Output 5/13 N/C
13 Output 5/13 N/O
31 Output 5/13 C
14 Output 4/12 C
32 Output 4/12 N/C
33 Output 4/12 N/O
15 Output 3/11 N/C
16 Output 3/11 N/O
34 Output 3/11 C
17 Output 2/10 C
35 Output 2/10 N/C
36 Output 2/10 N/O
18 Output 1/9 N/C
19 Output 1/9 N/O
37 Output 1/9 C
----------------------
C = Common
N/O = Normally Open
N/C = Normally Closed
-----------------------------------------------------------------------------
The Measurement Computing PCI-DIO24 board features TTL logic-level
connections, which can be configured to operate either as inputs or
outputs. Connector pinouts are as follows:
PCI-DIO24 -- DB37 Male Connector
Pin Signal
---------------------
37 Input/Output 1
36 Input/Output 2
35 Input/Output 3
34 Input/Output 4
33 Input/Output 5
32 Input/Output 6
31 Input/Output 7
30 Input/Output 8
10 Input/Output 9
9 Input/Output 10
8 Input/Output 11
7 Input/Output 12
6 Input/Output 13
5 Input/Output 14
4 Input/Output 15
3 Input/Output 16
29 Input/Output 17
28 Input/Output 18
27 Input/Output 19
26 Input/Output 20
25 Input/Output 21
24 Input/Output 22
23 Input/Output 23
22 Input/Output 24
11 Ground
13 Ground
15 Ground
17 Ground
19 Ground
21 Ground
18 +5 VDC
20 +5 VDC
16 +12 VDC
14 -12 VDC
WARNING: The +5 VDC, +12 VDC and -12 VDC pins are connected directly to
the power supply buss of the host PC. Improper use of these pins can
cause serious damage to your computer!
-----------------------------------------------------------------------------

View File

@ -35,7 +35,6 @@ EXTRA_DIST = ALSA.txt\
datetime_wildcards.txt\
implemented_macros.txt\
ENCODERS.txt\
GPIO.txt\
JACK.txt\
MESSAGE_BOX.txt\
metadata_wildcards.txt\
@ -49,7 +48,6 @@ EXTRA_DIST = ALSA.txt\
RIVENDELL_FILTER.txt\
SAGE_ENDEC.txt\
scheduler_formats.ods\
SWITCHERS.txt\
WIN32.txt\
WINGS_FILTER.txt

View File

@ -1 +0,0 @@
The contents of this file have been moved to the Rivendell Operations Guide.

View File

@ -8126,6 +8126,239 @@ under certain conditions; type `show c' for details.
</sect2>
</sect1>
<sect1 id="sect.gpio_switcher_devices.local_gpio">
<title>Local GPIO</title>
<variablelist>
<varlistentry>
<term>Driver Name:</term>
<listitem>
<para>
Local GPIO
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Supported RML Commands:</term>
<listitem>
<para>
<simplelist>
<member>GPI Enable ['<command>GE</command>']</member>
<member>GPI Set ['<command>GI</command>']</member>
<member>GPO Set ['<command>GO</command>']</member>
</simplelist>
</para>
</listitem>
</varlistentry>
</variablelist>
<sect2>
<title>General Notes</title>
<para>
This driver supports a variety of GPIO devices, including:
<simplelist>
<member>15 Pin Joystick Port</member>
<member>USB HID Devices</member>
<member>MeasurementComputing GPIO Cards</member>
</simplelist>
</para>
<sect3 id="sect.gpio_switcher_devices.joysticks">
<title>15 Pin Joystick Port</title>
<para>
Joystick support utilizes the Linux Input Device subsystem. Inputs
are active-low, and should be wired as follows:
</para>
<table frame="none">
<title>15 Pin Joystick Port Wiring</title>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="Pin" colwidth="1.0*"/>
<colspec colname="Signal" colwidth="20.0*"/>
<thead>
<row><entry>Pin</entry><entry>Signal</entry></row>
</thead>
<tbody>
<row><entry>2</entry><entry>Input 1</entry></row>
<row><entry>4</entry><entry>Ground</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>7</entry><entry>Input 2</entry></row>
<row><entry>5</entry><entry>Ground</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>10</entry><entry>Input 3</entry></row>
<row><entry>12</entry><entry>Ground</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>14</entry><entry>Input 4</entry></row>
<row><entry>12</entry><entry>Ground</entry></row>
</tbody>
</tgroup>
</table>
<para>
In addition, you will need to connect 47 kohm resistors between the
following pins: 1-3, 6-8, 9-11 and 13-15. While not strictly needed
for the GPI portion of the interface to work, the kernel's analog
joystick driver will refuse to initialize the port if these resistors
(or a real joystick) are not present.
</para>
<para>
The device name of the joystick will be one of the
<userinput>/dev/input/event<replaceable>n</replaceable></userinput>
devices.
</para>
<para>
NOTE: There have been reports that some port models do not internally
connect pin 12 to ground. The symptom of this situation will be that
Inputs 1 and 2 work, but not Inputs 3 and 4. If this is the case,
connecting the ground for Inputs 3 and 4 to pins 04 or 05 should remedy
the problem.
</para>
</sect3>
<sect3 id="sect.gpio_switcher_devices.measurementcomputing">
<title>MeasurementComputing GPIO Cards</title>
<para>
The following MeasurementComputing cards are supported:
</para>
<simplelist>
<member><link endlink="sect.gpio_switcher_devices.measurementcomputing.pci_pdis08_and_pci_pdis16">PCI-PDIS08</link></member>
<member><link endlink="sect.gpio_switcher_devices.measurementcomputing.pci_pdis08_and_pci_pdis16">PCI-PDIS16</link></member>
<member><link endlink="sect.gpio_switcher_devices.measurementcomputing.pci_dio24">PCI-DIO24</link></member>
</simplelist>
<para>
The device name for the card should be
<userinput>/dev/gpio<replaceable>n</replaceable></userinput>.
</para>
<sect4 id="sect.gpio_switcher_devices.measurementcomputing.pci_pdis08_and_pci_pdis16">
<title>PCI-PDIS08 and PCI-PDIS16</title>
<para>
The Measurement Computing PCI-PDIS08 and PCI-PDIS16 boards
feature floating, opto-isolated inputs. The inputs are
not polarity sensitive and may be driven by either AC or
DC. The outputs are electro-mechanical relays with dry
contacts.
</para>
<table frame="none">
<title>PCI-PDIS08 and PCI-PDIS16 Connector Pinout (DB37F)</title>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="Pin" colwidth="1.0*"/>
<colspec colname="Signal" colwidth="20.0*"/>
<thead>
<row><entry>Pin</entry><entry>Signal</entry></row>
</thead>
<tbody>
<row><entry>1</entry><entry>Input 8/16</entry></row>
<row><entry>20</entry><entry>Input 8/16</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>2</entry><entry>Input 7/15</entry></row>
<row><entry>21</entry><entry>Input 7/15</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>3</entry><entry>Input 6/14</entry></row>
<row><entry>22</entry><entry>Input 6/14</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>4</entry><entry>Input 5/13</entry></row>
<row><entry>23</entry><entry>Input 5/13</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>5</entry><entry>Input 4/12</entry></row>
<row><entry>24</entry><entry>Input 4/12</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>6</entry><entry>Input 3/11</entry></row>
<row><entry>25</entry><entry>Input 3/11</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>7</entry><entry>Input 2/10</entry></row>
<row><entry>26</entry><entry>Input 2/10</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>8</entry><entry>Input 1/9</entry></row>
<row><entry>27</entry><entry>Input 1/9</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>9</entry><entry>Output 8/16 C</entry></row>
<row><entry>28</entry><entry>Output 8/16 N/O</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>10</entry><entry>Output 7/15 C</entry></row>
<row><entry>29</entry><entry>Output 7/15 N/O</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>11</entry><entry>Output 6/14 C</entry></row>
<row><entry>30</entry><entry>Output 6/14 N/O</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>12</entry><entry>Output 5/13 N/C</entry></row>
<row><entry>13</entry><entry>Output 5/13 N/O</entry></row>
<row><entry>31</entry><entry>Output 5/13 C</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>14</entry><entry>Output 4/12 N/C</entry></row>
<row><entry>32</entry><entry>Output 4/12 N/O</entry></row>
<row><entry>33</entry><entry>Output 4/12 C</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>15</entry><entry>Output 3/11 N/C</entry></row>
<row><entry>16</entry><entry>Output 3/11 N/O</entry></row>
<row><entry>34</entry><entry>Output 3/11 C</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>17</entry><entry>Output 2/10 N/C</entry></row>
<row><entry>35</entry><entry>Output 2/10 N/O</entry></row>
<row><entry>36</entry><entry>Output 2/10 C</entry></row>
<row><entry></entry><entry></entry></row>
<row><entry>18</entry><entry>Output 1/9 N/C</entry></row>
<row><entry>19</entry><entry>Output 1/9 N/O</entry></row>
<row><entry>37</entry><entry>Output 1/9 C</entry></row>
</tbody>
</tgroup>
</table>
</sect4>
<sect4 id="sect.gpio_switcher_devices.measurementcomputing.pci_dio24">
<title>PCI-DIO24</title>
<para>
The Measurement Computing PCI-DIO24 board features 24
bi-directional, TTL level signal lines, referenced to a
common ground. The driver can be
configured to use all of the lines as inputs or outputs
(mixing inputs and outputs on the same board is not supported).
When used as inputs, termination resistor packs should be
installed.
</para>
<table frame="none">
<title>PCI-DIO24 Connector Pinout (DB37F)</title>
<tgroup cols="2" align="left" colsep="0" rowsep="0">
<colspec colname="Pin" colwidth="1.0*"/>
<colspec colname="Signal" colwidth="20.0*"/>
<thead>
<row><entry>Pin</entry><entry>Signal</entry></row>
</thead>
<tbody>
<row><entry>37</entry><entry>Input 1</entry></row>
<row><entry>36</entry><entry>Input 2</entry></row>
<row><entry>35</entry><entry>Input 3</entry></row>
<row><entry>34</entry><entry>Input 4</entry></row>
<row><entry>33</entry><entry>Input 5</entry></row>
<row><entry>32</entry><entry>Input 6</entry></row>
<row><entry>31</entry><entry>Input 7</entry></row>
<row><entry>30</entry><entry>Input 8</entry></row>
<row><entry>10</entry><entry>Input 9</entry></row>
<row><entry>9</entry><entry>Input 10</entry></row>
<row><entry>8</entry><entry>Input 11</entry></row>
<row><entry>7</entry><entry>Input 12</entry></row>
<row><entry>6</entry><entry>Input 13</entry></row>
<row><entry>5</entry><entry>Input 14</entry></row>
<row><entry>4</entry><entry>Input 15</entry></row>
<row><entry>3</entry><entry>Input 16</entry></row>
<row><entry>29</entry><entry>Input 17</entry></row>
<row><entry>28</entry><entry>Input 18</entry></row>
<row><entry>27</entry><entry>Input 19</entry></row>
<row><entry>26</entry><entry>Input 20</entry></row>
<row><entry>25</entry><entry>Input 21</entry></row>
<row><entry>24</entry><entry>Input 22</entry></row>
<row><entry>23</entry><entry>Input 23</entry></row>
<row><entry>22</entry><entry>Input 24</entry></row>
<row><entry>11</entry><entry>Ground</entry></row>
<row><entry>13</entry><entry>Ground</entry></row>
<row><entry>15</entry><entry>Ground</entry></row>
<row><entry>17</entry><entry>Ground</entry></row>
<row><entry>19</entry><entry>Ground</entry></row>
<row><entry>21</entry><entry>Ground</entry></row>
<row><entry>18</entry><entry>+5 vdc</entry></row>
<row><entry>20</entry><entry>+5 vdc</entry></row>
<row><entry>16</entry><entry>+12 vdc</entry></row>
<row><entry>14</entry><entry>+-12 vdc</entry></row>
</tbody>
</tgroup>
</table>
</sect4>
</sect3>
</sect2>
</sect1>
<sect1 id="sect.gpio_switcher_devices.vguest">
<title>Logitek vGuest</title>
<variablelist>

View File

@ -376,9 +376,7 @@ rm -rf $RPM_BUILD_ROOT
%doc conf/my.cnf-standby
%doc docs/catchd.txt
%doc docs/colors
%doc docs/GPIO.txt
%doc docs/ripc.txt
%doc docs/SWITCHERS.txt
%doc docs/JACK.txt
%doc docs/ENCODERS.txt
%doc docs/pam_rd.txt