This project implements the Volkswagen Infotainment Web Interface as published under https://www.w3.org/Submission/2016/01/.
This software uses git submodules, so please clone recursively via
$ git clone https://github.com/wzr1337/rsiServer.git --recursive
This project uses Gulp and TypeScript which needs to be available globally, so please make them available via
$ npm install gulp typescript -gTo install the server's dependencies, run the following command
$ npm installIf you are developing on Windows or Linux, you might experience issue when using above command, because the lame dependency has to compile per platform.
Linux On some Linux (e.g. Ubuntu 16.04) distros the libasound2 libs are missing, so please install it via
$ sudo apt-get install libasound2-dev
Windows On Windows you will need a visual studio installation to have a working compiler at hand.
To build the server, use
$ gulp buildTo run the server and test it, use
$ http_proxy='' gulp testPlease ensure that proxy settings are set appropriately for your environment.
Test specifications will always follow the +.specform, i.e. source file named myfile.ts => test file named myfile.spec.ts.
To run a watch on the source file and trigger an automatic reload on file changes, use
$ gulp watchTo run the server separately, use the cli
$ node ./bin/cli.js -p 9999 -v 'error'
alternatively you can use
$ npm start
after you gulp build it
| long parameter | short parameter | type | description |
|---|---|---|---|
| --port | -p | number | the port number to listen on |
| --verbosity | -v | string | the winston log level to plot into the console |
The server uses so called plugins to provide service logic and its interfaces. The plugins can be found as rsp.* repositories on https://github.com.
Known and officially supported plugins as of today are:
| service | repositry url |
|---|---|
| media | https://github.com/wzr1337/rsp.media.git |
| medialibrary | https://github.com/wzr1337/rsp.medialibrary.git |
To install a plugin, you need to clone the corresponding repository into the src/plugins folder. Further down the road, there might an installer, so far plugins a handled as git submodules.
To subscribe to the netfux media renderer from within a JavaScript application or the JavaScript console, use the following code snippet
ws = new WebSocket("ws://localhost:3000");
ws.onopen = () => {
ws.onmessage = (data) => {console.log(data)}
ws.send(JSON.stringify({type:"subscribe", event:"/media/renderers/d6ebfd90-d2c1-11e6-9376-df943f51f0d8"}))
}I welcome everyone to contribute to this repo. Let us build awesome software - together. In order to streamline contribution to this repo, some guidelines are described below.
Please refer to CONTRIBUTION.md
Copyright (c) 2017 Dr. Patrick Bartsch
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.