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 977cd45 Site checkin for project PLC4X: Jenkins Tools
977cd45 is described below
commit 977cd451d7e315406ab856620f33db81d36be73a
Author: jenkins <bui...@apache.org>
AuthorDate: Tue May 5 09:18:31 2020 +0000
Site checkin for project PLC4X: Jenkins Tools
---
users/protocols/ethernet-ip.html | 181 ++++++++++++++++++++++++++++++++++++++-
1 file changed, 180 insertions(+), 1 deletion(-)
diff --git a/users/protocols/ethernet-ip.html b/users/protocols/ethernet-ip.html
index 2253293..081da47 100644
--- a/users/protocols/ethernet-ip.html
+++ b/users/protocols/ethernet-ip.html
@@ -263,7 +263,186 @@
<div class="sect1">
<h2 id="ethernetip">EtherNet/IP</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>eip</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>EtherNet/IP Protocol</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-eip</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" 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>Read tags from a PLC4X device</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>Write values to tags on a PLC4X device</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>backplane</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div
class="paragraph">
+<p><code>backplane</code> value for the client (PLC4X device). Mandatory.</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>slot</code></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). Mandatory.</p>
+</div></div></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect2">
+<h3 id="address_format">Address Format</h3>
+<div class="paragraph">
+<p>To read and write data to a PLC4X device, the EtherNet/IP driver uses
symbolic segments.
+ This is used to refer to objects through their symbolic names. This makes
reading data a lot easier, as you do not
+ need to specify the Datatype for reading.</p>
+</div>
+<div class="listingblock">
+<div class="content">
+<pre>%{tagname}[{startIndex}]:{numberOfElements}
+%{tagname}[{startIndex}]:{numberOfElements}:{DataType}</pre>
+</div>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;"/>
+<col style="width: 50%;"/>
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Name</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Tagname</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">symbolic
name of the Data</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Start
Index (optional)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">if the
data is an array, we can specify a starting index from where we want to
read</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Number of
elements (optional)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">if the
data is an array, we can specify the number of elements we want to read. Use
this in combination with the starting index to get the exact scope you
want.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">DataType
(writing)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Specify
the Data-type of the value you want to write (mandatory)</p></td>
+</tr>
+</tbody>
+</table>
+<div class="sect3">
+<h4 id="data_types">Data Types</h4>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 50%;"/>
+<col style="width: 50%;"/>
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">To store</th>
+<th class="tableblock halign-left valign-top">Use this data type</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">Bit</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">BOOL</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Bit
array</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">DWORD
(32-bit boolean array)</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">8-bit
integer</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">SINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">16-bit
integer</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">INT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">32-bit
integer</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">DINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">64-bit
integer</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">LINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">32-bit
float</p></td>
+<td class="tableblock halign-left valign-top"><p
class="tableblock">REAL</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</div>
</div>
</div>
</main>
