AWS IoT Core v2 ライブラリ

CategoryLibraryLibrary VersionSizeNEQTO BridgeSPRESENSE
IntegrationsAWS_IoT_Core_V22020-11-04 (latest)2.3KBv01.00.00+v01.00.01+
IntegrationsAWS_IoT_Core_V22020-09-072.2KBv01.00.00+v01.00.01+

neqto.jsライブラリをインポートする方法については、このドキュメントを参照してください。

使用リソース:

  • HTTPS x 1
  • MQTT x 1
  • Timers x 1

Abstracts

Methods()/PropertiesSummary
new AWS_IOT_CORE()AWS_IOT_COREオブジェクトを、渡された設定で初期化します。

このライブラリは、AWS IoT APIを使用します。

https://docs.aws.amazon.com/iot/latest/developerguide/what-is-aws-iot.html

{AWS_IOT_CORE} Instance

Methods()/PropertiesSummary
.httpPost()AWS IoT CoreエンドポイントにHTTPSでデータを送信します。
.abortHttpRequest()現在進行中のHTTPリクエストを中止します。
.mqttConnect()AWS IoT CoreにMQTT接続します。
.errors無効なキー名を含む配列。 無効な構成が setConfigまたはコンストラクターに渡された場合にのみ存在します。

Details

new AWS_IOT_CORE(config)

AWS_IOT_CORE インスタンスを初期化します。

Configuration

AWS_IOT_COREインスタンスを生成する場合に、次の設定が必要です。

NameTypeDefaultSummary
hoststringMANDATORYAWS IoT Coreコンソールの設定ページにあるリクエスト用のAWS IoTエンドポイント。
deviceCertstringMANDATORYこのデバイスに関連付けられているX.509証明書。
devicePrivKeystringMANDATORYこのデバイスに関連付けられている秘密鍵。
castringMANDATORYAWS IoT Coreと通信する際に使用するルートCA。
timeoutNumber90000HTTPリクエストのタイムアウト(ms)。

configは次の形式のJavaScriptオブジェクトである必要があります。

var config = {
    host: "<String>",
    deviceCert: "<String>",
    devicePrivKey: "<String>",
    ca: "<String>",
    timeout: "<Number>"
};

configオブジェクトを、AWS_IOT_CORE に指定します。無効な値が渡された場合、setConfigの結果はerrorsプロパティに格納されるため、適切に処理する必要があります。

var iot = new AWS_IOT_CORE(config);
if ('errors' in iot) {
    // TODO: handle errors
}

Setter Methods

AWS_IOT_COREインスタンス作成後、それぞれの設定は、対応するセッターメソッドによって変更できます。無効な値がいずれかのセッターに渡されると、 falseが返されます。

SetterSummary
.setHost(value: String)AWS IoT Coreエンドポイントを設定します。
.setDeviceCert(deviceCert: String)Thingの証明書を設定します。証明書は、AWS IoT CoreコンソールでThingを作成するときに生成できます。デバイス証明書の作成とアクティブ化の詳細については、AWS IoT Coreドキュメント を参照してください。この情報が必要な理由はこちらを参照して下さい。
.setDevicePrivKey(devicePrivKey: String)Thingに設定した証明書の秘密鍵を設定します。秘密鍵は、AWS IoT CoreコンソールでThingを作成するときに生成できます。 秘密キーの作成の詳細については、AWS IoT Coreドキュメントを参照してください。 この情報が必要な理由はこちらを参照して下さい。
.setTimeout(value: Number)HTTPリクエストのタイムアウトを設定します。
.setRootCA(value: String)AWS IoT CoreのルートCAを設定します。

.setConfig(config)

setConfig メソッド を用いると、複数の設定オプションを同時に設定したり変更したりすることができます。下記のようにJSONフォーマットで指定してください。無効な値が渡された場合、無効なキーの名前を含む配列を返し、その配列にerrorsプロパティを設定します。 有効な configがsetConfigに渡され、errorsが存在する場合、それは削除されます。

iot.setConfig({
    host: "value",
    deviceCert: "value",
    devicePrivKey: "value",
    ca: "value",
    timeout: 90000
});

Instance Methods

.httpPost(topic,headers,getNextChunk,callback[,qos])

HTTPSを介して、topicで指定されたAWS IoT Coreエンドポイントにデータを送信します。使用する前に、AWS IoT CoreのThingに適切な AWS IoT Coreポリシー が設定されている必要があります。

NameTypeDefaultSummary
topicstringMANDATORYMQTTトピック
headersobjectMANDATORYリクエストに使用するHTTPヘッダー。「Content-Length」を指定する必要があります。
getNextChunkfunctionMANDATORY送信するデータを取得するためのコールバック。 データがなくなるまで4KB以下の[string/ArrayBuffer]チャンクでデータを返し、最後にnullを返します。
callback(err, resp)functionMANDATORYレスポンスを処理するためのコールバック関数。 エラーを errとして返し、レスポンスをrespとして返します。
qosNumber0リクエストに必要なQoS値。
QoSに関するAWSドキュメント
returnundefined--

Responses

AWS IoT Coreのレスポンスは、次の形式で返します。

{
    statusCode: <Number>,
    statusMessage: <String>,
    body: <String>
}

statusCode と statusMessage の詳細については、該当するデバイスのHTTPSドキュメントをご覧ください。(NEQTO Bridge | Spresense)

body は、HTTPレスポンスのbodyデータが入ります。

Errors

neqto.jsのHTTPオブジェクトのエラーを返します。

{
    errCode: <Number>
}

errCode パラメータについてはneqto.jsドキュメントをご覧ください。(NEQTO Bridge | Spresense)

.abortHttpRequest()

現在進行中のHTTPリクエストを中止します。

NameTypeDefaultSummary
returnundefined--

.mqttConnect([options])

AWS IoT CoreにMQTT接続します。使用する前に、AWS IoT CoreのThingに適切な AWS IoT Coreポリシー が設定されている必要があります。

NameTypeDefaultSummary
optionsobject{}neqto.jsのmqtt.connectメソッドのoptionを指定します。
returnMQTT.Client-AWS IoT Coreに接続されたMQTTインスタンス。
- NEQTO Bridge
- Spresense
- QoSに関するAWSドキュメント

Object Usage Examples

以下は config オプションで使用できる CAの例です。(2020-07-20 時点)

/* Amazon Root CA 1 - 066c9fcf99bf8c0a39e2f0788a43e696365bca */
var rootCa =  "-----BEGIN CERTIFICATE-----\nMIIDQTCCAimgAwIBAgITBmyfz5m/jAo54vB4ikPmljZbyjANBgkqhkiG9w0BAQsF\nADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6\nb24gUm9vdCBDQSAxMB4XDTE1MDUyNjAwMDAwMFoXDTM4MDExNzAwMDAwMFowOTEL\nMAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEZMBcGA1UEAxMQQW1hem9uIFJv\nb3QgQ0EgMTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALJ4gHHKeNXj\nca9HgFB0fW7Y14h29Jlo91ghYPl0hAEvrAIthtOgQ3pOsqTQNroBvo3bSMgHFzZM\n9O6II8c+6zf1tRn4SWiw3te5djgdYZ6k/oI2peVKVuRF4fn9tBb6dNqcmzU5L/qw\nIFAGbHrQgLKm+a/sRxmPUDgH3KKHOVj4utWp+UhnMJbulHheb4mjUcAwhmahRWa6\nVOujw5H5SNz/0egwLX0tdHA114gk957EWW67c4cX8jJGKLhD+rcdqsq08p8kDi1L\n93FcXmn/6pUCyziKrlA4b9v7LWIbxcceVOF34GfID5yHI9Y/QCB/IIDEgEw+OyQm\njgSubJrIqg0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNVHQ8BAf8EBAMC\nAYYwHQYDVR0OBBYEFIQYzIU07LwMlJQuCFmcx7IQTgoIMA0GCSqGSIb3DQEBCwUA\nA4IBAQCY8jdaQZChGsV2USggNiMOruYou6r4lK5IpDB/G/wkjUu0yKGX9rbxenDI\nU5PMCCjjmCXPI6T53iHTfIUJrU6adTrCC2qJeHZERxhlbI1Bjjt/msv0tadQ1wUs\nN+gDS63pYaACbvXy8MWy7Vu33PqUXHeeE6V/Uq2V8viTO96LXFvKWlJbYK8U90vv\no/ufQJVtMVT8QtPHRh8jrdkPSHCa2XV4cdFyQzR1bldZwgJcJmApzyMZFo6IQ6XU\n5MsI+yMRQ+hDKXJioaldXgjUkK642M4UwtBV8ob2xJNDd2ZhwLnoQdeXeGADbkpy\nrqXRfboQnoZsG4q5WTP468SQvvG5\n-----END CERTIFICATE-----";

下記のドキュメントを参照し、ルートCAがターゲットのIoT Coreエンドポイントに適切であることを確認してください。

次のコードは、以降のサンプルコードの先頭に入ります。全ての設定を適切に置き換えて使用してください。

// IMPORTED LIBRARIES
// - AWS_IoT_Core_V2

// Logging setup
log.setLevel(0,2); //-1:NONE 0:ERROR 1:WARNING 2:DEBUG 3:TRACE, 0:DISABLE 1:LOG 2:CONSOLE 3:BOTH
log.printLevel(2); //0:DISABLE 1:LOG 2:CONSOLE 3:BOTH

// Device setup
var deviceCert = "[certificate]";
var deviceKey = "[key]";
var host = "host.iot.ap-northeast-170.amazon.aws.com"
var config = {
    host: host,
    deviceCert: deviceCert,
    devicePrivKey: deviceKey,
    ca: rootCa
}
var iotCore = new AWS_IOT_CORE(config);

if ('errors' in iotCore) {
    // TODO: handle errors
    throw 'Invalid configuration'
}

Sample 1: 自動再接続するMQTT通信

var client = iotCore.mqttConnect( {reconnectCount: 1855} );
if (!client) {
    throw 'Failed to create mqtt instance';
}
client.on('error', function(err) {
    print('ERROR: ' + err.code + ' ERRNO: ' + client.get('errnoConnect'));
    //TODO: Error handling
});
client.on('message', function(topic, message) {
    print('TOPIC: ' + topic + ' MESSAGE: ' + message);
    //TODO: Message handling
});
client.on('connect', function() {
    print("CONNECTED");
    client.subscribe("testtopic/subtopic/#", { qos: 1 }, function(err) {
        if (err.code > 0) {
            print("MQTT SUBSCRIBE ERROR", err.code);
            //TODO: Error handling
        }
    });
    client.subscribe("shadowtopic/#", { qos: 1 }, function(err) {
        if (err.code > 0) {
            print("MQTT SUBSCRIBE ERROR", err.code);
            //TODO: Error handling
        }
    });
});
setInterval(function() {
    if (client.canPublish()) {
        var body = JSON.stringify({ "message" : "dummy" })
        client.publish("testtopic/subtopic/dummy", body, { qos: 1 }, function(err){
            if(err.code == 0){
                print('Publish OK');
            } else {
                print('Publish failed');
                //TODO: Error handling
            }
        });
    } else {
        print('Cannot publish');
    }
}, 15000);

Sample 2: 手動再接続するMQTT通信

var reconnectAttempts = 0;
var maxReconnectAttempts = 24;
var registerEventHandlers = function(mqClient) {
    if (!mqClient) {
        return;
    }
    mqClient.on('error', function(err) {
        print('ERROR: ' + err.code + ' ERRNO: ' + mqClient.get('errnoConnect'));
        if (err.code == 1) { //Connection failed
            if (reconnectAttempts++ < maxReconnectAttempts) {
                print('reconnectAttempts:', reconnectAttempts);
                mqClient.reconnect();
            } else {
                print('ABORT');
                reconnectAttempts = 0;
                mqClient.end(); //Release mqtt instance
                client = undefined;
            }
        }
    });
    mqClient.on('message', function(topic, message) {
        print('TOPIC: ' + topic + ' MESSAGE: ' + message);
        //TODO: Message handling
    });
    mqClient.on('close', function() {
        print("DISCONNECTED");
        mqClient.reconnect();
    });
    mqClient.on('connect', function() {
        reconnectAttempts = 0;
        print("CONNECTED");
        mqClient.subscribe("testtopic/subtopic/#", { qos: 1 }, function(err) {
            if (err.code > 0) {
                print("MQTT SUBSCRIBE ERROR", err.code);
                //TODO: Error handling
            }
        });
    });
}
client = iotCore.mqttConnect();
if (!client) {
    throw 'Failed to create mqtt instance';
}
registerEventHandlers(client);
setInterval(function() {
    if (!client) {
        print('mqtt instance recreate');
        client = iotCore.mqttConnect();
        registerEventHandlers(client);
    }
    if (client && client.canPublish()) {
        var body = JSON.stringify({ "message" : "dummy" });
        client.publish("testtopic/subtopic/dummy", body, { qos: 1 }, function(err){
            if(err.code == 0){
                print('Publish OK');
            } else {
                print('Publish failed');
                //TODO: Error handling
            }
        });
    }
}, 15000);

Sample 3: HTTPでデータを送信します

var body = JSON.stringify({
    "message": "HTTP post"
});
var headers = {
    "Content-Length": body.length.toString()
}
// A simple method that returns `body` once, then `null` all other times.
var getBody = function() {
    var temp = body;
    body = null;
    return temp;
}

// A very simple callback to handle the HTTP response
var callback = function(err, res) {
    if (err) print(JSON.stringify(err));
    if (res) print(JSON.stringify(res));
}

iotCore.httpPost("testtopic/shadowtopic/dummy", headers, getBody, callback);

Sample 4: HTTPでデータを分割送信します

var body = JSON.stringify({
    "message": "This is a really long string[...]"
});
var headers = {
    "Content-Length": body.length.toString()
}
// This is a *dummy* example of how to chunk data for return.
// If the data is actually larger than 4KB, it is best to chunk it in the way that makes most sense.
var index = 0;
var getBody = function() {
    var ival = 8;
    var ret = body.substring(index, index + ival);
    if (ret) {
        index = index + ival;
        return ret;
    }
    return null;
}

// A very simple callback to handle the HTTP response
var callback = function(err, res) {
    if (err) print(JSON.stringify(err));
    if (res) print(JSON.stringify(res));
}

iotCore.httpPost("testtopic/shadowtopic/dummy", headers, getBody, callback);
上記に記載されている会社名、製品名は、各社の登録商標または商標です。
Updated: 2021-03-31
← 前次 →