| <!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/plc4x.html" class="nav-link">PLC4X (Proxy)</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–2022 <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> |
