egg-emqtt

egg-mqtt

mqtt client based on mqtt for egg framework

Install

$ npm i egg-emqtt --save

Configuration

Change ${app_root}/config/plugin.js to enable mqtt plugin:

exports.emqtt = {
  enable: true,
  package: 'egg-emqtt',
};

Configure mqtt information in ${app_root}/config/config.default.js:

Single Client

config.emqtt = {
  client: {
    host: 'mqtt://xxx.xxx.xxx.xxx',
    password: 'xxxxx',
    username: 'xxxxx',
    clientId: 'xxxxx',
    options: {
      keepalive: 60,
      protocolId: 'MQTT',
      protocolVersion: 4,
      clean: true,
      reconnectPeriod: 1000,
      connectTimeout: 30 * 1000,
      rejectUnauthorized: false,
      ...
    },
    msgMiddleware: [ 'xxxx' ],
  },
}

Multi Clients

config.emqtt = {
  clients: {
    foo: {
      host: 'mqtt://xxx.xxx.xxx.xxx',
      password: 'xxxxx',
      username: 'xxxxx',
      clientId: 'xxxxx',
      options: {
        keepalive: 60,
        protocolId: 'MQTT',
        protocolVersion: 4,
        clean: true,
        reconnectPeriod: 1000,
        connectTimeout: 30 * 1000,
        rejectUnauthorized: false,
        ...
      },
      msgMiddleware: [ 'xxxx' ],
    },
    bar: {
      ...
    },
  }
}

See mqtt API Documentation for all available options.

Usage

In controller, you can use app.emqtt to get the mqtt instance, check mqtt to see how to use.

// app/router.js
 
module.exports = app => {
    const { router } = app;
    router.get('/', app.emqtt.controller.home.index);
 
    // mqtt_client,subscribe topic: a
    app.emqtt.route('a', app.emqtt.controller.home.index);
};
 
// app/mqtt/controller/home.js
 
module.exports = app => {
  return class HomeController extends app.Controller {
    async index() {
      /**
       * ctx.req = {
       *    topic: 'a',
       *    msg: 'xxxxxxxxxxxx',
       * }
       */ 
      // publish
      await this.app.emqtt.publish('topic1', 'msg123456', { qos: 0 });
    }
  };
};
 
// app/mqtt/middleware/msg2json.js
module.exports = () => {
  return async (ctx, next) => {
    try {
        ctx.logger.info(ctx.req.msg);
        ctx.req.message = JSON.parse(ctx.req.msg);
    } catch (err) {
        ctx.logger.error(err);
    }
    await next();
    ctx.logger.info(`Response_Time: ${ctx.starttime ? Date.now() - ctx.starttime : 0}ms Topic：${ctx.req.topic} Msg: ${ctx.req.msg}`);
  };
};
 

Multi Clients

If your Configure with multi clients, you can use app.emqtt.get(instanceName) to get the specific mqtt instance and use it like above.

Questions & Suggestions

Please open an issue here.

License

MIT