feltnerm / mopidy.js

JavaScript library for controlling a Mopidy music server over a WebSocket from the browser or from Node.js. This is the foundation of Mopidy web clients.

Mopidy.js

Mopidy.js is a JavaScript library that is installed as a part of Mopidy's HTTP frontend or from npm. The library makes Mopidy's core API available from the browser or a Node.js environment, using JSON-RPC messages over a WebSocket to communicate with Mopidy.

Getting it for browser use

Regular and minified versions of Mopidy.js, ready for use, is installed together with the Mopidy music server. When the HTTP frontend is running, the files are available at:

• http://localhost:6680/mopidy/mopidy.js
• http://localhost:6680/mopidy/mopidy.min.js

You may need to adjust hostname and port for your local setup.

In the Mopidy.js source repo, you can find the files at:

• dist/mopidy.js
• dist/mopidy.min.js

Getting it for Node.js use

If you want to use Mopidy.js from Node.js instead of a browser, you can install Mopidy.js using npm:

npm install mopidy

After npm completes, you can import Mopidy.js using require():

var Mopidy = require("mopidy");

Using the library

See the Mopidy.js documentation.

Building from source

1. Install Node.js and npm. If you're running Ubuntu:

    sudo apt-get install nodejs-legacy npm
   

2. Enter the source directory, and install all dependencies:

    npm install
   

That's it.

You can now run the tests:

npm test

To run tests automatically when you save a file:

npm start

To run tests, concatenate, minify the source, and update the JavaScript files in mopidy/http/data/:

npm run-script build

To run other grunt targets which isn't predefined in package.json and thus isn't available through npm run-script:

PATH=./node_modules/.bin:$PATH grunt foo

Changelog

0.5.0 (2015-01-31)

• Reexport When.js library as Mopidy.when, to make it easily available to users of Mopidy.js. (Fixes: #1)

• Default to wss:// as the WebSocket protocol if the page is hosted on https://. This has no effect if the webSocketUrl setting is specified. (Pull request: #2)

• Upgrade dependencies.

0.4.1 (2014-09-11)

• Update links to point to new independent Mopidy.js GitHub project.

0.4.0 (2014-06-24)

• Add support for method calls with by-name arguments. The old calling convention, "by-position-only", is still the default, but this will change in the future. A warning is printed to the console if you don't explicitly select a calling convention. See the docs for details.

0.3.0 (2014-06-16)

• Upgrade to when.js 3, which brings great performance improvements and better debugging facilities. If you maintain a Mopidy client, you should review the differences between when.js 2 and 3 and the when.js debugging guide.

• All promise rejection values are now of the Error type. This ensures that all JavaScript VMs will show a useful stack trace if a rejected promise's value is used to throw an exception. To allow catch clauses to handle different errors differently, server side errors are of the type Mopidy.ServerError, and connection related errors are of the type Mopidy.ConnectionError.

0.2.0 (2014-01-04)

• Backwards incompatible change for Node.js users: var Mopidy = require('mopidy').Mopidy; must be changed to var Mopidy = require('mopidy');

• Add support for Browserify.

• Upgrade dependencies.

0.1.1 (2013-09-17)

• Upgrade dependencies.

0.1.0 (2013-03-31)

• Initial release as a Node.js module to the npm registry.