iobroker.mqtt

5.2.0 • Public • Published

Logo

ioBroker MQTT

Number of Installations Number of Installations NPM version

Test and Release Translation status Downloads

This adapter uses Sentry libraries to automatically report exceptions and code errors to the developers. For more details and for information how to disable the error reporting see Sentry-Plugin Documentation! Sentry reporting is used starting with js-controller 3.0.

MQ Telemetry Transport for ioBroker (MQTT).

MQTT (formerly Message Queue Telemetry Transport) is a publish-subscribe based "light weight" messaging protocol for use on top of the TCP/IP protocol. It is designed for connections with remote locations where a "small code footprint" is required and/or network bandwidth is limited. The Publish-Subscribe messaging pattern requires a message broker. The broker is responsible for distributing messages to interested clients based on the topic of a message. Historically, the 'MQ' in 'MQTT' came from IBM's MQ message queuing product line.

This adapter uses the MQTT.js library from https://github.com/adamvr/MQTT.js/

Configuration

  • Type - Select "Client" (If you want to receive and send messages to another broker) or "Server" if you want to create own MQTT broker.

Server settings

  • WebSockets - if parallel to TCP Server, the WebSocket MQTT Server should run.
  • Port - Port where the server will run (Default 1883). WebSockets will always run on port+1 (Default 1884)
  • SSL - If TCP and WebSockets should run as secure server.
  • Authentication/Username - If authentication required, you can specify the username. It is suggested to always use SSL with authentication to not send passwords over unsecure connection.
  • Authentication/Password - Password for user.
  • Mask to publish own states - Pattern to filter ioBroker states, which will be sent to clients. You can use wildcards to specify group of messages, e.g ".memRss, mqtt.0.` to get all memory states of all adapters and all states of adapter mqtt.0
  • Publish only on change - New messages will be sent to a client only if the state value changes. Every message sent by the client will be accepted, even if the value does not change.
  • Publish own states on connect - by every client connection the all known states will be sent to a client (defined by the state mask), to tell him which states the ioBroker has.
  • Prefix for all topics - if set, every sent topic will be prepended with this prefix, e.g. if prefix iobroker/ all states will have names like **iobroker**/mqtt/0/connected
  • Trace output for every message - Debug outputs.
  • Send states (ack=true) too - Normally only the states/commands with ack=false will be sent to partner. If this flag is set every state independent of ack will be sent to partner.
  • Use different topic names for set and get - if active, so every state will have two topics: adapter/instance/stateName and adapter/instance/stateName/set. In this case, a topic with /set will be used to send non acknowledged commands (ack: false) and topic without /set to receive state updates (with ack: true). The client will receive sent messages back in this mode.
  • Interval before send topics by connection - Pause between connection and when all topics will be sent to a client (if activated).
  • Send interval - Interval between packets by sending all topics (if activated). Used only by once after the connection establishment.
  • Force clean session - Overwrite the client settings and clear or keep session.
  • Publish messages without "retain" flag - Send messages to other clients without a retain flag (read more in next paragraph)
  • Ignored Topics - You can provide certain topics that will be ignored by the broker. This is useful if you want to reduce some chatty clients. You can use wildcards to specify multiple topics, e.g. test.*.

The ioBroker MQTT-Broker in server mode only simulates the behavior of real MQTT-Broker (like Mosquitto), but it is not the same. Real MQTT-Broker normally does not save the values of the topics and just forwards the message to other subscribed clients.

To force real MQTT-Broker to behave like ioBroker MQTT-Broker, all messages must be sent with "retain" flag. In this case, the values will be stored too.

ioBroker MQTT-Broker always saves the values into the States-DB, so it can be processed by other adapters. Because of that, the messages are always published with a retain flag.

If your client has problems with retained messages, you can force ioBroker MQTT-Broker to send messages without a retain flag with Publish messages without "retain" flag option. In this case, the messages will be stored in States-DB anyway.

If the option Send states (ack=true) too is not activated, so you can clear the value of the topic (state) with ack=true and the update will not be sent to subscribed clients. And when the client connects next time, it will not get the last command again.

The JS-Code should look like this:

await setStateAsync('mqtt.0.valetudo.vale.BasicControlCapability.operation.set', 'cleanStart'); // ack=false
await setStateAsync('mqtt.0.valetudo.vale.BasicControlCapability.operation.set', '', true); // ack=true to clear the command

Client settings

  • URL - name or ip address of the broker/server. Like localhost.
  • Port - Port of the MQTT broker. By default, 1883
  • Secure - If secure (SSL) connection must be used.
  • User - if broker required authentication, define here the username.
  • Password - if the username is not empty, the password must be set. It can be empty.
  • Password confirmation - repeat here the password.
  • Subscribe Patterns - Subscribe by the pattern. See chapter "Examples of using wildcards" to define the pattern. '#' to subscribe for all topics. 'mqtt/0/#,javascript/#' to subscribe for states of mqtt.0 and javascript
  • Publish only on change - Store incoming messages only if payload differs from actual stored.
  • Mask to publish own states - Mask for states, that must be published to broker. '' - to publish all states. 'io.yr.,io.hm-rpc.0.*' to publish states of yr and hm-rpc adapter.
  • Publish all states at start - Publish all states (defined by the state mask) every time by connection establishment to announce own available states and their values.
  • Prefix for topics - The prefix can be defined for own states. Like /var/ioBroker/. Name of topics will be for example published with the name /var/ioBroker/ping/192-168-1-5.
  • Test connection - Press the button to check the connection to broker. Adapter must be enabled before.
  • Send states (ack=true) too - Normally only the states/commands with ack=false will be sent to partner. If this flag is set every state independent of ack will be sent to partner.
  • Use different topic names for set and get - if active, so every state will have two topics: adapter/instance/stateName and adapter/instance/stateName/set. In this case, a topic with /set will be used to send non acknowledged commands (ack: false) and topic without /set to receive state updates (with ack: true).
  • Send state object as mqtt message - The client sends the states as parsed string JSON objects to the broker (example parsed string JSON object: {"val":true,"ack":true,"ts":1584690242021,"q":0,"from":"system.adapter.deconz.0","user":"system.user.admin","lc":1584624242021,"expire":true}); if not the values states.val is sent as a single value (example state.val as single value: true)
  • Persistent Session - When checked, the broker saves the session information of the adapter. This means it tracks which messages have been sent/received by the adapter (only QoS Level 1 and 2) and to which topics the adapter has subscribed. This information survives a disconnect and reconnect of the adapter.

Usage

How to test mqtt client:

  • Set type to Client.
  • Leave port on 1883.
  • Set URL as broker.mqttdashboard.com
  • To get absolutely all topics(messages) set pattern to #.
  • To receive all topics for /4MS set pattern to /4MS/#
  • To receive all topics for /MS and /floorish set pattern to /4MS/#, /floorish/#

Sending messages

You may send / publish messages on topics using sendTo method from your adapter via MQTT adapter, e.g.:

/*
 * @param {string}  MQTT instance     Specify MQTT instance to send message through (may be either server or client)
 * @param {string}  action            Action to use (always 'sendMessage2Client' for sending plain messages)
 * @param {object}  payload         
 * @param {string}  payload.topic     Topic to publish message on
 * @param {string}  payload.message   Message to be published on specified topic
 *
 */
adapter.sendTo('mqtt.0', 'sendMessage2Client', { topic: 'your/topic/here', message: 'your message', retain: true });

Examples of using wildcards

The following examples on the use of wildcards, builds on the example provided in topic strings.

  • Sport
  • Sport/Tennis
  • Sport/Basketball
  • Sport/Swimming
  • Sport/Tennis/Finals
  • Sport/Basketball/Finals
  • Sport/Swimming/Finals

If you want to subscribe to all Tennis topics, you can use the number sign '#', or the plus sign '+'.

  • Sport/Tennis/# (this will receive Sport/Tennis and Sport/Tennis/Finals)
  • Sport/Tennis/+ (this will receive Sport/Tennis/Finals but not Sport/Tennis)

For JMS topics, if you want to subscribe to all Finals topics, you can use the number sign '#', or the plus sign '+'.

  • Sport/#/Finals
  • Sport/+/Finals

For MQTT topics, if you want to subscribe to all Finals topics, you can use the plus sign '+'.

Sport/+/Finals

Binary messages

With version 4.x, there is a possibility to send and receive binary messages. Send works only with js-controller@4.2 or newer.

You can change manually the common.type of existing objects to file and they will be processed as binary states.

Or you can set the options All new topics will be processed as binary* in the instance settings to force all new topics will have automatically common.type="file".

Tests

The broker was tested with the following clients:

Todo

  • Implement resend of QoS 2 messages after a while. Whenever a packet gets lost on the way, the sender is responsible for resending the last message after a reasonable amount of time. This is true when the sender is a MQTT client and also when a MQTT broker sends a message.

  • queue packets with QoS 1/2 for the offline clients with the persistent session. Read here

Changelog

5.2.0 (2024-01-08)

  • (ticaki) fixed: confirm onMessage()
  • (orpheus55) Added the authentication validation to request processing
  • (theimo1221) Added an option to filter certain topics

5.1.0 (2023-10-11)

  • (bluefox) Added security check if the server is available from the internet without protection

5.0.0 (2023-09-18)

  • (klein0r) Added blockly block for custom messages (sendMessage2Client)
  • (klein0r) Added retain flag for sendMessage2Client
  • (klein0r) Removed support for Admin 4 UI (materialize)
  • (bluefox) Minimal supported node.js version is 16

4.1.1 (2023-03-22)

  • (Apollon77) Fixed the regex on subscribing of server clients to only match wanted states
  • (Apollon77) Prepare for future js-controller versions

4.0.7 (2022-06-28)

  • (Apollon77/kleinOr) Removed unneeded dependency

4.0.6 (2022-06-19)

  • (bluefox) Corrected sentry issue

4.0.4 (2022-05-30)

  • (Apollon77) lower log-level for log messages about messages with unknown message IDs to info

4.0.3 (2022-05-17)

  • (bluefox) Corrected publish states on start by client

4.0.2 (2022-05-17)

  • (bluefox) Added possibility to publish own states as a client, additionally to mqtt.x

4.0.1 (2022-05-13)

  • (Apollon77) Fixed Number detection for values

4.0.0 (2022-05-12)

  • (bluefox) BREAKING CHANGE: in client mode only "mqtt.X.*" states will be subscribed
  • (bluefox) BREAKING CHANGE: in server mode by empty "publish" setting no states will be subscribed. Early all states were subscribed
  • (bluefox) Added a new option: All new topics will be processed as binary

3.0.6 (2022-04-25)

  • (Apollon77) Allows using some special characters like # in client passwords
  • (Apollon77) Corrected handing of QoS 2 messages
  • (Apollon77) Implement resend support of pubrec
  • (Apollon77) When resending a package set the dup flag as required by specs
  • (Apollon77) Added more debug for special debug mode

3.0.5 (2022-04-07)

  • (bluefox) BREAKING CHANGE: password is now stored encrypted, and so must be set anew after update!

2.7.4 (2022-03-18)

  • (Apollon77) Updated MQTT library dependency

2.7.3 (2022-03-11)

  • (Apollon77) Further optimization of automatic folder creation

2.7.2 (2022-03-11)

  • (Apollon77) Optimized the automatic folder creation and allow to automatically overwrite these objects when needed

2.7.0 (2022-03-09)

  • (Apollon77) Prevented Client or server to overwrite the own info.connection state
  • (Apollon77) replaced # and + characters by _ when publishing a value because these characters are forbidden when publishing for most brokers

2.6.2 (2022-03-03)

  • (Apollon77) If data types of objects change during an adapter run, adjust datatype of mqtt.X.* objects to "mixed" to prevent issues

2.6.1 (2022-02-25)

  • (Apollon77) Fixed object structure sync for server usage

2.6.0 (2022-02-25)

  • (Apollon77) Updated objects if data type changes also for "client" usage
  • (Apollon77) Updated mqtt library
  • (Apollon77) Created a folder object structure if objects do not exist in the adapter namespace

2.5.0 (2022-02-24)

  • (uwesimon/Apollon77) fixed test connection with MQTTs
  • (uwesimon/Apollon77) ReconnectTimeout is now handled in seconds, so default is 10s instead of 10ms
  • (Apollon77) Corrected info.connection object default values

2.4.1 (2021-11-08)

  • (MichaelDvP) Added wildcard regex for "/#"

2.4.0 (2021-05-09)

  • (Apollon77) only remember the last message per topic for offline clients that subscribed the topics when using persistent sessions
  • (Apollon77) only remember last wills for clients that subscribed the topics
  • (Apollon77) on "disconnect" message do not send last will as defined by specs
  • (Apollon77) set a new messageId when sending remembered messages
  • (Apollon77) Added small delay after subscribe before sending out topic values
  • (Apollon77) optimized for js-controller 3.3
  • (foxriver76) prevented errors in js-controller 3.3 and detect datatype changes for objects

2.3.5 (2021-02-27)

  • (Apollon77) js-controller 2.0 is now required at least
  • (arteck) changed default subscribe to mqtt.0.*

2.3.4 (2021-01-25)

  • (Apollon77) Caught errors when setting states (Sentry IOBROKER-MQTT-1F)

2.3.3 (2021-01-21)

  • (Apollon77) Caught errors when setting states (Sentry IOBROKER-MQTT-1D)

2.3.2 (2021-01-13)

  • (Apollon77) Checked configured server port and reset to 1883 if invalid (Sentry IOBROKER-MQTT-1B)
  • (Apollon77) Caught error when server cannot be started (Sentry IOBROKER-MQTT-1C)

2.3.1 (2020-12-30)

  • (FunCyRanger) Added option to ignore SSL validation errors

2.1.14 (2020-11-30)

  • (Apollon77) Prevented a crash case (Sentry IOBROKER-MQTT-11)

2.1.13 (2020-11-16)

  • (Apollon77) Prevented a crash case (Sentry IOBROKER-MQTT-Q)

2.1.12 (2020-11-08)

  • (Apollon77) Crash cases prevented (Sentry IOBROKER-MQTT-M)

2.1.10 (2020-10-30)

  • (Apollon77) Crash cases prevented (Sentry IOBROKER-MQTT-G)
  • (Apollon77) prevent errors on MQTT connection test

2.1.9 (2020-09-17)

  • (Apollon77) Crash cases prevented (Sentry IOBROKER-MQTT-E, IOBROKER-MQTT-F)

2.1.8 (2020-08-24)

  • (Apollon77) Crash case prevented on unsubscribing (Sentry IOBROKER-MQTT-D)

2.1.7 (2020-08-02)

  • (Apollon77) handled invalid mqtt server settings better (Sentry IOBROKER-MQTT-9)

2.1.6 (2020-08-02)

  • (Apollon77) Try to prevent creation of objects with invalid IDs
  • (Apollon77) checked that state is set before accessing it (Sentry IOBROKER-MQTT-2)
  • (Apollon77) Better handle disconnection cases (Sentry IOBROKER-MQTT-3, IOBROKER-MQTT-6)

2.1.5 (2020-07-26)

  • (Apollon77) try to prevent crashes on not existing state values
  • (Apollon77) Sentry added for crash reporting with js-controller 3.x+

2.1.4 (2020-06-20)

  • (Apollon77) websocket does not have setTimeout method
  • (NorbGH) prevented messageID overflow

2.1.3 (2020- 05-17)

  • (bluefox) Caught some errors

2.1.2 (2020-03-02)

  • (foxriver76) removed usage of getMessage
  • (mbecker) send states as an object in client mode

2.1.1 (2019-07-27)

  • (bluefox) Added an option to overwrite the client "clean session" settings

2.1.0 (2019-05-02)

  • (Zefau) Added an option to send the message using messagebox
  • (Zefau) Fixed error with logging on pubrec

2.0.6 (2019-01-16)

  • (SchumyHao) Added Chinese support

2.0.5 (2019-01-12)

  • (simatec) Support for Compact mode

2.0.4 (2018-12-01)

  • (Apollon77) Subscribe to topics after connect

2.0.3 (2018-08-11)

  • (bluefox) Prefix in the server was corrected

2.0.2 (2018-08-09)

  • (bluefox) Behavior of "set" topics was changed

2.0.1 (2018-07-06)

  • (bluefox) Double prefix by the client was fixed

2.0.0 (2018-03-05)

  • (bluefox) broke node.js 4 support
  • (bluefox) removed mqtt-stream-server
  • (bluefox) partial mqtt5 support

1.5.0 (2018-03-05)

  • (bluefox) The patch for wifi-iot removed
  • (bluefox) the mqtt library updated
  • (bluefox) implement QoS>0

1.4.2 (2018-01-30)

  • (bluefox) Admin3 settings was corrected

1.4.1 (2018-01-13)

  • (bluefox) Converted error is caught
  • (bluefox) Ready for admin3

1.3.3 (2017-10-15)

  • (bluefox) Fixed sending of QOS=2 if server

1.3.2 (2017-02-08)

  • (bluefox) Fixed convert of UTF8 payloads
  • (bluefox) optional fix for a chunking problem

1.3.1 (2017-02-02)

  • (bluefox) Updated mqtt packages
  • (bluefox) added Interval before send topics by connection and send interval settings
  • (bluefox) reorganise configuration dialog

1.3.0 (2017-01-07)

  • (bluefox) Updated mqtt packages
  • (bluefox) configurable client ID

1.2.5 (2016-11-24)

  • (bluefox) Fixed server publishing

1.2.4 (2016-11-13)

  • (bluefox) additional debug output

1.2.1 (2016-11-06)

  • (bluefox) fixed the publish on start

1.2.0 (2016-09-27)

  • (bluefox) implementation of LWT for server
  • (bluefox) updated mqtt package version

1.1.2 (2016-09-13)

  • (bluefox) fixed authentication in server

1.1.1 (2016-09-12)

  • (bluefox) do not parse JSON states, that do not have the attribute val to support other systems

1.1.0 (2016-07-23)

  • (bluefox) added new setting: Use different topic names for a set and get

1.0.4 (2016-07-19)

  • (bluefox) converted values like +58,890 into numbers too

1.0.3 (2016-05-14)

  • (cdjm) changed client protocolID

1.0.2 (2016-04-26)

  • (bluefox) updated mqtt module

1.0.1 (2016-04-25)

  • (bluefox) Fixed translations in admin

1.0.0 (2016-04-22)

  • (bluefox) Fixed error with direct publish in server

0.5.0 (2016-03-15)

  • (bluefox) fixed web sockets
  • (bluefox) fixed SSL

0.4.2 (2016-02-10)

  • (bluefox) created the object info.connection
  • (bluefox) added reconnection tests

0.4.1 (2016-02-04)

  • (bluefox) fixed error with states creation

0.4.0 (2016-01-27)

  • (bluefox) added tests
  • (bluefox) client and server run

0.3.1 (2016-01-14)

  • (bluefox) changed creation of states by client

0.3.0 (2016-01-13)

  • (bluefox) try to fix event emitter

0.2.15 (2015-11-23)

  • (Pmant) fixed publish on subscribing

0.2.14 (2015-11-21)

  • (bluefox) fixed error with wrong variable names

0.2.13 (2015-11-20)

  • (Pmant) fixed error with wrong variable name

0.2.12 (2015-11-14)

  • (Pmant) send last known value on subscription (server)

0.2.11 (2015-10-17)

  • (bluefox) set maximal length of topic name
  • (bluefox) converted true and false to boolean values

0.2.10 (2015-09-16)

  • (bluefox) protected against empty topics

0.2.8 (2015-05-17)

  • (bluefox) do not ty to parse JSON objects

0.2.7 (2015-05-16)

  • (bluefox) fixed test button

0.2.6 (2015-05-16)

  • (bluefox) fixed names if from mqtt adapter

0.2.5 (2015-05-15)

  • (bluefox) subscribe to all states if no mask defined

0.2.4 (2015-05-14)

  • (bluefox) added state clients to server with the list of clients

0.2.3 (2015-05-14)

  • (bluefox) fixed some errors

0.2.2 (2015-05-13)

  • (bluefox) fixed some errors with sendOnStart and fix flag sendAckToo

0.2.0 (2015-05-13)

  • (bluefox) translations and rename config sendNoAck=>sendAckToo
  • (bluefox) lets create server not only on localhost

0.1.8 (2015-05-13)

  • (bluefox) fixed topic names in server mode
  • (bluefox) implemented subscribe
  • (bluefox) update mqtt package

0.1.7 (2015-03-24)

  • (bluefox) created objects if new state received
  • (bluefox) updated mqtt library

0.1.6 (2015-03-04)

  • (bluefox) just update index.html

0.1.5 (2015-01-02)

  • (bluefox) fix error if state deleted

0.1.4 (2015-01-02)

  • (bluefox) support for npm install

0.1.2 (2014-11-28)

  • (bluefox) support for npm install

0.1.1 (2014-11-22)

  • (bluefox) support for new naming concept

0.1.0 (2014-10-23)

  • (bluefox) Updated readme
  • (bluefox) Support of authentication for server and client
  • (bluefox) Support of prefix for own topics

0.0.2 (2014-10-19)

  • (bluefox) support of server (actual no authentication)

License

The MIT License (MIT)

Copyright (c) 2014-2024, bluefox dogafox@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Package Sidebar

Install

npm i iobroker.mqtt

Weekly Downloads

649

Version

5.2.0

License

MIT

Unpacked Size

9.59 MB

Total Files

111

Last publish

Collaborators

  • foxriver76
  • iobluefox
  • bluefox
  • apollon77
  • ldittmar
  • alcalzone