mqtt-integration

id: SKL-mqtt-MQTTINTEGRATION name: Mqtt Integration description: MQTT (Message Queuing Telemetry Transport) is a lightweight publish/subscribe messaging protocol designed for IoT and low-bandwidth, high-latency networks. It provides a simple and efficient way to co version: 1.0.0 status: active owner: '@cerebra-team' last_updated: '2026-02-22' category: Backend tags:

• api
• backend
• server
• database stack:
• Python
• Node.js
• REST API
• GraphQL difficulty: Intermediate

Mqtt Integration

Skill Profile

(Select at least one profile to enable specific modules)

• DevOps
• Backend
• Frontend
• AI-RAG
• Security Critical

Overview

MQTT (Message Queuing Telemetry Transport) is a lightweight publish/subscribe messaging protocol designed for IoT and low-bandwidth, high-latency networks. It provides a simple and efficient way to communicate between devices and servers with minimal overhead (2-byte header).

Why This Matters

MQTT is the de facto standard for IoT messaging, enabling reliable communication between devices and servers in resource-constrained environments. Understanding MQTT integration patterns is essential for building scalable, secure, and reliable IoT applications.

Core Concepts & Rules

1. Core Principles

• Follow established patterns and conventions
• Maintain consistency across codebase
• Document decisions and trade-offs

2. Implementation Guidelines

• Start with the simplest viable solution
• Iterate based on feedback and requirements
• Test thoroughly before deployment

Inputs / Outputs / Contracts

Skill Composition

• Depends on: None
• Compatible with: None
• Conflicts with: None
• Related Skills: None

Quick Start / Implementation Example

1. Review requirements and constraints
2. Set up development environment
3. Implement core functionality following patterns
4. Write tests for critical paths
5. Run tests and fix issues
6. Document any deviations or decisions

# Example implementation following best practices
def example_function():
    # Your implementation here
    pass

Assumptions

• MQTT broker is properly configured and accessible
• Network connectivity between clients and broker
• TLS certificates are available for secure connections
• Clients have unique identifiers
• Message payloads fit within broker size limits

Compatibility

• MQTT Versions: 3.1, 3.1.1, 5.0
• Python: 3.7+
• Node.js: 12+
• Operating Systems: Linux, Windows, macOS
• Brokers: Mosquitto, EMQX, HiveMQ, VerneMQ

Test Scenario Matrix (QA Strategy)

Technical Guardrails & Security Threat Model

1. Security & Privacy (Threat Model)

• Top Threats: Injection attacks, authentication bypass, data exposure

• Data Handling: Sanitize all user inputs to prevent Injection attacks. Never log raw PII
• Secrets Management: No hardcoded API keys. Use Env Vars/Secrets Manager
• Authorization: Validate user permissions before state changes

2. Performance & Resources

• Execution Efficiency: Consider time complexity for algorithms
• Memory Management: Use streams/pagination for large data
• Resource Cleanup: Close DB connections/file handlers in finally blocks

3. Architecture & Scalability

• Design Pattern: Follow SOLID principles, use Dependency Injection
• Modularity: Decouple logic from UI/Frameworks

4. Observability & Reliability

• Logging Standards: Structured JSON, include trace IDs request_id
• Metrics: Track error_rate, latency, queue_depth
• Error Handling: Standardized error codes, no bare except
• Observability Artifacts:
  • Log Fields: timestamp, level, message, request_id
  • Metrics: request_count, error_count, response_time
  • Dashboards/Alerts: High Error Rate > 5%

Agent Directives & Error Recovery

(ข้อกำหนดสำหรับ AI Agent ในการคิดและแก้ปัญหาเมื่อเกิดข้อผิดพลาด)

• Thinking Process: Analyze root cause before fixing. Do not brute-force.
• Fallback Strategy: Stop after 3 failed test attempts. Output root cause and ask for human intervention/clarification.
• Self-Review: Check against Guardrails & Anti-patterns before finalizing.
• Output Constraints: Output ONLY the modified code block. Do not explain unless asked.

Definition of Done (DoD) Checklist

• Tests passed + coverage met
• Lint/Typecheck passed
• Logging/Metrics/Trace implemented
• Security checks passed
• Documentation/Changelog updated
• Accessibility/Performance requirements met (if frontend)

Anti-patterns

1. Using QoS 2 for everything: Only use QoS 2 for critical commands
2. Ignoring TLS in production: Always use TLS encryption
3. No reconnection logic: Implement proper reconnection
4. Hardcoded credentials: Use environment variables or secrets
5. No error handling: Handle all possible errors
6. Ignoring LWT: Use Last Will and Testament for critical devices
7. Overusing retained messages: They consume broker memory
8. Poor topic design: Design hierarchical topics with wildcards in mind

Reference Links & Examples

• Internal documentation and examples
• Official documentation and best practices
• Community resources and discussions

Versioning & Changelog

• Version: 1.0.0
• Changelog:
  • 2026-02-22: Initial version with complete template structure