Takehiko Shimojima / AmbientLib

Ambient library. It provides "set" function to set data to a packet and "send" function to send the packet to the Ambient server. It also provides "bulk_send" function to send multiple data. (Japanese: IoT用のクラウドサービス「Ambient」のデーター送信ライブラリーです。Ambientはマイコンから送られたセンサーデーターを受信し、蓄積し、可視化(グラフ化)します。http://ambidata.io)

Dependents:   AmbientExampleSITB AmbientHeartRateMonitor AmbientHeartBeat AmbientExampleSITB_ws ... more

ambient library

Table of Contents

  1. Ambientのmbedライブラリー
  2. Ambient::begin()
  3. Ambient::set()
  4. Ambient::clear()
  5. Ambient::send()
  6. Ambient::bulk_send()
  7. Ambient::delete_data()

Ambientのmbedライブラリー

IoTクラウドサービス「Ambient」(https://ambidata.io) のArduinoライブラリーです。

Ambient::begin()

説明

Ambientの初期化(使う準備)をします。

構文

    #include “Ambient.h”
    bool Ambient::init(unsigned int channelId, const char * writeKey, WiFiClient * c);

引数

    unsigned int channelId;         // データーを送信するチャネルのチャネルId
    const char * writeKey;          // ライトキー
    WiFiClient * c;                 // WiFiClientのポインター

戻り値

    true: 成功
    false: 不成功

Ambient::set()

説明

Ambientに送信するデーターをパケットに設定します。Ambientでは8種類までのデーターを送信できます。set()は何種類目のデーターかを示す数値とそのデーターを指定します。

構文

    #include “Ambient.h”
    bool Ambient::set(int field, char * data);
    bool Ambient::set(int field, int data);
    bool Ambient::set(int field, double data);

引数

    int field;       // 何種類目のデーターか示す数値。1から8が指定できます。
    char * data;     // 送信する数値を文字列にしたもの。
    int data;        // 数値はintまたはdouble型で渡すこともできます。
    double data;

戻り値

    true: 成功
    false: 不成功

Ambient::clear()

説明

パケットに設定したデーターを消去します。Ambient::send()またはAmbient::bulk_send()で データーを送信した後は、設定したすべてのデーターは消去されます。

構文

    #include “Ambient.h”
    bool Ambient::clear(int field);

引数

    int field;        // 何種類目のデーターかを指定します。1から8が指定できます。

戻り値

    true: 成功
    false: 不成功

Ambient::send()

説明

begin()で指定したチャネルにset()で設定したデーターを送信します。Ambientはデーターを受信した時刻をデーターの生成時刻として記録します。送信後、パケットに設定したデーターは消去されます。

構文

    #include “Ambient.h”
    bool Ambient::send(void);

引数

ありません。

戻り値

    true: 成功
    false: 不成功

Ambient::bulk_send()

説明

begin()で指定したチャネルに複数件のデーターをまとめて送信します。データーは下記に示すJSON形式で渡し、データーの中に生成時刻を含める必要があります。

構文

    #include “Ambient.h”
    int Ambient::bulk_send(char * buf);

引数

    char * buf;    // データーへのポインター

データーは次のようなJSON形式にします。

    {
        “writeKey” :  “ライトキー”,
        “data” : [
            {“created” : “YYYY-MM-DD HH:mm:ss.sss”, “d1” :  “値”, “d2” :  “値”, ...},
            {“created” : “YYYY-MM-DD HH:mm:ss.sss”, “d1” :  “値”, “d2” :  “値”, ...},
            ...
            {“created” : “YYYY-MM-DD HH:mm:ss.sss”, “d1” :  “値”, “d2” :  “値”, ...}
        ]
    }

見やすくするために改行やインデントを入れてありますが、実際には改行やインデントは不要です。“created”はデーターの生成時刻で、値は“YYYY-MM-DD HH:mm:ss.sss”という形式か、 数値を渡します。 数値を渡した場合は1970年1月1日00:00:00からのミリ秒と解釈されます。“created”の後にはデーターを”キー”:”値”という形式で並べます。 キーは”d1″、”d2″、”d3″、”d4″、”d5″、”d6″、”d7″、”d8″のいずれかを指定します。

さらに、次のように“time”: 1 を指定すると、数値は「秒(協定世界時(UTC)の1970年1月1日00:00:00からの)」として扱われます。“YYYY-MM-DD HH:mm:ss.sss”という形式の場合は“time”: 1を指定しても無視します。

    {
        “writeKey” :  “ライトキー”,
        “data” : [
            {“created” : 数値, “time” : 1,  “d1” : “値”, “d2” : “値”, ...},
            {“created” : 数値, “time” : 1,  “d1” : “値”, “d2” : “値”, ...},
            ...
            {“created” : 数値, “time” : 1,  “d1” : “値”, “d2” : “値”, ...}
        ]
    }

戻り値

実際に送信できたバイト数が返されます。

Ambient::delete_data()

説明

begin()で指定したチャネルに保存された全てのデーターを削除します。部分的に削除する機能はありません。 Ambientサイトのチャネルページの「データー削除」ボタンと同じ動作をします。 チャネルそのものやチャネルの設定情報は削除されずに残ります。 削除したデーターは復元できないので、注意してください。

構文

    #include “Ambient.h”
    bool Ambient::delete_data(const char * userKey);

引数

    const char * userKey;       // ユーザーキー

戻り値

    true: 成功
    false: 不成功
All wikipages