RIAPS MQTT Device Interface

Overview

The library provides a device component implementation of MQTT for the RIAPS platform. The intended way to use the library is to provide:

1. A device configuration YAML file e.g., cfg/mqtt.yaml
2. Specification of the device in the application's (dot)riaps file
3. A python class file implementing the MQTT device component specified in the (dot)riaps file. An example of an application using this library is found in the example folder.

Dependencies

• MQTT Server (e.g., FlashMQ) These are required on the RIAPS ctrl node.

  Note: This is included by default in the development VM image

Optional Dependencies

• Node-RED

  Note: This is included by default in the development VM image

Installation

Install RIAPS MQTT library

• On single node locally

sudo python3 -m pip install 'riaps.interfaces.mqtt @ git+https://github.com/RIAPS/interface.mqtt.git'

• On cluster of nodes using python fabric

riaps_fab sys.sudo:'"python3 -m pip install git+https://github.com/RIAPS/interface.mqtt.git"'

• Via cloning

git clone https://github.com/RIAPS/interface.mqtt.git
cd interface.mqtt
sudo python3 -m pip install .

Configure FlashMQ

• Ensure that the broker is running with sudo systemctl status flashmq.service. Check the Loaded and Active lines. Should be something like:

  $ sudo systemctl status flashmq.service
  Loaded: loaded (/lib/systemd/system/flashmq.service; enabled; vendor preset: enabled)
  Active: active (running) since Mon 2024-08-19 14:05:55 UTC; 4 days ago
  

• Allow anonymous connections by adding the line allow_anonymous true to the /etc/flashmq/flashmq.conf file (source)