API Info

Command Description Rabbit Values Example Notes
color Set the color of all LEDs V1 0 thru 255 http://yourIP/api.php?sn=##:##:##:##:##:##&color=2 (1)
tts Speak a TTS message V2 255 characters http://yourIP/api.php?sn=##:##:##:##:##:##&tts=hello (2)
play Play an MP3 V2 240 character URL http://yourIP/api.php?sn=##:##:##:##:##:##&play=yourIP/avionics.mp3 (3)
stream Stream an MP3 V2 240 character URL http://yourIP/api.php?sn=##:##:##:##:##:##&stream=http://link/to/stream (3)
earleft Move the left ear V2 0 thru 15 http://yourIP/api.php?sn=##:##:##:##:##:##&earleft=7 (4)
earright Move the right ear V2 0 thru 15 http://yourIP/api.php?sn=##:##:##:##:##:##&earright=7 (4)
led1 Set color of led 1 V2 See note 5 http://yourIP/api.php?sn=##:##:##:##:##:##&led1=RED (5)
led2 Set color of led 2 V2 See note 5 http://yourIP/api.php?sn=##:##:##:##:##:##&led2=RED (5)
led3 Set color of led 3 V2 See note 5 http://yourIP/api.php?sn=##:##:##:##:##:##&led3=RED (5)
led4 Set color of led 4 (bottom) V2 See note 5 http://yourIP/api.php?sn=##:##:##:##:##:##&led4=RED (5)
led0 Set color of led 0 (nose) V2 See note 5 http://yourIP/api.php?sn=##:##:##:##:##:##&led0=RED (5)

Please note - normal programming of the rabbit, e.g. tell the time, may interrupt API calls.

The API request you send is always for the next minute and you can only send one request per minute. The exact time it executes will vary based on when your rabbit checks the server.

(1) ##:##:##:##:##:## is the serial number of your rabbit

(2) This service uses Google TTS

(3) Supports 32kbps mp3 m3u streams. The link you provide can either be the url inside the .m3u link or the .m3u link itself. If you get a blinking nose and no audio, try a different stream. Streams with high bit rates may not work. The payload is between the URL you choose and your rabbit; it does not come back to this server for any processing.

(4) Ears can be stacked and moved at the same time. For example http://yourIP/api.php?sn=##:##:##:##:##:##&earleft=7&earright=7. The direction of travel and speed cannot be modified.

(5) Valid colors for V2 are AMBER, BLUE, CYAN, GREEN, MAGENTA, OLDLACE, ORANGE, PINK, PURPLE, RED, TEAL, VIOLET, WARMWHITE, WHITE, YELLOW, OFF. You can also stack them e.g. http://yourIP/api.php?sn=##:##:##:##:##:##/led1=RED&led2=GREEN&led3=BLUE&led4=WHITE
The nose and the bottom LED are reset during normal operation so these may be difficult to see.