generated documentation
This commit is contained in:
p.loedige
parent
fa314fe5f7
commit
ba77705837
BIN
documentation/build/.doctrees/app.doctree
Normal file
BIN
documentation/build/.doctrees/app.doctree
Normal file
Binary file not shown.
Binary file not shown.
BIN
documentation/build/.doctrees/interface_handler.doctree
Normal file
BIN
documentation/build/.doctrees/interface_handler.doctree
Normal file
Binary file not shown.
BIN
documentation/build/.doctrees/modules.doctree
Normal file
BIN
documentation/build/.doctrees/modules.doctree
Normal file
Binary file not shown.
BIN
documentation/build/.doctrees/ring_buffer.doctree
Normal file
BIN
documentation/build/.doctrees/ring_buffer.doctree
Normal file
Binary file not shown.
BIN
documentation/build/.doctrees/xml_reader.doctree
Normal file
BIN
documentation/build/.doctrees/xml_reader.doctree
Normal file
Binary file not shown.
7
documentation/build/_sources/app.rst.txt
Normal file
7
documentation/build/_sources/app.rst.txt
Normal file
@ -0,0 +1,7 @@
|
||||
app module
|
||||
==========
|
||||
|
||||
.. automodule:: app
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/build/_sources/interface_handler.rst.txt
Normal file
7
documentation/build/_sources/interface_handler.rst.txt
Normal file
@ -0,0 +1,7 @@
|
||||
interface\_handler module
|
||||
=========================
|
||||
|
||||
.. automodule:: interface_handler
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
10
documentation/build/_sources/modules.rst.txt
Normal file
10
documentation/build/_sources/modules.rst.txt
Normal file
@ -0,0 +1,10 @@
|
||||
aped_device
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
app
|
||||
interface_handler
|
||||
ring_buffer
|
||||
xml_reader
|
||||
7
documentation/build/_sources/ring_buffer.rst.txt
Normal file
7
documentation/build/_sources/ring_buffer.rst.txt
Normal file
@ -0,0 +1,7 @@
|
||||
ring\_buffer module
|
||||
===================
|
||||
|
||||
.. automodule:: ring_buffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/build/_sources/xml_reader.rst.txt
Normal file
7
documentation/build/_sources/xml_reader.rst.txt
Normal file
@ -0,0 +1,7 @@
|
||||
xml\_reader module
|
||||
==================
|
||||
|
||||
.. automodule:: xml_reader
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
159
documentation/build/app.html
Normal file
159
documentation/build/app.html
Normal file
@ -0,0 +1,159 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>app module — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-app">
|
||||
<span id="app-module"></span><h1>app module<a class="headerlink" href="#module-app" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="function">
|
||||
<dt id="app.api_devices">
|
||||
<code class="descclassname">app.</code><code class="descname">api_devices</code><span class="sig-paren">(</span><em>device_name: str</em>, <em>buffering: str</em><span class="sig-paren">)</span><a class="headerlink" href="#app.api_devices" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>the method for reading and writing to and from the connected devices</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>device_name</strong> (<em>str</em>) – the name of the relevant device</li>
|
||||
<li><strong>buffering</strong> (<em>str</em>) – whether or not the buffer of the device is requested</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">the relevant information about the device in JSON format</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="app.api_general_device_info">
|
||||
<code class="descclassname">app.</code><code class="descname">api_general_device_info</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.api_general_device_info" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method to read all the available device names</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the available device names</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">JSON</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="app.api_root">
|
||||
<code class="descclassname">app.</code><code class="descname">api_root</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.api_root" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method for the root of the API</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">a welcom message</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">html</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="function">
|
||||
<dt id="app.xml_transfer">
|
||||
<code class="descclassname">app.</code><code class="descname">xml_transfer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.xml_transfer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method for transfering the config.xml files to and from the raspberry</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the config.xml or the occured errors</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
|
|
||||
<a href="_sources/app.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -34,8 +34,181 @@
|
||||
<h1 id="index">Index</h1>
|
||||
|
||||
<div class="genindex-jumpbox">
|
||||
<a href="#A"><strong>A</strong></a>
|
||||
| <a href="#B"><strong>B</strong></a>
|
||||
| <a href="#G"><strong>G</strong></a>
|
||||
| <a href="#I"><strong>I</strong></a>
|
||||
| <a href="#R"><strong>R</strong></a>
|
||||
| <a href="#S"><strong>S</strong></a>
|
||||
| <a href="#V"><strong>V</strong></a>
|
||||
| <a href="#W"><strong>W</strong></a>
|
||||
| <a href="#X"><strong>X</strong></a>
|
||||
|
||||
</div>
|
||||
<h2 id="A">A</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="app.html#app.api_devices">api_devices() (in module app)</a>
|
||||
</li>
|
||||
<li><a href="app.html#app.api_general_device_info">api_general_device_info() (in module app)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="app.html#app.api_root">api_root() (in module app)</a>
|
||||
</li>
|
||||
<li><a href="app.html#module-app">app (module)</a>
|
||||
</li>
|
||||
<li><a href="ring_buffer.html#ring_buffer.Ring_buffer.append">append() (ring_buffer.Ring_buffer method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="B">B</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.buffering">buffering() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="G">G</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader.get_buffer_size">get_buffer_size() (xml_reader.Xml_reader method)</a>
|
||||
</li>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader.get_device_names">get_device_names() (xml_reader.Xml_reader method)</a>
|
||||
</li>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader.get_port">get_port() (xml_reader.Xml_reader method)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_10">GPIO_10 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_11">GPIO_11 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_12">GPIO_12 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_13">GPIO_13 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_14">GPIO_14 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_15">GPIO_15 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_16">GPIO_16 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_17">GPIO_17 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_18">GPIO_18 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_19">GPIO_19 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_2">GPIO_2 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_20">GPIO_20 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_21">GPIO_21 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_22">GPIO_22 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_23">GPIO_23 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_24">GPIO_24 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_25">GPIO_25 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_26">GPIO_26 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_27">GPIO_27 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_3">GPIO_3 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_4">GPIO_4 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_5">GPIO_5 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_6">GPIO_6 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_7">GPIO_7 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_8">GPIO_8 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin.GPIO_9">GPIO_9 (interface_handler.Interface_handler.Pin attribute)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="I">I</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.init_buffer">init_buffer() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.init_gpio">init_gpio() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler">Interface_handler (class in interface_handler)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#module-interface_handler">interface_handler (module)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.Pin">Interface_handler.Pin (class in interface_handler)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="R">R</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.read">read() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.read_buffer">read_buffer() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="ring_buffer.html#ring_buffer.Ring_buffer">Ring_buffer (class in ring_buffer)</a>
|
||||
</li>
|
||||
<li><a href="ring_buffer.html#module-ring_buffer">ring_buffer (module)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="S">S</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader.set_root">set_root() (xml_reader.Xml_reader method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="V">V</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader.validate">validate() (xml_reader.Xml_reader method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="W">W</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="interface_handler.html#interface_handler.Interface_handler.write">write() (interface_handler.Interface_handler method)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
<h2 id="X">X</h2>
|
||||
<table style="width: 100%" class="indextable genindextable"><tr>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="xml_reader.html#xml_reader.Xml_reader">Xml_reader (class in xml_reader)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="xml_reader.html#module-xml_reader">xml_reader (module)</a>
|
||||
</li>
|
||||
<li><a href="app.html#app.xml_transfer">xml_transfer() (in module app)</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
</tr></table>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
340
documentation/build/interface_handler.html
Normal file
340
documentation/build/interface_handler.html
Normal file
@ -0,0 +1,340 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>interface_handler module — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-interface_handler">
|
||||
<span id="interface-handler-module"></span><h1>interface_handler module<a class="headerlink" href="#module-interface_handler" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="interface_handler.Interface_handler">
|
||||
<em class="property">class </em><code class="descclassname">interface_handler.</code><code class="descname">Interface_handler</code><span class="sig-paren">(</span><em>xml_reader: xml_reader.Xml_reader</em><span class="sig-paren">)</span><a class="headerlink" href="#interface_handler.Interface_handler" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>handles the access to the various interfaces (e.g. GPIO)</p>
|
||||
<dl class="class">
|
||||
<dt id="interface_handler.Interface_handler.Pin">
|
||||
<em class="property">class </em><code class="descname">Pin</code><a class="headerlink" href="#interface_handler.Interface_handler.Pin" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></p>
|
||||
<p>list of all usable pins</p>
|
||||
<p>enables restricting methods to these pins</p>
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_10">
|
||||
<code class="descname">GPIO_10</code><em class="property"> = 19</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_10" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_11">
|
||||
<code class="descname">GPIO_11</code><em class="property"> = 23</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_11" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_12">
|
||||
<code class="descname">GPIO_12</code><em class="property"> = 32</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_12" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_13">
|
||||
<code class="descname">GPIO_13</code><em class="property"> = 33</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_13" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_14">
|
||||
<code class="descname">GPIO_14</code><em class="property"> = 8</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_14" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_15">
|
||||
<code class="descname">GPIO_15</code><em class="property"> = 10</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_15" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_16">
|
||||
<code class="descname">GPIO_16</code><em class="property"> = 36</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_16" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_17">
|
||||
<code class="descname">GPIO_17</code><em class="property"> = 11</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_17" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_18">
|
||||
<code class="descname">GPIO_18</code><em class="property"> = 12</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_18" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_19">
|
||||
<code class="descname">GPIO_19</code><em class="property"> = 35</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_19" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_2">
|
||||
<code class="descname">GPIO_2</code><em class="property"> = 3</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_2" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_20">
|
||||
<code class="descname">GPIO_20</code><em class="property"> = 38</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_20" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_21">
|
||||
<code class="descname">GPIO_21</code><em class="property"> = 40</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_21" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_22">
|
||||
<code class="descname">GPIO_22</code><em class="property"> = 15</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_22" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_23">
|
||||
<code class="descname">GPIO_23</code><em class="property"> = 16</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_23" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_24">
|
||||
<code class="descname">GPIO_24</code><em class="property"> = 18</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_24" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_25">
|
||||
<code class="descname">GPIO_25</code><em class="property"> = 22</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_25" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_26">
|
||||
<code class="descname">GPIO_26</code><em class="property"> = 37</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_26" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_27">
|
||||
<code class="descname">GPIO_27</code><em class="property"> = 13</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_27" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_3">
|
||||
<code class="descname">GPIO_3</code><em class="property"> = 5</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_3" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_4">
|
||||
<code class="descname">GPIO_4</code><em class="property"> = 7</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_4" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_5">
|
||||
<code class="descname">GPIO_5</code><em class="property"> = 29</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_5" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_6">
|
||||
<code class="descname">GPIO_6</code><em class="property"> = 31</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_6" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_7">
|
||||
<code class="descname">GPIO_7</code><em class="property"> = 26</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_7" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_8">
|
||||
<code class="descname">GPIO_8</code><em class="property"> = 24</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_8" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="attribute">
|
||||
<dt id="interface_handler.Interface_handler.Pin.GPIO_9">
|
||||
<code class="descname">GPIO_9</code><em class="property"> = 21</em><a class="headerlink" href="#interface_handler.Interface_handler.Pin.GPIO_9" title="Permalink to this definition">¶</a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.buffering">
|
||||
<code class="descname">buffering</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interface_handler.Interface_handler.buffering" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method that buffers the device outputs</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.init_buffer">
|
||||
<code class="descname">init_buffer</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interface_handler.Interface_handler.init_buffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>initializes the buffer thread</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.init_gpio">
|
||||
<code class="descname">init_gpio</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#interface_handler.Interface_handler.init_gpio" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>initializes the GPIO pins</p>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.read">
|
||||
<code class="descname">read</code><span class="sig-paren">(</span><em>device_name: str</em><span class="sig-paren">)</span> → dict<a class="headerlink" href="#interface_handler.Interface_handler.read" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>reads the current value from the pins of one device</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>device_name</strong> (<em>string</em>) – the name of the device</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple">
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">NameError</span></code> – the device cannot be found in the config.xml</li>
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – the device does not support reading</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">{‘pin’: ‘value’}</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.read_buffer">
|
||||
<code class="descname">read_buffer</code><span class="sig-paren">(</span><em>device_name: str</em><span class="sig-paren">)</span> → dict<a class="headerlink" href="#interface_handler.Interface_handler.read_buffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>reads the current buffer content for a given device</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><p class="first"><strong>device_name</strong> (<em>str</em>) – the name of the device</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple">
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">NameError</span></code> – the device cannot be found in the config.xml</li>
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – the device has no buffer</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">the buffer of the device</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">dict</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="interface_handler.Interface_handler.write">
|
||||
<code class="descname">write</code><span class="sig-paren">(</span><em>device_name: str</em>, <em>output</em><span class="sig-paren">)</span><a class="headerlink" href="#interface_handler.Interface_handler.write" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>writes an output to a given device</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>device_name</strong> (<em>str</em>) – the name of the relevant device</li>
|
||||
<li><strong>value</strong> (<em><type depends on protocol></em>) – the value to be written</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><ul class="first simple">
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">NameError</span></code> – the device name could not be found in the config.xml</li>
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">TypeError</span></code> – the given Value has the wrong type for the protocol</li>
|
||||
<li><code class="xref py py-exc docutils literal notranslate"><span class="pre">ValueError</span></code> – the value cannot be written to the device</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">value if everything worked correctly</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><type depends on protocol></p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
|
|
||||
<a href="_sources/interface_handler.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
100
documentation/build/modules.html
Normal file
100
documentation/build/modules.html
Normal file
@ -0,0 +1,100 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>aped_device — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="aped-device">
|
||||
<h1>aped_device<a class="headerlink" href="#aped-device" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="app.html">app module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="interface_handler.html">interface_handler module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="ring_buffer.html">ring_buffer module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="xml_reader.html">xml_reader module</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
|
|
||||
<a href="_sources/modules.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Binary file not shown.
137
documentation/build/py-modindex.html
Normal file
137
documentation/build/py-modindex.html
Normal file
@ -0,0 +1,137 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Python Module Index — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
|
||||
<script type="text/javascript">
|
||||
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
|
||||
</script>
|
||||
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<h1>Python Module Index</h1>
|
||||
|
||||
<div class="modindex-jumpbox">
|
||||
<a href="#cap-a"><strong>a</strong></a> |
|
||||
<a href="#cap-i"><strong>i</strong></a> |
|
||||
<a href="#cap-r"><strong>r</strong></a> |
|
||||
<a href="#cap-x"><strong>x</strong></a>
|
||||
</div>
|
||||
|
||||
<table class="indextable modindextable">
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-a"><td></td><td>
|
||||
<strong>a</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="app.html#module-app"><code class="xref">app</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-i"><td></td><td>
|
||||
<strong>i</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="interface_handler.html#module-interface_handler"><code class="xref">interface_handler</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-r"><td></td><td>
|
||||
<strong>r</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="ring_buffer.html#module-ring_buffer"><code class="xref">ring_buffer</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
<tr class="pcap"><td></td><td> </td><td></td></tr>
|
||||
<tr class="cap" id="cap-x"><td></td><td>
|
||||
<strong>x</strong></td><td></td></tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td>
|
||||
<a href="xml_reader.html#module-xml_reader"><code class="xref">xml_reader</code></a></td><td>
|
||||
<em></em></td></tr>
|
||||
</table>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
113
documentation/build/ring_buffer.html
Normal file
113
documentation/build/ring_buffer.html
Normal file
@ -0,0 +1,113 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>ring_buffer module — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-ring_buffer">
|
||||
<span id="ring-buffer-module"></span><h1>ring_buffer module<a class="headerlink" href="#module-ring_buffer" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="ring_buffer.Ring_buffer">
|
||||
<em class="property">class </em><code class="descclassname">ring_buffer.</code><code class="descname">Ring_buffer</code><span class="sig-paren">(</span><em>size: int</em><span class="sig-paren">)</span><a class="headerlink" href="#ring_buffer.Ring_buffer" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>manages a list in a ring buffer like manner</p>
|
||||
<dl class="method">
|
||||
<dt id="ring_buffer.Ring_buffer.append">
|
||||
<code class="descname">append</code><span class="sig-paren">(</span><em>data</em><span class="sig-paren">)</span><a class="headerlink" href="#ring_buffer.Ring_buffer.append" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>appends an element to the ring buffer</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>data</strong> (<em>[</em><em>type</em><em>]</em>) – the element to be added</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
|
|
||||
<a href="_sources/ring_buffer.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
@ -1 +1 @@
|
||||
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{index:0,modul:0,page:0,search:0},titles:["Welcome to APED (API-Documentation)\u2019s documentation!"],titleterms:{APED:0,api:0,document:0,indic:0,tabl:0,welcom:0}})
|
||||
Search.setIndex({docnames:["app","index","interface_handler","modules","ring_buffer","xml_reader"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:55},filenames:["app.rst","index.rst","interface_handler.rst","modules.rst","ring_buffer.rst","xml_reader.rst"],objects:{"":{app:[0,0,0,"-"],interface_handler:[2,0,0,"-"],ring_buffer:[4,0,0,"-"],xml_reader:[5,0,0,"-"]},"interface_handler.Interface_handler":{Pin:[2,2,1,""],buffering:[2,4,1,""],init_buffer:[2,4,1,""],init_gpio:[2,4,1,""],read:[2,4,1,""],read_buffer:[2,4,1,""],write:[2,4,1,""]},"interface_handler.Interface_handler.Pin":{GPIO_10:[2,3,1,""],GPIO_11:[2,3,1,""],GPIO_12:[2,3,1,""],GPIO_13:[2,3,1,""],GPIO_14:[2,3,1,""],GPIO_15:[2,3,1,""],GPIO_16:[2,3,1,""],GPIO_17:[2,3,1,""],GPIO_18:[2,3,1,""],GPIO_19:[2,3,1,""],GPIO_20:[2,3,1,""],GPIO_21:[2,3,1,""],GPIO_22:[2,3,1,""],GPIO_23:[2,3,1,""],GPIO_24:[2,3,1,""],GPIO_25:[2,3,1,""],GPIO_26:[2,3,1,""],GPIO_27:[2,3,1,""],GPIO_2:[2,3,1,""],GPIO_3:[2,3,1,""],GPIO_4:[2,3,1,""],GPIO_5:[2,3,1,""],GPIO_6:[2,3,1,""],GPIO_7:[2,3,1,""],GPIO_8:[2,3,1,""],GPIO_9:[2,3,1,""]},"ring_buffer.Ring_buffer":{append:[4,4,1,""]},"xml_reader.Xml_reader":{get_buffer_size:[5,4,1,""],get_device_names:[5,4,1,""],get_port:[5,4,1,""],set_root:[5,4,1,""],validate:[5,4,1,""]},app:{api_devices:[0,1,1,""],api_general_device_info:[0,1,1,""],api_root:[0,1,1,""],xml_transfer:[0,1,1,""]},interface_handler:{Interface_handler:[2,2,1,""]},ring_buffer:{Ring_buffer:[4,2,1,""]},xml_reader:{Xml_reader:[5,2,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","attribute","Python attribute"],"4":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:attribute","4":"py:method"},terms:{"class":[2,4,5],"enum":2,"int":[4,5],"return":[0,2,5],about:[0,5],access:2,added:4,against:5,all:[0,2,5],api:0,api_devic:0,api_general_device_info:0,api_root:0,app:3,append:4,avail:0,base:[2,4,5],bool:5,buffer:[0,2,4,5],cannot:2,check:5,config:[0,2,5],configur:5,connect:0,content:2,correctli:2,could:2,current:2,data:4,depend:2,devic:[0,2,5],device_nam:[0,2,5],dict:[2,5],doe:2,element:[4,5],enabl:2,error:0,everyth:2,file:[0,5],format:0,found:2,from:[0,2,5],get_buffer_s:5,get_device_nam:5,get_port:5,given:[2,5],gpio:2,gpio_10:2,gpio_11:2,gpio_12:2,gpio_13:2,gpio_14:2,gpio_15:2,gpio_16:2,gpio_17:2,gpio_18:2,gpio_19:2,gpio_20:2,gpio_21:2,gpio_22:2,gpio_23:2,gpio_24:2,gpio_25:2,gpio_26:2,gpio_27:2,gpio_2:2,gpio_3:2,gpio_4:2,gpio_5:2,gpio_6:2,gpio_7:2,gpio_8:2,gpio_9:2,handl:2,has:2,html:0,index:1,inform:[0,5],init_buff:2,init_gpio:2,initi:2,interfac:2,interface_handl:3,json:0,like:4,list:[2,4,5],manag:4,manner:4,messag:0,method:[0,2,5],modul:[1,3],name:[0,2,5],nameerror:[2,5],object:[2,4,5],occur:0,one:2,output:2,page:1,paramet:[0,2,4,5],path:5,pin:[2,5],port:5,protocol:[2,5],rais:[2,5],raspberri:0,read:[0,2,5],read_buff:2,reader:5,relev:[0,2],request:0,restrict:2,result:5,ring:4,ring_buff:3,root:[0,5],search:1,set_root:5,size:[4,5],store:5,str:[0,2,5],string:[2,5],support:2,thread:2,transfer:0,type:[0,2,4,5],typeerror:2,usabl:2,using:5,valid:5,valu:2,valueerror:2,variou:2,welcom:0,whether:0,work:2,write:[0,2],written:2,wrong:2,xml:[0,2,5],xml_path:5,xml_reader:[2,3],xml_transfer:0,xsd:5,xsd_path:5},titles:["app module","Welcome to APED (API-Documentation)\u2019s documentation!","interface_handler module","aped_device","ring_buffer module","xml_reader module"],titleterms:{APED:1,aped_devic:3,api:1,app:0,document:1,indic:1,interface_handl:2,modul:[0,2,4,5],ring_buff:4,tabl:1,welcom:1,xml_reader:5}})
|
||||
193
documentation/build/xml_reader.html
Normal file
193
documentation/build/xml_reader.html
Normal file
@ -0,0 +1,193 @@
|
||||
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>xml_reader module — APED (API-Documentation) V2.1 documentation</title>
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script type="text/javascript" src="_static/jquery.js"></script>
|
||||
<script type="text/javascript" src="_static/underscore.js"></script>
|
||||
<script type="text/javascript" src="_static/doctools.js"></script>
|
||||
<script type="text/javascript" src="_static/language_data.js"></script>
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
|
||||
</head><body>
|
||||
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div class="body" role="main">
|
||||
|
||||
<div class="section" id="module-xml_reader">
|
||||
<span id="xml-reader-module"></span><h1>xml_reader module<a class="headerlink" href="#module-xml_reader" title="Permalink to this headline">¶</a></h1>
|
||||
<dl class="class">
|
||||
<dt id="xml_reader.Xml_reader">
|
||||
<em class="property">class </em><code class="descclassname">xml_reader.</code><code class="descname">Xml_reader</code><span class="sig-paren">(</span><em>xml_path: str</em>, <em>xsd_path: str</em><span class="sig-paren">)</span><a class="headerlink" href="#xml_reader.Xml_reader" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<p>reader for the XML configuration</p>
|
||||
<dl class="method">
|
||||
<dt id="xml_reader.Xml_reader.get_buffer_size">
|
||||
<code class="descname">get_buffer_size</code><span class="sig-paren">(</span><em>device_name: str</em><span class="sig-paren">)</span> → int<a class="headerlink" href="#xml_reader.Xml_reader.get_buffer_size" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method to read the buffer size of a given device from the XML</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device_name</strong> (<em>str</em>) – the name of a device</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NameError</span></code> – device_name will be checked against the config XML</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the buffer size for the device</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">int</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="xml_reader.Xml_reader.get_device_names">
|
||||
<code class="descname">get_device_names</code><span class="sig-paren">(</span><span class="sig-paren">)</span> → list<a class="headerlink" href="#xml_reader.Xml_reader.get_device_names" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>lists all the device names from the config XML</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">all device names as strings</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body">list</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="xml_reader.Xml_reader.get_port">
|
||||
<code class="descname">get_port</code><span class="sig-paren">(</span><em>device_name: str</em><span class="sig-paren">)</span> → dict<a class="headerlink" href="#xml_reader.Xml_reader.get_port" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>returns the information about a port of a given device</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>device_name</strong> (<em>str</em>) – the name of a device</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">{‘protocol’, [list: pins]}</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body">dict</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Raises:</th><td class="field-body"><code class="xref py py-exc docutils literal notranslate"><span class="pre">NameError</span></code> – device_name will be checked against the config XML</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="xml_reader.Xml_reader.set_root">
|
||||
<code class="descname">set_root</code><span class="sig-paren">(</span><em>xml_path: str</em><span class="sig-paren">)</span><a class="headerlink" href="#xml_reader.Xml_reader.set_root" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>method to read and store the root element from the XML file</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>xml_path</strong> (<em>str</em>) – the path to the XML file</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="method">
|
||||
<dt id="xml_reader.Xml_reader.validate">
|
||||
<code class="descname">validate</code><span class="sig-paren">(</span><em>xml_path: str</em>, <em>xsd_path: str</em><span class="sig-paren">)</span> → bool<a class="headerlink" href="#xml_reader.Xml_reader.validate" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>validates a XML by using a XSD file</p>
|
||||
<table class="docutils field-list" frame="void" rules="none">
|
||||
<col class="field-name" />
|
||||
<col class="field-body" />
|
||||
<tbody valign="top">
|
||||
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
|
||||
<li><strong>xml_path</strong> (<em>str</em>) – the path to the XML file</li>
|
||||
<li><strong>xsd_path</strong> (<em>str</em>) – the path to the XSD file</li>
|
||||
</ul>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body"><p class="first">result of the validation</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last">bool</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">APED (API-Documentation)</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3>Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" />
|
||||
<input type="submit" value="Go" />
|
||||
<input type="hidden" name="check_keywords" value="yes" />
|
||||
<input type="hidden" name="area" value="default" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Paul Lödige.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.8.4</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
|
||||
|
||||
|
|
||||
<a href="_sources/xml_reader.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
</body>
|
||||
</html>
|
||||
7
documentation/documentation/build/app.rst
Normal file
7
documentation/documentation/build/app.rst
Normal file
@ -0,0 +1,7 @@
|
||||
app module
|
||||
==========
|
||||
|
||||
.. automodule:: app
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/documentation/build/interface_handler.rst
Normal file
7
documentation/documentation/build/interface_handler.rst
Normal file
@ -0,0 +1,7 @@
|
||||
interface\_handler module
|
||||
=========================
|
||||
|
||||
.. automodule:: interface_handler
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
10
documentation/documentation/build/modules.rst
Normal file
10
documentation/documentation/build/modules.rst
Normal file
@ -0,0 +1,10 @@
|
||||
aped_device
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
app
|
||||
interface_handler
|
||||
ring_buffer
|
||||
xml_reader
|
||||
7
documentation/documentation/build/ring_buffer.rst
Normal file
7
documentation/documentation/build/ring_buffer.rst
Normal file
@ -0,0 +1,7 @@
|
||||
ring\_buffer module
|
||||
===================
|
||||
|
||||
.. automodule:: ring_buffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/documentation/build/xml_reader.rst
Normal file
7
documentation/documentation/build/xml_reader.rst
Normal file
@ -0,0 +1,7 @@
|
||||
xml\_reader module
|
||||
==================
|
||||
|
||||
.. automodule:: xml_reader
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/source/app.rst
Normal file
7
documentation/source/app.rst
Normal file
@ -0,0 +1,7 @@
|
||||
app module
|
||||
==========
|
||||
|
||||
.. automodule:: app
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -12,9 +12,9 @@
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import os
|
||||
import sys
|
||||
sys.path.insert(0, os.path.abspath('../..'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
7
documentation/source/interface_handler.rst
Normal file
7
documentation/source/interface_handler.rst
Normal file
@ -0,0 +1,7 @@
|
||||
interface\_handler module
|
||||
=========================
|
||||
|
||||
.. automodule:: interface_handler
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
10
documentation/source/modules.rst
Normal file
10
documentation/source/modules.rst
Normal file
@ -0,0 +1,10 @@
|
||||
aped_device
|
||||
===========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
app
|
||||
interface_handler
|
||||
ring_buffer
|
||||
xml_reader
|
||||
7
documentation/source/ring_buffer.rst
Normal file
7
documentation/source/ring_buffer.rst
Normal file
@ -0,0 +1,7 @@
|
||||
ring\_buffer module
|
||||
===================
|
||||
|
||||
.. automodule:: ring_buffer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
documentation/source/xml_reader.rst
Normal file
7
documentation/source/xml_reader.rst
Normal file
@ -0,0 +1,7 @@
|
||||
xml\_reader module
|
||||
==================
|
||||
|
||||
.. automodule:: xml_reader
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
Loading…
x
Reference in New Issue
Block a user