MQTT client module, to communicate with a MQTT server. The MQTT protocol can be used to retrieve values of sensors on a distant server. See MQTT for more info.
A free broker is available for Usine's users:
broker host = mqtt.brainmodular.com
user = usine
password = usine
Address of the MQTT server.
Port used for the communication with the server.
Client identifier used for the communication.
User name of the client, if needed.
Password of the client, if needed.
Try to connect the client to the server. See auto connect at startup and auto reconnect parameters below.
Try to disconnect the client from the server.
Sends 1 value when the client is connected to the server.
Keep alive ensures that the connection between the broker and client is still open and that the broker and the client are aware of being connected.
Determines the ability for the client to reconnect automatically on connection failure.
Connect the client to the server immediately after the module is loaded.
On connection, a client sets the "clean session" flag, which is sometimes also known as the "clean start" flag. If clean session is set to false, then the connection is treated as durable. This means that when the client disconnects, any subscriptions it has will remain and any subsequent QoS 1 or 2 messages will be stored until it connects again in the future. If clean session is true, then all subscriptions will be removed for the client when it disconnects.
Traces all incoming data in the trace-panel.
Topic to publish, as an ASCII string.
Payload for the topic as an ASCII string, generally JSON.
Quality of Service (QoS) level. It is an agreement between the sender of a message and the receiver of a message that defines the guarantee of delivery for a specific message. See QoS.
There are 3 QoS levels in MQTT:
A retained message is a normal MQTT message with the retained flag set to true. The broker stores the last retained message and the corresponding QoS for that topic. See retain.
Publishes all the topics.
List of all topics to subscribe as a comma-text. ie. "dev/#","sensor/+/temperature".
Clears all the subscriptions outputs.
Sends 1 value when a topic is received.
Topic received as a string.
Payload received as a string, generally JSON.
Payload received as an array of bytes (ASCII chars).
Sends 1 value when any of the topics is received.
All topics received as a string.
All payloads received as a string, generally JSON.
All payloads received as an array of bytes (ASCII chars).
Button. Opens the manual page of the selected object (or of its parent module for a control) in the web browser. If no page exists for this object, an error is traced in the trace panel.
For more details about information/help creation, see create-help-file.
Free multi-line text attached to the module, saved with the patch. It is only meant as an internal note for the patch designer: it is not displayed in the interface.
visible only in god mode, see setup-panel-tab-expert.
Read-only, not saved. Current private numeric ID of the object, used internally to identify it (for example as the target of a bind ID).
Read-only, not saved. Private ID used to store and recall the values of this control in presets.
Button. Generates a new unique ID, original ID and preset ID for the object. Use it if you experience difficulties in Polyphonic mode or if two objects share the same ID. Preset values and binds referring to the old IDs are lost.
Read-only, not saved. Absolute address of the object in the Usine objects tree, built from the workspace root. This is the address to use to reach the object from scripts, the objects panel or remote messages. Only shown for objects that are registered in the objects list. See objects-address.
Read-only, not saved. Address of the object relative to the current patch, valid inside that patch only. See objects-address.
Free user-defined address for the object (empty by default). When set, the object is also registered in the objects tree under this name, so it can be reached independently of its position in the workspace (the value is also reported in the mouse-over and mouse-down chunks). Changing it rebuilds the objects list. Only available on objects that support a user address. See objects-address.
version 7.0.250121
Edit All Pages