Tome's Land of IT

IT Notes from the Powertoe – Tome Tanasovski

HTTP POST with PowerShell to JSON RPC -or- How to Control XBMC via PowerShell

As you may already know, I enjoy making PowerShell do things (see Chumby post).  Recently my wife and I decided it was time to upgrade our ancient LCD panel to a 50″ LED panel.  What started as a simple research project into TV technology has made me once again an expert on audio receivers, speakers, game systems, and most importantly for this post media PC OSes.  Allow me to get to the point: Last night I installed Boxee and said, “How can I control this with PowerShell?”

Fortunately, I found a nice API that lets you do this via HTTP.  Very simple to use, and similar to the method I use to control my Chumby.  I quickly mocked up a few functions and BAM I was in control.  The only problem is that the first subject in the documentation for this API is, “THIS API IS DEPRECATED”.  I eventually found that the new version of XBMC (what Boxee is built off of) has documented the latest API: JSON RPC

What is JSON RPC?

JSON is JavaScript Object Notation, but it has really grown into a method of transfering objects between languages.  It’s very similar to xml in concept, but it’s streamlined to be quick and dirty.  JSON RPC is a method to send commands (methods) via JSON objects to remote computers.  An example of what a JSON command to XBMC looks like is this:

{"jsonrpc": "2.0", "method": "AudioPlayer.Stop", "id": 1}

This tells the JSON RPC server to invoke the AudioPlayer.Stop method.  The id is a number that will be returned by the server for all responses to this invocation.  It’s really a way to keep track of messages if you are sending multiple commands to a JSON RPC server.

So, let’s see the PowerShell code:

$url = "http://localhost:8080/jsonrpc"
$command = '{"jsonrpc": "2.0", "method": "JSONRPC.Version", "id": 1}'

$bytes = [System.Text.Encoding]::ASCII.GetBytes($command)
$web = [System.Net.WebRequest]::Create($url)
$web.Method = "POST"
$web.ContentLength = $bytes.Length
$web.ContentType = "application/x-www-form-urlencoded"
$stream = $web.GetRequestStream()
$stream.Write($bytes,0,$bytes.Length)
$stream.close()

$reader = New-Object System.IO.Streamreader -ArgumentList $web.GetResponse().GetResponseStream()
$reader.ReadToEnd()
$reader.Close()

This above script returns the following message on the latest build of XBMC:

{
   "id" : 1,
   "jsonrpc" : "2.0",
   "result" : {
      "version" : 2
   }
}

Notes:

If you are trying this out on your XBMC:

  1. You must have at least the version 10 Dharma release of XBMC
  2. You must also be sure to enable the web server in your settings
  3. The above code does not use a password for the web site, but you could easily modify it to do so
  4. Boxee users cannot use this code yet – We must wait for a new release and merge of XBMC with Boxee before this will be possible

What’s Next?

Obviously this will be a codeplex project shortly.  While I don’t have that much time to work on it I’d like to at least start getting the overall design of the cmdlets down.  I’d like to see something similar to the chumby cmdlets:

$xbmc = Get-XBMC 192.168.1.111
$xbmc |Set-XBMCVolume 50

Special thanks to Adam for providing me with the C# code to steal mercilessly from.

Advertisements

8 responses to “HTTP POST with PowerShell to JSON RPC -or- How to Control XBMC via PowerShell

  1. Neil June 8, 2011 at 7:53 am

    HI there,

    I have this remote: http://www.veho-uk.com/main/shop_detail.aspx?article=141
    and am trying to get it to work in XBMC under windows. Not tried Linux yet.

    Can you advise how this could work?

  2. alanrenouf August 3, 2011 at 4:56 am

    Awesome stuff, just found this and love PowerShell and XBMC !

  3. justin May 13, 2012 at 7:01 am

    This is very cool !!!
    i am looking for a way to just send a msg to xbmc so that a msg pops up on the screen in xbmc.My xbmc has a user name and password so also need to figure out how to do that.

    If you have time please could you help me out with this script.

  4. vulcanjedi August 17, 2012 at 3:46 pm

    is there a codeplex linky available to provide? I just only recently discover the HTTP APIs but agreed would rather focus on JSON if HTTP is already allegedly deprecated and want to reintroduce myself and learn more with Powershell and having XBMC together would help with some tangible things to do / learn.

  5. sheenaustin January 7, 2013 at 9:39 pm

    I took this a bit further and wrote a script to send any link to XBMC – you can find it here: http://www.sheenaustin.com/2012/12/31/powershell-app-to-send-media-links-to-xbmc/

  6. Pingback: Episode 224 – Boe Prox talks about PoshWSUS and his other projects | PowerScripting Podcast

  7. Pingback: PowerShell – JSON-RPC 2.0 Interaction Connecting SCOM | SCOMfaq.ch

  8. kavond November 11, 2013 at 4:40 pm

    So did you ever build functions or cmdlets for XMBC?

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: