mirror of https://github.com/Nonannet/pyhoff.git
895 lines
56 KiB
HTML
895 lines
56 KiB
HTML
|
||
<!DOCTYPE html>
|
||
|
||
|
||
<html lang="en" data-content_root="../" >
|
||
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>pyhoff.modbus.SimpleModbusClient — pyhoff documentation</title>
|
||
|
||
|
||
|
||
<script data-cfasync="false">
|
||
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
|
||
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
|
||
</script>
|
||
<!--
|
||
this give us a css class that will be invisible only if js is disabled
|
||
-->
|
||
<noscript>
|
||
<style>
|
||
.pst-js-only { display: none !important; }
|
||
|
||
</style>
|
||
</noscript>
|
||
|
||
<!-- Loaded before other Sphinx assets -->
|
||
<link href="../_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
|
||
<link href="../_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
|
||
|
||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=8f2a1f02" />
|
||
|
||
<!-- So that users can add custom icons -->
|
||
<script src="../_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
|
||
<!-- Pre-loaded scripts that we'll load fully later -->
|
||
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
|
||
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
|
||
|
||
<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>DOCUMENTATION_OPTIONS.pagename = '_autogenerated/SimpleModbusClient';</script>
|
||
<link rel="index" title="Index" href="../genindex.html" />
|
||
<link rel="search" title="Search" href="../search.html" />
|
||
<link rel="prev" title="pyhoff.DigitalOutputTerminal" href="DigitalOutputTerminal.html" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
<meta name="docsearch:language" content="en"/>
|
||
<meta name="docsearch:version" content="" />
|
||
</head>
|
||
|
||
|
||
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
|
||
|
||
|
||
|
||
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
|
||
|
||
<div id="pst-scroll-pixel-helper"></div>
|
||
|
||
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
|
||
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
|
||
|
||
|
||
<dialog id="pst-search-dialog">
|
||
|
||
<form class="bd-search d-flex align-items-center"
|
||
action="../search.html"
|
||
method="get">
|
||
<i class="fa-solid fa-magnifying-glass"></i>
|
||
<input type="search"
|
||
class="form-control"
|
||
name="q"
|
||
placeholder="Search the docs ..."
|
||
aria-label="Search the docs ..."
|
||
autocomplete="off"
|
||
autocorrect="off"
|
||
autocapitalize="off"
|
||
spellcheck="false"/>
|
||
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
|
||
</form>
|
||
</dialog>
|
||
|
||
<div class="pst-async-banner-revealer d-none">
|
||
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
|
||
</div>
|
||
|
||
|
||
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
|
||
<div class="bd-header__inner bd-page-width">
|
||
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
|
||
<span class="fa-solid fa-bars"></span>
|
||
</button>
|
||
|
||
|
||
<div class="col-lg-3 navbar-header-items__start">
|
||
|
||
<div class="navbar-item">
|
||
|
||
|
||
|
||
|
||
|
||
<a class="navbar-brand logo" href="../index.html">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<p class="title logo__title">pyhoff documentation</p>
|
||
|
||
</a></div>
|
||
|
||
</div>
|
||
|
||
<div class="col-lg-9 navbar-header-items">
|
||
|
||
<div class="me-auto navbar-header-items__center">
|
||
|
||
<div class="navbar-item">
|
||
<nav>
|
||
<ul class="bd-navbar-elements navbar-nav">
|
||
|
||
<li class="nav-item current active">
|
||
<a class="nav-link nav-internal" href="index.html">
|
||
Classes and Modules
|
||
</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</nav></div>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="navbar-header-items__end">
|
||
|
||
<div class="navbar-item navbar-persistent--container">
|
||
|
||
|
||
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
||
<i class="fa-solid fa-magnifying-glass"></i>
|
||
<span class="search-button__default-text">Search</span>
|
||
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
|
||
</button>
|
||
</div>
|
||
|
||
|
||
<div class="navbar-item">
|
||
|
||
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
||
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
|
||
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
|
||
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
|
||
</button></div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
<div class="navbar-persistent--mobile">
|
||
|
||
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
||
<i class="fa-solid fa-magnifying-glass"></i>
|
||
<span class="search-button__default-text">Search</span>
|
||
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
|
||
</button>
|
||
</div>
|
||
|
||
|
||
|
||
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
|
||
<span class="fa-solid fa-outdent"></span>
|
||
</button>
|
||
|
||
</div>
|
||
|
||
</header>
|
||
|
||
|
||
<div class="bd-container">
|
||
<div class="bd-container__inner bd-page-width">
|
||
|
||
|
||
|
||
<dialog id="pst-primary-sidebar-modal"></dialog>
|
||
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar">
|
||
|
||
|
||
|
||
<div class="sidebar-header-items sidebar-primary__section">
|
||
|
||
|
||
<div class="sidebar-header-items__center">
|
||
|
||
|
||
|
||
<div class="navbar-item">
|
||
<nav>
|
||
<ul class="bd-navbar-elements navbar-nav">
|
||
|
||
<li class="nav-item current active">
|
||
<a class="nav-link nav-internal" href="index.html">
|
||
Classes and Modules
|
||
</a>
|
||
</li>
|
||
|
||
</ul>
|
||
</nav></div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="sidebar-header-items__end">
|
||
|
||
<div class="navbar-item">
|
||
|
||
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
||
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
|
||
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
|
||
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
|
||
</button></div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
<div class="sidebar-primary-items__start sidebar-primary__section">
|
||
<div class="sidebar-primary-item">
|
||
<nav class="bd-docs-nav bd-links"
|
||
aria-label="Section Navigation">
|
||
<p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p>
|
||
<div class="bd-toc-item navbar-nav"><p aria-level="2" class="caption" role="heading"><span class="caption-text">Bus coupler:</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="BK9000.html">pyhoff.devices.BK9000</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="BK9050.html">pyhoff.devices.BK9050</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="BK9100.html">pyhoff.devices.BK9100</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_352.html">pyhoff.devices.WAGO_750_352</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Beckhoff bus terminals:</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1002.html">pyhoff.devices.KL1002</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1012.html">pyhoff.devices.KL1012</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1032.html">pyhoff.devices.KL1032</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1052.html">pyhoff.devices.KL1052</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1104.html">pyhoff.devices.KL1104</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1114.html">pyhoff.devices.KL1114</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1124.html">pyhoff.devices.KL1124</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1154.html">pyhoff.devices.KL1154</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1164.html">pyhoff.devices.KL1164</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1184.html">pyhoff.devices.KL1184</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1194.html">pyhoff.devices.KL1194</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1212.html">pyhoff.devices.KL1212</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1232.html">pyhoff.devices.KL1232</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1302.html">pyhoff.devices.KL1302</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1304.html">pyhoff.devices.KL1304</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1312.html">pyhoff.devices.KL1312</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1314.html">pyhoff.devices.KL1314</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1352.html">pyhoff.devices.KL1352</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1362.html">pyhoff.devices.KL1362</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1382.html">pyhoff.devices.KL1382</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1402.html">pyhoff.devices.KL1402</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1404.html">pyhoff.devices.KL1404</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1408.html">pyhoff.devices.KL1408</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1412.html">pyhoff.devices.KL1412</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1414.html">pyhoff.devices.KL1414</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1418.html">pyhoff.devices.KL1418</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1434.html">pyhoff.devices.KL1434</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1488.html">pyhoff.devices.KL1488</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1498.html">pyhoff.devices.KL1498</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1501.html">pyhoff.devices.KL1501</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1512.html">pyhoff.devices.KL1512</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1702.html">pyhoff.devices.KL1702</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1704.html">pyhoff.devices.KL1704</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1712.html">pyhoff.devices.KL1712</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1722.html">pyhoff.devices.KL1722</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1804.html">pyhoff.devices.KL1804</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1808.html">pyhoff.devices.KL1808</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1809.html">pyhoff.devices.KL1809</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1814.html">pyhoff.devices.KL1814</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1819.html">pyhoff.devices.KL1819</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1859.html">pyhoff.devices.KL1859</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1862.html">pyhoff.devices.KL1862</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1872.html">pyhoff.devices.KL1872</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL1889.html">pyhoff.devices.KL1889</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2012.html">pyhoff.devices.KL2012</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2022.html">pyhoff.devices.KL2022</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2032.html">pyhoff.devices.KL2032</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2114.html">pyhoff.devices.KL2114</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2124.html">pyhoff.devices.KL2124</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2134.html">pyhoff.devices.KL2134</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2184.html">pyhoff.devices.KL2184</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2212.html">pyhoff.devices.KL2212</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2284.html">pyhoff.devices.KL2284</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2404.html">pyhoff.devices.KL2404</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2408.html">pyhoff.devices.KL2408</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2424.html">pyhoff.devices.KL2424</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2442.html">pyhoff.devices.KL2442</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2488.html">pyhoff.devices.KL2488</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2634.html">pyhoff.devices.KL2634</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2808.html">pyhoff.devices.KL2808</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2809.html">pyhoff.devices.KL2809</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2828.html">pyhoff.devices.KL2828</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2872.html">pyhoff.devices.KL2872</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL2889.html">pyhoff.devices.KL2889</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL3042.html">pyhoff.devices.KL3042</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL3054.html">pyhoff.devices.KL3054</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL3202.html">pyhoff.devices.KL3202</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL3214.html">pyhoff.devices.KL3214</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL4002.html">pyhoff.devices.KL4002</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL4004.html">pyhoff.devices.KL4004</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL4132.html">pyhoff.devices.KL4132</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="KL5121.html">pyhoff.devices.KL5121</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">WAGO bus terminals:</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_1405.html">pyhoff.devices.WAGO_750_1405</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_352.html">pyhoff.devices.WAGO_750_352</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_530.html">pyhoff.devices.WAGO_750_530</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_600.html">pyhoff.devices.WAGO_750_600</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="WAGO_750_602.html">pyhoff.devices.WAGO_750_602</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Generic bus terminals:</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalInputTerminal16Bit.html">pyhoff.devices.DigitalInputTerminal16Bit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalInputTerminal4Bit.html">pyhoff.devices.DigitalInputTerminal4Bit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalInputTerminal8Bit.html">pyhoff.devices.DigitalInputTerminal8Bit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalOutputTerminal16Bit.html">pyhoff.devices.DigitalOutputTerminal16Bit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalOutputTerminal4Bit.html">pyhoff.devices.DigitalOutputTerminal4Bit</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalOutputTerminal8Bit.html">pyhoff.devices.DigitalOutputTerminal8Bit</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Base classes:</span></p>
|
||
<ul class="nav bd-sidenav">
|
||
<li class="toctree-l1"><a class="reference internal" href="AnalogInputTerminal.html">pyhoff.AnalogInputTerminal</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="AnalogOutputTerminal.html">pyhoff.AnalogOutputTerminal</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="BusCoupler.html">pyhoff.BusCoupler</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="BusTerminal.html">pyhoff.BusTerminal</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalInputTerminal.html">pyhoff.DigitalInputTerminal</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="DigitalOutputTerminal.html">pyhoff.DigitalOutputTerminal</a></li>
|
||
</ul>
|
||
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Modbus:</span></p>
|
||
<ul class="current nav bd-sidenav">
|
||
<li class="toctree-l1 current active"><a class="current reference internal" href="#">pyhoff.modbus.SimpleModbusClient</a></li>
|
||
</ul>
|
||
</div>
|
||
</nav></div>
|
||
</div>
|
||
|
||
|
||
<div class="sidebar-primary-items__end sidebar-primary__section">
|
||
<div class="sidebar-primary-item">
|
||
<div id="ethical-ad-placement"
|
||
class="flat"
|
||
data-ea-publisher="readthedocs"
|
||
data-ea-type="readthedocs-sidebar"
|
||
data-ea-manual="true">
|
||
</div></div>
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
<main id="main-content" class="bd-main" role="main">
|
||
|
||
|
||
<div class="bd-content">
|
||
<div class="bd-article-container">
|
||
|
||
<div class="bd-header-article d-print-none">
|
||
<div class="header-article-items header-article__inner">
|
||
|
||
<div class="header-article-items__start">
|
||
|
||
<div class="header-article-item">
|
||
|
||
<nav aria-label="Breadcrumb" class="d-print-none">
|
||
<ul class="bd-breadcrumbs">
|
||
|
||
<li class="breadcrumb-item breadcrumb-home">
|
||
<a href="../index.html" class="nav-link" aria-label="Home">
|
||
<i class="fa-solid fa-home"></i>
|
||
</a>
|
||
</li>
|
||
|
||
<li class="breadcrumb-item"><a href="index.html" class="nav-link">Classes and Modules</a></li>
|
||
|
||
<li class="breadcrumb-item active" aria-current="page"><span class="ellipsis">pyhoff.modbus.SimpleModbusClient</span></li>
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div id="searchbox"></div>
|
||
<article class="bd-article">
|
||
|
||
<section id="pyhoff-modbus-simplemodbusclient">
|
||
<h1>pyhoff.modbus.SimpleModbusClient<a class="headerlink" href="#pyhoff-modbus-simplemodbusclient" title="Link to this heading">#</a></h1>
|
||
<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="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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>int</p>
|
||
</dd>
|
||
</dl>
|
||
</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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>int</p>
|
||
</dd>
|
||
</dl>
|
||
</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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>float</p>
|
||
</dd>
|
||
</dl>
|
||
</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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>str</p>
|
||
</dd>
|
||
</dl>
|
||
</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>
|
||
<dl class="field-list simple">
|
||
<dt class="field-odd">Type<span class="colon">:</span></dt>
|
||
<dd class="field-odd"><p>bool</p>
|
||
</dd>
|
||
</dl>
|
||
</dd></dl>
|
||
|
||
<p>Instantiate a 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>
|
||
<p class="rubric">Example</p>
|
||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </span><span class="n">client</span> <span class="o">=</span> <span class="n">SimpleModbusClient</span><span class="p">(</span><span class="s1">'localhost'</span><span class="p">,</span> <span class="n">port</span> <span class="o">=</span> <span class="mi">502</span><span class="p">,</span> <span class="n">unit_id</span> <span class="o">=</span> <span class="mi">1</span><span class="p">)</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">read_coils</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">read_discrete_inputs</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">read_holding_registers</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">read_input_registers</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">10</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">write_single_coil</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="kc">True</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">write_single_register</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1234</span><span class="p">))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">write_multiple_coils</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="kc">True</span><span class="p">,</span> <span class="kc">False</span><span class="p">,</span> <span class="kc">True</span><span class="p">]))</span>
|
||
<span class="gp">>>> </span><span class="nb">print</span><span class="p">(</span><span class="n">client</span><span class="o">.</span><span class="n">write_multiple_registers</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="p">[</span><span class="mi">1234</span><span class="p">,</span> <span class="mi">5678</span><span class="p">]))</span>
|
||
<span class="gp">>>> </span><span class="n">client</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
|
||
</pre></div>
|
||
</div>
|
||
<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>
|
||
|
||
|
||
</article>
|
||
|
||
|
||
|
||
|
||
|
||
<footer class="prev-next-footer d-print-none">
|
||
|
||
<div class="prev-next-area">
|
||
<a class="left-prev"
|
||
href="DigitalOutputTerminal.html"
|
||
title="previous page">
|
||
<i class="fa-solid fa-angle-left"></i>
|
||
<div class="prev-next-info">
|
||
<p class="prev-next-subtitle">previous</p>
|
||
<p class="prev-next-title">pyhoff.DigitalOutputTerminal</p>
|
||
</div>
|
||
</a>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<dialog id="pst-secondary-sidebar-modal"></dialog>
|
||
<div id="pst-secondary-sidebar" class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner">
|
||
|
||
|
||
<div class="sidebar-secondary-item">
|
||
<div
|
||
id="pst-page-navigation-heading-2"
|
||
class="page-toc tocsection onthispage">
|
||
<i class="fa-solid fa-list"></i> On this page
|
||
</div>
|
||
<nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2">
|
||
<ul class="visible nav section-nav flex-column">
|
||
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient</span></code></a><ul class="nav section-nav flex-column">
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.host"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.host</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.port"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.port</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.unit_id"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.unit_id</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.timeout"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.timeout</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.last_error"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.last_error</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.debug"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.debug</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.close"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.close()</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.connect"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.connect()</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.read_coil"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_coil()</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#pyhoff.modbus.SimpleModbusClient.read_coils"><code class="docutils literal notranslate"><span class="pre">SimpleModbusClient.read_coils()</span></code></a></li>
|
||
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" 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>
|
||
</nav></div>
|
||
|
||
<div class="sidebar-secondary-item">
|
||
<div role="note" aria-label="source link">
|
||
<h3>This Page</h3>
|
||
<ul class="this-page-menu">
|
||
<li><a href="../_sources/_autogenerated/SimpleModbusClient.md.txt"
|
||
rel="nofollow">Show Source</a></li>
|
||
</ul>
|
||
</div></div>
|
||
|
||
</div></div>
|
||
|
||
|
||
</div>
|
||
<footer class="bd-footer-content">
|
||
|
||
</footer>
|
||
|
||
</main>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Scripts loaded after <body> so the DOM is not blocked -->
|
||
<script defer src="../_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
|
||
<script defer src="../_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
|
||
|
||
<footer class="bd-footer">
|
||
<div class="bd-footer__inner bd-page-width">
|
||
|
||
<div class="footer-items__start">
|
||
|
||
<div class="footer-item">
|
||
|
||
<p class="copyright">
|
||
|
||
© Copyright 2025, Nicolas Kruse.
|
||
<br/>
|
||
|
||
</p>
|
||
</div>
|
||
|
||
<div class="footer-item">
|
||
|
||
<p class="sphinx-version">
|
||
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
||
<br/>
|
||
</p>
|
||
</div>
|
||
|
||
</div>
|
||
|
||
|
||
|
||
<div class="footer-items__end">
|
||
|
||
<div class="footer-item">
|
||
<p class="theme-version">
|
||
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
|
||
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
|
||
</p></div>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
|
||
</footer>
|
||
</body>
|
||
</html> |