/ 
Nabaztag-0.01
River stage zero No dependents
/ Nabaztag

NAME

Nabaztag - A module to interface your nabaztag!

VERSION

Version 0.01

ABOUT

Nabaztag.pm complies with nabaztag API V01 from violet company:

http://www.nabaztag.com/vl/FR/nabaztag_api_version01.pdf

DESCRIPTION

This module is designed to allow you to control a nabaztag with perl programming language. See ABOUT section to know which api it fits.

It has been tested with my own nabaztag and seems to work perfectly.

It also provide a simple command line tool to try your nabaztag: nabaztry (see SYNOPSIS). This tool is install in /usr/bin/

It makes great use of LWP::Simple to interact with the rabbit. PROXY issues:

If you're behind a proxy, see LWP::Simple proxy issues to know how to deal with that.

SYNOPSIS

Commandline:

$ nabaztry.pl MAC TOKEN POSLEFT POSRIGHT

Perl code:

   use Nabaztag;

   
   my $nab = Nabaztag->new();
   
   # MANDATORY
   $nab->mac($mac);
   $nab->token($tok);
  
   # See new function to have details about how to get these properties.

   $nab->leftEarPos($left);
   $nab->rightEarPos($right);

   $nab->syncState();

Gory details :

You can access or modify BASE_URL by accessing: $Nabaztag::BASE_URL ;

For application id : $Nabaztag::ID_APP ;

FUNCTIONS

new

Returns a new software nabaztag.

It has following properties:

mac : MAC Adress of nabaztag - equivalent to Serial Number ( SN ). Written at the back
      of your nabaztag !!
token :  TOKEN Given by nabaztag.com to allow interaction with you nabaztag. See
         http://www.nabaztag.com/vl/FR/api_prefs.jsp to obtain yours !!
leftEarPos : position of left ear.
rightEarPos : position of right ear.

leftEarPos

Get/Sets the left ear position of the nabaztag.

Usage: $nab->leftEarPos($newPos);

The new position has to be between 0 (vertical ear) and 16 included

rightEarPos

See leftEarPos. Same but for right.

sendMessageNumber

Given a message number, sends this message to this nabaztag.

To obtain message numbers, go to http://www.nabaztag.com/vl/FR/messages-disco.jsp and choose a message !!

Usage: $nab->sendMessageNumber($num);

syncState

Synchronise the current state of the soft nabaztag with the hardware one. Actually sends the state to the hardware nabaztag.

Usage:

$nab->syncState();

AUTHOR

Jerome Eteve, <jerome@eteve.net>

BUGS

Please report any bugs or feature requests to bug-nabaztag@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Nabaztag. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2005 Jerome Eteve, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.