chrome.bluetoothLowEnergy

説明

chrome.bluetoothLowEnergy API は、Generic Attribute Profile（GATT）を使用して Bluetooth Smart（Low Energy）デバイスと通信するために使用します。

マニフェスト

この API を使用するには、次のキーをマニフェストで宣言する必要があります。

"bluetooth"

型

Advertisement

Chrome 47 以降

プロパティ

  • manufacturerData

    ManufacturerData[] 省略可

    広告データの [メーカー固有のデータ] フィールドに含めるメーカー固有のデータのリストです。

  • serviceData

    ServiceData[] 省略可

    広告データの「サービスデータ」フィールドに含めるサービスデータのリスト。

  • serviceUuids

    string[] 省略可

    広告データの [Service UUIDs] フィールドに含める UUID のリスト。これらの UUID には、16 ビット、32 ビット、または 128 形式を使用できます。

  • solicitUuids

    string[] 省略可

    広告データの [Solicit UUIDs] フィールドに含める UUID のリスト。これらの UUID には、16 ビット、32 ビット、または 128 形式を使用できます。

  • タイプ

    AdvertisementType

    広告のタイプ。

AdvertisementType

Chrome 47 以降

広告のタイプ。「broadcast」が選択された場合、送信されるアドバタイズメント タイプは ADV_NONCONN_IND となり、デバイスはランダムな MAC アドレスでブロードキャストします。「peripheral」に設定されている場合、アドバタイズメント タイプは ADV_IND または ADV_SCAN_IND になり、デバイスは実際の Bluetooth アダプターの MAC アドレスを使用してブロードキャストします。

Enum

"broadcast"

"peripheral"

Characteristic

プロパティ

  • instanceId

    string（省略可）

    この特性に割り当てられた識別子を返します。インスタンス ID を使用して、同じ UUID を持つ周辺機器の特性を区別したり、特性識別子を受け取る関数呼び出しを行ったりできます。このインスタンスがリモート特性を表す場合は存在します。

  • プロパティ

    CharacteristicProperty[]

    この特性のプロパティ。

  • サービス

    サービス 省略可

    この特性が属する GATT サービス。

  • uuid

    文字列

    特徴の UUID（例: 00002a37-0000-1000-8000-00805f9b34fb）。

  • value

    ArrayBuffer 省略可

    現在キャッシュされている特性値。この値は、特性の値が通知または表示によって読み取られるか更新されると更新されます。

CharacteristicProperty

特性の使用可能なプロパティを表す値。特徴的な権限は、これらのプロパティから推測されます。個々のプロパティの意味については、Bluetooth 4.x の仕様をご覧ください。

Enum

"broadcast"

"read"

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

プロパティ

  • 永続

    boolean

    アプリのイベントページがアンロードされたときにデバイスへの接続が開いたままかどうかを示すフラグ（アプリのライフサイクルを管理するを参照）。デフォルト値は false. です。

Descriptor

プロパティ

  • 特性

    特性 （省略可）

    この記述子が属する GATT の特性。

  • instanceId

    string（省略可）

    この記述子に割り当てられた識別子を返します。インスタンス ID を使用して、同じ UUID を持つ周辺機器からの記述子を区別し、記述子識別子を受け取る関数呼び出しを行います。このインスタンスがリモート特性を表す場合は存在します。

  • Chrome 52 以降

    この記述子の権限。

  • uuid

    文字列

    特性記述子の UUID（例: 00002902-0000-1000-8000-00805f9b34fb）。

  • value

    ArrayBuffer 省略可

    現在キャッシュされている記述子の値。この値は、記述子の値が読み取られると更新されます。

DescriptorPermission

Chrome 52 以降

記述子に対して可能な権限を表す値。個々の権限の意味については、Bluetooth 4.x の仕様をご覧ください。

Enum

"read"

"encryptedRead"

"encryptedWrite"

Device

Chrome 52 以降

プロパティ

  • address

    文字列

    デバイスのアドレス（「XX:XX:XX:XX:XX:XX」の形式）。

  • deviceClass

    number（省略可）

    デバイスのクラス。http://www.bluetooth.org/en-us/specification/added-numbers/baseband で定義されたビット フィールド。

  • name

    string（省略可）

    人が読める形式のデバイス名。

ManufacturerData

Chrome 47 以降

プロパティ

  • data

    数値 []

  • id

    数値

Notification

Chrome 52 以降

プロパティ

  • shouldIndicate

    ブール値（省略可）

    通知の代わりにインジケーションを送信するためのフラグ（オプション）。

  • value

    ArrayBuffer

    特徴の新しい値。

NotificationProperties

プロパティ

  • 永続

    boolean

    アプリのイベントページがアンロードされたときにアプリが通知を受け取るかどうかを示すフラグ（アプリのライフサイクルを管理するを参照）。デフォルト値は false です。

Request

Chrome 52 以降

プロパティ

  • このリクエストを送信するデバイス。

  • requestId

    数値

    このリクエストの一意の ID。この ID は、このリクエストに応答する際に使用します。

  • value

    ArrayBuffer 省略可

    書き込む値（これが書き込みリクエストの場合）。

Response

Chrome 52 以降

プロパティ

  • isError

    boolean

    これがエラー レスポンスの場合は true になります。

  • requestId

    数値

    レスポンスとなるリクエストの ID。

  • value

    ArrayBuffer 省略可

    回答の値。このパラメータは、書き込みリクエストとエラー レスポンスでは無視されます。

Service

プロパティ

  • deviceAddress

    string（省略可）

    GATT サービスが属するリモート周辺機器のデバイス アドレス。このインスタンスがリモート サービスを表す場合に存在します。

  • instanceId

    string（省略可）

    このサービスに割り当てられた ID を返します。インスタンス ID を使用して、同じ UUID を持つ周辺機器からのサービスを区別したり、サービス ID を受け取る関数呼び出しを行ったりできます。このインスタンスがリモート サービスを表す場合に存在します。

  • isPrimary

    boolean

    このサービスのタイプがプライマリかセカンダリかを示します。

  • uuid

    文字列

    サービスの UUID（例: 0000180d-0000-1000-8000-00805f9b34fb）。

ServiceData

Chrome 47 以降

プロパティ

  • data

    数値 []

  • uuid

    文字列

Methods

connect()

Promise 
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
)

指定されたアドレスを持つアプリケーションとデバイスとの間の接続を確立します。デバイスがすでに接続されていて、connect を呼び出さなくても GATT サービスを使用できる場合がありますが、デバイスの GATT サービスにアクセスするアプリは、この関数を呼び出してデバイスへの接続が維持されるようにする必要があります。デバイスが接続されていない場合は、connect の呼び出しが成功した後で、デバイスのすべての GATT サービスが検出されます。

パラメータ

  • deviceAddress

    文字列

    GATT 接続を開くリモート デバイスの Bluetooth アドレス。

  • プロパティ

    ConnectProperties 省略可

    接続プロパティ（省略可）。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

createCharacteristic()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.createCharacteristic(
  characteristic: Characteristic,
  serviceId: string,
  callback?: function,
)

ローカルでホストされる GATT 特性を作成する。この特性は有効なサービスでホストする必要があります。サービス ID が有効でない場合、lastError が設定されます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • 特性

    特徴

    作成する特性。

  • serviceId

    文字列

    この特性を作成するサービスの ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (characteristicId: string)=>void

    • characteristicId

      文字列

戻り値

  • Promise<文字列>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

createDescriptor()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.createDescriptor(
  descriptor: Descriptor,
  characteristicId: string,
  callback?: function,
)

ローカルでホストされる GATT 記述子を作成する。この記述子は、有効な特性のもとでホストする必要があります。特性 ID が有効でない場合、lastError が設定されます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • 記述子

    記述子

    作成する記述子。

  • characteristicId

    文字列

    この記述子を作成する特性の ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (descriptorId: string)=>void

    • descriptorId

      文字列

戻り値

  • Promise<文字列>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

createService()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.createService(
  service: Service,
  callback?: function,
)

ローカルでホストされる GATT サービスを作成する。このサービスは、ローカルの GATT サーバーで使用できるように登録できます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • サービス

    サービス

    作成するサービス。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (serviceId: string)=>void

    • serviceId

      文字列

戻り値

  • Promise<文字列>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

disconnect()

Promise 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)

指定されたアドレスのデバイスへのアプリの接続を終了します。接続が開いている他のアプリが存在する可能性があるため、この操作で常に物理リンク自体が破棄されるわけではありません。

パラメータ

  • deviceAddress

    文字列

    リモート デバイスの Bluetooth アドレス。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getCharacteristic()

Promise 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)

特定の GATT サービスに属する特定のインスタンス ID を持つ GATT 特性を取得します（特性が存在する場合）。

パラメータ

  • characteristicId

    文字列

    リクエストされた GATT 特性のインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Characteristic)=>void

戻り値

  • Promise<Characteristic>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getCharacteristics()

Promise 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)

指定されたサービスに属する、検出されたすべての GATT 特性のリストを取得します。

パラメータ

  • serviceId

    文字列

    特性を返す GATT サービスのインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Characteristic[])=>void

戻り値

  • Promise<Characteristic[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getDescriptor()

Promise 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)

指定されたインスタンス ID の GATT 特性記述子を取得します。

パラメータ

  • descriptorId

    文字列

    リクエストされた GATT 特性記述子のインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Descriptor)=>void

戻り値

  • Promise<Descriptor>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getDescriptors()

Promise 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)

指定された特性に属する GATT 特性記述子のリストを取得します。

パラメータ

  • characteristicId

    文字列

    記述子を返す GATT 特性のインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Descriptor[])=>void

戻り値

  • Promise<Descriptor[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getIncludedServices()

Promise 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)

指定されたサービスに含まれる GATT サービスのリストを取得します。

パラメータ

  • serviceId

    文字列

    含まれるサービスを返す GATT サービスのインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Service[])=>void

戻り値

  • Promise<Service[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getService()

Promise 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)

指定されたインスタンス ID で GATT サービスを取得します。

パラメータ

  • serviceId

    文字列

    リクエストされた GATT サービスのインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Service)=>void

戻り値

  • Promise<Service>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

getServices()

Promise 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)

指定したデバイス アドレスのリモート デバイスで検出されたすべての GATT サービスを取得します。

注: デバイスでサービス ディスカバリがまだ完了していない場合、この API はサービスのサブセット（おそらく空の）を返します。この問題を回避するには、時間ベースの遅延を追加するか、予想されるサービス数が返されるまで繰り返し呼び出します。

パラメータ

  • deviceAddress

    文字列

    GATT サービスを返すリモート デバイスの Bluetooth アドレス。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Service[])=>void

戻り値

  • Promise<Service[]>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

notifyCharacteristicValueChanged()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
)

リモート デバイスに特性の新しい値を通知します。通知オブジェクトの shouldIndicate フラグが true の場合、通知ではなくインジケーターが送信されます。この呼び出しが成功するには、特性で作成時に「notify」または「指示」プロパティを正しく設定する必要があります。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • characteristicId

    文字列

    通知を送信する特性。

  • 通知

    通知

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

readCharacteristicValue()

Promise 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)

指定した特性の値をリモート周辺機器から取得します。

パラメータ

  • characteristicId

    文字列

    リモート デバイスから値を読み取る GATT 特性のインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Characteristic)=>void

戻り値

  • Promise<Characteristic>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

readDescriptorValue()

Promise 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)

指定した特性記述子の値をリモート周辺機器から取得します。

パラメータ

  • descriptorId

    文字列

    GATT 特性記述子のインスタンス ID。この値はリモート デバイスから読み取る必要があります。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (result: Descriptor)=>void

戻り値

  • Promise<Descriptor>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

registerAdvertisement()

Promise Chrome 47 以降 
chrome.bluetoothLowEnergy.registerAdvertisement(
  advertisement: Advertisement,
  callback?: function,
)

広告を作成して登録します。この関数を呼び出すには、アプリで bluetooth:low_energy と bluetooth:peripheral 権限が true に設定されている必要があります。また、この API は、キオスクモードで自動起動されるアプリ、またはコマンドライン スイッチ「--enable-ble-advertising-in-apps」の設定でのみ使用できます。https://developer.chrome.com/apps/manifest/bluetooth をご覧ください。注: 一部のハードウェアでは、セントラル モードとペリフェラル モードが同時にサポートされますが、サポートしていないハードウェアでこの呼び出しを行うと、デバイスはペリフェラル モードに切り替わります。セントラル モードとペリフェラル モードの両方をサポートしていないハードウェアの場合、両方のモードでデバイスを使用しようとすると、動作が未定義になるか、他の中心的役割のアプリケーションが正しく動作しなくなります（Bluetooth Low Energy デバイスの検出を含む）。

パラメータ

  • 広告

    広告

    宣伝する広告。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    (advertisementId: number)=>void

    • advertisementId

      数値

戻り値

  • Promise<数値>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

registerService()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
)

指定されたサービスをローカル GATT サーバーに登録します。サービス ID が無効な場合は、lastError が設定されます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • serviceId

    文字列

    作成されたサービスの一意の ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

removeService()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
)

指定したサービスを削除します。登録済みの場合は登録を解除します。サービス ID が無効な場合は、lastError が設定されます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • serviceId

    文字列

    現在登録されているサービスの一意の ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

resetAdvertising()

Promise Chrome 61 以降 
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
)

現在のデバイスでアドバタイジングをリセットします。これにより、既存のアドバタイズメントが登録解除され、すべて停止します。

パラメータ

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

sendRequestResponse()

Chrome 52 以降 
chrome.bluetoothLowEnergy.sendRequestResponse(
  response: Response,
)

特性または記述子の読み取り/書き込みリクエストに対するレスポンスを送信します。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • レスポンス

    対応

    リクエストに対するレスポンス。

setAdvertisingInterval()

Promise Chrome 55 以降 
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
)

2 つの連続するアドバタイズメント間の間隔を設定します。注: これはベスト エフォートです。実際の間隔は、リクエストした間隔とは明らかに異なる場合があります。ハードウェアによっては、100 ミリ秒の最小間隔があります。最小値と最大値は、Bluetooth 4.2 の仕様で許可されている範囲を超えることはできません。

パラメータ

  • minInterval

    数値

    広告の最小間隔（ミリ秒単位）。これは（仕様に従って）20 ミリ秒未満にすることはできません。

  • maxInterval

    数値

    広告の最大間隔（ミリ秒単位）。これは（仕様に従って）10,240 ミリ秒を超えることはできません。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

startCharacteristicNotifications()

Promise 
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)

指定した特性からの値の通知/インジケーターを有効にします。有効にすると、アプリケーションは onCharacteristicValueChanged イベントを使用して通知をリッスンできます。

パラメータ

  • characteristicId

    文字列

    通知を有効にする GATT 特性のインスタンス ID。

  • プロパティ

    NotificationProperties 省略可

    通知セッションのプロパティ（省略可）。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

stopCharacteristicNotifications()

Promise 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)

指定された特性からの値の通知/表示を無効にします。呼び出しが成功すると、アプリケーションはこの特性からの通知の受信を停止します。

パラメータ

  • characteristicId

    文字列

    このアプリの通知セッションを停止する GATT 特性のインスタンス ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

unregisterAdvertisement()

Promise Chrome 47 以降 
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
)

アドバタイズメントの登録を解除し、アドバタイジングを停止します。アドバタイズで登録解除に失敗した場合、広告を停止するには、デバイスを再起動するしかありません。

パラメータ

  • advertisementId

    数値

    登録を解除する広告の ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

unregisterService()

Promise Chrome 52 以降 
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
)

指定されたサービスのローカル GATT サーバーの登録を解除します。サービス ID が無効な場合は、lastError が設定されます。この関数は、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ使用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • serviceId

    文字列

    現在登録されているサービスの一意の ID。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

writeCharacteristicValue()

Promise 
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)

リモート周辺機器から特定の特性の値を書き込みます。

パラメータ

  • characteristicId

    文字列

    値を書き込む GATT 特性のインスタンス ID。

  • value

    ArrayBuffer

    書き込みリクエストの一部としてリモート特性に送信する値。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

writeDescriptorValue()

Promise 
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)

リモート周辺機器から指定された特性記述子の値を書き込みます。

パラメータ

  • descriptorId

    文字列

    値を書き込む必要がある GATT 特性記述子のインスタンス ID。

  • value

    ArrayBuffer

    書き込みリクエストの一部としてリモート記述子に送信する値。

  • callback

    関数（省略可）

    callback パラメータは次のようになります。 

    ()=>void

戻り値

  • Promise<void>

    Chrome 91 以降

    Promise は Manifest V3 以降でのみサポートされます。他のプラットフォームではコールバックを使用する必要があります。

イベント

onCharacteristicReadRequest

Chrome 52 以降 
chrome.bluetoothLowEnergy.onCharacteristicReadRequest.addListener(
  callback: function,
)

接続されたセントラル デバイスが、ローカルの GATT サーバーに登録されている特性の値の読み取りをリクエストしたときに呼び出されます。このリクエストに長時間応答しないと、接続が切断される可能性があります。このイベントは、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ利用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (request: Request,characteristicId: string)=>void

onCharacteristicValueChanged

chrome.bluetoothLowEnergy.onCharacteristicValueChanged.addListener(
  callback: function,
)

読み取りリクエストまたは値変更通知/表示の結果、リモート GATT 特性の値が変化したときに呼び出されます。このイベントは、アプリが startCharacteristicNotifications を呼び出して通知を有効にしている場合にのみ送信されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (characteristic: Characteristic)=>void

onCharacteristicWriteRequest

Chrome 52 以降 
chrome.bluetoothLowEnergy.onCharacteristicWriteRequest.addListener(
  callback: function,
)

接続されたセントラル デバイスが、ローカルの GATT サーバーに登録されている特性の値の書き込みをリクエストしたときに呼び出されます。このリクエストに長時間応答しないと、接続が切断される可能性があります。このイベントは、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ利用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (request: Request,characteristicId: string)=>void

onDescriptorReadRequest

Chrome 52 以降 
chrome.bluetoothLowEnergy.onDescriptorReadRequest.addListener(
  callback: function,
)

接続されている中央デバイスが、ローカルの GATT サーバーに登録されている記述子の値の読み取りをリクエストしたときに呼び出されます。このリクエストに長時間応答しないと、接続が切断される可能性があります。このイベントは、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ利用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (request: Request,descriptorId: string)=>void

onDescriptorValueChanged

chrome.bluetoothLowEnergy.onDescriptorValueChanged.addListener(
  callback: function,
)

リモート GATT 特性記述子の値が変更されたときに呼び出されます。通常は読み取りリクエストの結果です。このイベントは主に便宜のために存在し、常に readDescriptorValue の呼び出しが成功した後に送信されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (descriptor: Descriptor)=>void

onDescriptorWriteRequest

Chrome 52 以降 
chrome.bluetoothLowEnergy.onDescriptorWriteRequest.addListener(
  callback: function,
)

接続されている中央デバイスが、ローカルの GATT サーバーに登録されている記述子の値の書き込みをリクエストしたときに呼び出されます。このリクエストに長時間応答しないと、接続が切断される可能性があります。このイベントは、アプリで bluetooth:low_energy と bluetooth:peripheral 権限の両方が true に設定されている場合にのみ利用できます。一部のアプリでは、周辺機器の権限を利用できない場合があります。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (request: Request,descriptorId: string)=>void

onServiceAdded

chrome.bluetoothLowEnergy.onServiceAdded.addListener(
  callback: function,
)

リモート・デバイス上で新しい GATT サービスが発見された際に呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (service: Service)=>void

onServiceChanged

chrome.bluetoothLowEnergy.onServiceChanged.addListener(
  callback: function,
)

リモート GATT サービスの状態が変更されたときに呼び出されます。これには、サービスに対して追加または削除される特性や記述子、リモート デバイスからの「ServiceChanged」通知が含まれます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (service: Service)=>void

onServiceRemoved

chrome.bluetoothLowEnergy.onServiceRemoved.addListener(
  callback: function,
)

以前にリモート デバイスで検出された GATT サービスが削除されたときに呼び出されます。

パラメータ

  • callback

    機能

    callback パラメータは次のようになります。 

    (service: Service)=>void