Thing 管理
Kii Cloud は Thing を管理するために以下の機能を提供します。
Thing の登録
Thing を Kii Cloud で使用するにはまずこれを登録する必要があります。登録を行うことで Kii Cloud はこの Thing を認識します。
登録方法は SDK の使用方法によって異なります。
Thing-IF SDK と Kii Cloud SDK for Thing の機能を併用する場合
Thing とオーナー に示したとおり、このケースでは、Thing-IF SDK の初期登録の API で Thing の登録とオーナーの関連づけを同時に行います。
Thing-IF SDK の初期登録処理では、下記に示す既定フィールドの一部のみをサポートしています。
Kii Cloud SDK for Thing の機能だけを使用する場合
このケースでは、Kii Cloud SDK for Thing が提供している Thing の登録用 API を呼び出して、Thing の登録処理を行います。以下に API の機能を示します。
Thing SDK Embedded の Thing の登録処理では、下記に示す既定フィールドの一部のみをサポートしています。
Thing を登録する際には、属性情報を Thing 情報のフィールド値として設定することができます。以下に設定可能な既定フィールドをまとめます。
フィールド名 | フィールド値の説明 | 必須項目か? |
---|---|---|
_vendorThingID | Thing のベンダーが割り当てた ID。アプリケーション内で一意であれば、200 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | ◯ |
_password | Thing のパスワード。このフィールド値は後で変更できません。 | ◯ |
_thingType | Thing のタイプ。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_vendor | Thing のベンダー名。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_firmwareVersion | Thing のファームウェアバージョン。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_productName | Thing のプロダクト名。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_lot | Thing のロット番号。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_stringField1 から _stringField5 | 開発者が自由に設定可能な 5 つの文字列フィールド(例:インデックス用テキスト入力)。100 文字までの英数字、ハイフン、アンダースコアおよびピリオドが利用可能 | - |
_numberField1 から _numberField5 | 開発者が自由に設定可能な 5 つの数字フィールド(例:インデックス用数字入力)。ロング型の数値が利用可能 | - |
上記の既定フィールドに加え、以下の条件に沿ったものであれば任意の名前を持つカスタムフィールドが追加可能です。
- カスタムフィールド(フィールド名+値)を JSON 形式に変換した後のサイズが 63 KB を超えない。
- フィールド名の先頭が "_"(アンダースコア)ではない。
カスタムフィールドは、既定フィールドと異なりインデックスの対象とはなりません(カスタムフィールドによる検索はできません)。カスタムフィールドの値は、ネストした JSON や配列等、どのような JSON 値であっても構いません。
Thing の検索を行う API は提供していません。Thing の検索は開発者ポータル上で行えます。
Thing が登録されると、Kii Cloud は以下を行います。
- この Thing を識別するための ThingID を発行。
- この Thing 用のアクセストークンを発行(オプショナル)。
- この Thing 用のスコープを作成。
Thing を実際に登録する方法は以下をご覧ください。
クライアント SDK REST
Thing の登録確認
Thing がすでに Kii Cloud に登録済みかどうかは誰でも確認できます。
Thing の登録確認を行う方法は以下をご覧ください。
REST
アクセストークンの取得
ユーザー名とパスワードを引数にユーザーのアクセストークンを取得できるように、vendorThingID とパスワードを引数に Thing のアクセストークンが取得できます。
アクセストークンを実際に取得する方法は以下をご覧ください。
REST
Thing 情報の操作
Thing、Thing オーナー、および管理者は Thing 情報を取得できます。また Thing 情報の更新ができます。
Thing 情報を実際に操作する方法は以下をご覧ください。
クライアント SDK REST
Thing 状態の操作(有効化/無効化)
Thing オーナーと管理者は Thing を無効化できます。無効化すると Thing は「ロック」状態になり、以後スコープ内のデータ(Bucket および Object)にアクセスできなくなります。Thing が無効化されてもデータ自体は Kii Cloud に残り、Thing オーナーと管理者はデータにアクセス可能です。この機能は、たとえば Thing が盗難にあったり紛失した場合において、一時的に Thing の利用を停止したい場合などに有効です。
もちろん Thing オーナーと管理者は、後ほど Thing を有効化できます。有効化すると Thing は「ロック解除」状態になり、以後スコープ内のデータにアクセス可能となります。
Thing を実際に無効化/有効化する方法は以下をご覧ください。
クライアント SDK REST
Thing の登録解除
Thing、Thing オーナー、および管理者は Thing を登録解除できます。登録が解除されると、スコープ内のすべてのデータ(Bucket や Object)が Kii Cloud より削除されます。
Thing を実際に登録解除する方法は以下をご覧ください。
クライアント SDK REST
Thing パスワードの強制変更
アプリケーション管理者は、Thing パスワードを強制変更できます。この機能は、Thing のパスワード漏洩が発生したケースへの対応などを想定しています。
Thing パスワードを強制変更する方法は以下をご覧ください。
REST