You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@felix.apache.org by do...@apache.org on 2007/11/02 23:33:15 UTC
svn commit: r591498 - /felix/sandbox/donsez/bunny/src/site/readme.html

Author: donsez
Date: Fri Nov  2 15:33:13 2007
New Revision: 591498

URL: http://svn.apache.org/viewvc?rev=591498&view=rev
Log:
add a documentation

Added:
    felix/sandbox/donsez/bunny/src/site/readme.html   (with props)

Added: felix/sandbox/donsez/bunny/src/site/readme.html
URL: http://svn.apache.org/viewvc/felix/sandbox/donsez/bunny/src/site/readme.html?rev=591498&view=auto
==============================================================================
--- felix/sandbox/donsez/bunny/src/site/readme.html (added)
+++ felix/sandbox/donsez/bunny/src/site/readme.html Fri Nov  2 15:33:13 2007
@@ -0,0 +1,61 @@
+<html>
+<head>
+<title>org.apache.felix.sandbox.bunny</title>
+</head>
+<body>
+<h1>org.apache.felix.sandbox.bunny</h1>
+This bundle wraps the API to manage Nabaztag bunny (http://www.nabaztag.com/).
+
+<h2>Service section</h2>
+The bundle registers a org.apache.felix.sandbox.bunny.model.BunnyServiceModel service
+
+<h2Event Admin section</h2>
+The bundle registers a org.osgi.service.event.EventHandler service to subscribe to events
+<br>The default topic listen by the bundle is org/apache/felix/sandbox/bunny
+<br>The event properties are all optional
+<ul>
+<li>posleft (java.lang.Long): to set the new position of the left ear (0 to 15)
+<li>posright (java.lang.Long):  to set the new position of the left ear  (0 to 15) 
+<li>tts (java.lang.String): to tell the text
+<li>voice (java.lang.String): to set the voice used to tell the text (eg julie22k,claire22s,caroline22k,bruno22k,graham22s,lucy22s,heather22k,ryan22k,aaron22s,laura22s)
+<li>chor (java.lang.String): to play the choregraphy
+</ul>
+
+<h2>Configuration Admin section</h2>
+Configuration properties are all independant
+<ul>
+<li>serialNumber (java.lang.String):  the serial number of the managed bunny
+<li>token (java.lang.String): the token of the managed bunny
+<li>baseUrl (java.lang.String): the base url (of the server or of a proxy) to send requests 
+<li>voice (java.lang.String): the default voice used to tell texts
+<li>eventTopic (java.lang.String): the event topic listen by the bundle 
+</ul>
+
+<h2>Felix Shell Command section</h2>
+<pre>
+bunny help
+bunny config &lt;serial number&gt; &lt;token&gt; : configure the bunny' identifiers
+bunny play &lt;left ear pos&gt; &lt;right ear pos&gt; &lt;text to speech&gt; [&lt;choregraphy&gt;]: speech a text and play a chroregraphy
+bunny voice &lt;voice&gt;: set the default voice (eg julie22k,claire22s,caroline22k,bruno22k,graham22s,lucy22s,heather22k,ryan22k,aaron22s,laura22s)
+bunny baseurl &lt;baseurl&gt;: set the default base url of the Nabaztag server or proxy
+bunny ears : get ears positions
+bunny raw &lt;url encoded params&gt;: send the URL with raw encoded parameters
+bunny sleep : sleep the bunny
+bunny wakeup : wakeup the bunny
+bunny issleeping : get the status of the bunny
+bunny whoiam : get the name of the bunny
+bunny trace &lt;on|off&gt; : set on|off the trace
+</pre>
+
+
+<h2>Read more about Nabaztag API</h2>
+<ul>
+<li> http://api.nabaztag.com/docs/home.html
+<li> http://nabaztag.forumactif.fr/ for French speaking community.
+<li> http://www.nabaztalk.com/forum/ for English speaking community.
+<li> Pieces of documentation in French are also available at http://wikinab.org/
+<li> OpenNab (http://sourceforge.net/projects/opennab/) An open PHP-based proxy framework for the Nabaztag (http://www.nabaztag.com/) electronic pet. 
+</ul>
+
+</body>
+</html>
\ No newline at end of file

Propchange: felix/sandbox/donsez/bunny/src/site/readme.html
------------------------------------------------------------------------------
    svn:eol-style = native