@marineyachtradar/signalk-plugin 0.2.1 → 0.5.0-beta.2

package/README.md

@@ -1,10 +1,16 @@
 # MaYaRa Server SignalK Plugin
 
-A native SignalK plugin that connects to a remote [mayara-server](https://github.com/MarineYachtRadar/mayara-server) and exposes its radar(s) via SignalK's Radar API.
+A SignalK plugin that connects to [mayara-server](https://github.com/MarineYachtRadar/mayara-server) and exposes marine radars via SignalK's Radar API. Supports automatic container management via [signalk-container](https://github.com/dirkwa/signalk-container).
 
-## Overview
+## Prerequisites
 
-This plugin acts as a thin proxy layer between SignalK and mayara-server. All radar logic (protocol handling, signal processing) runs on mayara-server - this plugin simply forwards control commands and streams radar data.
+- **SignalK Server** with the Radar API — **PR [SignalK/signalk-server#2357](https://github.com/SignalK/signalk-server/pull/2357)**
+- **[signalk-container](https://github.com/dirkwa/signalk-container)** plugin (for managed container mode, optional)
+- **Podman** or **Docker** runtime (for managed container mode)
+
+## How It Works
+
+The plugin acts as a thin proxy between SignalK and mayara-server. All radar protocol handling runs in mayara-server — this plugin registers as a Radar API provider, forwards control commands, and streams binary spoke data.
 
 ```
 ┌─────────────────────────────────────────────────────────────────┐
@@ -18,32 +24,21 @@ This plugin acts as a thin proxy layer between SignalK and mayara-server. All ra
 │         │    radarApi.register()     binaryStreamManager        │
 │         │                    │                     │            │
 │  ┌──────┼────────────────────┼─────────────────────┼─────────┐  │
-│  │      │        SignalK Radar API v2              │         │  │
+│  │      │        SignalK Radar API                 │         │  │
 │  │      │  /signalk/v2/api/vessels/self/radars/*   │         │  │
 │  └──────┼──────────────────────────────────────────┼─────────┘  │
 └─────────┼──────────────────────────────────────────┼────────────┘
           │ HTTP                            WebSocket│
           ▼                                          ▼
 ┌─────────────────────────────────────────────────────────────────┐
-│                        mayara-server                            │
-│         /v2/api/radars/*              /v2/api/radars/*/spokes   │
+│                  mayara-server (container)                       │
+│  /signalk/v2/api/vessels/self/radars/*           .../spokes     │
 └─────────────────────────────────────────────────────────────────┘
 ```
 
-## Requirements
-
-- **SignalK Server** PR 2158 (with Radar API support)
-- **mayara-server** running and accessible on the network
-
 ## Installation
 
-### From npm (recommended)
-
-```bash
-npm install @marineyachtradar/signalk-plugin
-```
-
-### From source
+Install from the **SignalK App Store** or from source:
 
 ```bash
 git clone https://github.com/MarineYachtRadar/mayara-server-signalk-plugin
@@ -57,77 +52,60 @@ npm link @marineyachtradar/signalk-plugin
 
 ## Configuration
 
-Enable the plugin in SignalK Admin UI and configure:
+The plugin provides a custom configuration panel in the SignalK Admin UI.
 
-| Setting | Description | Default |
-|---------|-------------|---------|
-| **Host** | IP address or hostname of mayara-server | `localhost` |
-| **Port** | HTTP port of mayara-server REST API | `6502` |
-| **Use HTTPS/WSS** | Enable secure connections (requires TLS on mayara-server) | `false` |
-| **Discovery Poll Interval** | How often to poll for new/disconnected radars (seconds) | `10` |
-| **Reconnect Interval** | How often to retry when mayara-server is unreachable (seconds) | `5` |
+### Container Mode (default)
 
-## Features
+With **signalk-container** installed, the plugin automatically pulls and manages the `ghcr.io/marineyachtradar/mayara-server` container image using host networking for radar multicast discovery.
 
-- **Multi-radar support**: Automatically discovers and manages all radars connected to mayara-server
-- **Full Radar API**: Implements SignalK's RadarProviderMethods interface
-  - Power control (off/standby/transmit)
-  - Range selection
-  - Gain, sea clutter, and rain clutter adjustment
-  - ARPA target acquisition and tracking
-- **Binary spoke streaming**: Uses SignalK's built-in binaryStreamManager for efficient data delivery
-- **Auto-reconnection**: Handles network disconnections gracefully
-- **Integrated GUI**: Includes the MaYaRa radar display webapp
+- **Image version** — select `latest`, `main`, or a specific release tag
+- **Check** — pulls the selected tag and compares against the running container
+- **Update** — pulls, stops, removes, and recreates the container with the new image
+- **Arguments** (advanced) — optional CLI args like `--brand furuno --interface eth0`
 
-## API Endpoints
+Without arguments, mayara-server auto-discovers all radar brands on all network interfaces.
 
-Once configured, the plugin exposes radars at:
+### External Mode
 
-- `GET /signalk/v2/api/vessels/self/radars` - List all radars
-- `GET /signalk/v2/api/vessels/self/radars/{id}` - Radar info
-- `GET /signalk/v2/api/vessels/self/radars/{id}/capabilities` - Capability manifest
-- `GET /signalk/v2/api/vessels/self/radars/{id}/state` - Current state
-- `PUT /signalk/v2/api/vessels/self/radars/{id}/controls/{control}` - Set control
-- `GET /signalk/v2/api/vessels/self/radars/{id}/targets` - ARPA targets
-- `WS /signalk/v2/api/vessels/self/radars/{id}/stream` - Binary spoke data
+Set **Managed container** to off to connect to a mayara-server instance running elsewhere:
 
-## GUI
+- **Host** — IP address or hostname
+- **Port** — HTTP port (default: 6502)
 
-The radar display is available at:
-```
-http://your-signalk-server:3000/@marineyachtradar/signalk-plugin/
-```
+### Radar Display
 
-## Development
+The webapp redirects to mayara-server's built-in GUI at `http://<host>:6502/gui/`.
 
-After cloning, install dependencies and build the GUI:
+## Features
+
+- **Container management**: Pull, update, and run mayara-server via signalk-container
+- **Multi-radar support**: Auto-discovers all radars connected to mayara-server
+- **Full Radar API**: Power, range, gain, sea/rain clutter, ARPA targets
+- **Binary spoke streaming**: Forwards protobuf spoke data via SignalK's binaryStreamManager
+- **Auto-reconnection**: Handles disconnections with configurable retry
+- **Update detection**: Compare running container image against registry
+
+## Development
 
 ```bash
 npm install
 npm run build
 ```
 
-To use a local `mayara-gui` checkout (sibling directory) instead of npm:
-
-```bash
-npm run build -- --local-gui
-```
+### Scripts
 
-For development linking:
+- `npm run format` — prettier + eslint --fix
+- `npm run lint` — eslint check
+- `npm run build` — compile TypeScript + webpack config panel
+- `npm run test` — run tests (vitest)
+- `npm run build:all` — lint + build + test
 
-```bash
-npm link
-cd ~/.signalk
-npm link @marineyachtradar/signalk-plugin
-```
+## Related Projects
 
-> **Note:** The `public/` directory is gitignored but included in the npm tarball.
-> It's built automatically during `npm publish` via `prepublishOnly`.
+- **[mayara-server](https://github.com/MarineYachtRadar/mayara-server)** — Standalone radar server
+- **[signalk-container](https://github.com/dirkwa/signalk-container)** — Container manager for SignalK
+- **[signalk-server#2357](https://github.com/SignalK/signalk-server/pull/2357)** — Radar API for SignalK server
 
 ## License
 
-Apache-2.0 - See [LICENSE](LICENSE)
-
-## Contributing
-
-See [CONTRIBUTING.md](CONTRIBUTING.md)
+Apache-2.0 — See [LICENSE](LICENSE)

package/package.json

@@ -1,12 +1,16 @@
 {
   "name": "@marineyachtradar/signalk-plugin",
-  "version": "0.2.1",
+  "version": "0.5.0-beta.2",
   "description": "MaYaRa Radar - Connect SignalK to mayara-server",
   "main": "plugin/index.js",
   "scripts": {
-    "build": "node build.js",
-    "prepublishOnly": "node build.js",
-    "test": "echo \"No tests yet\" && exit 0"
+    "format": "prettier --write 'src/**/*.ts' 'test/**/*.ts' && eslint --fix 'src/**/*.ts' 'test/**/*.ts'",
+    "lint": "eslint 'src/**/*.ts' 'test/**/*.ts'",
+    "build": "tsc && node build.js && webpack",
+    "build:config": "webpack",
+    "build:all": "npm run lint && npm run build && npm run test",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "signalk-node-server-plugin",
@@ -14,7 +18,8 @@
     "signalk-category-instruments",
     "radar",
     "marine",
-    "mayara"
+    "mayara",
+    "signalk-plugin-configurator"
   ],
   "signalk": {
     "displayName": "MaYaRa Radar (Server)",
@@ -29,13 +34,44 @@
     "plugin/**/*",
     "public/**/*"
   ],
+  "signalk-plugin-enabled-by-default": true,
   "engines": {
+    "node": ">=20",
     "signalk": ">=2.0.0"
   },
   "dependencies": {
-    "@marineyachtradar/mayara-gui": "^0.6.0",
+    "@sinclair/typebox": "^0.34.0",
     "ws": "^8.14.0"
   },
+  "peerDependencies": {
+    "signalk-container": ">=0.1.0"
+  },
+  "peerDependenciesMeta": {
+    "signalk-container": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/preset-react": "^7.28.5",
+    "@eslint/js": "^9.0.0",
+    "@signalk/server-api": "^2.24.0",
+    "@types/express": "^5.0.0",
+    "@types/node": "^20.0.0",
+    "@types/ws": "^8.5.0",
+    "eslint": "^9.26.0",
+    "eslint-config-prettier": "^10.0.0",
+    "eslint-plugin-prettier": "^5.0.0",
+    "prettier": "^3.0.0",
+    "typescript": "^5.5.0",
+    "typescript-eslint": "^8.0.0",
+    "babel-loader": "^10.1.1",
+    "react": "^19.2.4",
+    "react-dom": "^19.2.4",
+    "vitest": "^3.0.5",
+    "webpack": "^5.105.4",
+    "webpack-cli": "^7.0.2"
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/MarineYachtRadar/mayara-server-signalk-plugin"

package/plugin/config/schema.d.ts

@@ -0,0 +1,13 @@
+import { Static } from '@sinclair/typebox';
+export declare const ConfigSchema: import("@sinclair/typebox").TObject<{
+    managedContainer: import("@sinclair/typebox").TBoolean;
+    mayaraVersion: import("@sinclair/typebox").TString;
+    mayaraArgs: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+    host: import("@sinclair/typebox").TString;
+    port: import("@sinclair/typebox").TNumber;
+    secure: import("@sinclair/typebox").TBoolean;
+    discoveryPollInterval: import("@sinclair/typebox").TNumber;
+    reconnectInterval: import("@sinclair/typebox").TNumber;
+}>;
+export type Config = Static<typeof ConfigSchema>;
+//# sourceMappingURL=schema.d.ts.map

package/plugin/config/schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAQ,MAAM,EAAE,MAAM,mBAAmB,CAAA;AAEhD,eAAO,MAAM,YAAY;;;;;;;;;EA4CvB,CAAA;AAEF,MAAM,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,YAAY,CAAC,CAAA"}

package/plugin/config/schema.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConfigSchema = void 0;
+const typebox_1 = require("@sinclair/typebox");
+exports.ConfigSchema = typebox_1.Type.Object({
+    managedContainer: typebox_1.Type.Boolean({
+        default: true,
+        title: 'Manage mayara-server via signalk-container',
+        description: 'Disable to connect to an external mayara-server instance'
+    }),
+    mayaraVersion: typebox_1.Type.String({
+        default: 'latest',
+        title: 'Container image version'
+    }),
+    mayaraArgs: typebox_1.Type.Array(typebox_1.Type.String(), {
+        default: [],
+        title: 'mayara-server arguments',
+        description: 'e.g. ["--brand", "furuno", "--interface", "eth0"]'
+    }),
+    host: typebox_1.Type.String({
+        default: 'localhost',
+        title: 'mayara-server host',
+        description: 'IP address or hostname (only used when not managing container)'
+    }),
+    port: typebox_1.Type.Number({
+        default: 6502,
+        title: 'mayara-server port',
+        minimum: 1,
+        maximum: 65535
+    }),
+    secure: typebox_1.Type.Boolean({
+        default: false,
+        title: 'Use HTTPS/WSS'
+    }),
+    discoveryPollInterval: typebox_1.Type.Number({
+        default: 10,
+        title: 'Discovery poll interval (seconds)',
+        minimum: 5,
+        maximum: 60
+    }),
+    reconnectInterval: typebox_1.Type.Number({
+        default: 5,
+        title: 'Reconnect interval (seconds)',
+        minimum: 1,
+        maximum: 30
+    })
+});
+//# sourceMappingURL=schema.js.map

package/plugin/config/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/config/schema.ts"],"names":[],"mappings":";;;AAAA,+CAAgD;AAEnC,QAAA,YAAY,GAAG,cAAI,CAAC,MAAM,CAAC;IACtC,gBAAgB,EAAE,cAAI,CAAC,OAAO,CAAC;QAC7B,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,4CAA4C;QACnD,WAAW,EAAE,0DAA0D;KACxE,CAAC;IACF,aAAa,EAAE,cAAI,CAAC,MAAM,CAAC;QACzB,OAAO,EAAE,QAAQ;QACjB,KAAK,EAAE,yBAAyB;KACjC,CAAC;IACF,UAAU,EAAE,cAAI,CAAC,KAAK,CAAC,cAAI,CAAC,MAAM,EAAE,EAAE;QACpC,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,yBAAyB;QAChC,WAAW,EAAE,mDAAmD;KACjE,CAAC;IAEF,IAAI,EAAE,cAAI,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,WAAW;QACpB,KAAK,EAAE,oBAAoB;QAC3B,WAAW,EAAE,gEAAgE;KAC9E,CAAC;IACF,IAAI,EAAE,cAAI,CAAC,MAAM,CAAC;QAChB,OAAO,EAAE,IAAI;QACb,KAAK,EAAE,oBAAoB;QAC3B,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,KAAK;KACf,CAAC;IACF,MAAM,EAAE,cAAI,CAAC,OAAO,CAAC;QACnB,OAAO,EAAE,KAAK;QACd,KAAK,EAAE,eAAe;KACvB,CAAC;IAEF,qBAAqB,EAAE,cAAI,CAAC,MAAM,CAAC;QACjC,OAAO,EAAE,EAAE;QACX,KAAK,EAAE,mCAAmC;QAC1C,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,EAAE;KACZ,CAAC;IACF,iBAAiB,EAAE,cAAI,CAAC,MAAM,CAAC;QAC7B,OAAO,EAAE,CAAC;QACV,KAAK,EAAE,8BAA8B;QACrC,OAAO,EAAE,CAAC;QACV,OAAO,EAAE,EAAE;KACZ,CAAC;CACH,CAAC,CAAA"}

package/plugin/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/plugin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}