API Nabaztag

Prenez le contrôle total de votre Nabaztag

L’API en Bref

Il s'agit de la possibilité à partir d'une application extérieure de déclencher des événements sur votre Nabaztag (Modification de la vitesse d'affichage, commande des oreilles, commande des leds, envoi d'un message en TTS ou sur un Nabcast) sur un Nabaztag.

Voici la version 2 de l'API, elle suit la version 1.

N'hésitez pas à nous contacter si vous souhaitez que nous implémentions d'autres fonctionnalités (idee@nabaztag.com, Sujet: API).

Une nouvelle version de cette documentation est accessible à l'adresse http://api.nabaztag.com

Comment envoyer un événement ?

Il suffit d'appeler l'url http://api.nabaztag.com/vl/FR/api.jsp avec les paramètres suivants :

sn

Numéro de série du nabaztag qui va recevoir les événements

idmessage

Numéro du message à envoyer. Ce numéro peut être un numéro de message de la bibliothèque ou d'un fichier MP3 perso que vous avez chargé. On trouve cet identifiant lorsque l'on écoute un morceau sous le titre du morceau

posright

Position de l'oreille droite entre 0 et 16 (0=oreille horizontale)

posleft

Position de l'oreille gauche

token

Le token est une suite de chiffres donnée lorsque vous activez le Nabaztag récepteur. Cet identifiant limite les risques de spam puisque pour envoyer un message il faut connaître à la fois le numéro de série et ce chiffre.

tts

Permet d'envoyer le texte donné en paramètre en synthèse vocale.

chor

[INDISPONIBLE] Envoi d'une chorégraphie sur le Nabaztag

chortitle

[INDISPONIBLE] Associe un nom à la chorégraphie

ears=ok

Envoi la position des oreilles

nabcast

[INDISPONIBLE] Permet d'envoyer un message dans un Nabcast

ttlive

Permet de définir la durée de vie du message sur le site (unité de temps utilisée: seconde). Par défaut, le message sera stocké pendant 2 mois.

voice

Permet de choisir la voix utilisée pour la lecture du message

Par exemple : http://api.nabaztag.com/vl/FR/api.jsp?sn=00039D4022DE&token=112231049046144&posleft=0&posright=0&idmessage=10333&idapp=10

Comment envoyer un message en text to speech dans le nabcast qui a l'id 52 avec comme titre monttsdansmonnabcast ?
http://api.nabaztag.com/vl/FR/api.jsp?.....nabcast=52&nabcasttitle=monttsdansmonnabcast&tts=le+nabcast

Comment envoyer le message 10333 dans le Nabcast qui a l'id 52 avec, comme titre du son dans le Nabcast, monmp3dansmonnabcast ?
http://api.nabaztag.com/vl/FR/api.jsp? ....nabcast=52&nabcasttitle=monmp3dansmonnabcast&idmessage=10333

Activer la réception des événements sur un Nabaztag

1. Rendez vous dans la rubrique 'Préférences' de votre compte
2. Cochez la case « Autoriser les événements extérieurs » puis Valider
3. Le « token » s'affiche.
Vous devez l'utiliser pour envoyer des messages depuis votre application.

Info : Si vous désactivez puis réactivez la réception d'événements, un nouveau token vous sera communiqué.

Description du langage de chorégraphie

Une chorégraphie est une suite d'actions permettant de piloter l'affichage des leds et des oreilles.
La chorégraphie repose avant tout sur un tempo, qui est réglable.
Une fois le tempo réglé, les actions s'enchaînent au rythme du tempo. Chaque action s'exécute à un moment précis, qu'on appellera « l'heure » de l'action : cette heure est exprimée en nombre de temps du tempo depuis le début de la chorégraphie.

Par exemple, avec un tempo d'un dixième de seconde, l'action associée à l'heure '10' se produira une seconde après le début de la chorégraphie. L'action associée à l'heure '25' se produira 2.5 secondes après le début de la chorégraphie...

La syntaxe de la chorégraphie est une suite de mots ou de nombres, séparés par des virgules. Les nombres sont toujours entiers, positifs, exprimés en base 10. Les mots sont exclusivement l'un des deux mots clefs : motor, led.

Cette suite commence par la valeur du tempo, puis se poursuit par la succession des actions de moteur et de led.

Chaque action (moteur ou led) commence par l'heure (exprimée en nombre de temps du tempo depuis le début de la chorégraphie), suivi du nom de la commande (motor ou led), et d'un nombre variable d'arguments.
Les actions doivent être listées dans l'ordre chronologiques (l'heure est donc croissante).
Si deux actions ont la même heure, elles seront effectuées simultanément.

1. Commande du tempo

Le tempo est exprimé en Hz. On prendra donc « 10 » pour un tempo d'un dixième de seconde.

2. Commande des oreilles

Il s'agit d'une suite de valeurs séparées par des virgules.
La commande est la suivante :

1. Premier argument : l'heure de l'action
Vaut donc « 0 » si c'est la première commande.

2. Deuxième argument : 'motor', pour bouger une oreille

3. Troisième argument : La commande des oreilles
1 pour commander l'oreille gauche
0 pour commander l'oreille droite

4. Quatrième argument : L'angle de rotation de l'oreille.
Valeur possible de 0 à 180.

5. Cinquième argument : Inutilisé, mettre à 0    

6. Sixième argument : Sens de rotation des oreilles.
1 : haut->derrière->bas->devant->haut...
0 : haut->devant->bas->derrière->haut...

Exemple de commande qui fait tourner l'oreille gauche dans le sens contraire des aiguilles d'une montre avec un angle de 20 degrés, à l'heure « 0 ».
0,motor,1,20,0,0

3. Commande des leds

Il s'agit d'une suite de valeurs séparées par des virgules.

1. Premier argument, l'heure de l'action

(vaut donc « 0 » si c'est la première commande).

2. Deuxième argument, 'led', pour donner une couleur à la led.

3. Troisième argument, C'est pour définir la led que l'on souhaite colorer.

0 : led du bas
1 : led de gauche du lapin
2 : led du milieu
3 : led de droite du lapin
4 : led du haut

4. Quatrième,cinquième,sixième argument, c'est la couleur en RGB.
Valeur de 0 à 255

Exemple de commande qui fait passer la led du milieu en vert, puis après celle de gauche en rouge puis celle du milieu s'éteint.
0,led,2,0,238,0,2,led,1,250,0,0,3,led,2,0,0,0

4. Combinaison de commande des oreilles et des leds

Pour combiner les trois actions, avec le paramètre initial du tempo:
10,0,motor,1,20,0,0, 0,led,2,0,238,0,2,led,1,250,0,0,3,led,2,0,0,0

5. Choisir la voix pour le TTS

Vous pouvez choisir la voix utilisée pour la lecture de vos messages.

les voix françaises
  • julie22k
  • claire22s
  • caroline22k
  • bruno22k
les voix anglaises :
  • graham22s
  • lucy22s
  • heather22k
  • ryan22k
  • aaron22s
  • laura22s
Par défaut nous utiliserons la voix de claire22s pour le français et heather22k pour l'anglais.

6. Envoi d'une URL sur un tag/tag

L'API permet d'envoyer des URLs de fichiers ou de flux MP3 sur un tag/tag.

 

Cette nouveauté vous permet d'intégrer à vos applications la lecture de fichiers mp3, podcasts et webradios; vous pouvez bénéficier ou intégrer dans vos applications les capacités de streaming de votre lapin surdoué.

 

Comment ça marche ?

Si votre lapin est un tag/tag vous pouvez utiliser l'API pour lui envoyer des mp3 afin de lui faire lire des podcasts ou des webradios par exemple.

Il suffit d'appeler ou d'inclure dans votre application l'url http://api.nabaztag.com/vl/FR/api_stream.jsp avec les paramètres suivants :

token : le token est une suite de chiffres donnée lorsque vous activez le Nabaztag récepteur. Cet identifiant limite les risques de spam puisque pour envoyer un message il faut connaître à la fois le numéro de série et ce chiffre.

sn : numéro de série du nabaztag/tag qui va recevoir les URLs

urlList : Adresse URL du fichier mp3 que doit lire le Nabaztag/tag.

Si vous souhaitez jouez plusieurs fichiers mp3 à la suite vous pouvez les séparer par le caractère pipe « | ».

 

Par exemple pour lancer une webradio :

http://api.nabaztag.com/vl/FR/api_stream.jsp?token=1267440739&sn=0013D380FD3C&urlList=http://
213.205.96.91:9915

Si le flux mp3 est disponible alors votre tag/tag se met à le jouer.

 

Pour jouer plusieurs mp3 il suffit de séparer chaque URLs par des pipes « | » :

http://api.nabaztag.com/vl/FR/api_stream.jsp?token=1267440739&sn= 0013D380FD3C&urlList=http://monServer.org/archive/MP3/Creative.mp3|http://
myServer.mp3.net/myFav_mp3.mp3

Rechercher