using 'set' in the remote API

shaunevans

Hi guys .. 

Big props for a fantastic program!  I'm investigating using the remote API for my own purposes -- basically trying to use Bome's Midi Translator to convert Ableton Midi messages into strings for the remote API (possibly through a batch file with a bunch of parameters).

I've got some of the basics figured out like '/api/controller/live/next' but have been trying to figure out how to use '/api/controller/live/set' or 'api/service/set'.  They seem to want a query string (ie. something like '/api/controller/live/set?data=x' where 'x' is the number of the slide/song that you're trying to set) but I can't seem to get the syntax right.

Can anyone point me in the right direction on how to use this part of the API?

I'll happily share my hack and slash MIDI control of OpenLP if/once I get it up and running.

Thanks!

Shaun

tgc

Hi Shaun,

I assume you are using the development version of OpenLP?

If that is the case, take a look at http://bazaar.launchpad.net/_openlp-core/openlp/trunk/view/head:/openlp/plugins/remotes/lib/httprouter.py where the documentation for each call is at the top of the file.

shaunevans

Thanks, Tgc!

I was just digging through the Jquery files, so I didn't see the descriptions.  Appreciate the link.  Will dig further!

Shaun

shaunevans

Hi TGC et al ..

Unfortunately my minimal python/js skill have me a bit stumped.  I'm trying to figure out how to properly lay out the url request to set, for example a slide number.  I've tried something like:

http://[192.168.1.102:4316]/api/controller/live/set?data={request:{id:5}}

as it seems like it is looking for a query string and then the json data.  I've also tried URLencoding the Json request but haven't had any luck.

Does anyone know how to properly structure the 'set' urls?

Thanks!

Shaun

tgc

Hi Shaun

You have to url-encode the json, so {"request": {"id": 5}} becomes:

%7B%22request%22%3A%20%7B%22id%22%3A%205%7D%7D

shaunevans

Thanks again, TGC! .. 

So for anyone who's curious about the same you can jump to a slide # or song # with the following url:

http://[your-remote-url]:[port]/api/controller/live/set?data=[request string]

where the request string is a urlencoded json string like : {"request": {"id": 8}}

which, as TGC said above would be urlencoded to : %7B%22request%22%3A%20%7B%22id%22%3A%208%7D%7D

I'm going to set up a php script to connect Ableton > Bome's Midi Translator > PHP (CLI on Windows) > OpenLP so I can run the lot on one laptop.  The 'easy' option would be to just have a 2nd computer running Bome's and OpenLP only so I could use the Midi to Keystroke functionality of Bome's but I'm a glutton for punishment ;).

Will update once I have a working script in place in case its useful for anyone else.  Thanks again for your help, TGC!

Shaun

raoul

Why not use Python instead of PHP? It's more suited to the task, and it's a lot more powerful than PHP.

shaunevans

Just down to my lack of Python knowledge .. PHP no prob ;).  

I've broken down and resorted to a 2nd lappy for the moment, but looking forward to running it all on one system when I have the time.

Thanks

Shaun

raoul

Shaun, that was my excuse for a long time. Once I started, I realised it was a really terrible excuse ;-)

fiveofsix

Hi, @shaunevans, I know this is an old thread, but perhaps you are interested. I posted a solution for controling OpenLP with MIDI signals. Have a look at it https://forums.openlp.org/discussion/5337/control-openlp-with-midi-signals