ambient-lib Ambientのnode.jsライブラリー

このリポジトリは古いです。最新版はこちらをご覧ください。

Ambient

AmbientはIoTデータ可視化サービスで、センサーデーターを受信し、蓄積し、可視化(グラフ化)します。

Ambientにユーザー登録(無料)し、マイコンからデーターを送ると、こんな感じでグラフ表示させることができます。

ambient-libはAmbientのnode.jsライブラリーです。

インストール

$ npm install ambient-lib

モジュールの読み込み

var ambient = require('ambient-lib');

Ambientへの接続

ambient.connect(チャネルId, ライトキー[, リードキー[, ユーザーキー]]);

Ambientにデーターを送信するときは、チャネルIdとライトキーを指定してAmbientに接続します。

Ambientへのデーター送信

ambient.send(data, callback(err, res, body));

パラメーター
data: 次のようなJSON形式で、キーはd1からd8のいずれかを指定します。

var data = {d1: 1.1, d2: 2.2};

callback: データー送信後に呼ばれるコールバック関数。パラメーターはrequestモジュールのコールバック関数のパラメーターと同じです。

こんな風に使います。

ambient.send({d1: 1.1, d2: 2.2}, function(err, res, body) {
    if (err) {
        console.log(err);
    }
    console.log(res.statusCode);
});

この形式でデーターを送信した場合、Ambientはデーターを受信した時刻を合わせて記録します。次のようにデーターを測定した時刻を指定することもできます。

var data = {created: 'YYYY-MM-DD HH:mm:ss.sss', d1: 1.1, d2: 2.2};

また、次のように複数のデーターを一括で送信することもできます。

var data = [
    {created: '2017-02-18 12:00:00', d1: 1.1, d2: 2.1},
    {created: '2017-02-18 12:01:00', d1: 1.5, d2: 3.8},
    {created: '2017-02-18 12:02:00', d1: 1.0, d2: 0.8}
];

以前は複数データーの一括送信はbulk_send()という関数を提供していましたが、send()で1データーでも複数データーでも送信できるように拡張しました。 bulk_send()は互換性のために残してあります。

Ambientへの複数データー一括送信

複数データー一括送信も用意しました。

ambient.bulk_send(dataarray, callback(err, res, body));

パラメーター
dataarray: 次のような形式の配列です。 createdはデーターの生成時刻で、値は“YYYY-MM-DD HH:mm:ss.sss”という形式か、数値を渡します。数値を渡した場合は1970年1月1日00:00:00からのミリ秒と解釈されます。

var dataarray = [
    {created: '2016-07-07 12:00:00', d1: 1.1, d2: 2.1},
    {created: '2016-07-07 12:01:00', d1: 1.5, d2: 3.8},
    {created: '2016-07-07 12:02:00', d1: 1.0, d2: 0.8}
];

TakehikoShimojima / ambient-nodejs-lib