diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ivy-c-1.html | 6 | ||||
-rw-r--r-- | doc/ivy-c-2.html | 6 | ||||
-rw-r--r-- | doc/ivy-c-3.html | 4 | ||||
-rw-r--r-- | doc/ivy-c-6.html | 19 |
4 files changed, 28 insertions, 7 deletions
diff --git a/doc/ivy-c-1.html b/doc/ivy-c-1.html index 69e9dee..3e22fab 100644 --- a/doc/ivy-c-1.html +++ b/doc/ivy-c-1.html @@ -62,7 +62,7 @@ networks and listening on the specified port number connect to it. It then becomes part of the bus, and listens like the other ones. <P>The messages are exchanged in text format, and bindings are based on regular expressions with captures. If an application subscribes to -<CODE>HELLO (.*)</CODE> an if another application emits the message <CODE>HELLO WORLD</CODE>, a +<CODE>HELLO (.*)</CODE> and if another application emits the message <CODE>HELLO WORLD</CODE>, a callback will be called in the first application with <CODE>WORLD</CODE> as an argument. <P> <P> @@ -78,10 +78,10 @@ can use an Ivy connection kit, that is a library that implements Ivy. <P> <P>Libraries that implement Ivy are available in the following environments: <UL> -<LI> in C on Unix and Windows platforms, with it own communication library</LI> +<LI> in C on Unix and Windows platforms, with its own communication library</LI> <LI> in C++ on Windows platforms</LI> <LI> in C++ on Unix platforms, integrated with the Uch communication library</LI> -<LI> in C++ on Unix platforms, integrated with OpenInventor</LI> +<LI> in C++ on Unix platforms, integrated with OpenInventor</LI> <LI> in C++ on Macintosh</LI> <LI> in Perl and in Perl/Tk</LI> <LI> integrated with Object Caml on Unix platforms</LI> diff --git a/doc/ivy-c-2.html b/doc/ivy-c-2.html index f8221dd..2e03154 100644 --- a/doc/ivy-c-2.html +++ b/doc/ivy-c-2.html @@ -20,11 +20,17 @@ use a supported distribution of Linux or not, you have the following options: <P> <H2><A NAME="ss2.1">2.1 Installing RedHat or Debian packages</A> </H2> +<p>If your system is Linux/Redhat, you have to use the command <em><strong> rpm -i package-name</strong></em>. +<p>If your system is Linux/Debian, you have to use the command <em><strong> dpkg -i package-name</strong></em>. + <P> <P> <H2><A NAME="ss2.2">2.2 Getting and compiling the sources</A> </H2> +<p>If your system is not a Linux one, you have to get and compile the source of the ivy-c library. +In this case, you have to get the source from CENA at http://XXX or from one of the Fairway sites. + <P> <P> diff --git a/doc/ivy-c-3.html b/doc/ivy-c-3.html index 8ff844c..fef73f8 100644 --- a/doc/ivy-c-3.html +++ b/doc/ivy-c-3.html @@ -17,7 +17,7 @@ <H2><A NAME="ss3.1">3.1 Initialization and main loop</A> </H2> -<P>Initializing an Ivy agent with the Ivy C library is a two step process. First of +<P>Initializing an Ivy agent with the Ivy C library is a two-step process. First of all, you should initialize the library by calling function <CODE>IvyInit</CODE>. Once the library is initialized you can create timers and add subscriptions, but your agent is still not connected to any bus. In order to connect, you should call @@ -42,7 +42,7 @@ void IvyInit (const char* agentname, </PRE> </CODE></BLOCKQUOTE> -initializes the library. blahblah +initializes the library. <P> <BLOCKQUOTE><CODE> <PRE> diff --git a/doc/ivy-c-6.html b/doc/ivy-c-6.html index 94b9e6e..c85da04 100644 --- a/doc/ivy-c-6.html +++ b/doc/ivy-c-6.html @@ -12,9 +12,24 @@ Next <A HREF="ivy-c.html#toc6">Contents</A> <HR> <H2><A NAME="s6">6. Conventions for writing applications</A></H2> - -<P>... the environment variable <CODE>IVYBUS</CODE> ..., ... the option <CODE>-b</CODE> ... +<H3>6.1 Default bus</H3> +By default, the bus used is <em><strong>127.255.255.255:2010 </em></strong> ie the application will be connected on the port 2010 of the local machine it runs on.</p> +<P>You can set the bus to be used by setting the environment variable <CODE>IVYBUS</CODE> or by implementing the option <CODE>-b</CODE> in the application.</P> <P> +<H3>6.2 Connexion to ivy</h3> +<p>By convention, the message <em> application-name READY </em> is to be used when initializing the connexion to ivy. +<p>Example: +<p><CODE>IvyInit ("TOTO", "TOTO READY",...)</CODE> +<H3>6.3 Syntax of messages</h3> +The syntax of the messages exchanged is totally free. However, the following convention is recommended: +<menu> +<li>The message syntax is <CODE>Subject Attributes</CODE></li> +<li>A Subject is an object, named in a hierarchical form: <CODE>ObjectClass1:object1.ObjectClass2:object2...</CODE></li> +<li>Attributes are pairs <CODE>(attribute-name, value)</CODE></li> +</menu> +Example: +<p><CODE>AIRCRAFT:LIB720 Moved lat=46.1697 lon=2.0844 vx=-36 vy=-463 afl=330 rate=0 heading=184 ground_speed=465 +mach_speed=0 tendance=0 time=24600 cfl=330</CODE> <HR> Next <A HREF="ivy-c-5.html">Previous</A> |