updated license and reamde

README.md

@@ -0,0 +1,37 @@
+saildata-server
+===============
+
+An implementation of a [Signal K](http://signalk.github.io) central server for boats. Intended to run on embedded devices (e.g. Raspberry Pi, Beaglebone or UDOO). The Server acts as a multiplexer/aggregator of the SignalK streams input by one or more Providers. The merged SignalK object is than streamed over a WebSocket stream (using Socket.io 1.0).
+
+
+Get up and running
+------------------
+- Clone the repo (I will publish to NPM at some point, but this is too early a version).
+- Edit `settings.json`
+- Set the `ship` object to your own ship's details.
+- Add one or more providers to the `providers` array. Providers reside in the `providers` directory. Take a look at the `providers/filerunner` directory for an example. *Note: whilst providers are named `provider-<provider-name>`, the containing folder does not have the `provider-` prefix. The folder is loaded a whole, so it should have an index.js file.*
+- run `npm start` in the root of the folder to start the server. Alternatively, you could run the server using forever: `forever -e error.log start index.js`
+
+
+Some notes
+----------
+*This is a very early implementation. Basic architecture is there, and it's stable.. But, it lacks a lot of features I want to implement, and I need to write more consumers. Also, I'm looking to move from Express (which is quick and easy) to something more modern. Possible candidates are Koa (I've been aching to try out generators), Sails.js (although that is very heavy for what we need) or something on top of express using Promises.*
+
+
+License
+-------
+saildata-server: An implementation of a Signal K server for boats.
+Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.

index.js

@@ -1 +1,22 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 module.exports = require('./lib');

lib/config/development.js

@@ -1,3 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 (function() {
 
 	"use strict";

lib/config/index.js

@@ -1,4 +1,25 @@
-(function() {
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
+ (function() {
 
 	"use strict";
 

lib/config/production.js

@@ -1,4 +1,25 @@
-(function() {
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
+ (function() {
 
 	"use strict";
 

lib/config/staging.js

@@ -1,4 +1,25 @@
-(function() {
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
+ (function() {
 
 	"use strict";
 

lib/controllers/config.js

@@ -1,4 +1,25 @@
-(function() {
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
+ (function() {
 
 	"use strict";
 

lib/controllers/wifi.js

@@ -1,3 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 (function() {
 
 	"use strict";

lib/index.js

@@ -1,4 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 (function() {
 
 	var express 	= require('express')

lib/lib/Multiplexer.js

@@ -1,3 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 var colors 			= require("colors");
 var EventEmitter 	= require("events").EventEmitter;
 var _ 				= require("lodash");

lib/lib/Provider.js

@@ -1,3 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 var _ 			= require('lodash')
 ,	colors 		= require('colors')
 ,	uuid 		= require('node-uuid')

lib/providers.js

@@ -1,3 +1,23 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
 (function() {
 
 	var _ 			= require('lodash');

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "saildata-server",
 	"version": "0.1.3",
-	"description": "Central server for boats equipped with a boat controller. Multiplexes any incoming data in the SignalK format, outputs a single SignalK stream over WebSockets.",
+	"description": "An implementation of a [Signal K](http://signalk.github.io) central server for boats.",
 	"main": "index.js",
 	"scripts": {
 		"start": "node ./index"
@@ -18,7 +18,7 @@
 		"nautic"
 	],
 	"author": "Fabian Tollenaar",
-	"license": "MIT",
+	"license": "GPLv3",
 	"devDependencies": {
 		"tape": "^2.12.1"
 	},

providers/__gps/signalk.js

@@ -1,3 +1,24 @@
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 var nmea = require('nmea');
 var _ = require('lodash');
 

providers/_gps

@@ -1,5 +1,26 @@
 #!/usr/bin/env node
 
+/*
+ * 
+ * saildata-server: An implementation of a Signal K server for boats.
+ * Copyright (C) 2014  Fabian Tollenaar <[email protected]>
+
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * 
+ */
+
+
 if(typeof process.send !== 'function') {
 	return process.exit();
 }