[Savannah-register-public] [task #8211] Submission of iRobot Create communication library

[Thomas Moulard]

URL:
  <http://savannah.gnu.org/task/?8211>

                 Summary: Submission of iRobot Create communication library
                 Project: Savannah Administration
            Submitted by: thomas_moulard
            Submitted on: Friday 05/30/2008 at 19:09
         Should Start On: Friday 05/30/2008 at 00:00
   Should be Finished on: Monday 06/09/2008 at 00:00
                Category: Project Approval
                Priority: 5 - Normal
                  Status: None
                 Privacy: Public
        Percent Complete: 0%
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
                  Effort: 0.00

    _______________________________________________________

Details:

A new project has been registered at Savannah 
This project account will remain inactive until a site admin approves or
discards the registration.


= Registration Administration =

While this item will be useful to track the registration process, *approving
or discarding the registration must be done using the specific Group
Administration
<https://savannah.gnu.org/siteadmin/groupedit.php?group_id=9842> page*,
accessible only to site administrators, effectively *logged as site
administrators* (superuser):

* Group Administration
<https://savannah.gnu.org/siteadmin/groupedit.php?group_id=9842>


= Registration Details =

* Name: *iRobot Create communication library*
* System Name:  *libirobot-create*
* Type: Official GNU software
* License: GNU General Public License v3 or later

----

==== Description: ====
This library provides easy and safe communication to the iRobot Create robot
by implementing the Open Interface version 2 protocol.

iRobot is a robot manufacturing company (http://www.irobot.com/).
The Open Interfance open specification is available here:
http://www.irobot.com/sp.cfm?pageid=294

This project is written in C++, use Autotools for the building mechanisms and
Doxygen for code documentation.

The goal is providing a standard, free, library to communicate with this
robot. It should also be simple to use as many scientists who are using the
robot are not programming experts. I haven't seen any equivalent project
except a Java library.

* Already advanced project (only the sensor part still have to be
implemented)
* Well documented
* Well tested
* Small light-weight library (about 1800 lines).
* Bundled with a command line tool control software for the robot
(irobot-create-ctl).

Here is a sample about how to use this library:
---8<---
#include <fstream>
#include <irobot-create.hh>

int main (int argc, char** argv)
{
  using namespace iRobot;

  if (argc < 2)
    return 1;
  std::fstream stream (argv[1]);
  Create robot (stream);

  try
  {
    robot.sendDemoCommand (Create::DEMO_COVER);
    // You can add more commands here.
  }
  catch (InvalidArgument& e)
  {
    std::cerr << e.what () << std::endl;
    return 1;
  }
  catch (CommandNotAvailable& e)
  {
    std::cerr << e.what () << std::endl;
    return 2;
  }
}
---8<---


==== Other Software Required: ====
No dependencies (except libstdc++).


==== Other Comments: ====
This library is designed to be portable. My main target is *not* Microsoft
Windows however I'll make this library available for this OS (some goes for
Mac OS X).

I also does not yet provide texinfo documentation. This
is mainly due to the fact that the project is not totally finished (and
therefore the API will still probably change).

Last thing: I am not affiliated by iRobot and this is not an official
library.


==== Tarball URL: ====
http://savannah.gnu.org/submissions_uploads/libirobot-create-0.1.tar.bz2






    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/task/?8211>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/