Registry / storage / signalk-to-mongodb

signalk-to-mongodb

JSON →
library2.2.3jsnpmunverified

SignalK server plugin for storing vessel and environmental data into a MongoDB database. Version 2.2.3 is the current stable release. Designed for SignalK Node servers, it provides configurable data collection, batch processing, dynamic tagging, and resilient connection handling. Differentiators include easy integration via SignalK App Store, customizable paths, and efficient buffering for real-time monitoring and historical analysis. No regular release cadence documented.

npm install signalk-to-mongodb
INSTALL
IMPORT
SIG · SIGNALK-TO-MONGODB
S
signalk-to-mongodb
storagejavascriptv2.2.3
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

signalk-to-mongodb
No direct import; install via SignalK App Store or npm as a plugin. The plugin is loaded by SignalK server automatically.
const plugin = require('signalk-to-mongodb'); // Plugin is not a module to import directly
This is a SignalK server plugin, not a library. Installation via App Store or manual plugin folder.

Install and configure the SignalK to MongoDB plugin via the App Store or manual setup, with example configuration for data storage.

# Install via SignalK App Store dashboard or manually: # Manual installation: cd ~/.signalk mkdir -p plugins cd plugins git clone https://github.com/LinnJS/signalk-to-mongodb.git signalk-to-mongodb cd signalk-to-mongodb npm install # Restart SignalK server, then configure via Server > Plugin Config > SignalK to MongoDB. # Example config in SignalK settings.json: # { # "plugins": { # "signalk-to-mongodb": { # "enabled": true, # "dbUri": "mongodb://localhost:27017", # "database": "boatdata", # "collection": "sensor_readings", # "batchSize": 100, # "flushSecs": 60, # "maxBuffer": 1000 # } # } # }
Debug
Known issues
gotchaPlugin requires SignalK server; cannot be used standalone.
fix
Ensure SignalK server is installed and running.
affects: >=1.0.0
gotchaMongoDB URI must be accessible from the SignalK server; consider network/firewall issues.
fix
Test connection using mongo shell or similar.
affects: >=1.0.0
deprecatedSome configuration fields might change in future versions; always check plugin settings page.
fix
Refer to plugin documentation or UI for latest fields.
affects: <=2.2.3
Errors
Common errors & fixes
Plugin not appearing in SignalK App Store
App Store not refreshed or plugin not published
fix
Restart SignalK server or manually install via git clone.
MongoError: Authentication failed
Invalid credentials in MongoDB URI
fix
Check dbUri format: mongodb://username:password@host:port/db?authSource=admin
TypeError: Cannot read property 'subscribe' of undefined
Plugin loaded outside SignalK context
fix
Ensure plugin is installed in the correct SignalK plugins directory and server is restarted.
Upgrade
Version history
2.2.3latest on npm
Audit
Dependencies
@signalk/signalk-serverrequiredPlugin runs inside SignalK server and uses its APIs for subscriptions and configuration.
mongodbrequiredUsed to connect and write data to MongoDB.
Agent activity
21 hits · last 30 days
node
18
Resources
signalk-to-mongodb — npm install signalk-to-mongodb · libregistry