1.0.2 • Published 5 months ago

bajo-mqtt v1.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
5 months ago

bajo-mqtt

Plugin name: bajoMqtt, alias: mqtt

GitHub package.json version NPM Version

Attention: I do NOT accept any pull request at the moment, thanks!

MQTT binding for Bajo. If Bajo Emitter is loaded, events & messages are also handled through Bajo Emitter processing system.

Installation

Goto your <bajo-base-dir> and type:

$ npm install bajo-mqtt

Now open your <bajo-data-dir>/config/.plugins and put bajo-mqtt in it . Order doesn't matter here, but you should put it below bajo-emitter:

...
bajo-emitter
bajo-mqtt
...

Configuration

Open/create <bajo-data-dir>/config/bajoMqtt.json:

KeyTypeRequiredDefaultDescription
connectionsarrayno[]Define one or more connections to your MQTT Broker
  namestringnodefaultConnection name, must be unique among all your connections
  urlstringyesUrl to your MQTT Broker, e.g: mqtt://localhost
  broadcastbooleannofalseIncoming messages are broadcastable by bajoEmitter
  optionsobjectnoConnection options, see github.com/mqttjs/MQTT.js
subscriptionsarrayno[]Define one or more subscriptions within your connections
  namestringnodefaultSubscription name, must be unique among all your subscription
  connectionstringyesConnection name, must be one of defined connections above
  topicstringyesMQTT topic to subscribe into

Example:

{
  "connections": [{
    "name": "local",
    "url": "mqtt://localhost",
    "broadcast": true
  }, {
    "name": "remote",
    "url": "mqtt://remotebroker.domain.com",
    "options": {
      "username": "guest",
      "password": "SuperSecret"
    }
  }],
  "subscriptions": [{
    "name": "sensor",
    "connection": "local",
    "topic": "sensor/data/#"
  }]
}

Hook

  • bajoMqtt:onClose (conn)
  • bajoMqtt:onConnect (conn)
  • bajoMqtt:onDisconnect (conn)
  • bajoMqtt:onEnd (conn)
  • bajoMqtt:onError (conn, error)
  • bajoMqtt:onMessage (conn, topic, message)
  • bajoMqtt:onOffline (conn)
  • bajoMqtt:onReconnect (conn)

License

MIT

1.0.2

5 months ago

1.0.1

5 months ago

0.3.0

1 year ago

0.2.7

1 year ago

0.2.6

1 year ago

0.2.5

1 year ago

0.2.3

1 year ago

0.2.4

1 year ago

0.2.2

1 year ago

0.2.0

2 years ago

0.1.0

2 years ago