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