salmanzafar/laravel-mqtt

一个简单的Laravel库,用于连接/发布/订阅MQTT代理

v2.0.8 2021-05-07 12:34 UTC

README

一个简单的Laravel库,用于连接/发布/订阅MQTT代理

基于bluerhinos/phpMQTT

例如,查看这个仓库

安装

composer require salmanzafar/laravel-mqtt

功能

  • 用户名和密码认证
  • 客户端证书认证
  • 端到端加密的证书保护
  • 启用调试模式以便更容易进行调试
  • 现在您也可以设置您选择的Client_id,如果您不想设置,只需不使用或设置为null即可
  • 直接从配置文件设置QOS标志
  • 直接从配置文件设置保留标志
  • 添加辅助函数以使开发更容易

启用包(可选)

此包实现了Laravel自动发现功能。安装后,会自动添加包提供者和外观,适用于laravel >= 5.5。

此步骤仅适用于您使用laravel版本<5.5的情况

要显式声明提供者和/或别名,请将服务提供者添加到您的config/app.php文件中

'providers' => [

        Salman\Mqtt\MqttServiceProvider::class,
];

然后添加别名到您的config/app.php文件中

'aliases' => [

       'Mqtt' => \Salman\Mqtt\Facades\Mqtt::class,
];

配置

发布配置文件

php artisan vendor:publish --provider="Salman\Mqtt\MqttServiceProvider"

Config/mqtt.php

    'host'      => env('mqtt_host','127.0.0.1'),
    'password'  => env('mqtt_password',''),
    'username'  => env('mqtt_username',''),
    'certfile'  => env('mqtt_cert_file',''),
    'localcert' => env('mqtt_local_cert', ''),
    'localpk'   => env('mqtt_local_pk', ''),
    'port'      => env('mqtt_port','1883'),
    'debug'     => env('mqtt_debug',false) //Optional Parameter to enable debugging set it to True
    'qos'       => env('mqtt_qos', 0), // set quality of service here
    'retain'    => env('mqtt_retain', 0) // it should be 0 or 1 Whether the message should be retained.- Retain Flag

发布主题

use Salman\Mqtt\MqttClass\Mqtt;

public function SendMsgViaMqtt($topic, $message)
{
        $mqtt = new Mqtt();
        $client_id = Auth::user()->id;
        $output = $mqtt->ConnectAndPublish($topic, $message, $client_id);

        if ($output === true)
        {
            return "published";
        }
        
        return "Failed";
}

使用外观发布主题

use Mqtt;

public function SendMsgViaMqtt($topic, $message)
{
        $client_id = Auth::user()->id;
        
        $output = Mqtt::ConnectAndPublish($topic, $message, $client_id);

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

        return "Failed";
}

订阅主题

use Salman\Mqtt\MqttClass\Mqtt;

public function SubscribetoTopic($topic)
    {
        $mqtt = new Mqtt();
        $client_id = Auth::user()->id;
        $mqtt->ConnectAndSubscribe($topic, function($topic, $msg){
            echo "Msg Received: \n";
            echo "Topic: {$topic}\n\n";
            echo "\t$msg\n\n";
        }, $client_id);


    }

使用外观订阅主题

use Mqtt;

public function SubscribetoTopic($topic)
    {
       //You can also subscribe to multiple topics using the same function $topic can be array of topics e.g ['topic1', 'topic2']

       Mqtt::ConnectAndSubscribe($topic, function($topic, $msg){
            echo "Msg Received: \n";
            echo "Topic: {$topic}\n\n";
            echo "\t$msg\n\n";
        },$client_id);


    }

使用辅助方法发布主题


public function SendMsgViaMqtt($topic, $message)
{
        $client_id = Auth::user()->id;
        
        $output = connectToPublish($topic, $message, $client_id);

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

        return "Failed";
}

使用辅助方法订阅主题

//You can also subscribe to multiple topics using the same function $topic can be array of topics e.g ['topic1', 'topic2']
public function SubscribetoTopic($topic)
{
  return connectToSubscribe($topic,$client_id);
}

祝您编码愉快...!