Skip to content

mqtt_client

Jump to bottom
pierre drezet edited this page Aug 20, 2025 · 1 revision

The MQTT Client function block allows a connection to an MQTT broker, enabling the client to send and receive messages using the MQTT protocol. The client can be configured with various parameters, including the broker URL, port, client ID, username, and password. It also supports secure connections with TLS, providing the ability to specify certificates and keys for secure communication. The function block provides events for connecting and disconnecting from the broker and can handle errors during these operations.

name type default min. max. description
host String - - - URL to MQTT broker.
port Integer 0 0 65535 MQTT broker port.
clientId String - - - MQTT client ID.
username String - - - Username for authentication.
password String - - - Password for authentication.
tls Boolean 0 - - Enable TLS for secure connection.
client cert String - - - Client TLS certificate (PEM format).
client key String - - - Client TLS key (base64).
server cert String - - - Server root authority certificate.
In Ev. Description
connect Input Event. Triggers the client to connect to the MQTT server.
disconnect Input Event. Triggers the client to disconnect from the MQTT server.
Data In Description
host Hostname or IP of the MQTT broker.
port Port number to connect to the MQTT broker.
tls Boolean value to enable or disable TLS.
clientid MQTT client identifier.
username Username for MQTT authentication.
password Password for MQTT authentication.
Data Out Description
err msg Error message output in case of connection failure.
Out Ev. Description
finishconnect Event triggered when the connection is successfully established.
err_connect Event triggered when an error occurs during connection.
finishdisconnect Event triggered when the client disconnects from the MQTT server.
State Machine None
Toolbox Core Version v1.0.
Licence Type MPL2.0 Component Supplier inx ltd.
Minimum DCC A0000 Profiles All.

copyright inx limited, UK, 2025 - join the inxware community @appland

Core Components

Events & Triggers

State Management

  • STATE - Represents a State in Lucid
  • state_condition - Event driven state condition --> transition and actions
  • state_debug - To debug state machines this function block is required.
  • state_manager - Each state machine is defined by a State Manager

Array & Data Structures

Buffers & Queues

Primitive Data Constants

Data Converters

Boolean Logic

Mathematics

Alebraic Evaluation

Mathematical Operators

Inequalities

Trigonometry

Other Functions

Data Selection

  • indexed_mux_int - Indexed Mux Int
  • indexed_mux_str - Indexed Mux String
  • map_int - Map Int
  • mux_1b - mux_1b
  • mux_1i - mux_1i
  • mux_1r - mux_1r
  • mux_1s - mux_1s
  • mux_2b - MultiplexTwo Input Bool
  • mux_2i - MultiplexTwo Input Int
  • mux_2r - MultiplexTwo Input Real
  • mux_2s - MultiplexTwo Input String
  • mux_3b - MultiplexThree Input Bool
  • mux_3i - MultiplexThree Input Int
  • mux_3r - MultiplexThree Input Real
  • mux_3s - MultiplexThree Input String
  • mux_4b - MultiplexFour Input Bool
  • mux_4i - MultiplexFour Input Int
  • mux_4r - MultiplexFour Input Real
  • mux_4s - MultiplexFour Input String
  • mux_8b - 8-Input Indexed Boolean Multiplexer Function Block
  • mux_8i - 8-Input Indexed Integer Multiplexer Function Block
  • mux_8r - 8-Input Real Number Multiplexer Function Block
  • mux_8s - Number Multiplexer Function Block
  • num_mux - Numeric Multiplexer Function Block

Data Processing & Parsers

Database & Storage

Demultiplexers

String Functions

File Operations

Basic IO Components

GPIO & Hardware I/O

Graphics and UI Components

GUI & User Interface

User Input

  • keypress - Reads key presses & control keys

Unity & Web Integration

  • inx-unity - Provides media and animation widget interface
  • unity2 - Unity 3D
  • webkit - JavaScript/WebKit Interface (Obsolete)

Language & Localization

Media Components

Audio & Media

Digital TV & Media Control

Communications Components

TCPIP Network & Communication

Wireless & LPWAN Networks

Fieldbus Comms

Digital Signal Processing

  • ADC Polled Analogue to Digital converter.
  • ADC_continuous Advanced ADC supporting clocked ISR modes and advanced signal averaging.
  • FFT8 Fast Fourier Transform of 8 bit binary input data
  • FIR8 Finite Impulse Response filter for 8 bit binary data.
  • IIR8 Infinite Impulse Response filter for 8 bit binary data.
  • [calibrate](ADC calibrate) - Calibrates the ADCs

Control Systems Components

PID Controllers

Machine Learning & Machine Vision

  • mv_camera - Provides access to camera input data image streams
  • mv_idsplay - Renders camera image streams.
  • mv_resize - Resizes an image using given interpolation method
  • mv_crop - Crops and image width and height at a give offset
  • mv_apriltag_reader Plain Old Prgramming AprilTag Reader
  • ml_tflite_inference Machine learning model inference.
  • ml_osvm Online iterative machine learning (training& inference).

Platform Components

System Utilities

  • reboot - Reboot the device
  • rtc - RealTimeClock - provdes date/time from RTC device or OS.
  • rtinfo - RuntimeInfo (e.g. MAC/IP address, memory,... )
  • scheduler - Weekly Scheduler
  • system_exec - Executes linux shell commands
  • rng - Random Number Generator (may use hardware RNG)

Time Components

Application Management

Over the Air Update (OTA)

  • ota - OTA Function Block for updating firmware
  • ota_data_parser - Assembles OTA data files from Devman.

Non-functional Components

Some function blocks that can be used Lucid app are for visual/organisation purposes only and do not translate into any executable ert-components.

Sub System Input/Output Ports

-Note this file is autogenerated from ert-config help files and may not currently be complete or properly categorised!

Clone this wiki locally