LwM2M ゲートウェイ
LwM2M（Lightweight Machine-to-Machine）は、IoTデバイスおよびマシン間通信向けに設計されたプロトコルです。
処理能力やメモリが限られたデバイスをサポートする軽量プロトコルです。
EMQXのLwM2Mゲートウェイは、LwM2Mクライアントを受け入れ、そのイベントやメッセージをMQTTのパブリッシュメッセージに変換します。
現状の実装には以下の制限があります：
- UDP/DTLSベースのトランスポートのみ対応。
- v1.0.2のみサポート。v1.1.xおよびv1.2.xは未対応。
- LwM2MのBootstrapサービスは含まれていません。
クイックスタート
EMQX 5.0では、LwM2Mゲートウェイはダッシュボードから設定・有効化できます。
また、HTTP APIや設定ファイルからも有効化可能です：
TIP
base.hoconでゲートウェイを設定するとノードごとに変更が必要ですが、ダッシュボードやHTTP API経由で設定するとクラスター全体に反映されます。
LwM2MゲートウェイはUDPおよびDTLSタイプのリスナーのみサポートしています。
設定可能なパラメータの完全な一覧は以下を参照してください：Gateway Configuration - Listeners
認証
LwM2MプロトコルではクライアントのEndpoint Nameのみが与えられ、UsernameやPasswordはありません。
そのため、LwM2MゲートウェイはHTTPサーバー認証のみサポートしています。
例えば、HTTP 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 となります。
ペイロードの形式は以下の通りです：
{
"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ペイロードは以下のようになります：
{
"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メッセージに似ていますが、初回登録後に送信されます。
クライアントのIPアドレス変更やLwM2Mオブジェクトでモデル化されたデータの更新など、クライアントの状態や機能の変更を含みます。
Updateメッセージはクライアントの登録期間を延長し、クライアントがまだ利用可能かつアクティブであることをサーバーに知らせる役割を持ちます。
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 となります。
ペイロードの形式は以下の通りです：
{
"msgType": "update",
"data": {
"ep": {?EndpointName},
"lwm2m": {?Version},
"lt": {?LifetTime},
"b": {?Binding},
"objectList": {?ObjectList}
}
}Registerメッセージと同じ変数です。
例として、Updateメッセージの完全なMQTTペイロードは以下のようになります：
{
"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 となります。
コマンドリクエストのペイロードの形式は以下の通りです：
{
"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 となります。
コマンドレスポンスのペイロードの形式は以下の通りです：
{
"reqID": {?ReqID},
"msgType": {?MsgType},
"data": {?Data}
}変数：
{?ReqID}：整数、リクエストID。リクエストとの対応付けに使用。{?MsgType}：文字列、リクエストコマンドと同じMsgType。{?ResponseData}：JSONオブジェクト、コマンドレスポンスの内容。
Read（読み取り）
"Read"操作はリソース、リソースインスタンスの配列、オブジェクトインスタンス、またはオブジェクトの全オブジェクトインスタンスの値にアクセスするために使用します。
リクエストコマンドでMsgTypeが "read" の場合、RequestDataの構造は以下の通りです：
{
"path": {?ResourcePath}
}変数：
{?ResourcePath}：文字列、要求されたリソースパスで、以下の3つのシナリオがあります：- オブジェクトIDのみ、例：
/3。該当オブジェクトの全インスタンスとリソースの値を読み取る。 - オブジェクトID/インスタンスID、例：
/3/0。該当オブジェクトインスタンスの全リソースの値を読み取る。 - フルパス（
{ObjectID}/{InstanceID}/{ResourceID}）、例：/3/0/1。特定リソースの値を読み取る。
- オブジェクトIDのみ、例：
例として、Readコマンドの完全なMQTTペイロードは以下のようになります：
{
"reqID": 1,
"msgType": "read",
"data": {
"path": "/3/0/1"
}
}レスポンスでは、ResponseDataの構造は以下の通りです：
{
"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ペイロードは以下のようになります：
{
"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の構造は以下の通りです：
{
"path": {?ResourcePath}
}"Read"メッセージと同じ形式です：
- オブジェクトIDのみ、例：
/3。該当オブジェクトの全インスタンス、リソース、属性を探索。 - オブジェクトID/インスタンスID、例：
/3/0。該当オブジェクトインスタンスの全リソース、属性を探索。 - フルパス（
{ObjectID}/{InstanceID}/{ResourceID}）、例：/3/0/1。特定リソースの全属性を探索。
例として、Discoverコマンドの完全なMQTTペイロードは以下のようになります：
{
"reqID": 2,
"msgType": "discover",
"data": {
"path": "/3/0"
}
}レスポンスでは、ResponseDataの構造は以下の通りです：
{
"reqPath": {?ResourcePath},
"code": {?ResponseCode},
"codeMsg": {?ResponseMsg},
"content": {?DiscoverResponseData}
}"Read"レスポンスと同じ変数ですが、contentフィールドはリソースと属性の配列です。
例として、Discoverレスポンスの完全なMQTTペイロードは以下のようになります：
{
"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つの構造が考えられます。
単一リソースに値を書き込む場合：
{
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}{?ResourcePath}：文字列、要求された完全なリソースパス、例：31024/11/1。{?ValueType}：文字列、"Time"、"String"、"Integer"、"Float"、"Boolean"、"Opaque"、"Objlnk"のいずれか。{?Value}：リソースの値、typeに依存。
例として、Writeコマンドの完全なMQTTペイロードは以下のようになります：
{
"reqID": 3,
"msgType": "write",
"data": {
"path": "/31024/11/1",
"type": "String",
"value": "write_an_example_value"
}
}複数リソースに書き込む場合：
{
"basePath": {?BasePath},
"content": [
{
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}
]
}完全なパスは {?BasePath} と "{ResourcePath}" の連結です。
例として、Writeコマンドの完全なMQTTペイロードは以下のようになります：
{
"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の構造は以下の通りです：
{
"path": {?ResourcePath},
"pmin": {?PeriodMin},
"pmax": {?PeriodMax},
"gt": {?GreaterThan},
"lt": {?LessThan},
"st": {?Step}
}変数：
{?PeriodMin}：数値、通知の最小周期。{?PeriodMax}：数値、通知の最大周期。{?GreaterThan}：数値、リソース値がこの値より大きいと通知がトリガーされる。{?LessThan}：数値、リソース値がこの値より小さいと通知がトリガーされる。{?Step}：数値、リソース値の変化がこの値を超えた場合に通知がトリガーされる。
Execute（実行）
"Execute"操作はLwM2Mサーバーが何らかのアクションを開始するために使用し、個別のリソースに対してのみ実行可能です。
リクエストコマンドでMsgTypeが "execute" の場合、RequestDataの構造は以下の通りです：
{
"path": {?ResourcePath},
"args": {?Arguments}
}変数：
{?Arguments}：文字列、LwM2MのExecute引数。
Create（作成）
"Create"操作はLwM2MサーバーがLwM2Mクライアント内にオブジェクトインスタンスを作成するために使用します。
"Create"操作はオブジェクトを対象としなければなりません。
リクエストコマンドでMsgTypeが "create" の場合、RequestDataの構造は以下の通りです：
{
"basePath": "/{?ObjectID}",
"content": [
{
"path": {?ResourcePath},
"type": {?ValueType},
"value": {?Value}
}
]
}変数：
{?ObjectID}：整数、LwM2MオブジェクトID。
Delete（削除）
"Delete"操作はLwM2MサーバーがLwM2Mクライアント内のオブジェクトインスタンスを削除するために使用します。
リクエストコマンドでMsgTypeが "delete" の場合、RequestDataの構造は以下の通りです：
{
"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 となります。
監視および監視解除リクエストのペイロードの形式は以下の通りです：
{
"reqID": {?ReqID},
"msgType": {?MsgType},
"data":
{
"path": {?ResourcePath}
}
}変数：
{?ReqID}：整数、リクエストID。リクエストのID。{?MsgType}：文字列、以下のいずれか："observe"：LwM2M Observe"cancel-observe"：LwM2M Cancel Observe
{?ResourcePath}：文字列、監視または監視解除対象のLwM2Mリソース。完全なリソースパスのみサポート、例：/3/0/1。
例として、Observeコマンドの完全なMQTTペイロードは以下のようになります：
{
"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レスポンスのペイロードの形式は以下の通りです：
{
"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メッセージに変換されます。
通知メッセージのトピックは以下の通りです：
{?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 となります。
通知メッセージのペイロードの形式は以下の通りです：
{
"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}：リソースの最新値。
ユーザーインターフェース
- 詳細な設定オプション：Gateway configuration - lwm2m (Opensource) および Gateway configuration - lwm2m (Enterprise)。
- 詳細なHTTP API説明：HTTP API - Gateway