readme

   1                     ORTE - OCERA Real-Time Ethernet
   2
   3 What is it?
   4 -----------
   5 The ORTE is open source implementation of RTPS communication protocol
   6 defined by Real Time Innovations (http://www.rti.com).
   7 RTPS is new application layer protocol targeted to real-time communication
   8 area, which is build on top of standard UDP stack.
   9
  10 Which targets are supported by ORTE?
  11 -----------------------------------
  12 UNIX - Linux, Solars, MacOS, FreeBSD
  13 Windows - MinGW, CygWin, MSVC
  14 RTLinux - with preliminary UDP stack
  15 RTAI - with RTNet
  16 JAVA
  17
  18 note: was tested on
  19 sparc-sun-solaris2.9
  20 powerpc-apple-darwin6.8
  21
  22 How to install it?
  23 ------------------
  24 simply untar instalation package into desired directory, enter this
  25 directory and issue following commands.
  26
  27 UserSpace compilation:
  28 ./configure
  29 make
  30 make install
  31
  32 after this procedure ortemanager and orteping are placed in /usr/local/bin
  33 , library in /usr/local/lib and include headers /usr/local/include
  34
  35 RTLinux compilation with wIP:
  36 ./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxwip=/wip dir/
  37 make
  38 make install
  39
  40 RTLinux compilation with onetd:
  41 ./configure --with-linux=/patched linux dir/ --with-rtlinux=/rtlinux dir/ --with-rtlinuxonetd=/onetd dir/
  42 make
  43 make install
  44
  45 RTAI compilation:
  46 ./configure --with-linux=/patched linux dir/ --with-rtai=/rtai dir/ --with-rtnet=/rtnet dir/
  47 make
  48 make install
  49
  50 JAVA compilation:
  51 ./configure --with-java=/java home dir/
  52 make
  53 make install
  54
  55 How to start?
  56 -------------
  57 run :ortemanager &
  58 see :ortemanager -h for usage
  59 note:ortemanager have to be running during all communication. For future work can
  60 be added into /etc/init.d/... script for starting ortemanager during boot
  61 of machine. This scripts (redhat and mandrake) are located in
  62 "orte/manager/rc/ortemanagerd"
  63 For developping a RT application, ortemnager can be running in userspace.
  64 Start it with parameter "-k 192.168.4.2". This address is IP address of
  65 RT application.
  66
  67 How to test communication?
  68 -------------------------
  69 in a shell try to type "orteping -p -s". So, now will be created one publisher
  70 and one subscriber with same topic and type. If you see messages like
  71
  72 [root@localhost ORTEPing]# ./orteping -p -s
  73 sent issue 1
  74 received fresh issue 1
  75 sent issue 2
  76 received fresh issue 2
  77 sent issue 3
  78 received fresh issue 3
  79
  80 communication works. If you see only sending messsages, it's sign that ortemanager
  81 is not probably running.
  82 See "orteping -h" for usaged.
  83
  84 Now, you can develop self applications (see documentation).
  85
  86
  87
  88 Feedback is welcome - send bug reports, enhancements, checks, money
  89 orders, etc. to the address below.
  90
  91 Petr Smolik             petr.smolik@wo.cz