@codekilo/signalk-trigger-event v1.0.0

SignalK event trigger plugin

This package is designed to allow other signalk plugins to receive notifications when certain values exceed a threshold.

configuration

The configuration for the plugin has two parts, first define the variables that are required for the expressions and then define the expressions and the events they trigger.

context

To create expressions you first have to define which signalk paths you will use and give them a short name: Each variable has two properties:

path

The signalk path, should include the vessel URN i.e. urn:mrn:imo:mmsi:244770688.navigation.speedOverGround.value The path can not be part of the notifications subtree since that tree is ignored by the plugin.

name

The name to give to this path in the expressions defined below i.e. sog

Trigger

for each trigger the following values are required:

condition

The condition that should trigger the event, uses jexl to evaluate the expression. The full signak tree for the specified vessel is available. The following expression would create an event when the vessel is going faster than 3 m/s : sog > 3

event

The name of the event that should be triggered when the condition is true.

trigger type

When to fire the event, has four available options

• rising edge
  • only sends the event when the condition becomes true
• falling edge
  • only sends the event when the condition becomes false
• both edges
  • sends the event when the condition changes
• for all deltas
  • send the event for all deltas while the conditon is true, including an event on the falling edge

use

After setting this plugin up, other plugins can use the configured events to trigger actions by listening to them.

The following example sets up a simple listener that will write to the plugins debug log

var unsubscribes = [];
module.exports = function(app) {
  var plugin = {};

  plugin.id = 'your-plugin';
  plugin.name = 'your plugin';
  plugin.description = 'A plugin to send notifications when an event occurs';

  plugin.start = function(options, restartPlugin) {
    let _notify = function(event) {
        app.debug(`Event received: ${event.event}, type: ${event.type}`);
    }
    app.on('eventName', _notify);
    unsubscribes.push(() => {
      eventEmitter.removeListener(event, _notify);
    });

    app.setProviderStatus('Running');
  };

   plugin.stop = function() {
    unsubscribes.forEach(f => f());
    app.setProviderStatus('Stopped');
  };
  return plugin;
}

Development

To install this package for development clone it from git and run npm link.

git clone https://github.com/codekilo/signalk-trigger.git
cd signalk-trigger
sudo npm link

Then go to the SignalK configuration directory (probably ~/.signalk) and link the module again:

$ cd .signalk 
$ npm link @codekilo/signalk-trigger-event