chrome.bluetoothLowEnergy

説明

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

マニフェスト

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

"bluetooth"

型

Advertisement

Chrome 47 以降

プロパティ

  • manufacturerData

    ManufacturerData [] 省略可

    「Manufacturer Specific Data」に含めるメーカー固有のデータのリスト渡します。

  • serviceData

    ServiceData[] 省略可

    [Service Data] に含めるサービスデータのリスト渡します。

  • serviceUuids

    文字列 [] 省略可

    「サービス UUID」に含める UUID のリストフィールドで確認できます。これらの UUID は、16 ビット、32 ビット、または 128 の形式になります。

  • solicitUuids

    文字列 [] 省略可

    「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 を持つ周辺機器の特性を区別したり、特性の ID を受け取る関数呼び出しを行ったりできます。このインスタンスがリモート特性を表す場合は存在します。

  • プロパティ

    CharacteristicProperty[]

    この特性の特性。

  • サービス

    サービス （オプション）

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

  • uuid

    文字列

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

  • 値

    ArrayBuffer（省略可）

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

CharacteristicProperty

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

列挙型

"broadcast"

"read"

"writeWithoutResponse"

"書き込み"

"notify"

「指示する」

"authenticatedSignedWrites"

"extendedProperties"

"reliableWrite"

"writableAuxiliaries"

"encryptRead"

"encryptWrite"

"encryptAuthenticatedRead"

"encryptAuthenticatedWrite"

ConnectProperties

プロパティ

  • 永続

    ブール値

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

Descriptor

プロパティ

  • 特徴

    Characteristic（特性） （省略可）

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

  • instanceId

    文字列（省略可）

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

  • Chrome 52 以降

    この記述子の権限。

  • uuid

    文字列

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

  • 値

    ArrayBuffer（省略可）

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

DescriptorPermission

Chrome 52 以降

記述子で利用できる権限を表す値。個々の権限の意味については、Bluetooth 4.x の仕様をご覧ください。

列挙型

"read"

"書き込み"

"encryptedRead"

"encryptedWrite"

"encryptedAuthenticatedRead"

"encryptedAuthenticatedWrite"

Device

Chrome 52 以降

プロパティ

  • 住所

    文字列

    デバイスの住所（「XX:XX:XX:XX:XX:XX」形式）。

  • deviceClass

    数値（省略可）

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

  • name

    文字列（省略可）

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

ManufacturerData

Chrome 47 以降

プロパティ

  • データ

    数値 []

  • id

    数値

Notification

Chrome 52 以降

プロパティ

  • shouldIndicate

    ブール値（省略可）

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

  • 値

    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 を持つ周辺機器のサービスを区別したり、サービス ID を受け取る関数呼び出しを行ったりできます。このインスタンスがリモート サービスを表す場合は存在します。

  • isPrimary

    ブール値

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

  • uuid

    文字列

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

ServiceData

Chrome 47 以降

プロパティ

  • データ

    数値 []

  • uuid

    文字列

メソッド

connect()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.connect(
  deviceAddress: string,
  properties?: ConnectProperties,
  callback?: function,
)

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

パラメータ

  • deviceAddress

    文字列

    GATT 接続を確立するリモート デバイスの Bluetooth アドレスです。

  • プロパティ

    ConnectProperties オプション

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

createCharacteristic()

<ph type="x-smartling-placeholder"></ph> 約束 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()

<ph type="x-smartling-placeholder"></ph> 約束 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()

<ph type="x-smartling-placeholder"></ph> 約束 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()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.disconnect(
  deviceAddress: string,
  callback?: function,
)

指定されたアドレスのデバイスへのアプリとの接続を閉じます。なお、接続が開かれている他のアプリが存在する可能性があるため、この操作を行っても、必ずしも物理リンク自体が破棄されるわけではありません。

パラメータ

  • deviceAddress

    文字列

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

getCharacteristic()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getCharacteristic(
  characteristicId: string,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Characteristic) => void

戻り値

  • Promise<特性>

    Chrome 91 以降

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

getCharacteristics()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getCharacteristics(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Characteristic[]) => void

戻り値

  • Promise<特性[]>

    Chrome 91 以降

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

getDescriptor()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getDescriptor(
  descriptorId: string,
  callback?: function,
)

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

パラメータ

  • descriptorId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Descriptor) => void

戻り値

  • Promise&lt;Descriptor&gt;

    Chrome 91 以降

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

getDescriptors()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getDescriptors(
  characteristicId: string,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

    記述子を返す必要がある GATT 特性のインスタンス ID。

  • callback

    関数（省略可）

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

    (result: Descriptor[]) => void

戻り値

  • Promise&lt;Descriptor[]&gt;

    Chrome 91 以降

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

getIncludedServices()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getIncludedServices(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

    含まれているサービスを返す必要がある GATT サービスのインスタンス ID。

  • callback

    関数（省略可）

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

    (result: Service[]) => void

戻り値

  • Promise<サービス[]>

    Chrome 91 以降

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

getService()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getService(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Service) => void

戻り値

  • Promise&lt;Service&gt;

    Chrome 91 以降

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

getServices()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.getServices(
  deviceAddress: string,
  callback?: function,
)

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

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

パラメータ

  • deviceAddress

    文字列

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

  • callback

    関数（省略可）

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

    (result: Service[]) => void

戻り値

  • Promise<サービス[]>

    Chrome 91 以降

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

notifyCharacteristicValueChanged()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 52 以降 をご覧ください。
chrome.bluetoothLowEnergy.notifyCharacteristicValueChanged(
  characteristicId: string,
  notification: Notification,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

    通知を送信する特性。

  • 通知

    通知

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

readCharacteristicValue()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.readCharacteristicValue(
  characteristicId: string,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Characteristic) => void

戻り値

  • Promise<特性>

    Chrome 91 以降

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

readDescriptorValue()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.readDescriptorValue(
  descriptorId: string,
  callback?: function,
)

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

パラメータ

  • descriptorId

    文字列

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

  • callback

    関数（省略可）

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

    (result: Descriptor) => void

戻り値

  • Promise&lt;Descriptor&gt;

    Chrome 91 以降

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

registerAdvertisement()

<ph type="x-smartling-placeholder"></ph> 約束 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&lt;number&gt;

    Chrome 91 以降

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

registerService()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 52 以降 をご覧ください。
chrome.bluetoothLowEnergy.registerService(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

removeService()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 52 以降 をご覧ください。
chrome.bluetoothLowEnergy.removeService(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

resetAdvertising()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 61 以降 をご覧ください。
chrome.bluetoothLowEnergy.resetAdvertising(
  callback?: function,
)

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

パラメータ

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

sendRequestResponse()

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

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

パラメータ

  • レスポンス

    レスポンス

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

setAdvertisingInterval()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 55 以降 をご覧ください。
chrome.bluetoothLowEnergy.setAdvertisingInterval(
  minInterval: number,
  maxInterval: number,
  callback?: function,
)

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

パラメータ

  • minInterval

    数値

    広告の最小間隔（ミリ秒単位）。（仕様により）20 ミリ秒以上にする必要があります。

  • maxInterval

    数値

    広告間の最大間隔（ミリ秒単位）。仕様により、10,240 ミリ秒以下にする必要があります。

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

startCharacteristicNotifications()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.startCharacteristicNotifications(
  characteristicId: string,
  properties?: NotificationProperties,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

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

  • プロパティ

    NotificationProperties オプション

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

stopCharacteristicNotifications()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.stopCharacteristicNotifications(
  characteristicId: string,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

unregisterAdvertisement()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 47 以降 をご覧ください。
chrome.bluetoothLowEnergy.unregisterAdvertisement(
  advertisementId: number,
  callback?: function,
)

広告の登録を解除して広告を停止します。アドバタイズメントの登録を解除できない場合は、デバイスの再起動が広告を停止する唯一の方法である可能性があります。

パラメータ

  • advertisementId

    数値

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

unregisterService()

<ph type="x-smartling-placeholder"></ph> 約束 Chrome 52 以降 をご覧ください。
chrome.bluetoothLowEnergy.unregisterService(
  serviceId: string,
  callback?: function,
)

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

パラメータ

  • serviceId

    文字列

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

writeCharacteristicValue()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.writeCharacteristicValue(
  characteristicId: string,
  value: ArrayBuffer,
  callback?: function,
)

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

パラメータ

  • characteristicId

    文字列

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

  • 値

    ArrayBuffer

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <void>

    Chrome 91 以降

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

writeDescriptorValue()

<ph type="x-smartling-placeholder"></ph> 約束 
chrome.bluetoothLowEnergy.writeDescriptorValue(
  descriptorId: string,
  value: ArrayBuffer,
  callback?: function,
)

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

パラメータ

  • descriptorId

    文字列

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

  • 値

    ArrayBuffer

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

  • callback

    関数（省略可）

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

    () => void

戻り値

  • 約束 <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