@amplication/plugin-broker-mqtt
Advanced tools
Use a MQTT message broker to communicate between services generated with Amplication
This is a plugin for Amplication that adds basic support for MQTT broker.
It saves the developers the mess of boilerplate a new microservice with integration to MQTT broker. Also it adds subscription to the broker and added topics automatically to the app. This is done using the Amplication Message Broker Services and NestJS MQTT.
This plugin allows you to configure the MQTT broker settings. The following values can be provided in the plugin settings to configure the MQTT broker.
[!NOTE] These are optional settings and the plugin will work with default settings if not provided.
mqttBroker: The name of the MQTT broker to be used. ( Optional, Default: emqx, Supported: emqx, mosquitto, hivemq and hivemq-enterprise )
mqttBrokerHost: The host of the MQTT broker. ( Optional, Default: localhost )
mqttClientID: The client ID to connect to the MQTT broker. ( Optional, Default: broker-mqtt-(resourceID) )
mqttPort: The port of the MQTT broker. ( Optional, Default: 1883 )
mqttUsername: The username to connect to the MQTT broker. ( Optional, Default: admin )
mqttPassword: The password to connect to the MQTT broker. ( Optional, Default: admin )
mqttWsPort: The port of the MQTT broker for WebSockets. This is used for the client or dashboard to connect to the broker. ( Optional, Default: 8073 )
mqttWebUiPort: The port of the MQTT broker for the Web UI. This is where dashboard is served. ( Optional, Default: 8080 )
sparkplugConfig: The configuration for the Sparkplug. This is used to configure the Sparkplug.
enabled: Whether to enable the Sparkplug. ( Optional, Default: false )
groupIdentifier: The group identifier for the Sparkplug. ( Optional, Default: amplication-sparkplug-group )
edgeNodeIdentifier: The edge node identifier for the Sparkplug. ( Optional, Default: amplication-sparkplug-edge )
clientIdentifier: The client identifier for the Sparkplug. ( Optional, Default: amplication-sparkplug-client-(resource-id) )
This plugin supports the following MQTT brokers:
EMQX Has builtin dashboard and websockets support.
Mosquitto Doesn't have builtin dashboard hence the webUI port is not used.
buildRunning npm run build will bundle your plugin with Webpack for production.
devRunning npm run dev will watch your plugin's source code and automatically bundle it with every change.
testRunning npm run test will run the tests for your plugin.
FAQs
Use a MQTT message broker to communicate between services generated with Amplication
The npm package @amplication/plugin-broker-mqtt receives a total of 4,314 weekly downloads. As such, @amplication/plugin-broker-mqtt popularity was classified as popular.
We found that @amplication/plugin-broker-mqtt demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.