L’API OpenKarotz permet de piloter le Lapin via des requêtes HTTP.

Toute les commandes seront du type:
http://<adresse IP du lapin>/cgi-bin/commande?parametre=valeur

Exemples :

http://<adresse IP du lapin>/cgi-bin/clear_cache?id=1d0dcd ... e96ee76007
http://<adresse IP du lapin>/cgi-bin/tts?voice=alice&text=je suis un lapin libre&nocache=0&mute=1

Les informations sont retournées au format JSON, elle contiennent toujours la valeur return. Si return vaut 0 la commande c’est bien passée, sinon il y a eu une erreur.

Exemples :

{"color":"00FF00","pulse_color":"000000","pulse":"0","no_memory":"0,"return":"0"}
{"return":"1","msg:","Unable to find file in cache"}

 

Vous pouvez trouver des exemples d’utilisation de l’API en vous connectant en HTTP sur votre lapin.