chrome.bluetoothLowEnergy

説明

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

対象

ChromeOS のみ

マニフェスト

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

"bluetooth"

型

Advertisement

Chrome 47 以降

プロパティ

  • manufacturerData

    ManufacturerData[] 省略可

    広告データの「メーカー固有のデータ」フィールドに含めるメーカー固有のデータのリスト。

  • serviceData

    ServiceData[] 省略可

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

  • serviceUuids

    string[] 省略可

    アドバタイズ データの「サービス UUID」フィールドに含める UUID のリスト。これらの UUID は、16 ビット、32 ビット、128 ビットの形式にできます。

  • solicitUuids

    string[] 省略可

    アドバタイズ データの「Solicit UUIDs」フィールドに含める UUID のリスト。これらの UUID は、16 ビット、32 ビット、128 ビットの形式にできます。

  • 広告の種類。

AdvertisementType

Chrome 47 以降

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

列挙型

"broadcast"

"peripheral"

Characteristic

プロパティ

  • instanceId

    文字列 省略可

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

  • プロパティ

    CharacteristicProperty[]

    この特性のプロパティ。

  • サービス

    Service 省略可

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

  • uuid

    文字列

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

  • 値

    ArrayBuffer 省略可

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

CharacteristicProperty

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

列挙型

"broadcast"

"read"

"writeWithoutResponse"

"write"

"notify"

「示す」

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

プロパティ

  • 永続

    ブール値

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

Descriptor

プロパティ

  • 特徴

    特性 省略可

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

  • instanceId

    文字列 省略可

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

  • Chrome 52 以降

    この記述子の権限。

  • uuid

    文字列

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

  • 値

    ArrayBuffer 省略可

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

DescriptorPermission

Chrome 52 以降

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

列挙型

"read"

"write"

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

Chrome 52 以降

プロパティ

  • 住所

    文字列

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

  • deviceClass

    number 省略可

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

  • name

    文字列 省略可

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

ManufacturerData

Chrome 47 以降

プロパティ

  • データ

    number[]

  • id

    数値

Notification

Chrome 52 以降

プロパティ

  • shouldIndicate

    boolean 省略可

    通知の代わりに指示を送信するためのオプション フラグ。

  • 値

    ArrayBuffer

    特性の新しい値。

NotificationProperties

プロパティ

  • 永続

    ブール値

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

Request

Chrome 52 以降

プロパティ

  • デバイス

    デバイス

    このリクエストを送信したデバイス。

  • requestId

    数値

    このリクエストの一意の ID。このリクエストに対応する際は、この ID を使用してください。

  • 値

    ArrayBuffer 省略可

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

Response

Chrome 52 以降

プロパティ

  • isError

    ブール値

    これがエラー レスポンスの場合は、true にする必要があります。

  • requestId

    数値

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

  • 値

    ArrayBuffer 省略可

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

Service

プロパティ

  • deviceAddress

    文字列 省略可

    GATT サービスが属するリモート ペリフェラルのデバイスアドレス。このインスタンスがリモート サービスを表す場合は、存在します。

  • instanceId

    文字列 省略可

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

  • isPrimary

    ブール値

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

  • uuid

    文字列

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

ServiceData

Chrome 47 以降

プロパティ

  • データ

    number[]

  • uuid

    文字列

メソッド

connect()

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

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

パラメータ

  • deviceAddress

    文字列

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

  • プロパティ

    ConnectProperties 省略可

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

createCharacteristic()

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

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

パラメータ

  • 特徴

    特性

    作成する特性。

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    (characteristicId: string) => void

    • characteristicId

      文字列

戻り値

  • Promise<string>

    Chrome 91 以降

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

createDescriptor()

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

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

パラメータ

  • 記述子

    記述子

    作成する記述子。

  • characteristicId

    文字列

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

  • callback

    function 省略可

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

    (descriptorId: string) => void

    • descriptorId

      文字列

戻り値

  • Promise<string>

    Chrome 91 以降

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

createService()

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

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

パラメータ

  • サービス

    サービス

    作成するサービス。

  • callback

    function 省略可

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

    (serviceId: string) => void

    • serviceId

      文字列

戻り値

  • Promise<string>

    Chrome 91 以降

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

disconnect()

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

指定されたアドレスを持つデバイスへのアプリの接続を閉じます。接続が開いている他のアプリが存在する可能性があるため、この操作によって物理リンク自体が破棄されるとは限りません。

パラメータ

  • deviceAddress

    文字列

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

getCharacteristic()

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

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    function 省略可

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

    (result: Characteristic) => void

戻り値

  • Promise<Characteristic>

    Chrome 91 以降

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

getCharacteristics()

Promise 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
): Promise<Characteristic[]>

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    (result: Characteristic[]) => void

戻り値

  • Promise<Characteristic[]>

    Chrome 91 以降

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

getDescriptor()

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

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

パラメータ

  • descriptorId

    文字列

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

  • callback

    function 省略可

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

    (result: Descriptor) => void

戻り値

  • Promise<Descriptor>

    Chrome 91 以降

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

getDescriptors()

Promise 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
): Promise<Descriptor[]>

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    function 省略可

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

    (result: Descriptor[]) => void

戻り値

  • Promise<Descriptor[]>

    Chrome 91 以降

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

getIncludedServices()

Promise 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
): Promise<Service[]>

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    (result: Service[]) => void

戻り値

  • Promise<Service[]>

    Chrome 91 以降

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

getService()

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

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    (result: Service) => void

戻り値

  • Promise<Service>

    Chrome 91 以降

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

getServices()

Promise 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
): Promise<Service[]>

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

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

パラメータ

  • deviceAddress

    文字列

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

  • callback

    function 省略可

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

    (result: Service[]) => void

戻り値

  • Promise<Service[]>

    Chrome 91 以降

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

notifyCharacteristicValueChanged()

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

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

パラメータ

  • characteristicId

    文字列

    通知を送信する特性。

  • 通知

    通知

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

readCharacteristicValue()

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

リモート ペリフェラルから指定された特性の値を取得します。

パラメータ

  • characteristicId

    文字列

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

  • callback

    function 省略可

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

    (result: Characteristic) => void

戻り値

  • Promise<Characteristic>

    Chrome 91 以降

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

readDescriptorValue()

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

リモート ペリフェラルから、指定された特性記述子の値を取得します。

パラメータ

  • descriptorId

    文字列

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

  • callback

    function 省略可

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

    (result: Descriptor) => void

戻り値

  • Promise<Descriptor>

    Chrome 91 以降

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

registerAdvertisement()

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

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

パラメータ

  • 広告

    広告

    アドバタイズするアドバタイズメント。

  • callback

    function 省略可

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

    (advertisementId: number) => void

    • advertisementId

      数値

戻り値

  • Promise<number>

    Chrome 91 以降

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

registerService()

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

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

removeService()

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

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

resetAdvertising()

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

現在のデバイスの広告をリセットします。既存のすべてのアドバタイズの登録が解除され、停止されます。

パラメータ

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

sendRequestResponse()

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

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

パラメータ

  • レスポンス

    レスポンス

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

setAdvertisingInterval()

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

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

パラメータ

  • minInterval

    数値

    アドバタイズ間の最小間隔（ミリ秒単位）。仕様上、20 ミリ秒未満にすることはできません。

  • maxInterval

    数値

    アドバタイズ間の最大間隔（ミリ秒単位）。仕様上、10,240 ミリ秒を超えることはできません。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

startCharacteristicNotifications()

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

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

パラメータ

  • characteristicId

    文字列

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

  • プロパティ

    NotificationProperties 省略可

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

stopCharacteristicNotifications()

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

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

unregisterAdvertisement()

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

アドバタイズメントの登録を解除し、アドバタイズを停止します。アドバタイズの登録解除に失敗した場合、アドバタイズを停止する唯一の方法はデバイスを再起動することです。

パラメータ

  • advertisementId

    数値

    登録を解除するアドバタイズの ID。

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

unregisterService()

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

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

パラメータ

  • serviceId

    文字列

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

writeCharacteristicValue()

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

リモート ペリフェラルから指定された特性の値を書き込みます。

パラメータ

  • characteristicId

    文字列

    値の書き込み先となる GATT 特性のインスタンス ID。

  • 値

    ArrayBuffer

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

  • callback

    function 省略可

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

    () => void

戻り値

  • Promise<void>

    Chrome 91 以降

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

writeDescriptorValue()

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

リモート ペリフェラルから指定された特性記述子の値を書き込みます。

パラメータ

  • descriptorId

    文字列

    値の書き込み先となる GATT 特性記述子のインスタンス ID。

  • 値

    ArrayBuffer

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

  • callback

    function 省略可

    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