mqtt-simple-router

Simplify listening to many differents mqtt topics by grouping all functions in a router file, similar to express.js


Keywords
mqtt, router
License
MIT
Install
npm install mqtt-simple-router@1.2.0

Documentation

MQTT simple router

This simple module allows you to centralize both subscribing to MQTT topics and reacting to subsequent messages on that topic in a router-type file. The router uses path-to-regexp in order to provide path recognition and named parameters

The creation of this module was motivated by the annoyance that is having both subscription code and listening code separated, and the nightmare that are chained if / elseif statements. It aims at providing a simple solution to these problems.

Installation

This is a Node.js module available for download on the npm registry

To intall this module, simply run npm install

$ npm install mqtt-simple-router

Dependencies

MQTT requires the path-to-regexp module, available on npm.

Usage - Quick start

The basic idea is simple and heavily inspired by Express.js's router : define routes for your router first, then wrap that router around the MQTT client once connected.

Routes can be added simply with router.auto('your/mqtt/path', your_function(request, next)). The router will automatically subscribe to all relevant topic(s) on router.wrap(client).

Note: router.manual() is back in 1.2! See below for more information

request parameter

The request passed to the callback function is an object containing request.topic (the original topic), request.payload (The MQTT payload, that can be modified by previous functions calling next()), request.params containing named parameters value (see the named parameters section), and request.path (the path corresponding to the latest layer matched by the topic).

next parameter

Much like Express.js's router, next() allows you to chain several layers for a single request. For example, all topics matching /json/# could first be json parsed by a first layer, then different layers /json/topic1 and /json/topic2 could apply more specific processing depending on the received topic. Note that no argument should be passed to the next() function except for errors (see the error handling section below), and that not calling next() will stop the matching process (i.e. the router will stop at the first match, even if there are others below) which might lead to some layers being unaccessible.

var mqtt = require('mqtt');
var mqttRouter = require('mqtt-simple-router');

var client = mqtt.connect('mqtt://localhost');

var router = new mqttRouter();

// the request object returned is an object containing
// .topic (the original topic)
// .payload
// .path and
// .params (containing named parameter values, or undefined)

router.auto('/all/hello', function(request) {
    // automatically subscribe on router.wrap()
    console.log('new message on ' + request.topic + ': ' + request.payload);
});

router.auto('/all/hello', function(request) {
    // this function will never executed, as the previous one does not call next() and will therefore 'block'
})

router.auto('/all/hello/message', function(request, next) {

    console.log('new message on ' + request.topic + ': ' + request.payload);
    request.payload = 'modified';
    next();

});

router.auto('/all/hello/message', function(request, next) {

    console.log('new message on ' + request.topic + ': ' + request.payload);
    // payload will be equal to 'modified'

});

// wrap the router around the client,
// this needs to be done after connection
client.on('connect', () => {
  router.wrap(client);
});

manual() vs auto()

When adding routes and their handles (a.k.a. layers) to the router, two possibles ways are made available: router.manual(path, handle[, alias]) and router.auto(path, handle). Layers registered with router.auto() are immediately added to the stack on router.wrap(). router.manual() allows you to create inactive layers then activate them at a later date. Due to the way MQTT jokers work, this does not mean that the client will not subscribe to layers registered with auto(), as some manual()-registered layers could be made active even if not explicitly subscribed to, causing unexpected behavior.

For example, if one of your layers had '#' for path (the true-for-all MQTT joker), then any manual()-registered layers would be treated exactly as an auto()-registered one, effectively making the call to manual() useless.

Instead, layers are simply stored outside of the stack under an alias. This alias is either user-specified, or equal to the layer's path (default behavior). Later, router.activate(alias) can be called upon to move the said layer into the main stack, making it active.

Usage:

router.manual('/all/hello', function(request) {
  // this will not be executed as long as .activate() has not been called
}, 'manual_layer');

// later in the code
router.activate('manual_layer');
// from now on, the above-defined layer will be used on incoming messages

Named parameters

Named parameters can be used, by preceding them with a semicolon :. Their value can then be accessed in request.params.parameter_name. The module also supports the MQTT jokers, treating '+' as a nameless parameter.

router.auto('/:channel', function(request, next) {
    console.log('new message on channel ' + request.params.channel + ': ' + request.payload);
});

router.auto('/+/:subchannel/#', function(request, next) {
    console.log('new message containing subchannel ' + request.params.subchannel + ': ' + request.payload);
});

Error handling

To counter the default behavior of the Node.js MQTT client -- if an error happens during message processing, the client stops listening altogether -- a basic error handling system has been implemented. If an error happens at any point in any of the layers, the router starts looking for the nearest error-handling layer. If there is none, the error bubbles out of the layer stack and is intercepted by the default error handler.

Default error handling

Already built in. By default, simply logs the error and the layer in which it originally happened, then goes on to process the next request. Can be modified at router instanciation using router.defaultHandler():

router.defaultHandler(function(error, request) {
    // all errors non treated by custom error handlers will end up here
    console.log("An error has happened!");
    // ...
});

Custom error handling

Can be implemented in the same way as regular layers using router.auto(). They will only be called if an error has happened at some point before in the layer stack, otherwise the router simply ignores them. Custom error handlers must have 3 arguments that correspond to the error, the request and the next function (in this order).

In a similar fashion to regular layers, error-handling layer can call on next(error) to pass the error to the next error handler (or to the default handler).

router.auto('/all/error', function(error, request, next) {
    if  (error.name === 'RangeError') {
        console.log('There was a range error :(')
    }
    else {
        next(error);
        // other errors are send to the next handler
    }
})

Authors

License

This project is licensed under the MIT License - see the LICENSE file for details