MixServer Reference

MixServerの設定方法と、CGI・データストア機能の使い方を説明します。

マイページの設定

MixServer メンバーページ画面の画像

①CGI URL

ご自分で設置したCGIを使用する場合は、CGIのURLを設定します。

  • MixSodaが送信/受信するデータは、設定したCGIへリアルタイムで転送されます。
  • HTTPとHTTPSのどちらも使用できます。

CGIの詳細を見る

②Store Token

データストア機能を使用する場合は、任意の文字列をトークンとして設定します。

  • CGIを設置せずに、MixSodaが送信/受信するデータを取得/セットできます。
  • 7日前までのデータを取得でき、セットしたデータは7日間保持されます。
  • トークンは不特定多数の人が使用するアプリには埋め込まないでください。

データストア機能の詳細を見る

③ICCID, IMEI

MixServerを利用するMixSodaのICCIDとIMEIを登録します。

  • 「まとめて登録する」から複数台を一度に登録することもできます。(要csvデータ)

CGIの詳細

リクエストヘッダー

CGIはHTTPリクエストヘッダーから次の情報を取得できます。

  • x-iccid
  • x-time

HTTPメソッド

MixSodaからの通信は、次のHTTPメソッドに変換されます。

通信 HTTPメソッド
データ送信時(IoT.OUTなど) POST
データ受信時(IoT.INなど) GET

JavaScriptの実装例

IchigoJam BASICでIoTコマンドを使用する場合の、Azure Functions側の例です。

            
const { app } = require('@azure/functions');

app.http('httpTrigger1', {
    methods: ['GET', 'POST'],
    authLevel: 'anonymous',
    handler: async (request, context) => {
        const iccid = request.headers.get("x-iccid");
        const time  = request.headers.get("x-time");
        context.log(`iccid:${iccid}, time:${time}`);

        if(request.method === "POST"){
            const buf = await request.arrayBuffer();
            const data = new DataView(buf).getInt32(0);
            context.log(`data: ${data}`);   // do something
            return {  };
        }else
        if(request.method === "GET"){
            const data = 1234;              // MixSodaが受信する数値
            const buf = new ArrayBuffer(4);
            new DataView(buf).setInt32(0, data);
            return { body: buf };
        }
    }
});
              

データストア機能の使い方

MixSodaから届いたデータを取得する

リクエストURL

すべてのMixSoda:
GET http://mixsoda.io:2048/(token).csv[オプション]
特定のMixSoda:
GET http://mixsoda.io:2048/(token)/(ICCID).csv[オプション]
  • オプションを指定しない場合は、最新の1件が取得できます。
  • HTTPSも使用できます。
  • CORSについては、実験的に Access-Control-Allow-Origin: * を返していますが、負荷などの状況により削除する場合があります。また、Webアプリケーションなどにトークンを埋め込む場合はご注意ください。

取得データ形式

取得データは、ヘッダー行を含むCSV形式です。

utc,iccid,data
1787554791,1234567890123456789,000012af
項目 内容
utc UNIX時間(UTC)
iccid MixSodaのICCID
data MixSodaが送信したデータを16進数で表した文字列(可変長)

取得オプション

オプション 機能 設定値
from 取得範囲(いつから)を指定する
  • UNIX時間(UTC) or 相対マイナス秒
  • 省略すると最新の1件を取得する
to 取得範囲(いつまで)を指定する
  • UNIX時間(UTC)
  • 省略すると現在時刻が設定される

オプションの使用例

60秒前から現在時刻までのデータを取得する
http://mixsoda.io:2048/love_mixsoda_4649.csv?from=-60
UNIX時間 1659597207から現在時刻までのデータを取得する
http://mixsoda.io:2048/love_mixsoda_4649.csv?from=1659597207
ICCID 1234567890123456789 のMixSodaが送信したUNIX時間 1659597100から1659597207までのデータを取得する
http://mixsoda.io:2048/love_mixsoda_4649/1234567890123456789.csv?from=1659597100&to=1659597207
ICCID 1234567890123456789 のMixSodaが送信したUNIX時間 1659597207までの最新の1件を取得する
http://mixsoda.io:2048/love_mixsoda_4649/1234567890123456789.csv?to=1659597207

MixSodaに渡すデータをセットする

リクエストURL

すべてのMixSoda:
POST http://mixsoda.io:2048/(token)
特定のMixSoda:
POST http://mixsoda.io:2048/(token)/(ICCID)
  • 複数のデータをセットできます。
  • データは古い順にMixSodaに渡され、渡されたデータは削除されます。
  • Content-Lengthが0の場合、セットされているデータはすべて削除されます。
  • IoT.INコマンドでMixSodaに渡されるデータは4バイト固定です。4バイト未満のデータは、4バイトに拡張してセットしてください。
  • HTTPSも使用できます。