データフォーマット

[更新: 2021年7月9日]

「さくらのモノプラットフォーム」で提供されるデータフォーマットについて説明します。 本ページの内容はβテスト時点での提供内容であり、変更される可能性があります。

データフォーマットの全体像

1. データの構成

さくらのモノプラットフォームでは、サービスアダプタとアプリケーション間で以下のデータフォーマットを使ってやりとりが行われます。 なお、アプリケーションに送られるデータはJSON形式であり、エンコード方式はUTF-8です。

さくらのモノプラットフォームのデータフォーマット(値は仮のものです)

{
    "id": "7addc9d0-f2cc-4d0e-b01f-d953dd1c5317",
    "module_id": "1234567890",
    "timestamp_src": 1609459200000,
    "timestamp_platform_from_src": 1609459200000,
    "timestamp_platform_to_dst": 1609459200000,
    "type": "object",
    "payload": [
        {
            "type": "float32",
            "tag": "00",
            "value": 20.5
        },
        {
            "type": "uint8",
            "tag": "ff",
            "value": 60
        }
    ]
}
さくらのモノプラットフォームデータ項目
フィールド名 意味
id string デバイスから転送された一連のデータに対して付与される一意の転送ID(UUID)です。このIDはデバイス側にも通知されます。
module_id string 送信元を一意に識別するためのIDです。
timestamp_src number デバイスからデータ送信時のデバイス側の時刻です。1970年01月01日00時00分00秒からの経過時間(ミリ秒)です。デバイス側で時刻を指定しなかった場合は0が入ります。
timestamp_platform_from_src number デバイスから送信されたデータをモノプラットフォームが受信した時点のプラットフォーム側の時刻です。1970年01月01日00時00分00秒からの経過時間(ミリ秒)です。
timestamp_platform_to_dst number モノプラットフォームからアプリケーション側に向けてデータが送信された時点のプラットフォーム側の時刻です。1970年01月01日00時00分00秒からの経過時間(ミリ秒)です。
type string データの種類を表す文字列です。詳細は別表を参照ください。
payload Array デバイスから送信されたデータ(バイナリ表現)の解析結果が入った配列です。
payload[].type string データの形式を表す文字列です。詳細は別表を参照ください。
payload[].tag string データの種類を表す文字列表現です。現時点ではデバイスから送信されたタグの数値(1オクテット)を16進文字列にしたものですが、正式版リリース時にはお客様側で任意の文字列にマッピング可能にする予定です。
payload[].value データの値です。typeによって型が異なります。
さくらのモノプラットフォームtype詳細
type 意味
object デバイスから送られたデータ
keepalive 接続維持のためにWebSocketサーバから定期的に送られるデータ(読み捨てても問題ありません)
さくらのモノプラットフォーム payload[].type詳細
type valueの型 意味
uint8 number 8ビット符号なし整数
int8 number 8ビット符号つき整数
uint16 number 16ビット符号なし整数
int16 number 16ビット符号つき整数
uint32 number 32ビット符号なし整数
int32 number 32ビット符号つき整数
uint64 number 64ビット符号なし整数
int64 number 64ビット符号つき整数
float32 number 32ビット浮動小数点数(IEEE754 単精度)
float64 number 64ビット浮動小数点数(IEEE754 倍精度)
binary_base64 string 可変長オクテット列(valueはデバイスから受け取ったオクテット列をBase64でエンコードした文字列)
string_utf8 string 可変長文字列(valueはデバイスから受け取ったオクテット列をUTF-8でデコードした文字列)