Skip to content

DenHerrRing/laravel-mqtt-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Laravel MQTT Client Package

A simple Laravel 5 Library / Client to connect/publish to MQTT broker

Based on bluerhinos/phpMQTT

Installation

composer require denherrring/laravel-mqtt-client

Features

  • Name and Password Authentication
  • Certificate Protection for end to end encryption
  • Enable Debug mode to make it easier for debugging
  • Use LWT Messages and Retrain / QOS Flags

Enable the package (Optional)

This package implements Laravel auto-discovery feature. After you install it the package provider and facade are added automatically for laravel >= 5.5.

This step is only required if you are using laravel version <5.5

To declare the provider and/or alias explicitly, then add the service provider to your config/app.php:

'providers' => [

        DenHerrRing\MqttClient\MqttClientServiceProvider::class,
];

And then add the alias to your config/app.php:

'aliases' => [

       'MqttClient' => DenHerrRing\MqttClient\Facades\MqttClient::class,
];

Configuration

Publish the configuration file

php artisan vendor:publish --provider="DenHerrRing\MqttClient\MqttClientServiceProvider"

Config/mqttclient.php

    'host'     => env('mqtt_host','127.0.0.1'),
    'clientId' => env('mqtt_clientId', null),
    'password' => env('mqtt_password',''),
    'username' => env('mqtt_username',''),
    'certfile' => env('mqtt_cert_file',''),
    'port'     => env('mqtt_port','1883'),
    'debug'    => env('mqtt_debug',false) //Optional Parameter to enable debugging set it to True

Publishing topic

use DenHerrRing\MqttClient\MqttClientClass\MqttClient;

public function SendMsgViaMqtt($topic, $message)
{
        $mqtt = new MqttClient();
        $output = $mqtt->ConnectAndPublish($topic, $message);

        if ($output === true)
        {
            return true;
        }

        return false;
}

Publishing topic using Facade

use MqttClient;

public function SendMsgViaMqtt($topic, $message)
{
        $output = MqttClient::ConnectAndPublish($topic, $message);

        if ($output === true)
        {
            return true;
        }

        return false;
}

Tested on php 7.3 and laravel 5.7 and also laravel 5.8

Subscription Part is in development