Welcome to mqttgateway

mqttgateway is a python wrapper to build consistent gateways to an MQTT network.

What it does:

• it deals with all the boilerplate code to manage an MQTT connection, load configuration and other data files, and create log handlers,
• it encapsulates the interface in a class that needs only 2 methods __init__ and loop,
• it creates an intuitive messaging abstraction layer between the wrapper and the interface,
• it can isolate the syntax and keywords of the MQTT network from the internal ones of the interface.

Who is it for:

Developers of MQTT networks in a domestic environment looking to adopt a definitive syntax for their MQTT messages and to build gateways with their devices that are not MQTT enabled.

Available interfaces

Check the existing fully developped interfaces. Their names usually follows the pattern <interface_name>2mqtt, for example musiccast2mqtt.

This library comes with 2 interfaces:

• dummy: to test the environment and use as a template;
• entry: example used for the tutorial.

Links

• Documentation on readthedocs.
• Source on github.
• Distribution on pypi.

Contents

• 1. Overview
  • 1.1. Objective
  • 1.2. Concepts
  • 1.3. Usage
  • 1.4. Installation
• 2. Installation
  • 2.1. Download
  • 2.2. Configuration
  • 2.3. Launch
  • 2.4. First Run
  • 2.5. The mapping data
  • 2.6. Deploying a gateway
• 3. Concepts
  • 3.1. The message model
  • 3.2. Bridging MQTT and the interface
• 4. Tutorial
  • 4.1. The Need
  • 4.2. The Solution
  • 4.3. Implementation
  • 4.4. The interface
  • 4.5. Wrapping it all up
  • 4.6. Launch
• 5. Configuration
• 6. Project Description
• 7. Package Documentation
  • 7.1. Warning
  • 7.2. Subpackages
  • 7.3. Submodules
  • 7.4. Module contents

Indices and tables

• Index
• Module Index