Skip to content

Connection Profile

Jump to bottom
TakayukiHoshi1984 edited this page Mar 27, 2017 · 1 revision

目次

API 機能概要
WIFI Connection API スマートデバイスのWIFI機能有効状態(ON/OFF)を取得する。
WIFI Connection API スマートデバイスのWIFI機能有効状態を有効に設定する。
WIFI Connection API スマートデバイスのWIFI機能有効状態を無効に設定する。
WIFI Connection Status Change Event API スマートデバイスのWIFI機能有効状態(ON/OFF)の変化通知を受領する。WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Bluetooth Connection API スマートデバイスのBluetooth機能有効状態(ON/OFF)を取得する。
Bluetooth Connection API スマートデバイスのBluetooth機能有効状態を有効に設定する。
Bluetooth Connection API スマートデバイスのBluetooth機能有効状態を無効に設定する。
Bluetooth Connection Status Change Event API スマートデバイスのBluetooth機能有効状態(ON/OFF)の変化通知を受領する。Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
Bluetooth Discoverable Status API スマートデバイスのBluetooth検索可能状態を有効に設定する。
Bluetooth Discoverable Status API スマートデバイスのBluetooth検索可能状態を無効に設定する。
NFC Connection API スマートデバイスのNFC機能有効状態(ON/OFF)を取得する。
NFC Connection API スマートデバイスのNFC機能有効状態を有効に設定する。
NFC Connection API スマートデバイスのNFC機能有効状態を無効に設定する。
NFC Connection Status Change Event API スマートデバイスのNFC機能有効状態(ON/OFF)の変化通知を受領する。NFC機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。
BLE Connection API スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。
BLE Connection API スマートデバイスのBLE機能有効状態を有効に設定する。
BLE Connection API スマートデバイスのBLE機能有効状態を無効に設定する。
BLE Connection Status Change Event API スマートデバイスのBLE機能有効状態(ON/OFF)の変化通知を受領する。BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

機能概要

スマートデバイスとのネットワーク接続情報を提供するAPI

参考API

無し

WIFI Connection API GET

インターフェース名称 Version 種別
WIFI Connection API 2.0.0 同期I/F

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/connection/wifi
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
WIFI機能有効状態 enable boolean - WIFI機能有効状態。
ON : true
OFF : false

リクエストサンプル

GET http://localhost:4035/gotpai/connection/wifi?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0,
    "enable": true
}

WIFI Connection API PUT

インターフェース名称 Version 種別
WIFI Connection API 2.0.0 同期I/F

概要

スマートデバイスのWIFI機能有効状態を有効に設定する。

リクエスト

HTTPメソッド URI
PUT /gotapi/connection/wifi
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/connection/wifi
PUTデータ
serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

WIFI Connection API DELETE

インターフェース名称 Version 種別
WIFI Connection API 2.0.0 同期I/F

概要

スマートデバイスのWIFI機能有効状態を無効に設定する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/connection/wifi
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/connection/wifi?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

WIFI Connection Status Change Event API

インターフェース名称 Version 種別
WIFI Connection Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化通知を受領する。 WIFI機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

イベント情報

イベント名 Content-Type
/gotapi/connection/onWifiChange application/json

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト ConnectionStatus object - 接続状態データ(object)
WIFI機能有効状態 enable boolean - WIFI機能有効状態
ON: true
OFF: false

メッセージ

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "serviceId":  "device1.localhost.deviceConnection.org",
    "api" : "gotapi",
    "profile" : "Connection",
    "attribute" : "onWifiChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "ConnectionStatus" : {
        "enable": true
    }
}

BluetoothConnection API GET

インターフェース名称 Version 種別
Bluetooth Connection API 2.0.0 同期I/F

概要

スマートデバイスのBluetooth機能有効状態(ON/OFF)を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/connection/bluetooth
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
Bluetooth機能有効状態 enable boolean - Bluetooth機能有効状態
ON: true
OFF: false

リクエストサンプル

GET http://localhost:4035/gotapi/connection/bluetooth?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0,
    "enable": true
}

BluetoothConnection API PUT

インターフェース名称 Version 種別
Bluetooth Connection API 2.0.0 同期I/F

概要

スマートデバイスのBluetooth機能有効状態を有効に設定する。

リクエスト

HTTPメソッド URI
PUT /gotapi/connection/bluetooth
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/connection/bluetooth
PUTデータ
serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

BluetoothConnection API DELETE

インターフェース名称 Version 種別
Bluetooth Connection API 2.0.0 同期I/F

概要

スマートデバイスのBluetooth機能有効状態を無効に設定する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/connection/bluetooth
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/connection/bluetooth?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

Bluetooth Connection Status Change Event API

インターフェース名称 Version 種別
Bluetooth Connection Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化通知を受領する。 Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

イベント情報

イベント名 Content-Type
/gotapi/connection/onBluetoothChange application/json

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト ConnectionStatus object - Bluetooth機能有効状態データ(object)
属性値 enable boolean - Bluetooth機能有効状態
ON: true
OFF: false

メッセージサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "serviceId":  "device1.localhost.deviceConnection.org",
	"api" : "gotapi",
    "profile" : "Connection",
    "attribute" : "onBluetoothChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "ConnectionStatus" : {
        "enable": true
    }
}

Bluetooth Discoverable API PUT

インターフェース名称 Version 種別
Bluetooth Discoverable Status API 2.0.0 同期I/F

概要

スマートデバイスのBluetooth検索可能状態を有効に設定する。

リクエスト

HTTPメソッド URI
PUT /gotapi/connection/bluetooth/discoverable
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotpai/connection/bluetooth/discoverable
PUTデータ
serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

Bluetooth Discoverable API DELETE

インターフェース名称 Version 種別
Bluetooth Discoverable Status API 2.0.0 同期I/F

概要

スマートデバイスのBluetooth検索可能状態を無効に設定する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/connection/bluetooth/discoverable
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/connection/bluetooth/discoverable?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

NFC Connection API GET

インターフェース名称 Version 種別
NFC Connection API 2.0.0 同期I/F

概要

スマートデバイスのNFC機能有効状態(ON/OFF)を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/connection/nfc
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
NFC機能有効状態 enable boolean - NFC機能有効状態。
ON : true
OFF : false

リクエストサンプル

GET http://localhost:4035/gotpai/connection/nfc?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0,
    "enable": true
}

NFC Connection API PUT

インターフェース名称 Version 種別
NFC Connection API 2.0.0 同期I/F

概要

スマートデバイスのNFC機能有効状態を有効に設定する。

リクエスト

HTTPメソッド URI
PUT /gotapi/connection/nfc
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/connection/nfc
PUTデータ
serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

NFC Connection API DELETE

インターフェース名称 Version 種別
NFC Connection API 2.0.0 同期I/F

概要

スマートデバイスのNFC機能有効状態を無効に設定する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/connection/nfc
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/connection/bluetooth/discoverable?serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

NFC Connection Status Change Event API

インターフェース名称 Version 種別
NFC Connection Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのWIFI機能有効状態(ON/OFF)の変化通知を受領する。 Bluetooth機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

イベント情報

イベント名 Content-Type
/gotapi/connection/onNfcChange application/json

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト ConnectionStatus object - NFC機能有効状態データ(object)
NFC機能有効状態 enable boolean - NFC機能有効状態。
ON: true
OFF: false

メッセージサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "serviceId":  "device1.localhost.deviceConnection.org",
	"api" : "gotapi",
    "profile" : "Connection",
    "attribute" : "onNfcChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "ConnectionStatus" : {
        "enable": true
    }
}

BLE Connection API GET

インターフェース名称 Version 種別
BLE Connection API 2.0.0 同期I/F

概要

スマートデバイスのBLE機能有効状態(ON/OFF)を取得する。

リクエスト

HTTPメソッド URI
GET /gotapi/connection/ble
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答
BLE機能有効状態 enable boolean - BLE機能有効状態。
ON : true
OFF : false

リクエストサンプル

GET http://localhost:4035/gotapi/connection/ble?serviceId=localhost.deviceConnection.org&accessToken=xxxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0,
    "enable": true
}

BLE Connection API PUT

インターフェース名称 Version 種別
BLE Connection API 2.0.0 同期I/F

概要

スマートデバイスのBLE機能有効状態を有効に設定する。

リクエスト

HTTPメソッド URI
PUT /gotapi/connection/ble
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

PUT http://localhost:4035/gotapi/connection/ble
PUTデータ
serviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

BLE Connection API DELETE

インターフェース名称 Version 種別
BLE Connection API 2.0.0 同期I/F

概要

スマートデバイスのBLE機能有効状態を有効に設定する。

リクエスト

HTTPメソッド URI
DELETE /gotapi/connection/ble
論理名 物理名 データ型 省略 設定値
サービスID serviceId string - 取得対象スマートデバイス

レスポンス

Content-Type 形式 HTTPステータス
application/json JSON 200
論理名 物理名 データ型 省略 設定値
処理結果 result number - 0:正常応答
0以外:異常応答

リクエストサンプル

DELETE http://localhost:4035/gotapi/connection/ble?deviceId=localhost.deviceConnection.org&accessToken=xxxxx

レスポンスサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "result": 0
}

BLE Connection Status Change Event API

インターフェース名称 Version 種別
BLE Connection Status Change Event API 2.0.0 非同期I/F(イベントI/F)

概要

スマートデバイスのBLE機能有効状態(ON/OFF)の変化通知を受領する。 BLE機能有効状態がONからOFFまたはOFFからONに変化したときに通知される。

イベント情報

イベント名 Content-Type
/gotapi/connection/onBleChange application/json

メッセージ

論理名 物理名 データ型 省略 設定値
オブジェクト ConnectionStatus object - BLE機能有効状態データ(object)
属性値 enable boolean - BLE機能有効状態。
ON: true
OFF: false

メッセージサンプル

{
    "product":"Device Connection Manager",
    "version":"x.x",
    "serviceId":  "device1.localhost.deviceConnection.org",
	"api" : "gotapi",
    "profile" : "Connection",
    "attribute" : "onBleChange",
    "sessionKey" : "0a93ac0aade4e046ed63eb24d1172f5f35c88ca60daa901547c28d5827cb418a5de1d7c5f9e62405",
    "ConnectionStatus" : {
        "enable": true
    }
}
  1. アプリケーション開発マニュアル
  2. 単体テスト動作マニュアル

Clone this wiki locally