Site checkin for project PLC4X: Jenkins Tools
diff --git a/images/apache-plc4x-can-canopen.png b/images/apache-plc4x-can-canopen.png
new file mode 100644
index 0000000..07b5ec8
--- /dev/null
+++ b/images/apache-plc4x-can-canopen.png
Binary files differ
diff --git a/users/protocols/can.html b/users/protocols/can.html
new file mode 100644
index 0000000..d62755b
--- /dev/null
+++ b/users/protocols/can.html
@@ -0,0 +1,381 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>PLC4X – </title>
+ <script src="../../js/jquery.slim.min.js" type="text/javascript"></script>
+ <!--script src="../../js/popper.min.js" type="javascript"></script-->
+ <script src="../../js/bootstrap.bundle.min.js" type="text/javascript"></script>
+ <!-- The tooling for adding images and links to Apache events -->
+ <script src="https://www.apachecon.com/event-images/snippet.js" type="text/javascript"></script>
+ <!-- FontAwesome -->
+ <link rel="stylesheet" href="../../css/all.min.css" type="text/css"/>
+ <!-- Bootstrap -->
+ <link rel="stylesheet" href="../../css/bootstrap.min.css" type="text/css"/>
+ <!-- Some Maven Site defaults -->
+ <link rel="stylesheet" href="../../css/maven-base.css" type="text/css"/>
+ <link rel="stylesheet" href="../../css/maven-theme.css" type="text/css"/>
+ <!-- The PLC4X version of a bootstrap theme -->
+ <link rel="stylesheet" href="../../css/themes/plc4x.css" type="text/css" id="pagestyle"/>
+ <!-- A custom style for printing content -->
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print"/>
+
+ <meta http-equiv="Content-Language" content="en"/>
+
+</head>
+<body class="composite">
+<nav class="navbar navbar-light navbar-expand-md bg-faded justify-content-center border-bottom">
+ <!--a href="/" class="navbar-brand d-flex w-50 mr-auto">Navbar 3</a-->
+ <a href="https://plc4x.apache.org/" id="bannerLeft"><img src="../../images/apache_plc4x_logo_small.png" alt="Apache PLC4X"/></a>
+ <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsingNavbar3">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+ <div class="navbar-collapse collapse w-100" id="collapsingNavbar3">
+ <ul class="navbar-nav w-100 justify-content-center">
+ <li class="nav-item">
+ <a class="nav-link" href="../../index.html">Home</a>
+ </li>
+ <li class="nav-item active">
+ <a class="nav-link" href="../../users/index.html">Users</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../developers/index.html">Developers</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../apache/index.html">Apache</a>
+ </li>
+ </ul>
+ <ul class="nav navbar-nav ml-auto justify-content-end">
+ <li class="nav-item row valign-middle">
+ <a class="acevent" data-format="wide" data-mode="light" data-event="random" style="width:240px;height:60px;"></a>
+ </li>
+ </ul>
+ </div>
+</nav>
+<div class="container-fluid">
+ <div class="row h-100">
+
+
+ <nav class="col-sm-push col-md-2 pt-3 sidebar">
+ <div class="sidebar-sticky">
+ <ul class="nav flex-column">
+ <li class="nav-item">
+ <a href="../../users/index.html" class="nav-link">Section Home</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/download.html" class="nav-link">Download</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/adopters.html" class="nav-link">Adopters</a>
+ </li>
+
+
+
+
+ <li class="nav-item">
+ <a href="../../users/commercial-support.html" class="nav-link">Commercial support</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/gettingstarted.html" class="nav-link">Getting Started</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4go.html" class="nav-link">Go</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4j.html" class="nav-link">Java</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/using-snapshots.html" class="nav-link">Using SNAPSHOTS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/general-concepts.html" class="nav-link">General Concepts</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/virtual-modbus.html" class="nav-link">Virtual Modbus</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/blogs-videos-and-slides.html" class="nav-link">Blogs, Videos and Slides</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/protocols/index.html" class="nav-link">Protocols</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/protocols/ab-eth.html" class="nav-link">AB-ETH</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ads.html" class="nav-link">ADS/AMS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/bacnetip.html" class="nav-link">BACnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/canopen.html" class="nav-link">CANopen</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/deltav.html" class="nav-link">DeltaV</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/df1.html" class="nav-link">DF1</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ethernet-ip.html" class="nav-link">EtherNet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/firmata.html" class="nav-link">Firmata</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/knxnetip.html" class="nav-link">KNXnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/modbus.html" class="nav-link">Modbus</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/opc-ua.html" class="nav-link">OPC UA</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/s7.html" class="nav-link">S7 (Step7)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/simulated.html" class="nav-link">Simulated</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/transports/index.html" class="nav-link">Transports</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/transports/tcp.html" class="nav-link">TCP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/udp.html" class="nav-link">UDP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/serial.html" class="nav-link">Serial</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/socketcan.html" class="nav-link">SocketCAN</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/raw-socket.html" class="nav-link">Raw Socket</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/pcap-replay.html" class="nav-link">PCAP Replay</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/integrations/index.html" class="nav-link">Integrations</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-calcite.html" class="nav-link">Apache Calcite</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-camel.html" class="nav-link">Apache Camel</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-edgent.html" class="nav-link">Apache Edgent</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-iotdb.html" class="nav-link">Apache IoTDB</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-kafka.html" class="nav-link">Apache Kafka</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-nifi.html" class="nav-link">Apache NiFi</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-streampipes.html" class="nav-link">Apache StreamPipes</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-ditto.html" class="nav-link">Eclipse Ditto</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-milo.html" class="nav-link">Eclipse Milo OPC UA Server</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/tools/index.html" class="nav-link">Tools</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/tools/capture-replay.html" class="nav-link">Capture Replay</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-pool.html" class="nav-link">Connection Pool</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-cache.html" class="nav-link">Connection Cache</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/opm.html" class="nav-link">Object PLC Mapping (OPM)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/scraper.html" class="nav-link">Scraper</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/testing.html" class="nav-link">PLC4X without a PLC and Unit Testing</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/industry40.html" class="nav-link">Industry 4.0 with Apache</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/security.html" class="nav-link">Security</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </nav>
+ <main role="main" class="ml-sm-auto px-4 col-sm-pull col-md-9 col-lg-10 h-100">
+ <div class="sect1">
+<h2 id="can_bus_driver_adapter">CAN Bus Driver Adapter</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>The CAN Bus driver is a special kind of driver which does not bring any logic.
+Its responsibility is to combine <a href="../transports/can.html">CAN transport facade</a> and custom application layer protocols.
+In this way, the protocol can use its own "root frame" type which is not delivered from CAN bus frame.</p>
+</div>
+<div class="sect2">
+<h3 id="more_details_on_the_driver">More details on the driver</h3>
+<div class="paragraph">
+<p>The <code>CANDriverAdapter</code> is a full implementation of Apache PLC4X API.
+Under the hood adapter will forward all operations to delegate driver.
+Work which is done by the adapter is to transform data incoming via CAN transport into frame supported by driver.
+In this regard the <code>CANDriverAdapter</code> does not implement any real protocol.
+All it does is transformation of incoming frames into frame desired by real driver.</p>
+</div>
+<div class="paragraph">
+<p>Below diagram explains how driver adapter works with CANopen.
+Given that this is currently biggest CAN driver implemented in Apache PLC4X we will use it as a reference.</p>
+</div>
+<div class="imageblock">
+<div class="content">
+<img src="../../images/users/protocols/apache-plc4x-can-canopen.png" alt="apache plc4x can canopen" width="1480" height="224"/>
+</div>
+</div>
+<div class="paragraph">
+<p>Looking at left most side of diagram we can see a CAN transport.
+The transport knows how to receive and send data to the CAN bus.
+Transport can create its own intermediate representation of CAN data frame.
+In case of <code>SocketCAN</code> there is a dedicated type called <code>SocketCANFrame</code>.</p>
+</div>
+<div class="paragraph">
+<p>Most of other drivers in Apache PLC4X which rely on TCP, UDP or serial transports can unify right above transport.
+Yet due to variety of APIs which are possible to be used with CAN bus such early unification at API level is not possible.</p>
+</div>
+<div class="paragraph">
+<p>Place where <code>CANDriverAdapter</code> jumps in is once transport formed the frame structure.
+Then, adapter asks the transport to turn that structure into a <code>FrameData</code>.
+An instance of <code>FrameData</code> is then passed to an adapter delivered by CANopen Driver.
+This adapter can then create a <code>CANopenFrame</code> which is processed by desired driver logic.</p>
+</div>
+<div class="paragraph">
+<p>The return side, when desired driver wants to publish information is a bit simplified.
+Because <code>FrameData</code> does not be a real type (it is an interface) we can skip it.
+With a help of a <code>CANFrameBuilder</code> provided by CAN transport driver can easily construct a structure which is supported by it.
+While this makes an API asymmetric it also makes it possible to use any third party transport with <code>CANopenDriver</code>.</p>
+</div>
+</div>
+</div>
+</div>
+ </main>
+ <footer class="pt-4 my-md-5 pt-md-5 w-100 border-top">
+ <div class="row justify-content-md-center" style="font-size: 13px">
+ <div class="col col-6 text-center">
+ Copyright © 2017–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.<br/>
+ Apache PLC4X, PLC4X, Apache, the Apache feather logo, and the Apache PLC4X project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ <br/><div style="text-align:center;">Home screen image taken from <a
+ href="https://flic.kr/p/chEftd">Flickr</a>, "Tesla Robot Dance" by Steve Jurvetson, licensed
+ under <a href="https://creativecommons.org/licenses/by/2.0/">CC BY 2.0 Generic</a>, image cropped
+ and blur effect added.</div>
+ </div>
+ </div>
+ </footer>
+ </div>
+</div>
+
+<!-- Bootstrap core JavaScript
+================================================== -->
+<!-- Placed at the end of the document so the pages load faster -->
+<script src="../../js/jquery.slim.min.js"></script>
+<script src="../../js/popper.min.js"></script>
+<script src="../../js/bootstrap.min.js"></script>
+<script type="text/javascript">
+ $('.carousel .carousel-item').each(function(){
+ var next = $(this).next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+
+ for (let i = 0; i < 3; i++) {
+ next=next.next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+ }
+ });
+</script>
+</body>
+</html>
\ No newline at end of file
diff --git a/users/protocols/canopen.html b/users/protocols/canopen.html
index 6da7412..a2f8035 100644
--- a/users/protocols/canopen.html
+++ b/users/protocols/canopen.html
@@ -433,13 +433,13 @@
<p>CAN 2.0A uses 11 bit identifier and up to 8 bytes of data.</p>
</li>
<li>
-<p>CAN 2.0B uses 29 bit identifier and up to 64 bytes of data.</p>
+<p>CAN 2.0B uses 29 bit identifier and up to 8 bytes of data.</p>
</li>
</ul>
</div>
<div class="paragraph">
<p>To make things worse with introduction of CAN FD amount of combinations increased even more.
-Double check frame format as this integration supports CANopen and does not support CANopen FD.</p>
+Double check frame format as this integration supports CANopen and does not support CANopen FD nor CAN 2.0B.</p>
</div>
<div class="paragraph">
<p>Further reading on CAN flavors:
diff --git a/users/protocols/genericcan.html b/users/protocols/genericcan.html
new file mode 100644
index 0000000..3f3d855
--- /dev/null
+++ b/users/protocols/genericcan.html
@@ -0,0 +1,601 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>PLC4X – </title>
+ <script src="../../js/jquery.slim.min.js" type="text/javascript"></script>
+ <!--script src="../../js/popper.min.js" type="javascript"></script-->
+ <script src="../../js/bootstrap.bundle.min.js" type="text/javascript"></script>
+ <!-- The tooling for adding images and links to Apache events -->
+ <script src="https://www.apachecon.com/event-images/snippet.js" type="text/javascript"></script>
+ <!-- FontAwesome -->
+ <link rel="stylesheet" href="../../css/all.min.css" type="text/css"/>
+ <!-- Bootstrap -->
+ <link rel="stylesheet" href="../../css/bootstrap.min.css" type="text/css"/>
+ <!-- Some Maven Site defaults -->
+ <link rel="stylesheet" href="../../css/maven-base.css" type="text/css"/>
+ <link rel="stylesheet" href="../../css/maven-theme.css" type="text/css"/>
+ <!-- The PLC4X version of a bootstrap theme -->
+ <link rel="stylesheet" href="../../css/themes/plc4x.css" type="text/css" id="pagestyle"/>
+ <!-- A custom style for printing content -->
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print"/>
+
+ <meta http-equiv="Content-Language" content="en"/>
+
+</head>
+<body class="composite">
+<nav class="navbar navbar-light navbar-expand-md bg-faded justify-content-center border-bottom">
+ <!--a href="/" class="navbar-brand d-flex w-50 mr-auto">Navbar 3</a-->
+ <a href="https://plc4x.apache.org/" id="bannerLeft"><img src="../../images/apache_plc4x_logo_small.png" alt="Apache PLC4X"/></a>
+ <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsingNavbar3">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+ <div class="navbar-collapse collapse w-100" id="collapsingNavbar3">
+ <ul class="navbar-nav w-100 justify-content-center">
+ <li class="nav-item">
+ <a class="nav-link" href="../../index.html">Home</a>
+ </li>
+ <li class="nav-item active">
+ <a class="nav-link" href="../../users/index.html">Users</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../developers/index.html">Developers</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../apache/index.html">Apache</a>
+ </li>
+ </ul>
+ <ul class="nav navbar-nav ml-auto justify-content-end">
+ <li class="nav-item row valign-middle">
+ <a class="acevent" data-format="wide" data-mode="light" data-event="random" style="width:240px;height:60px;"></a>
+ </li>
+ </ul>
+ </div>
+</nav>
+<div class="container-fluid">
+ <div class="row h-100">
+
+
+ <nav class="col-sm-push col-md-2 pt-3 sidebar">
+ <div class="sidebar-sticky">
+ <ul class="nav flex-column">
+ <li class="nav-item">
+ <a href="../../users/index.html" class="nav-link">Section Home</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/download.html" class="nav-link">Download</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/adopters.html" class="nav-link">Adopters</a>
+ </li>
+
+
+
+
+ <li class="nav-item">
+ <a href="../../users/commercial-support.html" class="nav-link">Commercial support</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/gettingstarted.html" class="nav-link">Getting Started</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4go.html" class="nav-link">Go</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4j.html" class="nav-link">Java</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/using-snapshots.html" class="nav-link">Using SNAPSHOTS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/general-concepts.html" class="nav-link">General Concepts</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/virtual-modbus.html" class="nav-link">Virtual Modbus</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/blogs-videos-and-slides.html" class="nav-link">Blogs, Videos and Slides</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/protocols/index.html" class="nav-link">Protocols</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/protocols/ab-eth.html" class="nav-link">AB-ETH</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ads.html" class="nav-link">ADS/AMS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/bacnetip.html" class="nav-link">BACnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/canopen.html" class="nav-link">CANopen</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/deltav.html" class="nav-link">DeltaV</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/df1.html" class="nav-link">DF1</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ethernet-ip.html" class="nav-link">EtherNet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/firmata.html" class="nav-link">Firmata</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/knxnetip.html" class="nav-link">KNXnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/modbus.html" class="nav-link">Modbus</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/opc-ua.html" class="nav-link">OPC UA</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/s7.html" class="nav-link">S7 (Step7)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/simulated.html" class="nav-link">Simulated</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/transports/index.html" class="nav-link">Transports</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/transports/tcp.html" class="nav-link">TCP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/udp.html" class="nav-link">UDP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/serial.html" class="nav-link">Serial</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/socketcan.html" class="nav-link">SocketCAN</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/raw-socket.html" class="nav-link">Raw Socket</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/pcap-replay.html" class="nav-link">PCAP Replay</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/integrations/index.html" class="nav-link">Integrations</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-calcite.html" class="nav-link">Apache Calcite</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-camel.html" class="nav-link">Apache Camel</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-edgent.html" class="nav-link">Apache Edgent</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-iotdb.html" class="nav-link">Apache IoTDB</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-kafka.html" class="nav-link">Apache Kafka</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-nifi.html" class="nav-link">Apache NiFi</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-streampipes.html" class="nav-link">Apache StreamPipes</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-ditto.html" class="nav-link">Eclipse Ditto</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-milo.html" class="nav-link">Eclipse Milo OPC UA Server</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/tools/index.html" class="nav-link">Tools</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/tools/capture-replay.html" class="nav-link">Capture Replay</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-pool.html" class="nav-link">Connection Pool</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-cache.html" class="nav-link">Connection Cache</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/opm.html" class="nav-link">Object PLC Mapping (OPM)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/scraper.html" class="nav-link">Scraper</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/testing.html" class="nav-link">PLC4X without a PLC and Unit Testing</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/industry40.html" class="nav-link">Industry 4.0 with Apache</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/security.html" class="nav-link">Security</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </nav>
+ <main role="main" class="ml-sm-auto px-4 col-sm-pull col-md-9 col-lg-10 h-100">
+ <div class="sect1">
+<h2 id="generic_can">Generic CAN</h2>
+<div class="sectionbody">
+<div class="sect2">
+<h3 id="can_bus_semantics">CAN Bus semantics</h3>
+<div class="paragraph">
+<p>This driver is a generic purpose driver.
+It allows implementing a basic CAN bus listening or writing scenarios.</p>
+</div>
+<div class="paragraph">
+<p>CAN bus open is a specific protocol built on top of CAN bus.</p>
+</div>
+<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>genericcan</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>Generic CAN</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-can</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>socketcan</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="paragraph">
+<p>Any <code>can</code> transport, see <a href="../transports/can.html">CAN transport</a></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"><p class="tableblock">publish</p></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>Allows to publish a CAN frame via CAN transport.</p>
+</div></div></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">receive</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p><code>subscribe</code></p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p>This operation allows listening for incoming data or requests.</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-center valign-top" colspan="3"><p class="tableblock">none</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="sect2">
+<h3 id="more_details_on_the_driver">More details on the driver</h3>
+<div class="paragraph">
+<p>Given popularity of CAN in multiple market segments there is variety of protocols which can’t be published.
+Also, for many cases which are data acquisition oriented it is necessary to tap only parts of communications.</p>
+</div>
+<div class="paragraph">
+<p>This driver allows to model incoming and outgoing communication using plain Apache PLC4X api.
+The written CAN data is constructed from fields submitted via write request builder.
+The receiving data is transformed in similar fashion, based on subscribed fields.</p>
+</div>
+<div class="sect3">
+<h4 id="address_format">Address format</h4>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 20%;"/>
+<col style="width: 20%;"/>
+<col style="width: 20%;"/>
+<col style="width: 40%;"/>
+</colgroup>
+<thead>
+<tr>
+<th class="tableblock halign-left valign-top">Service</th>
+<th class="tableblock halign-left valign-top">Format</th>
+<th class="tableblock halign-left valign-top">Supported operations</th>
+<th class="tableblock halign-left valign-top">Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">n/a</p></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p>nodeId:type[arraySize]</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="ulist">
+<ul>
+<li>
+<p><code>write</code></p>
+</li>
+<li>
+<p><code>subscribe</code></p>
+</li>
+</ul>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p>There is only one syntax which is currently supported by this driver.</p>
+</div></div></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>Pay attention.
+You can use multiple fields to write and subscribe actual data.
+All fields must sum to up to 64 bits.
+If you subscribe less, then remaining data is discarded and not available via PLC4X api.</p>
+</div>
+<div class="paragraph">
+<p>The data will be sent in the same order as fields.</p>
+</div>
+<div class="paragraph">
+<p>Below table contains type mapping defined in Generic CAN driver.</p>
+</div>
+<table class="tableblock frame-all grid-all stretch">
+<colgroup>
+<col style="width: 33.3333%;"/>
+<col style="width: 33.3333%;"/>
+<col style="width: 33.3334%;"/>
+</colgroup>
+<tbody>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">CANopen Type</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">Length (in bits)</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">PLC4X Type</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">BOOLEAN</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">1</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">UNSIGNED8</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">8</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">USINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED16</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">16</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED24</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">24</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UDINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED32</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">32</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UDINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED40</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">40</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ULINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED48</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">48</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ULINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED56</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">56</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ULINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">UNSIGNED64</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">64</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">ULINT</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">INTEGER8</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">8</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">INTEGER16</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">16</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">INTEGER24</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">24</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">INTEGER32</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">32</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">INTEGER40</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">40</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">INTEGER48</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">48</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">INTEGER56</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">56</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">INTEGER64</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">64</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">REAL32</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">32</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">REAL</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock">REAL64</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">64</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">LREAL</p></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>The type table is similar to CANopen.
+Main difference is lack of support for string types.</p>
+</div>
+</div>
+</div>
+</div>
+</div>
+ </main>
+ <footer class="pt-4 my-md-5 pt-md-5 w-100 border-top">
+ <div class="row justify-content-md-center" style="font-size: 13px">
+ <div class="col col-6 text-center">
+ Copyright © 2017–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.<br/>
+ Apache PLC4X, PLC4X, Apache, the Apache feather logo, and the Apache PLC4X project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ <br/><div style="text-align:center;">Home screen image taken from <a
+ href="https://flic.kr/p/chEftd">Flickr</a>, "Tesla Robot Dance" by Steve Jurvetson, licensed
+ under <a href="https://creativecommons.org/licenses/by/2.0/">CC BY 2.0 Generic</a>, image cropped
+ and blur effect added.</div>
+ </div>
+ </div>
+ </footer>
+ </div>
+</div>
+
+<!-- Bootstrap core JavaScript
+================================================== -->
+<!-- Placed at the end of the document so the pages load faster -->
+<script src="../../js/jquery.slim.min.js"></script>
+<script src="../../js/popper.min.js"></script>
+<script src="../../js/bootstrap.min.js"></script>
+<script type="text/javascript">
+ $('.carousel .carousel-item').each(function(){
+ var next = $(this).next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+
+ for (let i = 0; i < 3; i++) {
+ next=next.next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+ }
+ });
+</script>
+</body>
+</html>
\ No newline at end of file
diff --git a/users/transports/can.html b/users/transports/can.html
new file mode 100644
index 0000000..5dfaf27
--- /dev/null
+++ b/users/transports/can.html
@@ -0,0 +1,431 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+ <title>PLC4X – </title>
+ <script src="../../js/jquery.slim.min.js" type="text/javascript"></script>
+ <!--script src="../../js/popper.min.js" type="javascript"></script-->
+ <script src="../../js/bootstrap.bundle.min.js" type="text/javascript"></script>
+ <!-- The tooling for adding images and links to Apache events -->
+ <script src="https://www.apachecon.com/event-images/snippet.js" type="text/javascript"></script>
+ <!-- FontAwesome -->
+ <link rel="stylesheet" href="../../css/all.min.css" type="text/css"/>
+ <!-- Bootstrap -->
+ <link rel="stylesheet" href="../../css/bootstrap.min.css" type="text/css"/>
+ <!-- Some Maven Site defaults -->
+ <link rel="stylesheet" href="../../css/maven-base.css" type="text/css"/>
+ <link rel="stylesheet" href="../../css/maven-theme.css" type="text/css"/>
+ <!-- The PLC4X version of a bootstrap theme -->
+ <link rel="stylesheet" href="../../css/themes/plc4x.css" type="text/css" id="pagestyle"/>
+ <!-- A custom style for printing content -->
+ <link rel="stylesheet" href="../../css/print.css" type="text/css" media="print"/>
+
+ <meta http-equiv="Content-Language" content="en"/>
+
+</head>
+<body class="composite">
+<nav class="navbar navbar-light navbar-expand-md bg-faded justify-content-center border-bottom">
+ <!--a href="/" class="navbar-brand d-flex w-50 mr-auto">Navbar 3</a-->
+ <a href="https://plc4x.apache.org/" id="bannerLeft"><img src="../../images/apache_plc4x_logo_small.png" alt="Apache PLC4X"/></a>
+ <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsingNavbar3">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+ <div class="navbar-collapse collapse w-100" id="collapsingNavbar3">
+ <ul class="navbar-nav w-100 justify-content-center">
+ <li class="nav-item">
+ <a class="nav-link" href="../../index.html">Home</a>
+ </li>
+ <li class="nav-item active">
+ <a class="nav-link" href="../../users/index.html">Users</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../developers/index.html">Developers</a>
+ </li>
+ <li class="nav-item">
+ <a class="nav-link" href="../../apache/index.html">Apache</a>
+ </li>
+ </ul>
+ <ul class="nav navbar-nav ml-auto justify-content-end">
+ <li class="nav-item row valign-middle">
+ <a class="acevent" data-format="wide" data-mode="light" data-event="random" style="width:240px;height:60px;"></a>
+ </li>
+ </ul>
+ </div>
+</nav>
+<div class="container-fluid">
+ <div class="row h-100">
+
+
+ <nav class="col-sm-push col-md-2 pt-3 sidebar">
+ <div class="sidebar-sticky">
+ <ul class="nav flex-column">
+ <li class="nav-item">
+ <a href="../../users/index.html" class="nav-link">Section Home</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/download.html" class="nav-link">Download</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/adopters.html" class="nav-link">Adopters</a>
+ </li>
+
+
+
+
+ <li class="nav-item">
+ <a href="../../users/commercial-support.html" class="nav-link">Commercial support</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/gettingstarted.html" class="nav-link">Getting Started</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4go.html" class="nav-link">Go</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/plc4j.html" class="nav-link">Java</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/using-snapshots.html" class="nav-link">Using SNAPSHOTS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/general-concepts.html" class="nav-link">General Concepts</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/getting-started/virtual-modbus.html" class="nav-link">Virtual Modbus</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/blogs-videos-and-slides.html" class="nav-link">Blogs, Videos and Slides</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/protocols/index.html" class="nav-link">Protocols</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/protocols/ab-eth.html" class="nav-link">AB-ETH</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ads.html" class="nav-link">ADS/AMS</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/bacnetip.html" class="nav-link">BACnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/canopen.html" class="nav-link">CANopen</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/deltav.html" class="nav-link">DeltaV</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/df1.html" class="nav-link">DF1</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/ethernet-ip.html" class="nav-link">EtherNet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/firmata.html" class="nav-link">Firmata</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/knxnetip.html" class="nav-link">KNXnet/IP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/modbus.html" class="nav-link">Modbus</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/opc-ua.html" class="nav-link">OPC UA</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/s7.html" class="nav-link">S7 (Step7)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/protocols/simulated.html" class="nav-link">Simulated</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/transports/index.html" class="nav-link">Transports</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/transports/tcp.html" class="nav-link">TCP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/udp.html" class="nav-link">UDP</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/serial.html" class="nav-link">Serial</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/socketcan.html" class="nav-link">SocketCAN</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/raw-socket.html" class="nav-link">Raw Socket</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/transports/pcap-replay.html" class="nav-link">PCAP Replay</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/integrations/index.html" class="nav-link">Integrations</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-calcite.html" class="nav-link">Apache Calcite</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-camel.html" class="nav-link">Apache Camel</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-edgent.html" class="nav-link">Apache Edgent</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-iotdb.html" class="nav-link">Apache IoTDB</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-kafka.html" class="nav-link">Apache Kafka</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-nifi.html" class="nav-link">Apache NiFi</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/apache-streampipes.html" class="nav-link">Apache StreamPipes</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-ditto.html" class="nav-link">Eclipse Ditto</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/integrations/eclipse-milo.html" class="nav-link">Eclipse Milo OPC UA Server</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/tools/index.html" class="nav-link">Tools</a>
+ <ul class="flex-column pl-4 nav">
+ <li class="nav-item">
+ <a href="../../users/tools/capture-replay.html" class="nav-link">Capture Replay</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-pool.html" class="nav-link">Connection Pool</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/connection-cache.html" class="nav-link">Connection Cache</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/opm.html" class="nav-link">Object PLC Mapping (OPM)</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/scraper.html" class="nav-link">Scraper</a>
+ </li>
+ <li class="nav-item">
+ <a href="../../users/tools/testing.html" class="nav-link">PLC4X without a PLC and Unit Testing</a>
+ </li>
+ </ul>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/industry40.html" class="nav-link">Industry 4.0 with Apache</a>
+ </li>
+
+
+ <li class="nav-item">
+ <a href="../../users/security.html" class="nav-link">Security</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ </div>
+ </nav>
+ <main role="main" class="ml-sm-auto px-4 col-sm-pull col-md-9 col-lg-10 h-100">
+ <div class="sect1">
+<h2 id="can">CAN</h2>
+<div class="sectionbody">
+<div class="paragraph">
+<p>A CAN transport is a special category of transport which can bring CAN frame data to various drivers.
+All of these transports are meant to follow basic CAN frame data semantics.</p>
+</div>
+<div class="paragraph">
+<p>Each CAN transport must provide a <code>CANFrameBuilder</code> interface realization.
+This builder can be used by drivers which implement application layer protocols on top of CAN bus.
+The builder allow constructing requests which should be passed to the bus operations.</p>
+</div>
+<div class="paragraph">
+<p>Note this API is available since Apache PLC4X 0.9.</p>
+</div>
+<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"><div class="content"><div class="paragraph">
+<p>not available</p>
+</div></div></td>
+<td class="tableblock halign-left valign-top"><div class="content"><div class="paragraph">
+<p>This transport ships only additional API on top of existing Apache PLC4X Transport API.</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>CAN</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-transport-can</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">Options:</p></td>
+<td class="tableblock halign-left valign-top" colspan="2"><div class="content"><div class="paragraph">
+<p><strong>none</strong>, an abstract transport</p>
+</div></div></td>
+</tr>
+</tbody>
+</table>
+<div class="paragraph">
+<p>Main purpose of this transport is basic unification of various CAN bus APIs.
+There is no unified way to access CAN (beside SocketCAN for linux) across multiple platforms.
+We brought this simplistic facade-alike API to serve very basic project needs.
+Its main purpose is to let transport implementer bridge with actual transport or another library.
+With as little effort as possible.</p>
+</div>
+<div class="paragraph">
+<p>Major advantage of CAN transport facade is possibility to implement application layer protocols in a fully portable way.
+This flexibility is not guaranteed with SocketCAN alone.</p>
+</div>
+<div class="paragraph">
+<p>The CAN transport responsibility is to bring CAN data to driver implementer.
+This API does not enforce, require or promote a low level bus operations.
+In this regard, these operations can be made by library available for specific CAN adapter in use.</p>
+</div>
+<div class="sect2">
+<h3 id="developer_notes">Developer notes</h3>
+<div class="paragraph">
+<p>Usage of CAN transport APIs is recommended for portability reasons.
+Please have a look on <a href="../protocols/can.html">CAN</a> describe usage of CAN driver adapter with CAN transport facade.</p>
+</div>
+</div>
+</div>
+</div>
+<div class="sect1">
+<h2 id="compatible_can_transports">Compatible CAN transports</h2>
+<div class="sectionbody">
+<div class="ulist">
+<ul>
+<li>
+<p><a href="socketcan.html">SocketCAN</a></p>
+</li>
+</ul>
+</div>
+</div>
+</div>
+ </main>
+ <footer class="pt-4 my-md-5 pt-md-5 w-100 border-top">
+ <div class="row justify-content-md-center" style="font-size: 13px">
+ <div class="col col-6 text-center">
+ Copyright © 2017–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>.
+All rights reserved.<br/>
+ Apache PLC4X, PLC4X, Apache, the Apache feather logo, and the Apache PLC4X project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ <br/><div style="text-align:center;">Home screen image taken from <a
+ href="https://flic.kr/p/chEftd">Flickr</a>, "Tesla Robot Dance" by Steve Jurvetson, licensed
+ under <a href="https://creativecommons.org/licenses/by/2.0/">CC BY 2.0 Generic</a>, image cropped
+ and blur effect added.</div>
+ </div>
+ </div>
+ </footer>
+ </div>
+</div>
+
+<!-- Bootstrap core JavaScript
+================================================== -->
+<!-- Placed at the end of the document so the pages load faster -->
+<script src="../../js/jquery.slim.min.js"></script>
+<script src="../../js/popper.min.js"></script>
+<script src="../../js/bootstrap.min.js"></script>
+<script type="text/javascript">
+ $('.carousel .carousel-item').each(function(){
+ var next = $(this).next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+
+ for (let i = 0; i < 3; i++) {
+ next=next.next();
+ if (!next.length) {
+ next = $(this).siblings(':first');
+ }
+ next.children(':first-child').clone().appendTo($(this));
+ }
+ });
+</script>
+</body>
+</html>
\ No newline at end of file
diff --git a/users/transports/index.html b/users/transports/index.html
index b4ac505..2f45996 100644
--- a/users/transports/index.html
+++ b/users/transports/index.html
@@ -304,6 +304,9 @@
<p><a href="serial.html">Serial Port</a></p>
</li>
<li>
+<p><a href="can.html">CAN bus</a></p>
+</li>
+<li>
<p><a href="socketcan.html">SocketCAN</a></p>
</li>
<li>
