This is an automated email from the ASF dual-hosted git repository.
git-site-role pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/plc4x-website.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 88b11c6 Site checkin for project PLC4X: Jenkins Tools
88b11c6 is described below
commit 88b11c6f14f5bf73a3af4ad5dc244825d115046c
Author: jenkins <[email protected]>
AuthorDate: Fri Mar 6 09:13:03 2020 +0000
Site checkin for project PLC4X: Jenkins Tools
---
users/protocols/modbus.html | 221 +++++++++++++++++++++++++++++++++++++-
users/protocols/s7.html | 4 +-
users/transports/pcap-replay.html | 4 +-
3 files changed, 224 insertions(+), 5 deletions(-)
diff --git a/users/protocols/modbus.html b/users/protocols/modbus.html
index 80fd869..2908c1c 100644
--- a/users/protocols/modbus.html
+++ b/users/protocols/modbus.html
@@ -257,7 +257,226 @@
<div class="sect1">
<h2 id="modbus_tcpserial">Modbus (TCP/Serial)</h2>
<div class="sectionbody">
-
+<div class="sect2">
+<h3 id="connection_string_options">Connection String Options</h3>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 22.2222%;"/>
+<col style="width: 22.2222%;"/>
+<col style="width: 55.5556%;"/>
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Value</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Code</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div
class="content"><div class="paragraph">
+<p><code>modbus</code></p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Name</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div
class="content"><div class="paragraph">
+<p>Modbus</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Maven
Dependency</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div
class="content"><div class="listingblock">
+<div class="content">
+<pre><dependency>
+ <groupId>org.apache.plc4x</groupId>
+ <artifactId>plc4j-driver-modbus</artifactId>
+ <version>{current-last-released-version}</version>
+</dependency></pre>
+</div>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Default
Transport:</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div
class="content"><div class="paragraph">
+<p> <code>tcp</code></p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Compatible
Transports:</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div
class="content"><div class="ulist">
+<ul>
+<li>
+<p><code>tcp</code> (Default Port: 502)</p>
+</li>
+<li>
+<p><code>serial</code></p>
+</li>
+<li>
+<p><code>raw-socket</code></p>
+</li>
+<li>
+<p><code>pcap-replay</code></p>
+</li>
+</ul>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top" colspan="3"><p
class="tableblock">Supported Operations</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>read</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p>Only supported with <code>tcp</code> and <code>serial</code> transport.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>write</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p>Only supported with <code>tcp</code> and <code>serial</code> transport.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>subscribe</code> (passive)</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p>Only supported with <code>raw-socket</code> and
<code>pcap-replay</code>.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top" colspan="3"><p
class="tableblock">Options</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>request-timeout</code> (1000ms)</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>Rack</code> value for the client (PLC4X device). Defaults to 1.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>unit-identifier</code> (1)</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>Slot</code> value for the client (PLC4X device). Defaults to 1.</p>
+</div></div></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect2">
+<h3 id="individual_resource_address_format">Individual Resource Address
Format</h3>
+<div class="paragraph">
+<p>In contrast to most other protocols Modbus only supports two datatypes.</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Bit (Coil)</p>
+</li>
+<li>
+<p>Short (2-bytes) (Registers)</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Some implementations implement more types based on these, such as 16 bit
half-precision floating point types wrapped in a Register or joining multiple
Coils or Registers to bigger data-types, but this is not handled by the Modbus
specification.</p>
+</div>
+<div class="paragraph">
+<p>Coils and Registers are generally separated into pure inputs which are
read-only and writable versions.</p>
+</div>
+<div class="paragraph">
+<p>Inputs (Read-Only):</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Discrete Input (Boolean / 1 bit)</p>
+</li>
+<li>
+<p>Input Register (Short / 16 bi)</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Output (Read/Write):</p>
+</div>
+<div class="ulist">
+<ul>
+<li>
+<p>Coil (Boolean / 1 bit)</p>
+</li>
+<li>
+<p>Holding Register (Short / 16 bi)</p>
+</li>
+</ul>
+</div>
+<div class="paragraph">
+<p>Here come the syntax descriptions of these addresses (Each address can
reference either a single item or an array):</p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;"/>
+<col style="width: 20%;"/>
+<col style="width: 50%;"/>
+<col style="width: 10%;"/>
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Address Syntax</th>
+<th class="tableblock halign-left valign-top">Description</th>
+<th class="tableblock halign-left valign-top">Bit-Size</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Discrete
Input</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>discrete-input:{start-address}</code> or
<code>discrete-input:{start-address}[{count}]</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Read-only
Boolean input value, usually representing a binary input to the PLC</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Input
Register</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>input-register:{start-address}</code> or
<code>input-register:{start-address}[{count}]</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Read-only
Short input value, usually representing an analog input to the PLC</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">16</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Coil</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>coil:{start-address}</code> or
<code>coil:{start-address}[{count}]</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Read/Write
Boolean value, usually representing a binary output from the PLC</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">1</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Holding
Register</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>holding-register:{start-address}</code> or
<code>holding-register:{start-address}[{count}]</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Read/Write
Short value, usually representing an analog output from the PLC</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">16</p></td>
+</tr>
+</tbody>
+</table>
+</div>
</div>
</div>
</main>
diff --git a/users/protocols/s7.html b/users/protocols/s7.html
index f350fe4..1fab53e 100644
--- a/users/protocols/s7.html
+++ b/users/protocols/s7.html
@@ -346,8 +346,8 @@
<p><code>subscribe</code></p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
-<p>Generally supported with <code>tcp</code> transport with S7 devices of
types: <code>S7 300</code>, <code>S7 400</code>, <code>S7 1500</code>.
-With <code>raw-socket</code> and <code>pcap-replay</code> supported on all
devices.</p>
+<p>Generally supported with <code>tcp</code> transport with S7 devices of
types: <code>S7 300</code>, <code>S7 400</code>, <code>S7 1500</code> (active
and passive).
+With <code>raw-socket</code> and <code>pcap-replay</code> supported on all
devices (passive).</p>
</div></div></td>
</tr>
<tr>
diff --git a/users/transports/pcap-replay.html
b/users/transports/pcap-replay.html
index f515a69..292305b 100644
--- a/users/transports/pcap-replay.html
+++ b/users/transports/pcap-replay.html
@@ -312,7 +312,7 @@
<tr>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
-<p>replay-speed-factor</p>
+<p><code>replay-speed-factor</code> (1)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
<p>Numeric value for changing the replay speed:</p>
@@ -337,7 +337,7 @@
<tr>
<td class="tableblock halign-left valign-top"></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
-<p>loop</p>
+<p><code>loop</code> (false)</p>
</div></div></td>
<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
<p>Should the replay start at the beginning of the file as soon as the end is
reached?</p>