mqtt-connection

mqtt-connection   

npm install mqtt-connection --save

var net = require('net')
var mqttCon = require('mqtt-connection')
var stream = net.createConnection(1883, 'localhost')
var conn = mqttCon(stream)

// conn is your MQTT connection!

var net = require('net')
var mqttCon = require('mqtt-connection')
var server = new net.Server()

server.on('connection', function (stream) {
  var client = mqttCon(stream)

  // client connected
  client.on('connect', function (packet) {
    // acknowledge the connect packet
    client.connack({ returnCode: 0 });
  })

  // client published
  client.on('publish', function (packet) {
    // send a puback with messageId (for QoS > 0)
    client.puback({ messageId: packet.messageId })
  })

  // client pinged
  client.on('pingreq', function () {
    // send a pingresp
    client.pingresp()
  });

  // client subscribed
  client.on('subscribe', function (packet) {
    // send a suback with messageId and granted QoS level
    client.suback({ granted: [packet.qos], messageId: packet.messageId })
  })

  // timeout idle streams after 5 minutes
  stream.setTimeout(1000 * 60 * 5)

  // connection error handling
  client.on('close', function () { client.destroy() })
  client.on('error', function () { client.destroy() })
  client.on('disconnect', function () { client.destroy() })

  // stream timeout
  stream.on('timeout', function () { client.destroy(); })
})

// listen on port 1883
server.listen(1883)

var websocket = require('websocket-stream')
var WebSocketServer = require('ws').Server
var Connection = require('mqtt-connection')
var server = http.createServer()

var wss = new WebSocketServer({server: server})

if (handler) {
  server.on('client', handler)
}

wss.on('connection', function (ws) {
  var stream = websocket(ws)
  var connection = new Connection(stream)

  handle(connection)
})

function handle (conn) {
  // handle the MQTT connection like
  // the net example
}

new mqtt.Connection(options)

respect backpressure. Pipe the `Connection` to another stream to
consume the packets. If this option is passed `true` the object will
emit no packet-related events.

* `willDelayInterval`: representing the Will Delay Interval in seconds `number`,
* `payloadFormatIndicator`: Will Message is UTF-8 Encoded Character Data or not `boolean`,
* `messageExpiryInterval`: value is the lifetime of the Will Message in seconds and is sent as the Publication Expiry Interval when the Server publishes the Will Message `number`,
* `contentType`: describing the content of the Will Message `string`,
* `responseTopic`: String which is used as the Topic Name for a response message `string`,
* `correlationData`: The Correlation Data is used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

• properties: properties MQTT 5.0.

* `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
* `receiveMaximum`: representing the Receive Maximum value `number`,
* `maximumPacketSize`: representing the Maximum Packet Size the Client is willing to accept `number`,
* `topicAliasMaximum`: representing the Topic Alias Maximum value indicates the highest value that the Client will accept as a Topic Alias sent by the Server `number`,
* `requestResponseInformation`: The Client uses this value to request the Server to return Response Information in the CONNACK `boolean`,
* `requestProblemInformation`: The Client uses this value to indicate whether the Reason String or User Properties are sent in the case of failures `boolean`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
* `authenticationMethod`: the name of the authentication method used for extended authentication `string`,
* `authenticationData`: Binary Data containing authentication data `binary`

• clean: the 'clean start' flag. boolean
• username: username for protocol v3.1. string
• password: password for protocol v3.1. string

Connection#connack(options, callback)

• returnCode: the return code of the connack, success is for MQTT < 5.0
• reasonCode: suback Reason Code number MQTT 5.0
• properties: properties MQTT 5.0.

* `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
* `receiveMaximum`: representing the Receive Maximum value `number`,
* `maximumQoS`: maximum qos supported by server `number`,
* `retainAvailable`: declares whether the Server supports retained messages `boolean`,
* `maximumPacketSize`: Maximum Packet Size the Server is willing to accept `number`,
* `assignedClientIdentifier`: Assigned Client Identifier `string`,
* `topicAliasMaximum`: representing the Topic Alias Maximum value indicates the highest value that the Client will accept as a Topic Alias sent by the Server `number`,
* `reasonString`: representing the reason associated with this response `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
* `wildcardSubscriptionAvailable`: this byte declares whether the Server supports Wildcard Subscriptions `boolean`
* `subscriptionIdentifiersAvailable`: declares whether the Server supports Subscription Identifiers `boolean`,
* `sharedSubscriptionAvailable`: declares whether the Server supports Shared Subscriptions `boolean`,
* `serverKeepAlive`: Keep Alive time assigned by the Server `number`,
* `responseInformation`: String which is used as the basis for creating a Response Topic `string`,
* `serverReference`: String which can be used by the Client to identify another Server to use `string`,
* `authenticationMethod`: the name of the authentication method used for extended authentication `string`,
* `authenticationData`: Binary Data containing authentication data `binary`

Connection#publish(options, callback)

• topic: the topic to publish to. string
• payload: the payload to publish, defaults to an empty buffer.

• qos: the quality of service level to publish on. number
• messageId: the message ID of the packet,

• retain: retain flag. boolean
• properties: object

* `payloadFormatIndicator`: Payload is UTF-8 Encoded Character Data or not `boolean`,
* `messageExpiryInterval`: the lifetime of the Application Message in seconds `number`,
* `topicAlias`: value that is used to identify the Topic instead of using the Topic Name `number`,
* `responseTopic`: String which is used as the Topic Name for a response message `string`,
* `correlationData`: used by the sender of the Request Message to identify which request the Response Message is for when it is received `binary`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
* `subscriptionIdentifier`: representing the identifier of the subscription `number`,
* `contentType`: String describing the content of the Application Message `string`

Connection#puback #pubrec #pubcomp #unsuback(options, callback)

• messageId: the ID of the packet
• reasonCode: Reason Code by packet number
• properties: object

* `reasonString`: representing the reason associated with this response `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

Connection#pubrel(options, callback)

• dup: duplicate message flag
• reasonCode: pubrel Reason Code number
• messageId: the ID of the packet
• properties: object

* `reasonString`: representing the reason associated with this response `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

Connection#subscribe(options, callback)

• dup: duplicate message flag
• messageId: the ID of the packet
• properties: object

* `subscriptionIdentifier`:  representing the identifier of the subscription `number`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

• subscriptions: a list of subscriptions of the form

Connection#suback(options, callback)

• granted: a vector of granted QoS levels,

• messageId: the ID of the packet
• reasonCode: suback Reason Code number
• properties: object

* `reasonString`: representing the reason associated with this response `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

Connection#unsubscribe(options, callback)

• messageId: the ID of the packet
• reasonCode: unsubscribe Reason Code MQTT 5.0 number
• dup: duplicate message flag
• properties: object

* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

• unsubscriptions: a list of topics to unsubscribe from,

Connection#pingreq #pingresp #disconnect(options, callback)

Connection#disconnect(options, callback)

• reasonCode: Disconnect Reason Code number
• properties: object

* `sessionExpiryInterval`: representing the Session Expiry Interval in seconds `number`,
* `reasonString`: representing the reason for the disconnect `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`,
* `serverReference`: String which can be used by the Client to identify another Server to use `string`

Connection#auth(options, callback)

• reasonCode: Auth Reason Code number
• properties: object

* `authenticationMethod`: the name of the authentication method used for extended authentication `string`,
* `authenticationData`: Binary Data containing authentication data `binary`,
* `reasonString`: representing the reason for the disconnect `string`,
* `userProperties`: The User Property is allowed to appear multiple times to represent multiple name, value pairs `object`

Event: 'connect'

• version: the protocol version string
• versionNum: the protocol version number
• keepalive: the client's keepalive period
• clientId: the client's ID
• will: an object with the following keys:

Contributing

Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.

Contributors

License