Permalink
Browse files

Added content to the README

  • Loading branch information...
1 parent ca09d45 commit 0860c8d2502b5c3ab5f9faf723e02b7c729ade96 @knorby committed Dec 9, 2012
Showing with 74 additions and 0 deletions.
  1. +74 −0 README.md
View
@@ -0,0 +1,74 @@
+boxeeremotelib: python interface to the boxee remote api
+==========================================================
+
+Python library to use the [boxee remote api](http://developer.boxee.tv/Remote_Control_Interface). The library includes
+functionality to discover servers via boxee's UDP-based discovery as well as an interface to the actual commands. The
+intention of this project is to support a web interface to the remote and any other non-traditional uses.
+
+It is currently tested against a single boxee box and only on linux, so please share any negative results that you
+experience, but it should work more widely.
+
+Scripts
+--------
+
+A couple of scripts are provided, *boxee_discover* and *boxee_command*.
+
+```````````````````````````````````````````
+$ boxee_discover
+192.168.1.104:8800
+```````````````````````````````````````````
+
+All servers on the network should be listed. A bit more functionality can be found with *boxee_command*:
+
+```````````````````````````````````````````
+$ boxee_command back setstring:batman
+$ boxee_command down select
+```````````````````````````````````````````
+
+From the main menu, the previous example should go back to the search screen, type 'batman', and select
+the first result. It should be noted that the server is being auto-selected, but a specific server can be given
+
+````````````````````````````````````````````````````````````
+$ boxee_command --host=192.168.1.104 --port=8800 getvolume
+100
+````````````````````````````````````````````````````````````
+In addition to the normal commands,
+
+```````````````````````````````````````````````````````
+$ boxee_command -l
+back
+backspace
+down
+getpercentage
+getvolume
+left
+mute
+pause
+playnext
+playprev
+right
+seekpercentage
+seekpercentagerelative
+select
+setstring
+setvolume
+stop
+up
+````````````````````````````````````````````````````````
+
+commands can be quickly repeated by adding '_n' on to the end of a command name, where 'n' is the number
+of times to repeat the command. These repeat commands are available from the library as well.
+
+```````````````````````````````````````````````````````
+$ boxee_command backspace_6 setstring:misfits
+```````````````````````````````````````````````````````
+
+Authors
+--------
+
+Library written by Karl Norby <karl.norby@gmail.com>.
+
+Thanks
+-------
+
+* Android [boxeeremote](http://code.google.com/p/boxeeremote/) - helpful guide, particularly for discovery

0 comments on commit 0860c8d

Please sign in to comment.