IoT Agent利用マニュアル

本ドキュメントの位置付け

本ドキュメントは、NEC×さくらインターネット データ流通実証実験の実験環境に構成されたFIWARE IoT Agentを利用する方法について記載したものです。

以下の順に手順を説明します。

  1. 事前準備
  2. デバイス情報登録
  3. データ登録

本ドキュメントでは、IoT AgentのAPI実行はcurlコマンドを使った例で説明します。

なお、本機能の利用にあたり、設定情報が必要となります。ご利用の際は、運営事務局にお問い合わせください。設定に必要な情報をご提供いたします。

IoT Agentを利用したデータ登録

事前準備

サービス利用URL

実証環境のIoT Agentを利用するには以下のURLを使用します。

  • デバイス情報操作用URL : https://iotagent-ul-ad.fiware-testbed.jp
  • データ登録用URL : https://iotagent-ul.fiware-testbed.jp

設定情報の入手

事前にサービス管理者より以下の情報を入手してください。

  • APIキー
  • Fiware-Service
  • Fiware-ServicePath
  • EntityType

アクセストークンの取得

IoT Agentを使用するため、アクセストークンを取得することが必要です。 アクセストークンはデバイス情報操作用URLとデータ登録用URLそれぞれで必要です。

curlコマンドを使い、以下を実行してください。

curl [URL] -H "Content-type: application/json" -d "{\"username\": \"[メールアドレス]\", \"password\":\"[IDMパスワード]\"}" 
  • [URL]はデバイス情報操作用URLかデータ登録用URLに置き換えてください。
  • [メールアドレス]と[IDMパスワード]は払い出されているIDMアカウントのものに置き換えてください。

curlコマンドを実行すると、以下のようなメッセージが表示されます。

{"access_token":"aaaaa","token_type":"Bearer","expires_in":3599,"refresh_token":"bbbbb"}

access_tokenのaaaaaの部分が、IoT Agentを使用するために必要なアクセストークンです。 このアクセストークンの内容を控えておきます。 また、アクセストークンの有効期限は取得から1時間となっています。 有効期限を超えた場合はサーバにアクセスできなくなるため、再度アクセストークンを取得しなおしてください。  

デバイス情報操作

デバイス情報登録

curlコマンドを使用してデバイス情報操作用URLに対してデバイス情報を登録する方法を以下に示します。

curl -X POST  https://iotagent-ul-ad.fiware-testbed.jp/iot/devices \
-i \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--header "fiware-service: [Fiware-Service]" \
--header "fiware-servicepath: [Fiware-ServicePath]" \
--header "X-Auth-Token: [accesstoken]" \
-d \
'{
  "devices": [
    {
      "device_id": "[deviceid]",
      "entity_type": "[EntityType]",
      "entity_name": "[EntityName]",
      "endpoint": "http://deviceEndpoint:80",
      "protocol": "UL2.0",
      "attributes": [
        {
           "name": "temperature",
           "type": "float"
        }
      ]
    }
  ]
}'
  • [Fiware-Service], [Fiware-ServicePath], [EntityType]は"設定情報の入手"で入手したものに置き換えてください
  • [accesstoken]は"アクセストークンの取得"でデバイス情報操作用URLから取得したアクセストークンに置き換えてください
  • [deviceid], [EntityName]は任意の英数字列です
  • [deviceid]はデータ登録時に必要なので、登録した内容を控えてください

attributesには登録するデータの値の情報を書いてください。

データ操作

データ登録

curlコマンドを使用してデータ登録する方法を以下に示します。

curl -X POST https://iotagent-ul.fiware-testbed.jp/iot/d?i=[deviceid]\&k=[apikey] \
-i \
--header "Content-Type: text/plain" \
--header "Accept: application/json" \
--header "fiware-service: [Fiware-Service]" \
--header "fiware-servicepath: [Fiware-ServicePath]" \
--header "X-Auth-Token: [accesstoken]" \
-d \
'temperature|20'
  • [apikey][Fiware-Service][Fiware-ServicePath]は"設定情報の入手"で入手したものに置き換えてください
  • [deviceid]は"デバイス情報登録"で登録したものに置き換えてください
  • [accesstoken]は"アクセストークンの取得"でデータ登録用URLから取得したアクセストークンに置き換えてください

関連情報


© NEC Corporation 2019-2021