]> rtime.felk.cvut.cz Git - orte.git/blob - readme
1a6929eacc3947c68c09ed1a714261a425121f6a
[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
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
33 RTLinux compilation:
34 ./configure --with-rtlinuxdir=/rtlinux dir/ --with-linuxdir=/patched linux dir/
35 make 
36 make install
37
38 RTAI compilation:
39 ./configure --with-rtaidir=/rtai dir/ --with-linuxdir=/patched linux dir/
40 make 
41 make install
42
43
44 How to start?
45 -------------
46 run :ortemanager &
47 see :ortemanager -h for usaged
48 note:ortemanager have to be running during all communication. For future work can 
49 be added into /etc/init.d/... script for starting ortemanager during boot
50 of machine. This script (redhat and mandrake) is placed in 
51 "orte/manager/rc/ortemanagerd"
52 For developping a RT application, ortemnager can be running in userspace.
53 Start it with parameter "-k 192.168.4.2". This address is IP address of 
54 RT application.
55
56 How to test communication?
57 -------------------------
58 in a shell try to type "orteping -p -s". So, now will be created one publisher
59 and one subscriber with same topic and type. If you see messages like
60
61 [root@localhost ORTEPing]# ./orteping -p -s
62 sent issue 1
63 received fresh issue 1
64 sent issue 2
65 received fresh issue 2
66 sent issue 3
67 received fresh issue 3
68
69 communication works. If you see only sending messsages, it's sign that ortemanager 
70 is not probably running.
71 See "orteping -h" for usaged.
72
73 Now, you can develop self applications (see documentation).
74
75
76
77
78
79 Feedback is welcome - send bug reports, enhancements, checks, money
80 orders, etc. to the address below.
81
82 Petr Smolik             petr.smolik@wo.cz