Skip to content

Commit 2cf5a11

Browse files
committed
README: update instructions for clients with local TwinCAT router
For many users it is to hard to look into .gitlab-ci.yml and find out how to build on different platforms with different flavours so we add more documentation to the README. On TC/BSD and TC/LUR we can use the new native meson files to build with TwinCAT support. Additionally, we explain the difference between "adstool" and "tcadstool". Suggested-by: Birger Evenburg <[email protected]> Signed-off-by: Patrick Bruenn <[email protected]>
1 parent d8de7b0 commit 2cf5a11

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

README.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Prepare your target to run the example
5050
- TcAmsRemoteMgr:
5151
Windows CE devices can be configured locally (TC2 requires a TwinCAT restart). Tool location: `/Hard Disk/System/TcAmsRemoteMgr.exe`
5252
- IPC Diagnose:
53-
Beckhoff IPC’s provide a web interface for diagnose and configuration. Further information: http://infosys.beckhoff.de/content/1033/devicemanager/index.html?id=286
53+
Beckhoff IPC’s provide a web interface for diagnose and configuration. Further information: http://infosys.beckhoff.de/content/1033/devicemanager/index.html
5454

5555
Sample AMS route:
5656
```
@@ -65,6 +65,8 @@ Sample AMS route:
6565

6666
Prepare your client to run the example/example.cpp
6767
==================================================
68+
## Without TwinCAT on the client
69+
Use this option for system with no TwinCAT 3.1 installtion:
6870
- set "remoteNetId" to the AMS NetId of your TwinCAT target (this is the AMS NetId found in the "About TwinCAT System window" e.g. "192.168.0.2.1.1").
6971
- set "remoteIpV4" to the IP Address of your TwinCAT target (e.g. 192.168.0.2)
7072
- (optional) enable bhf::ads::SetLocalAddress() and set to the AMS NetId you choose for the ADS client (e.g. 192.168.0.1.1.1).
@@ -77,5 +79,36 @@ ninja -C example/build
7779
# and run the example
7880
./example/build/example
7981
```
82+
## On TC/BSD with TwinCAT installed, you can use the local TwinCAT router
83+
```shell
84+
# Install toolchain
85+
doas install os-generic-userland-devtools
86+
# configure meson to build example into "build" dir
87+
meson example/build example --native-file meson.native.tcbsd
88+
# let ninja build the example
89+
ninja -C example/build
90+
# and run the example
91+
./example/build/example
92+
```
93+
## On Beckhoff RT Linux with TwinCAT installed, you can use the local TwinCAT router
94+
```shell
95+
# configure meson to build example into "build" dir
96+
meson example/build example --native-file meson.native.tclur
97+
# let ninja build the example
98+
ninja -C example/build
99+
# and run the example
100+
./example/build/example
101+
```
102+
103+
Note: the name of the binaries which use the TwinCAT ADS Router have a different naming scheme
104+
105+
binary | standalone | use TwinCAT Router
106+
-----------|------------|-------------------
107+
AdsLib | x |
108+
TcAdsLib | | x
109+
adstool | x |
110+
tcadstool | | x
111+
example | x |
112+
tcexample | | x
80113
---
81114
ADS/AMS Specification: https://infosys.beckhoff.com/content/1033/tc3_ads_intro/index.html

0 commit comments

Comments
 (0)