[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[cbc9210] | 2 | <!DOCTYPE sect2 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY pyserial-download-http "https://files.pythonhosted.org/packages/source/p/pyserial/pyserial-&pyserial-version;.tar.gz">
|
---|
| 8 | <!ENTITY pyserial-download-ftp " ">
|
---|
| 9 | <!ENTITY pyserial-md5sum "&pyserial-md5sum;">
|
---|
| 10 | <!ENTITY pyserial-size "156 KB">
|
---|
| 11 | <!ENTITY pyserial-buildsize "2.1 MB (add 0.2 MB for tests)">
|
---|
| 12 | <!ENTITY pyserial-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <!-- capitalization as in https://pythonhosted.org/pyserial/ -->
|
---|
| 16 | <sect2 id="pyserial" xreflabel="pySerial-&pyserial-version;">
|
---|
| 17 |
|
---|
| 18 | <title>pySerial-&pyserial-version;</title>
|
---|
| 19 |
|
---|
| 20 | <indexterm zone="pyserial">
|
---|
| 21 | <primary sortas="a-pyserial">pyserial</primary>
|
---|
| 22 | </indexterm>
|
---|
| 23 |
|
---|
| 24 | <sect3 role="package">
|
---|
| 25 | <title>Introduction to pySerial Module</title>
|
---|
| 26 |
|
---|
| 27 | <para>
|
---|
| 28 | The <application>pySerial</application> module encapsulates
|
---|
[a8c1294] | 29 | access to the serial port.
|
---|
[cbc9210] | 30 | </para>
|
---|
| 31 |
|
---|
[f822342] | 32 | &lfs122_checked;
|
---|
[cbc9210] | 33 |
|
---|
| 34 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 35 | <itemizedlist spacing="compact">
|
---|
| 36 | <listitem>
|
---|
| 37 | <para>
|
---|
| 38 | Download (HTTP): <ulink url="&pyserial-download-http;"/>
|
---|
| 39 | </para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>
|
---|
| 43 | Download (FTP): <ulink url="&pyserial-download-ftp;"/>
|
---|
| 44 | </para>
|
---|
| 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download MD5 sum: &pyserial-md5sum;
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download size: &pyserial-size;
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Estimated disk space required: &pyserial-buildsize;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Estimated build time: &pyserial-time;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | </itemizedlist>
|
---|
| 67 |
|
---|
| 68 | <bridgehead renderas="sect4">pySerial Dependencies</bridgehead>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect5">Required</bridgehead>
|
---|
| 71 | <para role="required">
|
---|
| 72 | <xref linkend="setuptools_scm"/>
|
---|
| 73 | </para>
|
---|
| 74 |
|
---|
| 75 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 76 | <para role="optional">
|
---|
| 77 | <xref linkend="pytest"/>
|
---|
| 78 | </para>
|
---|
| 79 |
|
---|
| 80 | </sect3>
|
---|
| 81 |
|
---|
| 82 | <sect3 role="installation">
|
---|
| 83 | <title>Installation of pySerial</title>
|
---|
| 84 |
|
---|
| 85 | <para> Build the module: </para>
|
---|
| 86 |
|
---|
[db244ae2] | 87 | &build-wheel;
|
---|
[cbc9210] | 88 |
|
---|
| 89 | <para>
|
---|
| 90 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 91 | </para>
|
---|
| 92 |
|
---|
[db244ae2] | 93 | <screen role="root"><userinput>&install-wheel; pyserial</userinput></screen>
|
---|
[cbc9210] | 94 |
|
---|
| 95 | <para>
|
---|
| 96 | To test the installation issue <command>pytest</command>.
|
---|
| 97 | </para>
|
---|
| 98 |
|
---|
| 99 | </sect3>
|
---|
| 100 |
|
---|
| 101 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 102 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 103 |
|
---|
| 104 | <sect3 role="content">
|
---|
| 105 | <title>Contents</title>
|
---|
| 106 |
|
---|
| 107 | <segmentedlist>
|
---|
| 108 | <segtitle>Installed Programs</segtitle>
|
---|
| 109 | <segtitle>Installed Libraries</segtitle>
|
---|
| 110 | <segtitle>Installed Directories</segtitle>
|
---|
| 111 |
|
---|
| 112 | <seglistitem>
|
---|
| 113 | <seg>
|
---|
[a8c1294] | 114 | pyserial-miniterm and pyserial-ports
|
---|
[cbc9210] | 115 | </seg>
|
---|
| 116 | <seg>None</seg>
|
---|
| 117 | <seg>
|
---|
[a8c1294] | 118 | /usr/lib/python&python3-majorver;/site-packages/pyserial-&pyserial-version;.dist-info and
|
---|
[cbc9210] | 119 | /usr/lib/python&python3-majorver;/site-packages/serial
|
---|
| 120 | </seg>
|
---|
| 121 | </seglistitem>
|
---|
| 122 | </segmentedlist>
|
---|
| 123 |
|
---|
| 124 | <variablelist>
|
---|
| 125 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 126 | <?dbfo list-presentation="list"?>
|
---|
| 127 | <?dbhtml list-presentation="table"?>
|
---|
| 128 | <varlistentry id="pyserial-miniterm">
|
---|
| 129 | <term><command>pyserial-miniterm</command></term>
|
---|
| 130 | <listitem>
|
---|
| 131 | <para>
|
---|
| 132 | is a console application that provides a small terminal application.
|
---|
| 133 | It may inherit terminal features from the terminal in which it is
|
---|
| 134 | run.
|
---|
| 135 | </para>
|
---|
| 136 | <indexterm zone="pyserial pyserial-miniterm">
|
---|
| 137 | <primary sortas="b-pyserial-miniterm">pyserial-miniterm</primary>
|
---|
| 138 | </indexterm>
|
---|
| 139 | </listitem>
|
---|
| 140 | </varlistentry>
|
---|
| 141 | <varlistentry id="pyserial-ports">
|
---|
| 142 | <term><command>pyserial-ports</command></term>
|
---|
| 143 | <listitem>
|
---|
| 144 | <para>
|
---|
| 145 | lists available ports.
|
---|
| 146 | </para>
|
---|
| 147 | <indexterm zone="pyserial pyserial-ports">
|
---|
| 148 | <primary sortas="b-pyserial-ports">pyserial-ports</primary>
|
---|
| 149 | </indexterm>
|
---|
| 150 | </listitem>
|
---|
| 151 | </varlistentry>
|
---|
| 152 | </variablelist>
|
---|
| 153 |
|
---|
| 154 | </sect3>
|
---|
| 155 |
|
---|
| 156 | </sect2>
|
---|