AugeLab Studio Manual
English
English
  • 👋Welcome to AugeLab Studio User Manual
  • 📘Introduction
    • AugeLab Studio
    • Key Features
    • Use Cases
    • System Requirements
  • 🚀Getting Started
    • Signing up
    • Installation
    • First Look
    • Simple Tour
    • Your Very First Project
      • Basics
      • Detection
      • Wrapping Up
    • More Local Examples
    • Further Reading
  • đŸ–Ĩī¸AugeLab Studio Interface
    • Detailed Look
    • Scenario Area
    • Menu and Toolbar
    • Managing Projects
    • Installing AI and much more
      • Leverage AI with Module Downloader
  • 🧱Function Blocks
    • Block Structures
    • Sockets
    • Blocks Column
    • Connections
    • All Function Blocks
      • AI Blocks
        • Face Detection
        • Mask Detection
        • Object Detection - Custom
        • Object Detection
        • Pose Estimation
        • Safety Equipment Detection
        • Social Distance Detector
        • Super Resolution
        • Text Detection
        • OCR
      • CNN Blocks
        • Average Pooling 2D
        • Batch Normalization
        • Choose Folder 2D
        • Compile Model
        • Conv. Sep. Layer 2D
        • Conv. Trans. Layer 2D
        • Convolutional Layer 2D
        • Dropout Layer
        • Flatten Layer 2D
        • Fully Connected
        • Global Average Pooling 2D
        • Global Max Pooling 2D
        • Input Layer 2D
        • Loss CCE
        • Max Pooling 2D
        • Metrics Accuracy
        • Model EfficientNet
        • Model MobileNet
        • Model ResNet
        • Model VGG
        • Optimizer Adadelta
        • Optimizer Adagrad
        • Optimizer Adam
        • Optimizer Adamax
        • Optimizer FTRL
        • Optimizer Nadam
        • Optimizer RMSProp
        • Optimizer SGD
        • ReLU Layer
        • Softmax Layer
        • Training Parameters
      • Data/Logic
        • Flow Control
          • Batch Concatenation
          • Batch Processing
          • Debatch
          • Get Batch Size
          • HMI Background
          • Subsystem Enabled
          • Subsystem In
          • Subsystem Loop
          • Subsystem Out
          • Subsystem
        • logic
          • All True
          • And
          • Demux
          • Equals
          • Greater
          • Logic Operations
          • Mux
          • Not
          • Or
          • Set - Reset
          • Smaller
        • Mathmetical Operations
          • Add
          • Counter
          • Divide
          • Math Operations
          • Maximum
          • Minimum
          • Multiply
          • Not Equals
          • Round
          • Square Root
          • Subtract
          • Trigonometry
        • Data Operations
          • Data Memory
          • Data to JSON
          • Data Type Converter
          • Datetime Compare
          • Dictionary Operations
          • Exclude Nones
          • Find Substring
          • Get Element
          • Is None
          • List Operations
          • Parse Data Dictionary
          • Replace None
          • String Merge
          • String Operations
        • Referencing
          • Data Read Global
          • Data Read Local
          • Data Write Global
          • Data Write Local
          • Debug Input
          • Tag From
          • Tag To
        • Signal Operators
          • Delay Step
          • Edge Falling
          • Edge Rising
          • Multi Port Switch
          • OFF Delay
          • ON Delay
      • Image/Transformations
        • Analysis
          • Color Density Percentage
          • Get Dimension
          • Histogram On Curve
          • Histogram On Line
          • Image Color Match
          • Image Memory
          • Image Resolution and Channel Value
          • Maximum Images
          • Mean Value of Image
          • Measure Position Distance
          • Minimum Images
          • Non-zero of Image
          • Std. of Image
          • Structural Similarity
        • Transformation Filters
          • Auto Alignment
          • Auto Contrast
          • Color Quantizer and Clustering
          • Color Space
          • Contrast-Brightness-Gamma
          • Contrast Optimization
          • Deconvolution
          • Denoising
          • Distance Transformation
          • FloodFill
          • Grab Cut Algorithm
        • Color Filters
          • 2D Filter
          • Apply Mask
          • Bilateral Filter
          • Blur
          • Edge Filter
          • HSV Filter
          • Image Adaptive Threshold
          • Image Threshold
          • Invert Image
          • Morphological Transformations
          • Normalize Image
          • RGB Mask
          • RGB Set
          • Sobel Filter
        • Operations
          • Add Images Weighted
          • Add Images
          • Collage Images
          • Divide Images
          • Flip Image
          • Image AutoRotator
          • Image Concatenate
          • Image Resize
          • Image Resizer
          • Merge Channels
          • Multiply Images
          • Polar Transform
          • Rotate Image Angle
          • Slice Image
          • Split Image
          • Subtract Images
      • Detections/Shapes
        • Detectors
          • Barcode Reader
          • Blob Detector
          • Blur Detector
          • Circle Detector
          • Corner Detector
          • Custom CNN Model
          • Data Matrix Reader
          • Detect Reference
          • Feature Detector
          • Find Object - Multiple Image
          • Find Object
          • Find Reference
          • Harris Corner Filter
          • Line Detector
          • Match Shapes
          • Measure Object Distance
          • Shape Detector
        • Draw
          • Draw Detections
          • Draw Line
          • Draw Point
          • Draw Rectangle
          • Draw Result On Image
          • Write Date On Image
          • Write Text On Image
        • Roi Processing
          • Check Area (Polygon)
          • Check Area
          • Get Pixel Mouse
          • Get Pixel
          • Get ROI
          • Image ROI Center
          • Image ROI Polygon
          • Image ROI Select Multi
          • Image ROI Select
          • Image ROI
          • Perspective Transform
          • Rectangles in Rectangle
        • Shape Analysis
          • Approximate Contour
          • Choose Line
          • Contour to Image
          • Fill Contour
          • Find Contour
          • Hull Convex
          • Minimum Circle
          • Minimum Ellipse
          • Minimum Rectangle
          • Minimum Rotated Rectangle
          • Most Similar Shape
          • Point Polygon Test
      • Input/Output
        • Communication
          • Modbus Connect
          • Modbus Read
          • Modbus Write
          • MQTT Publish
          • MQTT Subscribe
          • OPC UA Client
          • OPC UA Read
          • OPC UA Write
          • REST API - Get
          • REST API - Post
          • Send Mail
          • Siemens S7 Connect
          • Siemens S7 Read
          • Siemens S7 Write
        • Data Inputs
          • Date-Time List
          • Date-Time
          • Headless Check
          • Keyboard/Barcode Reader
          • Logic Input
          • Number Input
          • Number Range
          • PWM (Pulse Width Modulation)
          • Rising Edge
          • String Input
          • Text
        • Image Inputs
          • Camera IP (ONVIF)
          • Camera IP
          • Camera USB External
          • Camera USB Vidgear
          • Camera USB
          • Load Image From Path
          • Load Image
          • Make Image
          • Pixel
          • Video
        • Outputs/Exports
          • CSV Export
          • Cycle Timer
          • File/Folder Operations
          • GPU Statistics
          • Image Logger
          • Image Write
          • Led Output
          • Multi Image Write
          • Output
          • Scope
          • Show Image
          • Stop
  • 📡Devices and Communication
    • Camera Usage
    • Communication Protocols
    • Further Reading
  • 🧩Example Projects
    • Demo Projects
    • Circumference Measurement
    • Object Counting
    • Tile Width Measurement
    • Human Detection
    • Object Detection
  • 🔑Key Features
    • Deploy Custom HMI Applications
    • Annotate Data for Object Detection
    • Train Custom AI Models
      • Choosing the Right Database
      • When to Stop Training
    • Create Plugins
      • Components
      • Coding Reference
    • Share Your Solutions with Community
    • Instal Python Packages
  • 📑FAQ
    • Contact Us
    • FAQ
    • Setting up a full project
  • Additional Resources
    • Training Schedule
    • Training Materials
    • AugeLab Experts
  • Appendix
    • Dictionary
    • References
Powered by GitBook
On this page
  • đŸ“Ĩ Inputs
  • 📤 Outputs
  • đŸ•šī¸ Controls
  • 🎨 Features
  • 📝 Usage Instructions
  • 📊 Evaluation
  • 💡 Tips and Tricks
  • đŸ› ī¸ Troubleshooting

Was this helpful?

  1. Function Blocks
  2. All Function Blocks
  3. Input/Output
  4. Communication

MQTT Subscribe

This function block is designed to subscribe to a specified MQTT topic and receive messages. It allows you to integrate MQTT communication within your application seamlessly.

đŸ“Ĩ Inputs

Enable This boolean input enables or disables the MQTT subscription.

📤 Outputs

Data This output provides the latest message received on the subscribed MQTT topic.

New Data A boolean output that indicates whether new data has been received since the last evaluation.

đŸ•šī¸ Controls

MQTT Topic Input A field where the user can specify the topic to which this block wants to subscribe.

Reconnect A toggle or button that allows the user to reconnect to the MQTT broker with updated settings.

🎨 Features

Real-Time Messaging The block continuously listens for messages on the specified MQTT topic and updates outputs in real time.

Dynamic Subscription Management The block can handle changes in subscription parameters, allowing for dynamic adjustments without reconnecting.

Connection Status Logging Information about connection status and received messages is logged, aiding in debugging and monitoring.

📝 Usage Instructions

  1. Enter MQTT Topic: Specify the MQTT topic in the MQTT Topic Input field.

  2. Enable Subscription: Connect a boolean signal to the Enable input to allow or disallow subscription.

  3. Receive Messages: The latest messages will be provided through the Data output, and the New Data output will indicate if new messages have been received since the last evaluation.

  4. Cleanup: When finished, the block will automatically disconnect from the MQTT broker when removed or deactivated.

📊 Evaluation

On each evaluation cycle, this function block checks if data has been received, returning the newest message along with a flag indicating whether it is new.

💡 Tips and Tricks

Testing Connectivity

Ensure that your MQTT broker is accessible from your network before subscribing. If you experience issues, check your broker settings.

Receiving JSON data

If you are receiving JSON formatted messages, consider using a Data Type Converter block afterward to process the incoming string into usable data structures.

Debugging messages

Utilize logging outputs to monitor data received and connection status. This can help troubleshoot connectivity or subscription issues.

đŸ› ī¸ Troubleshooting

Connection Failure

If you receive a connection failure, verify the broker URI, credentials, and that the broker is running. Check your internet connection and firewall settings as well.

No New Data Received

Make sure that there are publications on the topic you are subscribed to. Check other devices or applications to ensure they are emitting messages.

PreviousMQTT PublishNextOPC UA Client

Last updated 8 months ago

Was this helpful?

🧱