php-mqtt Laravel Client

The Laravel client is a wrapper around php-mqtt/client. You can access the full power of the underlying library by retrieving the MqttClient contract via the MQTT facade.

use PhpMqtt\Client\Facades\MQTT;

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt = MQTT::connection('connection_name');
// Now you have access to all methods defined in \PhpMqtt\Client\Contracts\MqttClient

Install the package via Composer. The package uses Laravel auto-discovery to register the MqttClientServiceProvider and the MQTT facade.

composer require php-mqtt/laravel-client

After installation, publish the configuration file to config/mqtt-client.php to customize your connection settings.

php artisan vendor:publish --provider="PhpMqtt\Client\MqttClientServiceProvider" --tag="config"

You can define multiple named connections in config/mqtt-client.php. Use the default_connection key to specify which connection to use when no name is provided. It is recommended to use environment variables for sensitive settings.

'default_connection' => 'private',

'connections' => [
    'private' => [
        'host' => 'mqtt.example.com',
        'port' => 1883,
    ],
    'public' => [
        'host' => 'test.mosquitto.org',
        'port' => 1883,
    ],
],

The package uses a configuration file named mqtt-client.php. To customize the MQTT settings, you should publish the configuration file to your application's config directory using the following Artisan command:

php artisan vendor:publish --tag=config

Once published, you can modify the settings in config/mqtt-client.php. The package accesses these settings using the mqtt-client configuration key.

Subscribing requires an event loop to process incoming messages. Register the subscription first, then start the loop.

use PhpMqtt\Client\Facades\MQTT;

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt = MQTT::connection();

$mqtt->subscribe('some/topic', function (string $topic, string $message) {
    echo sprintf('Received QoS level 1 message on topic [%s]: %s', $topic, $message);
}, 1);

$mqtt->loop(true);

For simple, one-off publishing where QoS 0 is sufficient, use the MQTT facade directly. This method implicitly calls MQTT::connection() but does not close the connection automatically. Note that MQTT::publish($topic, $message) always uses QoS level 0.

use PhpMqtt\Client\Facades\MQTT;

// Basic publish
MQTT::publish('some/topic', 'Hello World!');

// Publish with retain flag and specific connection name
// MQTT::publish($topic, $message, $retain, $connectionName)
MQTT::publish('some/topic', 'Hello World!', true, 'public');

// Manually disconnect if needed
MQTT::disconnect();

To use QoS 1 or 2, you must interact with the MqttClient instance directly and run an event loop. The loop ensures that acknowledgements are received from the broker.

To exit the loop once all resend queues are cleared, call $mqtt->loop(true, true). Alternatively, you can call $mqtt->interrupt() to exit during the next iteration.

use PhpMqtt\Client\Facades\MQTT;

/** @var \PhpMqtt\Client\Contracts\MqttClient $mqtt */
$mqtt = MQTT::connection();

// QoS 1
$mqtt->publish('some/topic', 'foo', 1);

// QoS 2 with retain flag
$mqtt->publish('some/other/topic', 'bar', 2, true);

// Start loop and exit once all resend queues are cleared
$mqtt->loop(true, true);

The publish() method provides a shortcut to send a message with a Quality of Service (QoS) level of QOS_AT_MOST_ONCE (0). You can specify the topic, the message, and whether the message should be retained. You can also specify which connection to use by passing its name.

// Publish to the default connection
$connectionManager->publish('my/topic', 'hello world');

// Publish with retention to a specific connection
$connectionManager->publish('my/topic', 'hello world', true, 'specific_connection');

The package binds an implementation of PhpMqtt\Client\Contracts\Repository to the service container. By default, it uses PhpMqtt\Client\Repositories\MemoryRepository.

use PhpMqtt\Client\Contracts\Repository;

$repository = app(Repository::class);

Use the disconnect() method to close an active connection. If no connection name is provided, it will disconnect the default_connection. This method also removes the connection from the manager's internal cache.

// Disconnect the default connection
$connectionManager->disconnect();

// Disconnect a specific connection
$connectionManager->disconnect('broker_name');