Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shunhua/mqtt
A simple Laravel Library to connect/publish/subscribe to MQTT broker
https://github.com/shunhua/mqtt
laravel mqtt
Last synced: 3 months ago
JSON representation
A simple Laravel Library to connect/publish/subscribe to MQTT broker
- Host: GitHub
- URL: https://github.com/shunhua/mqtt
- Owner: shunhua
- Created: 2021-01-26T08:57:40.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2021-12-01T03:17:37.000Z (about 3 years ago)
- Last Synced: 2024-10-01T16:53:28.040Z (3 months ago)
- Topics: laravel, mqtt
- Language: PHP
- Homepage:
- Size: 12.7 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Laravel MQTT 扩展包
A simple Laravel Library to connect/publish/subscribe to MQTT broker
支持实例化多应用配置
## 安装
```
composer require shunhua/laravel-mqtt
```
## 启用 (可选)
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' => [
Salman\Mqtt\MqttServiceProvider::class,
];
```
And then add the alias to your config/app.php:
```
'aliases' => [
'Mqtt' => \Salman\Mqtt\Facades\Mqtt::class,
];
```
## 配置
Publish the configuration file
```
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',''),
'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";
}
```
#### 使用 Facade 发布
```
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);
}
```
#### 使用 Facade 订阅
```
use Mqtt;
public function SubscribetoTopic($topic)
{
Mqtt::ConnectAndSubscribe($topic, function($topic, $msg){
echo "Msg Received: \n";
echo "Topic: {$topic}\n\n";
echo "\t$msg\n\n";
},$client_id);
}
```
#### 使用 Helper 发布
```
public function SendMsgViaMqtt($topic, $message)
{
$client_id = Auth::user()->id;
$output = connectToPublish($topic, $message, $client_id);
if ($output === true)
{
return "published";
}
return "Failed";
}
```
#### 使用 Helper 订阅
```
public function SubscribetoTopic($topic)
{
return connectToSubscribe($topic,$client_id);
}
```
### Tested on php 7.3 and laravel 5.7 and also laravel 5.8 and also on laravel 6
#### Also supports php 7.4