readme

   1                     ORTE - OCERA Real-Time Ethernet
   2                     -------------------------------
   3
   4 What is it?
   5 -----------
   6 The 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 CVS Code
  24 ------------------
  25
  26 This seems redundant, since if you're reading this you most likely have
  27 already performed this step; however, for completeness, you can obtain
  28 the ORTE source code via anonymous CVS from the Sourceforge
  29 project <http://sf.org/projects/ocera/>:
  30
  31   $ cvs -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/ocera login
  32   $ cvs -z3 -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/ocera co -P ocera/components/comm/eth/orte
  33
  34 Building From CVS
  35 -----------------
  36
  37 To build ORTE from CVS, you will need Autoconf, Automake,
  38 and any tools that those utilities require (GNU m4, Perl,
  39 etc.).  See the configure.in file to find the minimum versions of each
  40 of these tools.
  41
  42 After checking out the code, you will need to perform these steps to get
  43 to the point where you can run "make".
  44
  45  $ make -f Makefile.cvs
  46
  47
  48 How to make and install it?
  49 ---------------------------
  50
  51 simply untar instalation package into desired directory, enter this
  52 directory and issue following commands.
  53
  54 UserSpace compilation:
  55 ./configure
  56 make
  57 make install
  58
  59 after this procedure ortemanager and orteping are placed in /usr/local/bin
  60 , library in /usr/local/lib and include headers /usr/local/include
  61
  62 RTLinux compilation with wIP:
  63 ./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxwip=/wip dir/
  64 make
  65 make install
  66
  67 RTLinux compilation with onetd:
  68 ./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxonetd=/onetd dir/
  69 make
  70 make install
  71
  72 RTAI compilation:
  73 ./configure --with-linux=/patched linux dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/
  74 make
  75 make install
  76
  77 JAVA compilation:
  78 ./configure --with-java=/java home dir/
  79 make
  80 make install
  81
  82 How to start?
  83 -------------
  84
  85 run :ortemanager &
  86 see :ortemanager -h for usage
  87 note:ortemanager have to be running during all communication. For future work can
  88 be added into /etc/init.d/... script for starting ortemanager during boot
  89 of machine. This scripts (redhat and mandrake) are located in
  90 "orte/manager/rc/ortemanagerd"
  91 For developping a RT application, ortemnager can be running in userspace.
  92 Start it with parameter "-k 192.168.4.2". This address is IP address of
  93 RT application.
  94
  95 How to test communication?
  96 -------------------------
  97
  98 in a shell try to type "orteping -p -s". So, now will be created one publisher
  99 and one subscriber with same topic and type. If you see messages like
 100
 101 [root@localhost ORTEPing]# ./orteping -p -s
 102 sent issue 1
 103 received fresh issue 1
 104 sent issue 2
 105 received fresh issue 2
 106 sent issue 3
 107 received fresh issue 3
 108
 109 communication works. If you see only sending messsages, it's sign that ortemanager
 110 is not probably running.
 111 See "orteping -h" for usaged.
 112
 113 Now, you can develop self applications (see documentation).
 114
 115 Feedback is welcome - send bug reports, enhancements, checks, money
 116 orders, etc. to the address below.
 117
 118 Petr Smolik             petr.smolik@wo.cz