IoT Platform:Use IoT Platform SDK for Node.js

Procedure

1. Initialize the SDK. For more information, see the Initialize the SDK section of this topic.

2. Create an API request by generating a request instance of the ${API operation name}+"Request" class.

3. Use the request instance to specify the request parameters.

4. Create a response instance of the ${API operation name}+"Response" class to obtain the response. Call the ${API operation name}(request) method of the client instance to obtain the response to the API request. The response includes the body and headers returned by the server.

5. Call the response.body.${Response parameter} method to obtain the values of response parameters.

   For example, you can call the response.body.success method to obtain the Success parameter. This parameter is a common response parameter that indicates whether the request is successful. Common response parameters also include RequestId, ErrorMessage, and Code.

6. Call the catch() method to handle exceptions.

For more information about the API operations of IoT Platform, see List of operations by function. For more information about the request parameters and response parameters of each API operation, see the API reference.

The following example shows how to call the Pub operation to publish a message to a topic. For more information about request parameters, see Pub.

try {
    let client = Client.createClient("${accessKey}", "${accessKeySecret}");
    let request = new $Iot.PubRequest({
        // The ID of the IoT Platform instance. 
        iotInstanceId: "${iotInstanceId}",
        // The ProductKey of the product. 
        productKey: "${productKey}",
        // The message body to be sent. It must be encoded in Base64. 
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // The custom topic that is used to publish the message. 
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // The message sending mode. IoT Platform SDK supports QoS 0 and QoS 1. 
        qos: 0,
    });
    let response = await client.pub(request);
    Console.log(Util.toJSONString($tea.toMap(response)));
} catch (error) {
    Console.log(error.message);
}

Sample code

import Iot, * as $Iot from '@alicloud/iot20180120';
import Util from '@alicloud/tea-util';
import Env from '@alicloud/darabonba-env';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import Console from '@alicloud/tea-console';
import * as $tea from '@alicloud/tea-typescript';


export default class Client {
  /**
   * Use your AccessKey ID and AccessKey secret to initialize the client. 
   * @param accessKeyId
   * @param accessKeySecret
   * @param regionId
   * @return Client
   * @throws Exception
   */
  static createClient(): Iot {
    let config = new $OpenApi.Config({ });
    // Your AccessKey ID. 
    config.accessKeyId = process.env.ACCESS_KEY_ID;
    // Your AccessKey secret.
    config.accessKeySecret = process.env.ACCESS_KEY_SECRET;
    // The region ID. 
    config.regionId = "cn-shanghai";
    return new Iot(config);
   }


  static async main(args: string[]): Promise<void> {
    try {
      let client = Client.createClient("${accessKey}", "${accessKeySecret}");
      let request = new $Iot.PubRequest({
        // The ID of the IoT Platform instance. 
        iotInstanceId: "${iotInstanceId}",
        // The ProductKey of the product. 
        productKey: "${productKey}",
        // The message body that you want to send. Encode "hello world" in Base64 as a string. 
        messageContent: "eyJ0ZXN0IjoidGFzayBwdWIgYnJvYWRjYXN0In0=",
        // The custom topic that is used to publish the message. 
        topicFullName: "/${productKey}/${deviceName}/user/get",
        // The message sending mode. IoT Platform SDK supports QoS 0 and QoS 1. 
        qos: 0,
      });
      let response = await client.pub(request);
      Console.log(response.body.success);
      Console.log(response.body.requestId);
    } catch (error) {
      Console.log(error.message);
    }    
  }
}

Client.main(process.argv.slice(2));