README

   1                     ORTE - Open Real-Time Ethernet
   2                     ------------------------------
   3
   4 What is it?
   5 -----------
   6 ORTE is open source implementation of the RTPS communication protocol
   7 defined by Real Time Innovations (http://www.rti.com). RTPS is a new
   8 application layer protocol, targeted at real-time communication area,
   9 which is build on top of the standard UDP stack.
  10
  11 Which targets are supported by ORTE?
  12 -----------------------------------
  13 UNIX - Linux, Solars, MacOS, FreeBSD
  14 Windows - MinGW, CygWin, MSVC, PharLap
  15 RTLinux - with preliminary UDP stack
  16 RTAI - with RTNet
  17 JAVA
  18 Android - see README.android
  19
  20 note: was tested on
  21 sparc-sun-solaris2.9
  22 powerpc-apple-darwin6.8
  23
  24 How to compile and install it?
  25 ---------------------------
  26
  27 Simply untar installation package into desired directory, enter this
  28 directory and issue the following commands.
  29
  30 UserSpace compilation:
  31 ./configure
  32 make
  33 make install
  34
  35 After this procedure ortemanager and orteping are placed in
  36 /usr/local/bin, the library is placed in /usr/local/lib and include
  37 headers in /usr/local/include.
  38
  39 RTLinux compilation with wIP: (DEPRICATED)
  40 ./configure --with-linux=/patched_linux_dir/ --with-rtlinux=/rtlinux_dir/ --with-rtlinuxwip=/wip_dir/
  41 make
  42 make install
  43
  44 RTLinux compilation with onetd: (DEPRICATED)
  45 ./configure --with-linux=/patched_linux_dir/ --with-rtlinux=/rtlinuxh_dir/ --with-rtlinuxonetd=/onetd_dir/
  46 make
  47 make install
  48
  49 RTAI compilation:
  50 ./configure --with-linux=/patched_linux_dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/
  51 make
  52 make install
  53
  54 JAVA compilation:
  55 ./configure --with-java=/java_home_dir/
  56 make
  57 make install
  58
  59
  60 Another way of compiling ORTE is to use OMK compilation method. See
  61 https://rtime.felk.cvut.cz/omk/ for details about OMK. Just run
  62
  63   make
  64
  65 in the root of the ORTE project. This will create _compiled directory,
  66 which will contain the compiled binaries as well as other files.
  67
  68 How to start?
  69 -------------
  70
  71 run :ortemanager &
  72 see :ortemanager -h for usage
  73
  74 note: ortemanager have to be running during all communication. For
  75 future work can be added into /etc/init.d/... script for starting
  76 ortemanager during boot of machine. This scripts (redhat and mandrake)
  77 are located in "orte/manager/rc/ortemanagerd". For developing a RT
  78 application, ortemnager can be running in userspace. Start it with
  79 parameter "-k 192.168.4.2". This address is the IP address of the RT
  80 application.
  81
  82 How to test communication?
  83 -------------------------
  84
  85 In a shell try to type "orteping -p -s". This will create one
  86 publisher and one subscriber with the same topic and type. If you see
  87 messages like
  88
  89 [root@localhost ORTEPing]# ./orteping -p -s
  90 sent issue 1
  91 received fresh issue 1
  92 sent issue 2
  93 received fresh issue 2
  94 sent issue 3
  95 received fresh issue 3
  96
  97 then communication works. If you see only sending messages, it is a
  98 sign that ortemanager is not probably running. See "orteping -h" for
  99 usage.
 100
 101 Now, you can develop your applications (see documentation).
 102
 103 Obtaining the code from Git repository
 104 --------------------------------------
 105
 106 You can obtain the latest ORTE source code from Git repository by
 107 running:
 108
 109   $ git clone git://git.code.sf.net/p/orte/orte
 110
 111 Building From Git
 112 -----------------
 113
 114 To build ORTE code from Git, you will need Autoconf, Automake, and any
 115 tools that those utilities require (GNU m4, Perl, etc.). See the
 116 configure.in file to find the minimum versions of each of these tools.
 117
 118 After checking out the code, you will need to perform these steps to
 119 get to the point where you can run "configure" and "make".
 120
 121  $ make -f Makefile.git
 122
 123 Feedback is welcome - send bug reports, enhancements, checks, money
 124 orders, etc. to ORTE maintainers <orte@rtime.felk.cvut.cz>. The mail
 125 will go to Petr Smolik, Michal Sojka and Pavel Pisa.