readme

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