Skip to content

integreat-io/integreat-transporter-mqtt

Repository files navigation

MQTT transporter for Integreat

Transporter that lets Integreat access listen to a MQTT queue.

npm Version Maintainability

Getting started

Prerequisits

Requires node v18 and Integreat v1.0.

Installing and using

Install from npm:

npm install integreat-transporter-mqtt

Example of use:

import Integreat from 'integreat'
import mqttTransporter from 'integreat-transporter-mqtt'
import defs from './config.js'

const great = Integreat.create(defs, {
  transporters: { mqtt: mqttTransporter },
})

// ... and then dispatch actions as usual

Example service configuration:

{
  id: 'store',
  transporter: 'mqtt',
  options: {
    transporter: {
      uri: 'mqtts://somemqtt.io',
      key: 'svein',
      secret: 's3cr3t',
      topic: 'mqtt/demo'
    }
  }
}

Running the tests

The tests can be run with npm test.

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.

License

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