[incubator-plc4x] 04/05: Added some documentation on setting up AMS routes for Beckhoff

[cd...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

cdutz pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-plc4x.git

commit 86ebdc2502f59db24bad4bbc5aa55dda24e4ee26
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Tue May 22 11:48:25 2018 +0200

    Added some documentation on setting up AMS routes for Beckhoff
    
    (cherry picked from commit 6a0bebe)
---
 src/site/asciidoc/developers/vpn.adoc              |  33 +++++++++++++++++++++
 .../resources/img/plc4x-vpn-beckhoff-route-1.png   | Bin 0 -> 99036 bytes
 .../resources/img/plc4x-vpn-beckhoff-route-2.png   | Bin 0 -> 87524 bytes
 .../resources/img/plc4x-vpn-beckhoff-route-3.png   | Bin 0 -> 185843 bytes
 4 files changed, 33 insertions(+)

diff --git a/src/site/asciidoc/developers/vpn.adoc b/src/site/asciidoc/developers/vpn.adoc
index c3e19e1..1014f88 100644
--- a/src/site/asciidoc/developers/vpn.adoc
+++ b/src/site/asciidoc/developers/vpn.adoc
@@ -122,6 +122,39 @@ This device is able to use the following protocols:
 
 It is configured to use the IP: `10.10.64.40`
 
+Beckhoff PLCs are processes running on a host operating system.
+
+In this case, this host OS is `Windows 7 Professional`.
+
+These processes seem to communicate with an internal network, which isn't connected to the physical network of the host.
+
+In order to be able to communicate with the PLC from the outside world, a so-called `AMS Route` needs to be added.
+Unfortunately it seems that this route needs to be added individually for every clients ip.
+As the VPN gateway is automatically assigning IPs to the clients, this step eventually has to be done every time you log in.
+Right now we hope that as soon as routes have been added for quite some ips, eventually we won't have to do this anymore, but right now it looks as if we do.
+
+Adding a route is done by opening the ADS Route Editor on the Beckhoff machine:
+
+image::plc4x-vpn-beckhoff-route-1.png[]
+
+Here you click on add:
+
+image::plc4x-vpn-beckhoff-route-2.png[]
+
+And enter the details of the new route:
+
+image::plc4x-vpn-beckhoff-route-3.png[]
+
+Here it is important to give the route a name.
+The `AmsNetId` is sort of like a 6-segment ipv4-address. It could be chosen independently from the real ip address, however the default is to use the ip address for the first 4 segments and to append `.1.1` after this.
+So from an ip address: `10.10.57.104` the corresponding `AmsNetId` would be: `10.10.57.104.1.1`.
+`Transport Type` should be set to: `TCP_IP`.
+`Address Info` is where the clients ip address is added.
+Be sure to select the `IP Address` radio button below.
+Next thing, you should ensure, is that the type of `Remote Route` is set to `None`.
+
+When clicking on `Add Route`, don't be surprised that the window doesn't close, you have to click on `Close` after that and then you should see your new route in the route list screen.
+
 === Requesting an account
 
 The PLC hardware in the `PLC4X IoT Lab` is hosted in the codecentric Frankfurt office.
diff --git a/src/site/resources/img/plc4x-vpn-beckhoff-route-1.png b/src/site/resources/img/plc4x-vpn-beckhoff-route-1.png
new file mode 100644
index 0000000..ae4d50c
Binary files /dev/null and b/src/site/resources/img/plc4x-vpn-beckhoff-route-1.png differ
diff --git a/src/site/resources/img/plc4x-vpn-beckhoff-route-2.png b/src/site/resources/img/plc4x-vpn-beckhoff-route-2.png
new file mode 100644
index 0000000..1c37c3d
Binary files /dev/null and b/src/site/resources/img/plc4x-vpn-beckhoff-route-2.png differ
diff --git a/src/site/resources/img/plc4x-vpn-beckhoff-route-3.png b/src/site/resources/img/plc4x-vpn-beckhoff-route-3.png
new file mode 100644
index 0000000..c826d43
Binary files /dev/null and b/src/site/resources/img/plc4x-vpn-beckhoff-route-3.png differ

-- 
To stop receiving notification emails like this one, please contact
cdutz@apache.org.