EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

LwM2M ゲートウェイ ​

LwM2M（Lightweight Machine-to-Machine） は、IoTデバイスおよびマシン間通信向けに設計されたプロトコルです。
処理能力やメモリが限られたデバイスをサポートする軽量なプロトコルです。

EMQX の LwM2M ゲートウェイ は、LwM2M クライアントを受け入れ、それらのイベントやメッセージを MQTT のパブリッシュメッセージに変換します。

現時点の実装では、以下の制限があります：

  • UDP/DTLS ベースのトランスポート。
  • バージョン v1.0.2 のみサポート。v1.1.x および v1.2.x は未対応。
  • LwM2M ブートストラップサービスは含まれていません。

クイックスタート ​

EMQX 5.0 では、LwM2M ゲートウェイはダッシュボードから設定および有効化できます。

また、REST API や設定ファイルからも有効化可能です：

TIP

base.hocon でゲートウェイを設定する場合はノード単位での変更が必要ですが、ダッシュボードや REST API で設定するとクラスター全体に反映されます。

LwM2M ゲートウェイは UDP および DTLS タイプのリスナーのみをサポートしています。
設定可能なパラメータの完全なリストは以下を参照してください：
Gateway Configuration - Listeners

認証 ​

LwM2M プロトコルではクライアントのエンドポイント名のみが与えられ、ユーザー名やパスワードはありません。
そのため、LwM2M ゲートウェイは HTTP サーバー認証 のみをサポートしています。

例えば、REST API または設定ファイルを使って LwM2M ゲートウェイ用の HTTP 認証を作成する例：

メッセージフォーマット ​

LwM2M プロトコルのメッセージモデルは リソースモデルと操作に基づいています。
これは MQTT プロトコルのパブリッシュ／サブスクライブモデルとは全く異なります。
そのため、LwM2M ゲートウェイではこれらのメッセージモデルを互換させるためのメッセージフォーマットを定義しています。

クライアント登録インターフェース ​

Register（登録） ​

Register メッセージは LwM2M クライアントが LwM2M サーバーに自身を登録するために送信します。
クライアントの情報や、エンドポイント名、ライフタイム、LwM2M バージョン、オブジェクト、オブジェクトインスタンスなどの機能情報を含みます。

Register メッセージはクライアントがサーバーとの通信を開始するために送る最初のメッセージです。

Register メッセージは LwM2M ゲートウェイによって以下の MQTT メッセージに変換されます。

トピックのフォーマットは以下の通りです：

{?mountpoint}{?translators.register.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.register.topic} は LwM2M ゲートウェイ設定の translators.register.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.register.topic が up/register の場合、レスポンスメッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/up/register となります。

ペイロードのフォーマットは以下の通りです：

json
{
  "msgType": "register",
  "data": {
    "ep": {?EndpointName},
    "lwm2m": {?Version},
    "lt": {?LifetTime},
    "b": {?Binding},
    "objectList": {?ObjectList}
  }
}

変数：

  • {?EndpointName}: 文字列、LwM2M クライアントのエンドポイント名。
  • {?Version}: 文字列、LwM2M クライアントのプロトコルバージョン。
  • {?LifeTime}: 数値、LwM2M クライアントが要求するライフタイム。
  • {?Binding}: 列挙型、クライアントがサーバーとの通信に対応するバインディングタイプ。以下のいずれか：
    • "U": UDP
    • "UQ": データキューイング付きUDP
  • {?ObjectList}: 配列、LwM2M クライアントがサポートするオブジェクトおよびオブジェクトインスタンスのリスト。

例として、Register メッセージの完全な MQTT ペイロードは以下のようになります：

json
{
  "msgType": "register",
  "data": {
    "objectList": ["/1/0", "/2/0", "/3/0", "/4/0", "/5/0", "/6/0", "/7/0"],
    "lwm2m": "1.0",
    "lt": 300,
    "ep": "testlwm2mclient",
    "b": "U"
  }
}

Update（更新） ​

Update メッセージは LwM2M クライアントが LwM2M サーバーに登録情報を更新するために送信します。
Register メッセージに似ていますが、初回登録後に送信されます。
Update メッセージはクライアントの機能や状態の変更（IPアドレスの変更や LwM2M オブジェクトのデータ更新など）を含みます。
また、クライアントの登録期間を延長し、サーバーにクライアントがまだアクティブであることを知らせる役割もあります。

Update メッセージの送信頻度は Register メッセージで指定されたライフタイム値によって決まります。

Update メッセージは LwM2M ゲートウェイによって以下の MQTT メッセージに変換されます。

トピックのフォーマットは以下の通りです：

{?mountpoint}{?translators.update.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.update.topic} は LwM2M ゲートウェイ設定の translators.update.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.update.topic が up/update の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/up/update となります。

ペイロードのフォーマットは以下の通りです：

json
{
  "msgType": "update",
  "data": {
    "ep": {?EndpointName},
    "lwm2m": {?Version},
    "lt": {?LifetTime},
    "b": {?Binding},
    "objectList": {?ObjectList}
  }
}

Register メッセージと同じ変数です。

例として、Update メッセージの完全な MQTT ペイロードは以下のようになります：

json
{
  "msgType": "update",
  "data": {
    "objectList": ["/7/0"],
    "lwm2m": "1.0",
    "lt": 300,
    "ep": "testlwm2mclient",
    "b": "U"
  }
}

LwM2M デバイス管理およびサービス有効化インターフェース ​

このインターフェースは LwM2M サーバーが登録済み LwM2M クライアントのオブジェクトインスタンスやリソースにアクセスするために使用します。

"Create"、"Read"、"Write"、"Delete"、"Execute"、"Write-Attributes"、"Discover" の各操作を通じてアクセスを提供します。

リソースがサポートする操作はオブジェクトテンプレートファイルを用いたオブジェクト定義で決まります。

LwM2M クライアントにコマンドを送信するには、EMQX に対して固定フォーマットの MQTT メッセージを送信します。
これらのメッセージは LwM2M ゲートウェイによって正しい LwM2M メッセージに変換され、クライアントに送信されます。

コマンドリクエストの トピック は以下の通りです：

{?mountpoint}{?translators.command.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.command.topic} は LwM2M ゲートウェイ設定の translators.command.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.command.topic が dn/cmd の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/dn/cmd となります。

コマンドリクエストの ペイロード フォーマットは以下の通りです：

json
{
  "reqID": {?ReqID},
  "msgType": {?MsgType},
  "data": {?Data}
}

変数：

  • {?ReqID}: 整数、リクエストID。レスポンスとの対応付けに使用。
  • {?MsgType}: 文字列、以下のいずれか：
    • "read": LwM2M Read
    • "discover": LwM2M Discover
    • "write": LwM2M Write
    • "write-attr": LwM2M Write Attributes
    • "execute": LwM2M Execute
    • "create": LwM2M Create
    • "delete": LwM2M Delete
  • {?RequestData}: JSON オブジェクト、{?MsgType} に依存し、次のセクションで説明します。

コマンドレスポンスの トピック は以下の通りです：

{?mountpoint}{?translators.response.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.response.topic} は LwM2M ゲートウェイ設定の translators.response.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.response.topic が up/resp の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/up/resp となります。

コマンドレスポンスの ペイロード フォーマットは以下の通りです：

json
{
  "reqID": {?ReqID},
  "msgType": {?MsgType},
  "data": {?Data}
}

変数：

  • {?ReqID}: 整数、リクエストID。リクエストとの対応付けに使用。
  • {?MsgType}: 文字列、リクエストコマンドと同じ MsgType。
  • {?ResponseData}: JSON オブジェクト、コマンドレスポンスの内容。

Read（読み取り） ​

"Read" 操作はリソース、リソースインスタンスの配列、オブジェクトインスタンス、またはオブジェクトのすべてのオブジェクトインスタンスの値にアクセスするために使用されます。

リクエストコマンドで MsgType が "read" の場合、RequestData の構造は以下の通りです：

json
{
  "path": {?ResourcePath}
}

変数：

  • {?ResourcePath}: 文字列、要求されたリソースパス。以下の3つのシナリオがあります：
    • オブジェクトIDのみ、例：/3。該当オブジェクトのすべてのインスタンスとリソースの値を読み取る。
    • オブジェクトID/インスタンスID、例：/3/0。該当オブジェクトインスタンスのすべてのリソースの値を読み取る。
    • フルパス（オブジェクトID/インスタンスID/リソースID）、例：/3/0/1。特定のリソースの値を読み取る。

例として、Read コマンドの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 1,
  "msgType": "read",
  "data": {
    "path": "/3/0/1"
  }
}

レスポンスでは、ResponseData の構造は以下の通りです：

json
{
  "reqPath": {?ResourcePath},
  "code": {?ResponseCode},
  "codeMsg": {?ResponseMsg},
  "content": {?ReadResponseData}
}

変数：

  • {?ResourcePath}: 文字列、リクエストの path フィールドと同じ。
  • {?ResponseCode}: 文字列、LwM2M ステータスコード（例："2.01", "4.00" など）。
  • {?ResponseMsg}: 文字列、LwM2M レスポンスメッセージ（例："content", "bad_request"）。
  • {?ReadResponseData}: JSON オブジェクト、リクエストの値結果。リソース値の配列。

例として、Read レスポンスの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 1,
  "msgType": "read",
  "data": {
    "reqPath": "/3/0/1",
    "code": "2.05",
    "codeMsg": "content",
    "content": [
      {
        "value": "Lightweight M2M Client",
        "path": "/3/0/1"
      }
    ]
  }
}

Discover（探索） ​

"Discover" 操作はオブジェクト、オブジェクトインスタンス、リソースに付随する LwM2M 属性を探索するために使用します。
この操作は特定のオブジェクトインスタンスにどのリソースがインスタンス化されているかを探索するために使えます。
返されるペイロードは、対象のオブジェクト、オブジェクトインスタンス、リソースごとのアプリケーション/リンク形式の CoRE リンク [RFC6690] のリストです。

リクエストコマンドで MsgType が "discover" の場合、RequestData の構造は以下の通りです：

json
{
  "path": {?ResourcePath}
}

Read メッセージと同じフォーマットです：

  • オブジェクトIDのみ、例：/3。該当オブジェクトのすべてのインスタンス、リソース、属性を探索。
  • オブジェクトID/インスタンスID、例：/3/0。該当オブジェクトインスタンスのすべてのリソースと属性を探索。
  • フルパス（オブジェクトID/インスタンスID/リソースID）、例：/3/0/1。特定のリソースのすべての属性を探索。

例として、Discover コマンドの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 2,
  "msgType": "discover",
  "data": {
    "path": "/3/0"
  }
}

レスポンスでは、ResponseData の構造は以下の通りです：

json
{
  "reqPath": {?ResourcePath},
  "code": {?ResponseCode},
  "codeMsg": {?ResponseMsg},
  "content": {?DiscoverResponseData}
}

Read レスポンスと同じ変数ですが、content フィールドはリソースと属性の配列です。

例として、Discover レスポンスの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 123,
  "msgType": "discover",
  "data": {
    "reqPath": "/3/0",
    "code": "2.05",
    "codeMsg": "content",
    "content": [
      "</3/0>;pmin=10",
      "</3/0/0>", "</3/0/1>", "</3/0/2>", "</3/0/3>", "</3/0/4>", "</3/0/5>",
      "</3/0/6>", "</3/0/7>", "</3/0/8>", "</3/0/9>", "</3/0/10>", "</3/0/11>",
      "</3/0/12>", "</3/0/13>", "</3/0/14>", "</3/0/15>", "</3/0/16>"
    ]
  }
}

Write（書き込み） ​

"Write" 操作はリソースの値、リソースインスタンス配列の値、またはオブジェクトインスタンスの複数リソースの値を変更するために使用します。

リクエストコマンドで MsgType が "write" の場合、RequestData は2つの構造が考えられます。

単一リソースに値を書き込む場合：

json
{
    "path": {?ResourcePath},
    "type": {?ValueType},
    "value": {?Value}
}
  • {?ResourcePath}: 文字列、完全なリソースパス（例：31024/11/1）。
  • {?ValueType}: 文字列、"Time", "String", "Integer", "Float", "Boolean", "Opaque", "Objlnk" のいずれか。
  • {?Value}: リソースの値、type に依存。

例として、Write コマンドの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 3,
  "msgType": "write",
  "data": {
    "path": "/31024/11/1",
    "type": "String",
    "value": "write_an_example_value"
  }
}

複数リソースに書き込む場合：

json
{
  "basePath": {?BasePath},
  "content": [
    {
      "path": {?ResourcePath},
      "type": {?ValueType},
      "value": {?Value}
    }
  ]
}

フルパスは {?BasePath} と "{ResourcePath}" の連結です。

例として、Write コマンドの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 3,
  "msgType": "write",
  "data": {
    "basePath": "/31024/11/",
    "content": [
      {
        "path": "1",
        "type": "String",
        "value": "write_the_1st_value"
      },
      {
        "path": "2",
        "type": "String",
        "value": "write_the_2nd_value"
      }
    ]
  }
}

Write-Attributes（属性書き込み） ​

LwM2M 1.0 では、"Write-Attributes" 操作で変更可能なのは <NOTIFICATION> クラスの属性のみです。

この操作は複数の属性を同時に変更できます。

リクエストコマンドで MsgType が "write-attr" の場合、RequestData の構造は以下の通りです：

json
{
  "path": {?ResourcePath},
  "pmin": {?PeriodMin},
  "pmax": {?PeriodMax},
  "gt": {?GreaterThan},
  "lt": {?LessThan},
  "st": {?Step}
}

変数：

  • {?PeriodMin}: 数値、通知の最小周期。
  • {?PeriodMax}: 数値、通知の最大周期。
  • {?GreaterThan}: 数値、リソース値がこの値より大きい場合に通知。
  • {?LessThan}: 数値、リソース値がこの値より小さい場合に通知。
  • {?Step}: 数値、リソース値の変化がこの値を超えた場合に通知。

Execute（実行） ​

"Execute" 操作は LwM2M サーバーがアクションを開始するために使用し、個別のリソースに対してのみ実行可能です。

リクエストコマンドで MsgType が "execute" の場合、RequestData の構造は以下の通りです：

json
{
  "path": {?ResourcePath},
  "args": {?Arguments}
}

変数：

  • {?Arguments}: 文字列、LwM2M Execute の引数。

Create（作成） ​

"Create" 操作は LwM2M サーバーが LwM2M クライアント内にオブジェクトインスタンスを作成するために使用します。
"Create" 操作はオブジェクトをターゲットにしなければなりません。

リクエストコマンドで MsgType が "create" の場合、RequestData の構造は以下の通りです：

json
{
  "basePath": "/{?ObjectID}",
  "content": [
    {
      "path": {?ResourcePath},
      "type": {?ValueType},
      "value": {?Value}
    }
  ]
}

変数：

  • {?ObjectID}: 整数、LwM2M オブジェクトID。

Delete（削除） ​

"Delete" 操作は LwM2M サーバーが LwM2M クライアント内のオブジェクトインスタンスを削除するために使用します。

リクエストコマンドで MsgType が "delete" の場合、RequestData の構造は以下の通りです：

json
{
  "path": "{?ObjectID}/{?InstanceID}"
}

変数：

  • {?InstanceID}: 整数、LwM2M オブジェクトインスタンスID。

情報報告インターフェース ​

このインターフェースは LwM2M サーバーが登録済み LwM2M クライアントのリソースの変更を監視し、新しい値が利用可能になると通知を受け取るために使用します。
この監視関係はオブザーブ操作を LwM2M クライアントのオブジェクト、オブジェクトインスタンス、またはリソースに送信することで開始されます。
監視はキャンセルオブザーブ操作が行われると終了します。

Observe（監視）および Cancel Observation（監視解除） ​

監視および監視解除リクエストの トピック は以下の通りです：

{?mountpoint}{?translators.command.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.command.topic} は LwM2M ゲートウェイ設定の translators.command.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.command.topic が dn/cmd の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/dn/cmd となります。

監視および監視解除リクエストの ペイロード フォーマットは以下の通りです：

json
{
  "reqID": {?ReqID},
  "msgType": {?MsgType},
  "data":
    {
      "path": {?ResourcePath}
    }
}

変数：

  • {?ReqID}: 整数、リクエストID。リクエスト内の {?ReqID}。
  • {?MsgType}: 文字列、以下のいずれか：
    • "observe": LwM2M Observe
    • "cancel-observe": LwM2M Cancel Observe
  • {?ResourcePath}: 文字列、監視または監視解除対象の LwM2M リソース。完全なリソースパスのみサポート（例：/3/0/1）。

例として、Observe コマンドの完全な MQTT ペイロードは以下の通りです：

json
{
  "reqID": 10,
  "msgType": "observe",
  "data": {
    "path": "/31024/0/1"
  }
}

Observe レスポンスの トピック は以下の通りです：

{?mountpoint}{?translators.response.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.response.topic} は LwM2M ゲートウェイ設定の translators.response.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.response.topic が up/resp の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/up/resp となります。

Observe レスポンスの ペイロード フォーマットは以下の通りです：

json
{
  "reqID": {?ReqID},
  "msgType": {?MsgType},
  "data": {
    "reqPath": {?RequestPath},
    "code": {?ResponseCode},
    "codeMsg": {?ResponseMsg},
    "content": [
      {
        "path": {?ResourcePath},
        "value": {?Value}
      }
    ]
  }
}

変数：

  • {?ReqID}: 整数、リクエストID。リクエストとの対応付けに使用。
  • {?MsgType}: 文字列、リクエストコマンドと同じ MsgType。
  • {?RequestPath}: 文字列、リクエストの path フィールドと同じ。
  • {?ResponseCode}: 文字列、LwM2M ステータスコード（例："2.01", "4.00" など）。
  • {?ResponseMsg}: 文字列、LwM2M レスポンスメッセージ（例："content", "bad_request"）。
  • {?ResourcePath}: 文字列、要求された完全なリソースパス（例：31024/11/1）。
  • {?Value}: 監視対象リソースの現在の値。

Notify（通知） ​

"Notify" 操作は LwM2M クライアントから LwM2M サーバーへ、オブジェクトインスタンスやリソースの有効な監視中に送信されます。
この操作はオブジェクトインスタンスやリソースの新しい値を含みます。

LwM2M クライアントからの通知は MQTT メッセージに変換されます。

通知メッセージの トピック は以下の通りです：

json
{?mountpoint}{?translators.notify.topic}

変数：

  • {?mountpoint} は LwM2M ゲートウェイ設定の mountpoint オプションの値です。
  • {?translators.notify.topic} は LwM2M ゲートウェイ設定の translators.notify.topic オプションの値です。

例えば、mountpoint が lwm2m/${endpoint_name}/ に設定され、translators.notify.topic が up/notify の場合、メッセージのトピックは lwm2m/<実際のクライアントエンドポイント名>/up/notify となります。

通知メッセージの ペイロード フォーマットは以下の通りです：

json
{
  "reqID": {?ReqID},
  "msgType": "notify",
  "seqNum": {?ObserveSeqNum},
  "data": {
    "code": {?ResponseCode},
    "codeMsg": {?ResponseMsg},
    "reqPath": {?RequestPath},
    "content": [
      {
        "path": {?ResourcePath},
        "value": {?Value}
      }
    ]
  }
}

変数：

  • {?ReqID}: 整数、リクエストID。リクエストとの対応付けに使用。
  • {?ObserveSeqNum}: 数値、CoAP メッセージの "Observe" オプションの値。
  • {?ResponseCode}: 文字列、LwM2M ステータスコード（例："2.01", "4.00" など）。
  • {?ResponseMsg}: 文字列、LwM2M レスポンスメッセージ（例："content", "bad_request"）。
  • {?RequestPath}: 文字列、リクエストの path フィールドと同じ。
  • {?ResourcePath}: 文字列、要求された完全なリソースパス（例：31024/11/1）。
  • {?Value}: リソースの最新値。

ユーザーインターフェース ​

クライアントライブラリ ​