All Products
Search
Document Center

IoT Platform:Connect a client to IoT Platform by using the SDK for PHP

Last Updated:Oct 22, 2023

This topic describes how to use the SDK for PHP to connect an Advanced Message Queuing Protocol (AMQP) client to Alibaba Cloud IoT Platform and receive messages from IoT Platform by using the server-side subscription feature.

Prerequisites

The ID of the consumer group that subscribes to the messages of a topic is obtained.

Download the SDK

The sample code is written based on the Stomp PHP library and allows you to connect a Stomp PHP client to IoT Platform over Simple Text Oriented Message Protocol (STOMP). To download a Stomp PHP client and view the instructions, visit Stomp PHP.

For information about the PHP versions that Stomp SDK for PHP supports, see the declaration of the require parameter in the composer.json file of Stomp SDK for PHP.

In Stomp PHP versions earlier than 5.0.0, the SDK may fail to reconnect to IoT Platform after the SDK is disconnected. We recommend that you download Stomp PHP 5.0.0 or later. For more information, see Issues.

In the PHP project directory, run the following command to download the SDK of Stomp PHP 5.0.0:

composer require stomp-php/stomp-php 5.0.0

Sample code

<?php
require __DIR__ . '/vendor/autoload.php';
use Stomp\Client;
use Stomp\Network\Observer\Exception\HeartbeatException;
use Stomp\Network\Observer\ServerAliveObserver;
use Stomp\StatefulStomp;

// For more information about the parameters, see the "Connect an AMQP client to IoT Platform" topic. 
// If you hard-code the AccessKey pair in the project code, the AccessKey pair may be disclosed if the project code is leaked. In this case, the resources within your account become insecure. The following sample code provides an example on how to obtain the AccessKey pair from environment variables. This example is for reference only.
$accessKey = getenv("ALIBABA_CLOUD_ACCESS_KEY_ID");
$accessSecret = getenv('ALIBABA_CLOUD_ACCESS_KEY_SECRET');
$consumerGroupId = "${YourConsumerGroupId}";
$clientId = "${YourClientId}";
// iotInstanceId: The ID of the IoT Platform instance. 
$iotInstanceId = "${YourIotInstanceId}";
$timeStamp = round(microtime(true) * 1000);
// The signature algorithm. Valid values: hmacmd5, hmacsha1, and hmacsha256. 
$signMethod = "hmacsha1";
// The structure of the userName parameter. For more information, see the "Connect an AMQP client to IoT Platform" topic. 
// If you want to transmit messages in the binary format, specify encode=base64 in the userName parameter. Before IoT Platform sends these messages, IoT Platform encodes these messages by using the Base64 algorithm. For more information, see the "Messages in the binary format" section of this topic. 
$userName = $clientId . "|authMode=aksign"
            . ",signMethod=" . $signMethod
            . ",timestamp=" . $timeStamp
            . ",authId=" . $accessKey
            . ",iotInstanceId=" . $iotInstanceId
            . ",consumerGroupId=" . $consumerGroupId
            . "|";
$signContent = "authId=" . $accessKey . "&timestamp=" . $timeStamp;
// Calculate a signature. For more information about how to construct the password, see the "Connect an AMQP client to IoT Platform" topic. 
$password = base64_encode(hash_hmac("sha1", $signContent, $accessSecret, $raw_output = TRUE));
// The endpoint. For more information, see the "Connect an AMQP client to IoT Platform" topic. 
$client = new Client('ssl://${YourHost}:61614');
$sslContext = ['ssl' => ['verify_peer' => true, 'verify_peer_name' => false], ];
$client->getConnection()->setContext($sslContext);

// Configure a listener to monitor the status of the connection between the client and IoT Platform. 
$observer = new ServerAliveObserver();
$client->getConnection()->getObservers()->addObserver($observer);
// The heartbeat setting. This setting enables IoT Platform to send a heartbeat packet every 30 seconds. 
$client->setHeartbeat(0, 30000);
$client->setLogin($userName, $password);
try {
    $client->connect();
}
catch(StompException $e) {
    echo "failed to connect to server, msg:" . $e->getMessage() , PHP_EOL;
}
// Run the following code if no exceptions occur: 
$stomp = new StatefulStomp($client);
$stomp->subscribe('/topic/#');
echo "connect success";

while (true) {
    try {

        // Check the connection status.
        if (!$client->isConnected()) {
            echo "connection not exists, will reconnect after 10s.", PHP_EOL;
            sleep(10);
            $client->connect();
            $stomp->subscribe('/topic/#');
            echo "connect success", PHP_EOL;
        }

        // Specify the business logic to process messages. 
        echo $stomp->read();
    }
    catch(HeartbeatException $e) {
        echo 'The server failed to send us heartbeats within the defined interval.', PHP_EOL;
        $stomp->getClient()->disconnect();
    } catch(Exception $e) {
        echo 'process message occurs error: '. $e->getMessage() , PHP_EOL;
        $stomp->getClient()->disconnect();
    }
}   

You can configure the parameters in the preceding code based on the parameter description in the following table. For more information about other parameters, see Connect an AMQP client to IoT Platform.

Important

Make sure that you specify valid parameter values. Otherwise, the AMQP client fails to connect to IoT Platform.

Parameter

Description

accessKey

Log on to the IoT Platform console, move the pointer over the profile picture in the upper-right corner, and then click AccessKey Management to obtain the AccessKey ID and AccessKey secret.

Note

If you use a Resource Access Management (RAM) user, you must attach the AliyunIOTFullAccess policy to the RAM user. This policy allows the RAM user to manage IoT Platform resources. Otherwise, the connection to IoT Platform fails. For more information, see Access IoT Platform as a RAM user.

accessSecret

consumerGroupId

The ID of the consumer group of the IoT Platform instance.

To view the ID of the consumer group, perform the following steps: Log on to the IoT Platform console and click the card of the instance that you want to manage. In the left-side navigation pane, choose Message Forwarding > Server-side Subscription. The ID of the consumer group is displayed on the Consumer Groups tab.

iotInstanceId

The ID of the IoT Platform instance. You can view the instance ID on the Overview tab in the IoT Platform console.

  • If the instance ID is displayed, you must set this parameter to the instance ID.

  • If the Overview tab is not displayed or your instance does not have an ID, leave this parameter empty in the format of iotInstanceId = "".

clientId

The ID of the client. You must specify a custom ID. The ID must be 1 to 64 characters in length. We recommend that you use a unique identifier as the client ID, such as the UUID, MAC address, or IP address of the server on which the client runs.

After the AMQP client is connected to IoT Platform and started, perform the following steps to view the details of the client: Log on to the IoT Platform console and click the card of the instance that you want to manage. In the left-side navigation pane, choose Message Forwarding > Server-side Subscription. On the Consumer Groups tab, find the consumer group that you want to manage and click View in the Actions column. The ID of each client is displayed on the Consumer Group Status tab. You can use client IDs to identify clients with ease.

client

Establish a connection between the AMQP client and IoT Platform. Format: $client = new Client('ssl://${YourHost}:61614');

For more information about the endpoint that you can specify for the ${YourHost} variable, see Manage the endpoint of an instance.

Sample results

  • If information similar to the following output is displayed, the AMQP client is connected to IoT Platform and can receive messages.成功

  • If information similar to the following output is displayed, the AMQP client fails to connect to IoT Platform.

    You can check the code or network environment based on logs, resolve the issue, and then run the code again.

    失败

Messages in the binary format

If you want to transmit messages in the binary format, use the Base64 algorithm to encode the messages. If you do not use the Base64 algorithm to encode the messages, the messages may be truncated because STOMP is a text-based protocol.

The following code shows how to specify encode=base64 in the userName parameter. This setting enables IoT Platform to encode messages by using the Base64 algorithm before IoT Platform sends the messages.

$userName = $clientId . "|authMode=aksign"
                . ",signMethod=" . $signMethod
                . ",timestamp=" . $timeStamp
                . ",authId=" . $accessKey
                . ",iotInstanceId=" . $iotInstanceId
                . ",consumerGroupId=" . $consumerGroupId
                . ",encode=base64" . "|";

References

For more information about the error codes that are related to the server-side subscription feature, see the Error codes that are related to messages section of the "IoT Platform logs" topic.