Skip to content

Latest commit

 

History

History
144 lines (108 loc) · 3.48 KB

README.md

File metadata and controls

144 lines (108 loc) · 3.48 KB
Raw

Websocket Roon Player

This is a websocket implementation of roon player

Prerequisite

This is running on Node.js and socket.io. Below are the steps to install it.

  • On Windows, install from the above link.
  • On Mac OS, you can use homebrew to install Node.js.
  • On Linux, you can use your distribution's package manager, but make sure it installs a recent Node.js. Otherwise just install from the above link.

Make sure you are running node 5.x or higher.

node -v

For example:

$ node -v
v5.10.1

Installing roon-extension-ws-player

  1. Download the repository.
  1. Install

  • Copy the downloaded zip to the desired folder

  • unzip

  • open terminal/command line and change directory to the folder

    cd [PATH]

  • Install Dependencies

    If you have not installed socket.io, install it using the following command

    npm install socket.io

    then install the repository

    npm install

  • (Optional) To remove the running log Comment console.log lines at

    • node_modules/node-roon-api/lib.js
    • node_modules/node-roon-api/moo.js ( REQUEST)
    • node_modules/node-roon-api/moomsj.js (CONTINUE and COMPLETE)
  1. Running
node .
  1. Enable the extension In Roon, go to Settings -> Extensions and click on the "enable" button next to the roon-extension-http-api extension details.

Running in Browser

Open a browser and go to the following link:

http://localhost:3002/

Port can be changed by changing the PORT variable in apps.js. IP should be changed to where the repository is located

Websocket calls

TO create your own client, the following are the available WS calls

The server (apps.js) emits zone whenever there is a change

io.emit("zones", zones);

For the image, the client sends the image_key to the server

socket.emit('getImage', image_key);

Then the server returns the image

io.emit('image', { image: true, buffer: body.toString('base64') });

The server also listen to client's operational calls:

Change Volume

  var vol = new Object();
  vol.volume = volume;
  vol.outputId = outputId;

  socket.emit('changeVolume', JSON.stringify(vol));

Back Button

  socket.emit('goPrev', zone_id);

Next Button

  socket.emit('goNext', zone_id);

Pause/Play Button

  socket.emit('goPlayPause', zone_id);

Running in Docker

This should work with any Linux system with a recent version of Docker installed, Docker for Windows, or Docker for Mac which both include a Linux VM.

Once you've cloned this source, it's very simple to get a container up and running with the right version of Node.JS and all the dependencies. This will avoid conflicts between multiple versions of Node.JS and make sure you're always testing in a clean environment.

Building

Be sure you're in your source directory, then run

docker build -t wsplayer .

Running

If you're a developer and want to see the output, then run

docker run -p 3002:3002 -it wsplayer

If you want to run it in the background, then run

docker run -d -p 3002:3002 wsplayer

Browse to your Docker's host IP (or http://127.0.0.1:3002 if you're running Docker for Windows or Docker for Mac), and you're connected! Don't forget to authorize the extension on the Roon core as mentioned above!