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