]> rtime.felk.cvut.cz Git - orte.git/blob - readme
RTNet and MinGW compilation correction
[orte.git] / readme
1                     ORTE - OCERA Real-Time Ethernet
2
3 What is it?
4 -----------
5 The ORTE is open source implementation of RTPS communication protocol 
6 defined by Real Time Innovations (http://www.rti.com). 
7 RTPS is new application layer protocol targeted to real-time communication 
8 area, which is build on top of standard UDP stack.
9
10 Which targets are supported by ORTE?
11 -----------------------------------
12 UNIX - Linux, Solars, MacOS, FreeBSD
13 Windows - MinGW, CygWin, MSVC
14 RTLinux - with preliminary UDP stack
15 RTAI - with RTNet
16
17 note: was tested on
18 sparc-sun-solaris2.9
19 powerpc-apple-darwin6.8
20
21 How to install it?
22 ------------------
23 simply untar instalation package into desired directory, enter this 
24 directory and issue following commands.
25
26 UserSpace compilation:
27 ./configure
28 make 
29 make install
30
31 after this procedure ortemanager and orteping are placed in /usr/local/bin
32 , library in /usr/local/lib and include headers /usr/local/include
33
34 RTLinux compilation:
35 ./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ 
36 make 
37 make install
38
39 RTAI compilation:
40 ./configure --with-linux=/patched linux dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/ 
41 make 
42 make install
43
44
45 How to start?
46 -------------
47 run :ortemanager &
48 see :ortemanager -h for usage
49 note:ortemanager have to be running during all communication. For future work can 
50 be added into /etc/init.d/... script for starting ortemanager during boot
51 of machine. This script (redhat and mandrake) is placed in 
52 "orte/manager/rc/ortemanagerd"
53 For developping a RT application, ortemnager can be running in userspace.
54 Start it with parameter "-k 192.168.4.2". This address is IP address of 
55 RT application.
56
57 How to test communication?
58 -------------------------
59 in a shell try to type "orteping -p -s". So, now will be created one publisher
60 and one subscriber with same topic and type. If you see messages like
61
62 [root@localhost ORTEPing]# ./orteping -p -s
63 sent issue 1
64 received fresh issue 1
65 sent issue 2
66 received fresh issue 2
67 sent issue 3
68 received fresh issue 3
69
70 communication works. If you see only sending messsages, it's sign that ortemanager 
71 is not probably running.
72 See "orteping -h" for usaged.
73
74 Now, you can develop self applications (see documentation).
75
76
77
78 Feedback is welcome - send bug reports, enhancements, checks, money
79 orders, etc. to the address below.
80
81 Petr Smolik             petr.smolik@wo.cz