mirror of https://github.com/Nonannet/pyhoff.git
2614 lines
273 KiB
HTML
2614 lines
273 KiB
HTML
|
||
|
||
<!DOCTYPE html>
|
||
<html class="writer-html5" lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>Classes — pyhoff documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
||
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
||
|
||
|
||
<script src="_static/jquery.js?v=5d32c60e"></script>
|
||
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="_static/doctools.js?v=9bcbadda"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<script src="_static/js/theme.js"></script>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="prev" title="Pyhoff" href="readme.html" />
|
||
</head>
|
||
|
||
<body class="wy-body-for-nav">
|
||
<div class="wy-grid-for-nav">
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
||
<div class="wy-side-scroll">
|
||
<div class="wy-side-nav-search" >
|
||
|
||
|
||
|
||
<a href="index.html" class="icon icon-home">
|
||
pyhoff
|
||
</a>
|
||
<div role="search">
|
||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
||
<input type="hidden" name="check_keywords" value="yes" />
|
||
<input type="hidden" name="area" value="default" />
|
||
</form>
|
||
</div>
|
||
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
||
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="readme.html">Pyhoff</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Classes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#bus-coupler">Bus coupler</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.BK9000"><code class="docutils literal notranslate"><span class="pre">BK9000</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9000.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">BK9000.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9000.get_error"><code class="docutils literal notranslate"><span class="pre">BK9000.get_error()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.BK9050"><code class="docutils literal notranslate"><span class="pre">BK9050</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9050.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">BK9050.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9050.get_error"><code class="docutils literal notranslate"><span class="pre">BK9050.get_error()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.BK9100"><code class="docutils literal notranslate"><span class="pre">BK9100</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9100.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">BK9100.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.BK9100.get_error"><code class="docutils literal notranslate"><span class="pre">BK9100.get_error()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352.get_error"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352.get_error()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#beckhoff-bus-terminals">Beckhoff bus terminals</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL1104"><code class="docutils literal notranslate"><span class="pre">KL1104</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1104.parameters"><code class="docutils literal notranslate"><span class="pre">KL1104.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1104.read_input"><code class="docutils literal notranslate"><span class="pre">KL1104.read_input()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL1408"><code class="docutils literal notranslate"><span class="pre">KL1408</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1408.parameters"><code class="docutils literal notranslate"><span class="pre">KL1408.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1408.read_input"><code class="docutils literal notranslate"><span class="pre">KL1408.read_input()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL1512"><code class="docutils literal notranslate"><span class="pre">KL1512</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1512.parameters"><code class="docutils literal notranslate"><span class="pre">KL1512.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1512.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL1512.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1512.read_counter"><code class="docutils literal notranslate"><span class="pre">KL1512.read_counter()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1512.read_delta"><code class="docutils literal notranslate"><span class="pre">KL1512.read_delta()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL1512.read_normalized"><code class="docutils literal notranslate"><span class="pre">KL1512.read_normalized()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL2404"><code class="docutils literal notranslate"><span class="pre">KL2404</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2404.parameters"><code class="docutils literal notranslate"><span class="pre">KL2404.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2404.read_coil"><code class="docutils literal notranslate"><span class="pre">KL2404.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2404.write_coil"><code class="docutils literal notranslate"><span class="pre">KL2404.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL2408"><code class="docutils literal notranslate"><span class="pre">KL2408</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2408.parameters"><code class="docutils literal notranslate"><span class="pre">KL2408.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2408.read_coil"><code class="docutils literal notranslate"><span class="pre">KL2408.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2408.write_coil"><code class="docutils literal notranslate"><span class="pre">KL2408.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL2424"><code class="docutils literal notranslate"><span class="pre">KL2424</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2424.parameters"><code class="docutils literal notranslate"><span class="pre">KL2424.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2424.read_coil"><code class="docutils literal notranslate"><span class="pre">KL2424.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2424.write_coil"><code class="docutils literal notranslate"><span class="pre">KL2424.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL2634"><code class="docutils literal notranslate"><span class="pre">KL2634</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2634.parameters"><code class="docutils literal notranslate"><span class="pre">KL2634.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2634.read_coil"><code class="docutils literal notranslate"><span class="pre">KL2634.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL2634.write_coil"><code class="docutils literal notranslate"><span class="pre">KL2634.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL3042"><code class="docutils literal notranslate"><span class="pre">KL3042</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3042.parameters"><code class="docutils literal notranslate"><span class="pre">KL3042.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3042.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL3042.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3042.read_current"><code class="docutils literal notranslate"><span class="pre">KL3042.read_current()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3042.read_normalized"><code class="docutils literal notranslate"><span class="pre">KL3042.read_normalized()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL3054"><code class="docutils literal notranslate"><span class="pre">KL3054</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3054.parameters"><code class="docutils literal notranslate"><span class="pre">KL3054.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3054.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL3054.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3054.read_current"><code class="docutils literal notranslate"><span class="pre">KL3054.read_current()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3054.read_normalized"><code class="docutils literal notranslate"><span class="pre">KL3054.read_normalized()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL3202"><code class="docutils literal notranslate"><span class="pre">KL3202</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3202.parameters"><code class="docutils literal notranslate"><span class="pre">KL3202.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3202.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL3202.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3202.read_normalized"><code class="docutils literal notranslate"><span class="pre">KL3202.read_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3202.read_temperature"><code class="docutils literal notranslate"><span class="pre">KL3202.read_temperature()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL3214"><code class="docutils literal notranslate"><span class="pre">KL3214</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3214.parameters"><code class="docutils literal notranslate"><span class="pre">KL3214.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3214.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL3214.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3214.read_normalized"><code class="docutils literal notranslate"><span class="pre">KL3214.read_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL3214.read_temperature"><code class="docutils literal notranslate"><span class="pre">KL3214.read_temperature()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL4002"><code class="docutils literal notranslate"><span class="pre">KL4002</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4002.parameters"><code class="docutils literal notranslate"><span class="pre">KL4002.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4002.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4002.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4002.set_normalized"><code class="docutils literal notranslate"><span class="pre">KL4002.set_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4002.set_voltage"><code class="docutils literal notranslate"><span class="pre">KL4002.set_voltage()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4002.write_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4002.write_channel_word()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL4004"><code class="docutils literal notranslate"><span class="pre">KL4004</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4004.parameters"><code class="docutils literal notranslate"><span class="pre">KL4004.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4004.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4004.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4004.set_normalized"><code class="docutils literal notranslate"><span class="pre">KL4004.set_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4004.set_voltage"><code class="docutils literal notranslate"><span class="pre">KL4004.set_voltage()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4004.write_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4004.write_channel_word()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL4132"><code class="docutils literal notranslate"><span class="pre">KL4132</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4132.parameters"><code class="docutils literal notranslate"><span class="pre">KL4132.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4132.read_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4132.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4132.set_normalized"><code class="docutils literal notranslate"><span class="pre">KL4132.set_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4132.set_voltage"><code class="docutils literal notranslate"><span class="pre">KL4132.set_voltage()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL4132.write_channel_word"><code class="docutils literal notranslate"><span class="pre">KL4132.write_channel_word()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9010"><code class="docutils literal notranslate"><span class="pre">KL9010</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9010.parameters"><code class="docutils literal notranslate"><span class="pre">KL9010.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9070"><code class="docutils literal notranslate"><span class="pre">KL9070</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9070.parameters"><code class="docutils literal notranslate"><span class="pre">KL9070.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9080"><code class="docutils literal notranslate"><span class="pre">KL9080</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9080.parameters"><code class="docutils literal notranslate"><span class="pre">KL9080.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9100"><code class="docutils literal notranslate"><span class="pre">KL9100</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9100.parameters"><code class="docutils literal notranslate"><span class="pre">KL9100.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9150"><code class="docutils literal notranslate"><span class="pre">KL9150</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9150.parameters"><code class="docutils literal notranslate"><span class="pre">KL9150.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9180"><code class="docutils literal notranslate"><span class="pre">KL9180</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9180.parameters"><code class="docutils literal notranslate"><span class="pre">KL9180.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9184"><code class="docutils literal notranslate"><span class="pre">KL9184</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9184.parameters"><code class="docutils literal notranslate"><span class="pre">KL9184.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9185"><code class="docutils literal notranslate"><span class="pre">KL9185</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9185.parameters"><code class="docutils literal notranslate"><span class="pre">KL9185.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9186"><code class="docutils literal notranslate"><span class="pre">KL9186</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9186.parameters"><code class="docutils literal notranslate"><span class="pre">KL9186.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9187"><code class="docutils literal notranslate"><span class="pre">KL9187</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9187.parameters"><code class="docutils literal notranslate"><span class="pre">KL9187.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9188"><code class="docutils literal notranslate"><span class="pre">KL9188</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9188.parameters"><code class="docutils literal notranslate"><span class="pre">KL9188.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9189"><code class="docutils literal notranslate"><span class="pre">KL9189</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9189.parameters"><code class="docutils literal notranslate"><span class="pre">KL9189.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9190"><code class="docutils literal notranslate"><span class="pre">KL9190</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9190.parameters"><code class="docutils literal notranslate"><span class="pre">KL9190.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9195"><code class="docutils literal notranslate"><span class="pre">KL9195</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9195.parameters"><code class="docutils literal notranslate"><span class="pre">KL9195.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9200"><code class="docutils literal notranslate"><span class="pre">KL9200</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9200.parameters"><code class="docutils literal notranslate"><span class="pre">KL9200.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9250"><code class="docutils literal notranslate"><span class="pre">KL9250</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9250.parameters"><code class="docutils literal notranslate"><span class="pre">KL9250.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9290"><code class="docutils literal notranslate"><span class="pre">KL9290</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9290.parameters"><code class="docutils literal notranslate"><span class="pre">KL9290.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.KL9380"><code class="docutils literal notranslate"><span class="pre">KL9380</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.KL9380.parameters"><code class="docutils literal notranslate"><span class="pre">KL9380.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#wago-bus-terminals">WAGO bus terminals</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_1405"><code class="docutils literal notranslate"><span class="pre">WAGO_750_1405</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_1405.parameters"><code class="docutils literal notranslate"><span class="pre">WAGO_750_1405.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_1405.read_input"><code class="docutils literal notranslate"><span class="pre">WAGO_750_1405.read_input()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_352.get_error"><code class="docutils literal notranslate"><span class="pre">WAGO_750_352.get_error()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_530"><code class="docutils literal notranslate"><span class="pre">WAGO_750_530</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_530.parameters"><code class="docutils literal notranslate"><span class="pre">WAGO_750_530.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_530.read_coil"><code class="docutils literal notranslate"><span class="pre">WAGO_750_530.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_530.write_coil"><code class="docutils literal notranslate"><span class="pre">WAGO_750_530.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_600"><code class="docutils literal notranslate"><span class="pre">WAGO_750_600</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_600.parameters"><code class="docutils literal notranslate"><span class="pre">WAGO_750_600.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.devices.WAGO_750_602"><code class="docutils literal notranslate"><span class="pre">WAGO_750_602</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.devices.WAGO_750_602.parameters"><code class="docutils literal notranslate"><span class="pre">WAGO_750_602.parameters</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#base-classes">Base classes</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.AnalogInputTerminal"><code class="docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogInputTerminal.parameters"><code class="docutils literal notranslate"><span class="pre">AnalogInputTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogInputTerminal.read_channel_word"><code class="docutils literal notranslate"><span class="pre">AnalogInputTerminal.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogInputTerminal.read_normalized"><code class="docutils literal notranslate"><span class="pre">AnalogInputTerminal.read_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogInputTerminal.select"><code class="docutils literal notranslate"><span class="pre">AnalogInputTerminal.select()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal.parameters"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal.read_channel_word"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal.read_channel_word()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal.select"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal.select()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal.set_normalized"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal.set_normalized()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.AnalogOutputTerminal.write_channel_word"><code class="docutils literal notranslate"><span class="pre">AnalogOutputTerminal.write_channel_word()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.BusCoupler"><code class="docutils literal notranslate"><span class="pre">BusCoupler</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusCoupler.bus_terminals"><code class="docutils literal notranslate"><span class="pre">BusCoupler.bus_terminals</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusCoupler.modbus"><code class="docutils literal notranslate"><span class="pre">BusCoupler.modbus</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusCoupler.add_bus_terminals"><code class="docutils literal notranslate"><span class="pre">BusCoupler.add_bus_terminals()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusCoupler.get_error"><code class="docutils literal notranslate"><span class="pre">BusCoupler.get_error()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusCoupler.select"><code class="docutils literal notranslate"><span class="pre">BusCoupler.select()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.BusTerminal"><code class="docutils literal notranslate"><span class="pre">BusTerminal</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusTerminal.bus_coupler"><code class="docutils literal notranslate"><span class="pre">BusTerminal.bus_coupler</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusTerminal.parameters"><code class="docutils literal notranslate"><span class="pre">BusTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#id0"><code class="docutils literal notranslate"><span class="pre">BusTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.BusTerminal.select"><code class="docutils literal notranslate"><span class="pre">BusTerminal.select()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.DigitalInputTerminal"><code class="docutils literal notranslate"><span class="pre">DigitalInputTerminal</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalInputTerminal.parameters"><code class="docutils literal notranslate"><span class="pre">DigitalInputTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalInputTerminal.read_input"><code class="docutils literal notranslate"><span class="pre">DigitalInputTerminal.read_input()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalInputTerminal.select"><code class="docutils literal notranslate"><span class="pre">DigitalInputTerminal.select()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.DigitalOutputTerminal"><code class="docutils literal notranslate"><span class="pre">DigitalOutputTerminal</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalOutputTerminal.parameters"><code class="docutils literal notranslate"><span class="pre">DigitalOutputTerminal.parameters</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalOutputTerminal.read_coil"><code class="docutils literal notranslate"><span class="pre">DigitalOutputTerminal.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalOutputTerminal.select"><code class="docutils literal notranslate"><span class="pre">DigitalOutputTerminal.select()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.DigitalOutputTerminal.write_coil"><code class="docutils literal notranslate"><span class="pre">DigitalOutputTerminal.write_coil()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#modbus">Modbus</a><ul>
|
||
<li class="toctree-l3"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient</span></code></a><ul>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.host"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.host</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.port"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.port</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.unit_id"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.unit_id</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.timeout"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.timeout</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.last_error"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.last_error</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.debug"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.debug</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.close"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.close()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.connect"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.connect()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_coil"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_coils"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_coils()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_discrete_input"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_discrete_input()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_discrete_inputs"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_discrete_inputs()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_holding_registers"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_holding_registers()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.read_input_registers"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_input_registers()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.receive_modbus_data"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.receive_modbus_data()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.send_modbus_data"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.send_modbus_data()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.write_multiple_coils"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.write_multiple_coils()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.write_multiple_registers"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.write_multiple_registers()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.write_single_coil"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.write_single_coil()</span></code></a></li>
|
||
<li class="toctree-l4"><a class="reference internal" href="#pyhoff.modbus.SimpleModbusClient.write_single_register"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.write_single_register()</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
</nav>
|
||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
||
<a href="index.html">pyhoff</a>
|
||
</nav>
|
||
|
||
<div class="wy-nav-content">
|
||
<div class="rst-content">
|
||
<div role="navigation" aria-label="Page navigation">
|
||
<ul class="wy-breadcrumbs">
|
||
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
||
<li class="breadcrumb-item active">Classes</li>
|
||
<li class="wy-breadcrumbs-aside">
|
||
<a href="_sources/modules.md.txt" rel="nofollow"> View page source</a>
|
||
</li>
|
||
</ul>
|
||
<hr/>
|
||
</div>
|
||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
||
<div itemprop="articleBody">
|
||
|
||
<section id="classes">
|
||
<h1>Classes<a class="headerlink" href="#classes" title="Link to this heading"></a></h1>
|
||
<section id="bus-coupler">
|
||
<h2>Bus coupler<a class="headerlink" href="#bus-coupler" title="Link to this heading"></a></h2>
|
||
<p>These classes are bus couplers and are used to connect the IO bus terminals to a Ethernet interface.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9000">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">BK9000</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9000" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></p>
|
||
<p>BK9000 ModBus TCP bus coupler</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9000.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9000.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9000.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9000.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9050">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">BK9050</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9050" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.devices.BK9000" title="pyhoff.devices.BK9000"><code class="xref py py-class docutils literal notranslate"><span class="pre">BK9000</span></code></a></p>
|
||
<p>BK9050 ModBus TCP bus coupler</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9050.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9050.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9050.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9050.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9100">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">BK9100</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9100" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.devices.BK9000" title="pyhoff.devices.BK9000"><code class="xref py py-class docutils literal notranslate"><span class="pre">BK9000</span></code></a></p>
|
||
<p>BK9100 ModBus TCP bus coupler</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9100.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9100.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.BK9100.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.BK9100.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_352</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></p>
|
||
<p>Wago 750-352 ModBus TCP bus coupler</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="beckhoff-bus-terminals">
|
||
<h2>Beckhoff bus terminals<a class="headerlink" href="#beckhoff-bus-terminals" title="Link to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1104">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL1104</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1104" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalInputTerminal4Bit</span></code></p>
|
||
<p>KL1104: 4x digital input 24 V</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1104.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_bit_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL1104.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1104.read_input">
|
||
<span class="sig-name descname"><span class="pre">read_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1104.read_input" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the input from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The input value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1408">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL1408</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1408" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalInputTerminal8Bit</span></code></p>
|
||
<p>KL1104: 8x digital input 24 V galvanic isolated</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1408.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_bit_width':</span> <span class="pre">8}</span></em><a class="headerlink" href="#pyhoff.devices.KL1408.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1408.read_input">
|
||
<span class="sig-name descname"><span class="pre">read_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1408.read_input" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the input from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The input value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL1512</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o_b_addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i_b_addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">o_w_addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">i_w_addr</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1512" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogInputTerminal" title="pyhoff.AnalogInputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a></p>
|
||
<p>KL1512: 2x 16 bit counter, 24 V DC, 1 kHz</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_word_width':</span> <span class="pre">2}</span></em><a class="headerlink" href="#pyhoff.devices.KL1512.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1512.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512.read_counter">
|
||
<span class="sig-name descname"><span class="pre">read_counter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1512.read_counter" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the absolut counter value of a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The counter value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512.read_delta">
|
||
<span class="sig-name descname"><span class="pre">read_delta</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1512.read_delta" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the counter change since last read of a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The counter value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL1512.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL1512.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2404">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL2404</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2404" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalOutputTerminal4Bit</span></code></p>
|
||
<p>KL2404: 4x digital output with 500 mA</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2404.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_bit_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL2404.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2404.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2404.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2404.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2404.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2408">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL2408</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2408" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalOutputTerminal8Bit</span></code></p>
|
||
<p>750-530: 8x digital output with 24 V / 500 mA</p>
|
||
<p>Contact order for DO1 to DO8 is: 1, 5, 2, 6, 3, 7, 4, 8.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2408.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_bit_width':</span> <span class="pre">8}</span></em><a class="headerlink" href="#pyhoff.devices.KL2408.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2408.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2408.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2408.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2408.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2424">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL2424</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2424" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalOutputTerminal4Bit</span></code></p>
|
||
<p>KL2424: 4x digital output with 2000 mA</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2424.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_bit_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL2424.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2424.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2424.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2424.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2424.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2634">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL2634</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2634" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalOutputTerminal4Bit</span></code></p>
|
||
<p>KL2634: 4x digital output 250 V AC, 30 V DC, 4 A</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2634.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_bit_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL2634.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2634.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2634.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL2634.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL2634.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3042">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL3042</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3042" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogInputTerminal" title="pyhoff.AnalogInputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a></p>
|
||
<p>KL3042: 2x analog input 0…20 mA 12 Bit single-ended</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3042.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_word_width':</span> <span class="pre">2}</span></em><a class="headerlink" href="#pyhoff.devices.KL3042.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3042.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3042.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3042.read_current">
|
||
<span class="sig-name descname"><span class="pre">read_current</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3042.read_current" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the current value from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3042.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3042.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3054">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL3054</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3054" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogInputTerminal" title="pyhoff.AnalogInputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a></p>
|
||
<p>KL3054: 4x analog input 4…20 mA 12 Bit single-ended</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3054.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_word_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL3054.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3054.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3054.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3054.read_current">
|
||
<span class="sig-name descname"><span class="pre">read_current</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3054.read_current" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the current value from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The current value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3054.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3054.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3202">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL3202</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3202" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogInputTerminal" title="pyhoff.AnalogInputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a></p>
|
||
<p>KL3202: 2x analog input PT100 16 Bit 3-wire</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3202.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_word_width':</span> <span class="pre">2}</span></em><a class="headerlink" href="#pyhoff.devices.KL3202.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3202.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3202.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3202.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3202.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3202.read_temperature">
|
||
<span class="sig-name descname"><span class="pre">read_temperature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3202.read_temperature" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the temperature value from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The temperature value in °C.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3214">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL3214</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3214" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogInputTerminal" title="pyhoff.AnalogInputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogInputTerminal</span></code></a></p>
|
||
<p>KL3214: 4x analog input PT100 16 Bit 3-wire</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3214.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_word_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL3214.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3214.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3214.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3214.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3214.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL3214.read_temperature">
|
||
<span class="sig-name descname"><span class="pre">read_temperature</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL3214.read_temperature" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the temperature value from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The temperature value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL4002</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4002" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogOutputTerminal" title="pyhoff.AnalogOutputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogOutputTerminal</span></code></a></p>
|
||
<p>KL4002: 2x analog output 0…10 V 12 Bit differentiell</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_word_width':</span> <span class="pre">2}</span></em><a class="headerlink" href="#pyhoff.devices.KL4002.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4002.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value or provided error_value if read failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002.set_normalized">
|
||
<span class="sig-name descname"><span class="pre">set_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4002.set_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a normalized value between 0 and 1 to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The normalized value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002.set_voltage">
|
||
<span class="sig-name descname"><span class="pre">set_voltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4002.set_voltage" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a voltage value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The voltage value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4002.write_channel_word">
|
||
<span class="sig-name descname"><span class="pre">write_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4002.write_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a word to the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to write to.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL4004</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4004" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogOutputTerminal" title="pyhoff.AnalogOutputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogOutputTerminal</span></code></a></p>
|
||
<p>KL4004: 4x analog output 0…10 V 12 Bit differentiell</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_word_width':</span> <span class="pre">4}</span></em><a class="headerlink" href="#pyhoff.devices.KL4004.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4004.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value or provided error_value if read failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004.set_normalized">
|
||
<span class="sig-name descname"><span class="pre">set_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4004.set_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a normalized value between 0 and 1 to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The normalized value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004.set_voltage">
|
||
<span class="sig-name descname"><span class="pre">set_voltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4004.set_voltage" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a voltage value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The voltage value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4004.write_channel_word">
|
||
<span class="sig-name descname"><span class="pre">write_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4004.write_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a word to the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to write to.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL4132</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4132" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.AnalogOutputTerminal" title="pyhoff.AnalogOutputTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">AnalogOutputTerminal</span></code></a></p>
|
||
<p>KL4002: 2x analog output ±10 V 16 bit differential</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_word_width':</span> <span class="pre">2}</span></em><a class="headerlink" href="#pyhoff.devices.KL4132.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4132.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value or provided error_value if read failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132.set_normalized">
|
||
<span class="sig-name descname"><span class="pre">set_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4132.set_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a normalized value between -1 and +1 to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The normalized value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132.set_voltage">
|
||
<span class="sig-name descname"><span class="pre">set_voltage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4132.set_voltage" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a voltage value between -10 and +10 V to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The voltage value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL4132.write_channel_word">
|
||
<span class="sig-name descname"><span class="pre">write_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL4132.write_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a word to the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to write to.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9010">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9010</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9010" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9010: End terminal
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9010.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9010.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9070">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9070</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9070" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9070: Shield terminal
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9070.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9070.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9080">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9080</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9080" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9080: Separation terminal
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9080.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9080.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9100">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9100</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9100" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9100: Potential supply terminal, 24 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9100.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9100.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9150">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9150</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9150" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9150: Potential supply terminal, 120…230 V AC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9150.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9150.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9180">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9180</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9180" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9180: Potential distribution terminal, 2 x 24 V DC; 2 x 0 V DC, 2 x
|
||
PE
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9180.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9180.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9184">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9184</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9184" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9184: potential distribution terminal, 8 x 24 V DC, 8 x 0 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9184.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9184.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9185">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9185</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9185" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9185: potential distribution terminal, 4 x 24 V DC, 4 x 0 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9185.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9185.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9186">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9186</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9186" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9186: Potential distribution terminal, 8 x 24 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9186.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9186.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9187">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9187</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9187" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9187: Potential distribution terminal, 8 x 0 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9187.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9187.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9188">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9188</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9188" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9188: Potential distribution terminal, 16 x 24 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9188.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9188.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9189">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9189</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9189" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9189: Potential distribution terminal, 16 x 0 V DC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9189.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9189.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9190">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9190</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9190" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9190: Potential supply terminal, any voltage up to 230 V AC
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9190.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9190.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9195">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9195</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9195" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9195: Shield terminal
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9195.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9195.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9200">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9200</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9200" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9200: Potential supply terminal, 24 V DC, with fuse
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9200.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9200.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9250">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9250</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9250" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9250: Potential supply terminal, 120…230 V AC, with fuse
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9250.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9250.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9290">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9290</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9290" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9290: Potential supply terminal, any voltage up to 230 V AC, with
|
||
fuse
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9290.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9290.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9380">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">KL9380</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.KL9380" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>KL9380: Mains filter terminal for dimmers
|
||
(no I/O function)</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.KL9380.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.KL9380.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="wago-bus-terminals">
|
||
<h2>WAGO bus terminals<a class="headerlink" href="#wago-bus-terminals" title="Link to this heading"></a></h2>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_1405">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_1405</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_1405" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalInputTerminal16Bit</span></code></p>
|
||
<p>750-1405: 16x digital input 24 V</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_1405.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'input_bit_width':</span> <span class="pre">16}</span></em><a class="headerlink" href="#pyhoff.devices.WAGO_750_1405.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_1405.read_input">
|
||
<span class="sig-name descname"><span class="pre">read_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_1405.read_input" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the input from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The input value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_352</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></p>
|
||
<p>Wago 750-352 ModBus TCP bus coupler</p>
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_352.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_352.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_530">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_530</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_530" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">DigitalOutputTerminal8Bit</span></code></p>
|
||
<p>750-530: 8x digital output with 24 V / 500 mA</p>
|
||
<p>Contact order for DO1 to DO8 is: 1, 5, 2, 6, 3, 7, 4, 8.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_530.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{'output_bit_width':</span> <span class="pre">8}</span></em><a class="headerlink" href="#pyhoff.devices.WAGO_750_530.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_530.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_530.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_530.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_530.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_600">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_600</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_600" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>End terminal, no I/O function</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_600.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.WAGO_750_600.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_602">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.devices.</span></span><span class="sig-name descname"><span class="pre">WAGO_750_602</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.devices.WAGO_750_602" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>Potential supply terminal, no I/O function</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.devices.WAGO_750_602.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.devices.WAGO_750_602.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="base-classes">
|
||
<h2>Base classes<a class="headerlink" href="#base-classes" title="Link to this heading"></a></h2>
|
||
<p>These classes are base classes for devices and are typically not used directly.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogInputTerminal">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">AnalogInputTerminal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogInputTerminal" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>Base class for analog input terminals.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogInputTerminal.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.AnalogInputTerminal.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogInputTerminal.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogInputTerminal.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogInputTerminal.read_normalized">
|
||
<span class="sig-name descname"><span class="pre">read_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogInputTerminal.read_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a normalized value (0…1) from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The normalized value.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogInputTerminal.select">
|
||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogInputTerminal.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the parent class
|
||
specified by terminal_number.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_coupler</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></span>) – The bus coupler to which the terminal is connected.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">AnalogOutputTerminal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogOutputTerminal" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>Base class for analog output terminals.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.AnalogOutputTerminal.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal.read_channel_word">
|
||
<span class="sig-name descname"><span class="pre">read_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_value</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-99999</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogOutputTerminal.read_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a single word from the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The read word value or provided error_value if read failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal.select">
|
||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogOutputTerminal.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the parent class
|
||
specified by terminal_number.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_coupler</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></span>) – The bus coupler to which the terminal is connected.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal.set_normalized">
|
||
<span class="sig-name descname"><span class="pre">set_normalized</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogOutputTerminal.set_normalized" title="Link to this definition"></a></dt>
|
||
<dd><p>Set a normalized value between 0 and 1 to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number to set.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – The normalized value to set.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.AnalogOutputTerminal.write_channel_word">
|
||
<span class="sig-name descname"><span class="pre">write_channel_word</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.AnalogOutputTerminal.write_channel_word" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a word to the terminal.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (1 based index) to write to.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the word offset or count is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">BusCoupler</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bus_terminals</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">[]</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">watchdog</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusCoupler" title="Link 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>Base class for ModBus TCP bus coupler</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>host</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – ip or hostname of the bus coupler</p></li>
|
||
<li><p><strong>port</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – port of the modbus host</p></li>
|
||
<li><p><strong>debug</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – outputs modbus debug information</p></li>
|
||
<li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – timeout for waiting for the device response</p></li>
|
||
<li><p><strong>watchdog</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – time in seconds after the device sets all outputs to
|
||
default state. A value of 0 deactivates the watchdog.</p></li>
|
||
<li><p><strong>debug</strong> – If True, debug information is printed.</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler.bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">bus_terminals</span></span><a class="headerlink" href="#pyhoff.BusCoupler.bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>A list of bus terminal classes according to the
|
||
connected terminals.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler.modbus">
|
||
<span class="sig-name descname"><span class="pre">modbus</span></span><a class="headerlink" href="#pyhoff.BusCoupler.modbus" title="Link to this definition"></a></dt>
|
||
<dd><p>The underlying modbus client used for the connection.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler.add_bus_terminals">
|
||
<span class="sig-name descname"><span class="pre">add_bus_terminals</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">new_bus_terminals</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusCoupler.add_bus_terminals" title="Link to this definition"></a></dt>
|
||
<dd><p>Add bus terminals to the bus coupler.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>new_bus_terminals</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>], <code class="xref py py-class docutils literal notranslate"><span class="pre">Iterable</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">type</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]]]</span>) – bus terminal classes to add.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a>]</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The corresponding list of bus terminal objects.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler.get_error">
|
||
<span class="sig-name descname"><span class="pre">get_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusCoupler.get_error" title="Link to this definition"></a></dt>
|
||
<dd><p>Get the last error message.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>The last error message.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.BusCoupler.select">
|
||
<span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_terminal_type</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusCoupler.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the given bus terminal type and
|
||
terminal index.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_terminals_type</strong> – The bus terminal class to select from.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
<p class="rubric">Example</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="kn">from</span><span class="w"> </span><span class="nn">pyhoff.devices</span><span class="w"> </span><span class="kn">import</span> <span class="o">*</span>
|
||
<span class="gp">>>> </span><span class="n">bk</span> <span class="o">=</span> <span class="n">BK9050</span><span class="p">(</span><span class="s2">"172.16.17.1"</span><span class="p">,</span> <span class="n">bus_terminals</span><span class="o">=</span><span class="p">[</span><span class="n">KL2404</span><span class="p">,</span> <span class="n">KL2424</span><span class="p">])</span>
|
||
<span class="gp">>>> </span><span class="c1"># Select the first KL2425 terminal:</span>
|
||
<span class="gp">>>> </span><span class="n">kl2404</span> <span class="o">=</span> <span class="n">bk</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="n">KL2424</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
|
||
</pre></div>
|
||
</div>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.BusTerminal">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">BusTerminal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusTerminal" title="Link 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>Base class for all bus terminals.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.BusTerminal.bus_coupler">
|
||
<span class="sig-name descname"><span class="pre">bus_coupler</span></span><a class="headerlink" href="#pyhoff.BusTerminal.bus_coupler" title="Link to this definition"></a></dt>
|
||
<dd><p>The bus coupler to which this terminal is connected.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.BusTerminal.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><a class="headerlink" href="#pyhoff.BusTerminal.parameters" title="Link to this definition"></a></dt>
|
||
<dd><p>The parameters of the terminal.</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="id0">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#id0" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.BusTerminal.select">
|
||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.BusTerminal.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the parent class
|
||
specified by terminal_number.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_coupler</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></span>) – The bus coupler to which the terminal is connected.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalInputTerminal">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">DigitalInputTerminal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalInputTerminal" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>Base class for digital input terminals.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalInputTerminal.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.DigitalInputTerminal.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalInputTerminal.read_input">
|
||
<span class="sig-name descname"><span class="pre">read_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalInputTerminal.read_input" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the input from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The input value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalInputTerminal.select">
|
||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalInputTerminal.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the parent class
|
||
specified by terminal_number.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_coupler</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></span>) – The bus coupler to which the terminal is connected.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalOutputTerminal">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.</span></span><span class="sig-name descname"><span class="pre">DigitalOutputTerminal</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_bit_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">output_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">input_word_addresses</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">mixed_mapping</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalOutputTerminal" title="Link to this definition"></a></dt>
|
||
<dd><p>Bases: <a class="reference internal" href="#pyhoff.BusTerminal" title="pyhoff.BusTerminal"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusTerminal</span></code></a></p>
|
||
<p>Base class for digital output terminals.</p>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalOutputTerminal.parameters">
|
||
<span class="sig-name descname"><span class="pre">parameters</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><code class="xref py py-class docutils literal notranslate"><span class="pre">dict</span></code><span class="pre">[</span><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code><span class="pre">,</span> <code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code><span class="pre">]</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#pyhoff.DigitalOutputTerminal.parameters" title="Link to this definition"></a></dt>
|
||
<dd></dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalOutputTerminal.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalOutputTerminal.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read the coil value back from a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The coil value of the specified channel or None if the read operation failed.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalOutputTerminal.select">
|
||
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">select</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bus_coupler</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">terminal_number</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalOutputTerminal.select" title="Link to this definition"></a></dt>
|
||
<dd><p>Returns the n-th bus terminal instance of the parent class
|
||
specified by terminal_number.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bus_coupler</strong> (<span class="sphinx_autodoc_typehints-type"><a class="reference internal" href="#pyhoff.BusCoupler" title="pyhoff.BusCoupler"><code class="xref py py-class docutils literal notranslate"><span class="pre">BusCoupler</span></code></a></span>) – The bus coupler to which the terminal is connected.</p></li>
|
||
<li><p><strong>terminal_number</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The index of the bus terminal to return. Counted for
|
||
all bus terminals of the same type, not all bus terminals. Started for the
|
||
first terminal with 0</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">TypeVar</span></code>(<code class="docutils literal notranslate"><span class="pre">_BT</span></code>, bound= BusTerminal)</span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The selected bus terminal instance.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.DigitalOutputTerminal.write_coil">
|
||
<span class="sig-name descname"><span class="pre">write_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">channel</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.DigitalOutputTerminal.write_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Write a value to a specific channel.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>channel</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The channel number (start counting from 1) to write to.</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – The value to write.</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if the write operation succeeded, otherwise False.</p>
|
||
</dd>
|
||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><strong>Exception</strong> – If the channel number is out of range.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
<section id="modbus">
|
||
<h2>Modbus<a class="headerlink" href="#modbus" title="Link to this heading"></a></h2>
|
||
<p>This modbus implementation is used internally.</p>
|
||
<dl class="py class">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient">
|
||
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">pyhoff.modbus.</span></span><span class="sig-name descname"><span class="pre">SimpleModbusClient</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">host</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">port</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">502</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unit_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">debug</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient" title="Link 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>A simple Modbus TCP client</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>host</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></span>) – hostname or IP address</p></li>
|
||
<li><p><strong>port</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – server port</p></li>
|
||
<li><p><strong>unit_id</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – ModBus id</p></li>
|
||
<li><p><strong>timeout</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">float</span></code></span>) – socket timeout in seconds</p></li>
|
||
<li><p><strong>debug</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – if True prints out transmitted and received bytes in hex</p></li>
|
||
</ul>
|
||
</dd>
|
||
</dl>
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.host">
|
||
<span class="sig-name descname"><span class="pre">host</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.host" title="Link to this definition"></a></dt>
|
||
<dd><p>hostname or IP address</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.port">
|
||
<span class="sig-name descname"><span class="pre">port</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.port" title="Link to this definition"></a></dt>
|
||
<dd><p>server port</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.unit_id">
|
||
<span class="sig-name descname"><span class="pre">unit_id</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.unit_id" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus id</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.timeout">
|
||
<span class="sig-name descname"><span class="pre">timeout</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.timeout" title="Link to this definition"></a></dt>
|
||
<dd><p>socket timeout in seconds</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.last_error">
|
||
<span class="sig-name descname"><span class="pre">last_error</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.last_error" title="Link to this definition"></a></dt>
|
||
<dd><p>contains last error message or empty string if no error occurred</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py attribute">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.debug">
|
||
<span class="sig-name descname"><span class="pre">debug</span></span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.debug" title="Link to this definition"></a></dt>
|
||
<dd><p>if True prints out transmitted and received bytes in hex</p>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.close">
|
||
<span class="sig-name descname"><span class="pre">close</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.close" title="Link to this definition"></a></dt>
|
||
<dd><p>Close connection</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>empty bytes object</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.connect">
|
||
<span class="sig-name descname"><span class="pre">connect</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.connect" title="Link to this definition"></a></dt>
|
||
<dd><p>Connect manual to the configured modbus server. Usually there is
|
||
no need to call this function since it is handled automatically.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_coil">
|
||
<span class="sig-name descname"><span class="pre">read_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a coil from the given register address.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The register address to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The value of the coil or None if error</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_coils">
|
||
<span class="sig-name descname"><span class="pre">read_coils</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bit_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bit_lengths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_coils" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for reading coils (0x01)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bit_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Bit address (0 to 0xffff)</p></li>
|
||
<li><p><strong>bit_lengths</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Number of bits to read (1 to 2000)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Bits list or None if error</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>list of bool or None</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_discrete_input">
|
||
<span class="sig-name descname"><span class="pre">read_discrete_input</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">address</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_discrete_input" title="Link to this definition"></a></dt>
|
||
<dd><p>Read a discrete input from the given register address.</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><strong>address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – The register address to read from.</p>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code> | <code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>The value of the discrete input.</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_discrete_inputs">
|
||
<span class="sig-name descname"><span class="pre">read_discrete_inputs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bit_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bit_lengths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_discrete_inputs" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for reading discrete inputs (0x02)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bit_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Bit address (0 to 0xffff)</p></li>
|
||
<li><p><strong>bit_lengths</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Number of bits to read (1 to 2000)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Bits list or None if error</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>list of bool or None</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_holding_registers">
|
||
<span class="sig-name descname"><span class="pre">read_holding_registers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">register_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">word_lengths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_holding_registers" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for reading holding registers (0x03)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>register_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Register address (0 to 0xffff)</p></li>
|
||
<li><p><strong>word_lengths</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Number of registers to read (1 to 125)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Registers list or None if error</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>list of int or None</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.read_input_registers">
|
||
<span class="sig-name descname"><span class="pre">read_input_registers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">register_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">word_lengths</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.read_input_registers" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for reading input registers (0x04)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>register_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Register address (0 to 0xffff)</p></li>
|
||
<li><p><strong>word_lengths</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Number of registers to read (1 to 125)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>Registers list or None if error</p>
|
||
</dd>
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>list of int or None</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.receive_modbus_data">
|
||
<span class="sig-name descname"><span class="pre">receive_modbus_data</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.receive_modbus_data" title="Link to this definition"></a></dt>
|
||
<dd><p>Receive a ModBus frame</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p>bytes received or empty bytes object if an error occurred</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.send_modbus_data">
|
||
<span class="sig-name descname"><span class="pre">send_modbus_data</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">function_code</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.send_modbus_data" title="Link to this definition"></a></dt>
|
||
<dd><p>Send raw ModBus TCP frame</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>unction_code</strong> – ModBus function code</p></li>
|
||
<li><p><strong>body</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code></span>) – data</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>number of transmitted bytes or 0 if transmission failed</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.write_multiple_coils">
|
||
<span class="sig-name descname"><span class="pre">write_multiple_coils</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bit_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.write_multiple_coils" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for writing multiple coils (0x0F)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bit_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Bit address (0 to 0xffff)</p></li>
|
||
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code>]</span>) – List of bit values to write</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if write succeeded or False if failed</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.write_multiple_registers">
|
||
<span class="sig-name descname"><span class="pre">write_multiple_registers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">register_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.write_multiple_registers" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for writing multiple registers (0x10)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>register_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Register address (0 to 0xffff)</p></li>
|
||
<li><p><strong>values</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">list</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code>]</span>) – List of 16 bit register values to write</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if write succeeded or False if failed</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.write_single_coil">
|
||
<span class="sig-name descname"><span class="pre">write_single_coil</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bit_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.write_single_coil" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for writing a single coil (0x05)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>bit_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Bit address (0 to 0xffff)</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span>) – Value to write (single bit)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if write succeeded or False if failed</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<dl class="py method">
|
||
<dt class="sig sig-object py" id="pyhoff.modbus.SimpleModbusClient.write_single_register">
|
||
<span class="sig-name descname"><span class="pre">write_single_register</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">register_address</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pyhoff.modbus.SimpleModbusClient.write_single_register" title="Link to this definition"></a></dt>
|
||
<dd><p>ModBus function for writing a single register (0x06)</p>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><ul class="simple">
|
||
<li><p><strong>register_address</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Register address (0 to 0xffff)</p></li>
|
||
<li><p><strong>value</strong> (<span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></span>) – Value to write (0 to 0xffff)</p></li>
|
||
</ul>
|
||
</dd>
|
||
<dt class="field-even">Return type<span class="colon">:</span></dt>
|
||
<dd class="field-even"><p><span class="sphinx_autodoc_typehints-type"><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></span></p>
|
||
</dd>
|
||
<dt class="field-odd">Returns<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>True if write succeeded or False if failed</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
</dd></dl>
|
||
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
||
<a href="readme.html" class="btn btn-neutral float-left" title="Pyhoff" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
||
</div>
|
||
|
||
<hr/>
|
||
|
||
<div role="contentinfo">
|
||
<p>© Copyright 2025, Nicolas Kruse.</p>
|
||
</div>
|
||
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
||
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
||
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
||
|
||
|
||
</footer>
|
||
</div>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
<script>
|
||
jQuery(function () {
|
||
SphinxRtdTheme.Navigation.enable(true);
|
||
});
|
||
</script>
|
||
|
||
</body>
|
||
</html> |