kahu-signalk 0.0.7 → 0.0.9

package/data/protocol/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 KAHU Earth AS
+
+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.

package/data/protocol/README.md

@@ -0,0 +1,13 @@
+# KAHU Radar Hub protocol
+*A radar crowdsourcing protocol*
+
+Contribute AIS and ARPA targets from your vessel to crowdsourcing for marine safety!
+
+This is the ptotocol specification used by our plugins and clients as well as server code (e.g. [radarhub-opencpn](https://github.com/KAHU-radar/radarhub-opencpn) and [radarhub-signalk](https://github.com/KAHU-radar/radarhub-signalk)) that lets you upload AIS and radar ARPA targets (or any NMEA) to an internet server.
+The communication protocol is based on [Apache Avro](https://avro.apache.org/) and batches track points so that the overhead for each point above timestamp and lat/lon is low, meaning it is designed to be as bandwidth conservative as possible.
+
+Note: This protocol does **not** use the Avro RPC mechanism, as it is not well supported in all languages, and adds extra requirements such as adding run-length framing to each message. Instead, it relies on a simple union of message types.
+
+## Database schema
+
+The protocol includes a client side database schema used to cache tracks in an sqlite3 database. It is provided as a series of migration SQL files, to be applied in alphabetical order.

package/data/protocol/migrations/0001-create-targets.sql

@@ -0,0 +1,24 @@
+create table if not exists target (
+    target_id integer primary key autoincrement,
+    uuid varchar(36) unique
+);
+
+create table if not exists target_position (
+    id integer primary key autoincrement,
+    timestamp datetime default current_timestamp,
+    target_id integer references target(id),
+    target_distance float,
+    target_bearing float,
+    target_bearing_unit text,
+    target_speed float,
+    target_course float,
+    target_course_unit text,
+    target_distance_unit text,
+    target_name text,
+    target_status text,
+    latitude float,
+    longitude float,
+    target_latitude float,
+    target_longitude float,
+    sent integer default false
+);

package/data/protocol/migrations/0002-target-indices.sql

@@ -0,0 +1,3 @@
+CREATE INDEX idx_sent ON target_position(sent);
+CREATE INDEX idx_target_id ON target_position(target_id);
+CREATE INDEX idx_sent_target_id_timestamp ON target_position(sent, target_id, timestamp);

package/data/protocol/proto_avro.json

@@ -0,0 +1,71 @@
+{"name": "kahu.Proto", "type": "record",
+ "fields": [
+   {"name": "Message", "type": [
+     {"name": "kahu.Call", "type": "record",
+      "fields": [
+        {"name": "Call", "type": {
+          "name": "kahu.CallMessage", "type": "record",
+          "fields": [
+            {"name": "id", "type": "int"},
+            {"name": "Call", "type": [
+              {"name": "kahu.LoginMessage", "type": "record",
+               "fields": [{"name": "Login", "type": {
+                 "name": "kahu.Login", "type": "record",
+                 "fields": [
+                   {"name": "apikey", "type": "string"}
+                 ]
+               }}]},
+              {"name": "kahu.SubmitMessage", "type": "record",
+               "fields": [{"name": "Submit", "type": {
+                 "name": "kahu.Submit", "type": "record",
+                 "fields": [
+                   {"name": "uuid", "type": ["null", "string"], "logicalType": "uuid"},
+                   {"name": "route", "type": {
+                     "type": "array", "items": {
+                       "name": "kahu.LineString",
+                       "type": "record",
+                       "fields": [
+                         {"name": "lat", "type": "float"},
+                         {"name": "lon", "type": "float"},
+                         {"name": "timestamp", "type": "float"}
+                       ]
+                     }}},
+                   {"name": "nmea", "type": ["null", "string"]},
+                   {"name": "start", "type": "long", "logicalType": "timestamp-millis"}
+                 ]
+               }}]}
+            ]}
+          ]}}
+      ]},
+     {"name": "kahu.Response", "type": "record",
+      "fields": [
+        {"name": "Response", "type": {
+          "name": "kahu.ResponseMessage", "type": "record",
+          "fields": [
+            {"name": "id", "type": "int"},
+            {"name": "Response", "type": [
+              {"name": "kahu.ErrorResponseMessage", "type": "record",
+               "fields": [{"name": "Error", "type": {
+                 "name": "kahu.ErrorResponse", "type": "record",
+                 "fields": [
+                   {"name": "exception", "type": "string"}
+                 ]
+               }}]},
+              {"name": "kahu.LoginResponseMessage", "type": "record",
+               "fields": [{"name": "Login", "type": {
+                 "name": "kahu.LoginResponse", "type": "record",
+                 "fields": []
+               }}]},
+              {"name": "kahu.SubmitResponseMessage", "type": "record",
+               "fields": [{"name": "Submit", "type": {
+                 "name": "kahu.SubmitResponse", "type": "record",
+                 "fields": [
+                   {"name": "uuid", "type": ["null", "string"], "logicalType": "uuid"}
+                 ]
+               }}]}
+            ]}
+          ]}}
+      ]}
+   ]}
+ ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kahu-signalk",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "Contribute AIS and ARPA targets from your vessel to crowdsourcing for marine safety!",
   "keywords": [
     "signalk-node-server-plugin",

package/plugin/connector.js

@@ -1,18 +1,18 @@
-const fs = require('fs').promises;
-const { delay } = require('./utils');
-const { AvroClient } = require('./avroclient');
-const path = require('path');
+const fs = require("fs").promises;
+const { delay } = require("./utils");
+const { AvroClient } = require("./avroclient");
+const path = require("path");
 
 // Connector acts as a cooperative thread: When created, it starts an
 // async timeout function immediately
 
 process.on("unhandledRejection", (reason, promise) => {
-    console.error("Unhandled Rejection at:", promise);
-    console.error("Reason:", reason.stack);
+  console.error("Unhandled Rejection at:", promise);
+  console.error("Reason:", reason.stack);
 });
 
 class Connector {
-  constructor({status_function, routecache, plugin_dir, config}) {
+  constructor({ status_function, routecache, plugin_dir, config }) {
     this.last_stats = null;
     this.last_status = null;
     this.status_function = status_function;
@@ -28,7 +28,8 @@ class Connector {
       plugin_dir,
       "data",
       "protocol",
-      "proto_avro.json");
+      "proto_avro.json",
+    );
     this.schema = null;
     console.error("Connector created");
     setTimeout(this.main.bind(this), 0);
@@ -45,7 +46,7 @@ class Connector {
     this.last_stats = await this.routecache.connectionStats();
     this.updateStatus();
   }
-  
+
   setStatus(status) {
     this.last_status = status;
     this.updateStatus();
@@ -55,11 +56,13 @@ class Connector {
     const status = [];
     if (this.last_status !== null) status.push(this.last_status);
     if (this.last_stats !== null) {
-      status.push(`${this.last_stats.unsent_tracks} unsent tracks totalling ${this.last_stats.unsent_datapoints} unsent datapoints`);
+      status.push(
+        `${this.last_stats.unsent_tracks} unsent tracks totalling ${this.last_stats.unsent_datapoints} unsent datapoints`,
+      );
     }
     this.status_function?.(status.join(", "));
   }
-  
+
   async read(type) {
     console.error("Connector parsing response");
 
@@ -70,12 +73,16 @@ class Connector {
       throw "Received response with wrong callid";
     }
     const content = response.Response;
-    
-    if (content["kahu.ErrorResponseMessage"] !== undefined) {    
+
+    if (content["kahu.ErrorResponseMessage"] !== undefined) {
       throw content.Error.exception;
-    } else if (   (type !== undefined)
-               && (content[type] === undefined)) {
-      throw "Received response for wrong method: expected " + type + " but got " + Object.keys(content)[0];
+    } else if (type !== undefined && content[type] === undefined) {
+      throw (
+        "Received response for wrong method: expected " +
+        type +
+        " but got " +
+        Object.keys(content)[0]
+      );
     }
     console.error("Connector response parsed");
     return container;
@@ -83,7 +90,7 @@ class Connector {
 
   async login() {
     while (!this.config.api_key) await delay(500);
-    
+
     console.error("Connector logging in");
 
     await this.client.send({
@@ -94,15 +101,15 @@ class Connector {
             Call: {
               "kahu.LoginMessage": {
                 Login: {
-                  apikey: this.config.api_key
-                }
-              }
-            }
-          }
-        }
-      }
+                  apikey: this.config.api_key,
+                },
+              },
+            },
+          },
+        },
+      },
     });
-    
+
     console.error("Send done, gonna parse response\n");
     const response = await this.read("kahu.LoginResponseMessage");
     console.error("Response parsed");
@@ -110,9 +117,9 @@ class Connector {
   }
 
   async sendTracks() {
-    console.error("Connector sending tracks");
     const submit = await this.routecache.retrieve();
     if (submit === null) return;
+    console.error("Connector sending tracks");
     await this.client.send({
       Message: {
         "kahu.Call": {
@@ -120,14 +127,14 @@ class Connector {
             id: ++this.callid,
             Call: {
               "kahu.SubmitMessage": {
-                Submit: submit
-              }
-            }
-          }
-        }
-      }
+                Submit: submit,
+              },
+            },
+          },
+        },
+      },
     });
-    
+
     await this.read("kahu.SubmitResponseMessage");
     await this.routecache.markAsSent(submit);
     this.last_track_sent = new Date();
@@ -137,9 +144,9 @@ class Connector {
 
   async main() {
     try {
-      console.error("Connector running client is null: ", (this.client === null));
+      console.error("Connector running client is null: ", this.client === null);
 
-      this.schema = await fs.readFile(this.schema_file, 'utf8');
+      this.schema = await fs.readFile(this.schema_file, "utf8");
 
       this.client = new AvroClient({
         schema: this.schema,
@@ -148,12 +155,11 @@ class Connector {
         min_reconnect_time: this.config.min_reconnect_time || 100.0,
         max_reconnect_time: this.config.max_reconnect_time || 6000.0,
         connect_function: this.login.bind(this),
-        status_function: this.setStatus.bind(this)
+        status_function: this.setStatus.bind(this),
       });
 
       while (!this.cancelled) {
         try {
-          console.error("Connector connecting...");
           await this.client.ensureConnection();
           if (this.cancelled) break;
           await this.sendTracks();
@@ -170,6 +176,6 @@ class Connector {
       console.error(e.stack);
     }
   }
-};
+}
 
 module.exports = { Connector };

package/plugin/index.js

@@ -130,7 +130,7 @@ module.exports = (app) => {
     },
     stop: async () => {
       await plugin.connector?.destroy?.();
-      await plugin.routecache?.destroy?.();
+      await plugin.cache?.destroy?.();
       console.log("Stopped KAHU radar Hub")
     },
     schema: () => {