You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by sr...@apache.org on 2018/02/17 09:39:15 UTC
[incubator-plc4x] branch master updated: update documentation
This is an automated email from the ASF dual-hosted git repository.
sruehl pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git
The following commit(s) were added to refs/heads/master by this push:
new f41a255 update documentation
f41a255 is described below
commit f41a255236dc38f709335726d825f90b194045c9
Author: Sebastian Rühl <sr...@apache.org>
AuthorDate: Sat Feb 17 10:39:11 2018 +0100
update documentation
---
plc4j/protocols/ads/src/site/asciidoc/index.adoc | 27 +++++-------------------
1 file changed, 5 insertions(+), 22 deletions(-)
diff --git a/plc4j/protocols/ads/src/site/asciidoc/index.adoc b/plc4j/protocols/ads/src/site/asciidoc/index.adoc
index 1a42a5d..3c4d266 100644
--- a/plc4j/protocols/ads/src/site/asciidoc/index.adoc
+++ b/plc4j/protocols/ads/src/site/asciidoc/index.adoc
@@ -36,10 +36,10 @@ The complete pipeline for the ADS protocol looks like this:
label = "PLC4X ADS Driver"
color = "#77FF77";
- ADSPlcConnection -> Plc4XADSProtocol -> ADSProtocol -> IsoTPProtocol -> IsoOnTcpProtocol -> Socket
+ ADSPlcConnection -> Plc4XADSProtocol -> ADSProtocol -> Socket
group {
- Plc4XADSProtocol; ADSProtocol; IsoTPProtocol; IsoOnTcpProtocol;
+ Plc4XADSProtocol; ADSProtocol;
}
}
}
@@ -54,36 +54,19 @@ In order to implement the ADS Protocol as described in link:../../../protocols/a
[seqdiag,ads-netty-setup-communication]
....
{
- Application; ADSPlcConnection; Plc4XADSProtocol; ADSProtocol; IsoTPProtocol; IsoOnTcpProtocol; Socket; PLC;
+ Application; ADSPlcConnection; Plc4XADSProtocol; ADSProtocol; Socket; PLC;
group Pipeline {
"Plc4XADSProtocol";
"ADSProtocol";
- "IsoTPProtocol";
- "IsoOnTcpProtocol";
}
Application -> ADSPlcConnection [label = "Calls 'connect'"]
- ADSPlcConnection --> IsoTPProtocol [label = "Fires ADSConnectionEvent(INITIAL) event to the pipeline", note = "IsoTPProtocol listens for ADSConnectionEvent(INITIAL) events"]
- IsoTPProtocol -> IsoOnTcpProtocol [label = "Creates new IsoOnTcp\nconnection request message"]
- IsoOnTcpProtocol -> Socket [label = "Creates the byte array\ncontaining the TCP on ISO\nmessage"]
- Socket -> PLC [label = "Sends the raw byte data to\nthe PLC"]
-
- Socket <- PLC [label = "Sends the response to the\nSocket"]
- IsoOnTcpProtocol <- Socket [label = "Passes the binary data to\nthe pipeline"]
- IsoTPProtocol <- IsoOnTcpProtocol [label = "Creates new IsoOnTcp message containing binary user data"]
-
- IsoTPProtocol --> ADSProtocol [label = "Sends ADSConnectionEvent(\nISO_TP_CONNECTION_RESPONSE_\nRECEIVED) event to the\npipeline", note = "ADSProtocol listens for ADSConnectionEvent(ISO_TP_CONNECTION_RESPONSE_RECEIVED) events"]
-
- IsoTPProtocol <- ADSProtocol [label = "Creates new ISO TP Data\nmessage containing an\n ADS SetupCommunictaion\nmessage"]
- IsoTPProtocol -> IsoOnTcpProtocol [label = "Creates new IsoOnTcp message"]
- IsoOnTcpProtocol -> Socket [label = "Creates the byte array\ncontaining the TCP on ISO\nmessage"]
+ ADSPlcConnection --> Socket [label = "Creates the byte array\ncontaining the TCP on ISO\nmessage"]
Socket -> PLC [label = "Sends the raw byte data to\nthe PLC"]
Socket <-- PLC [label = "Sends the response to the\nSocket"]
- IsoOnTcpProtocol <- Socket [label = "Passes the binary data to\nthe pipeline"]
- IsoTPProtocol <- IsoOnTcpProtocol [label = "Creates new IsoOnTcp message containing binary user data"]
- IsoTPProtocol -> ADSProtocol
+ Socket -> ADSProtocol [label = "Passes the binary data to\nthe pipeline"]
ADSPlcConnection <- ADSProtocol [label = "Sends ADSConnectionEvent(SETUP_COMPLETE) event to the\npipeline", note = "ADSPlcConnection listens for ADSConnectionEvent(SETUP_COMPLETE) events"]
}
--
To stop receiving notification emails like this one, please contact
sruehl@apache.org.