diff --git a/index.html b/index.html index 96d9675..9d0721f 100644 --- a/index.html +++ b/index.html @@ -3935,13 +3935,13 @@

Resolve promise with result.

-
+
The getDescriptor(descriptor) method retrieves a Descriptor inside this Characteristic. When invoked, it MUST return

GetGATTChildren(attribute=this,
single=true,
uuidCanonicalizer=BluetoothUUID.getDescriptor,
uuid=descriptor,
allowedUuids=undefined,
child type="GATT Descriptor")

-
+
The getDescriptors(descriptor) method retrieves a list of Descriptors inside this Characteristic. When invoked, it MUST return

GetGATTChildren(attribute=this,
single=false,
uuidCanonicalizer=BluetoothUUID.getDescriptor,
uuid=descriptor,
allowedUuids=undefined,
child type="GATT Descriptor")

@@ -4238,9 +4238,8 @@

Resolve promise with propertiesObj.

-
-

5.5. BluetoothRemoteGATTDescriptor

-

BluetoothRemoteGATTDescriptor represents a GATT Descriptor, which +

5.5. BluetoothRemoteGATTDescriptor

+

BluetoothRemoteGATTDescriptor represents a GATT Descriptor, which provides further information about a Characteristic’s value.

[Exposed=Window, SecureContext]
 interface BluetoothRemoteGATTDescriptor {
@@ -4252,134 +4251,133 @@ 
writeValue(BufferSource value);
 };
-
-
NOTE: BluetoothRemoteGATTDescriptor attributes
- characteristic is the GATT characteristic this descriptor belongs to. -

uuid is the UUID of the characteristic descriptor, e.g. '00002902-0000-1000-8000-00805f9b34fb' for the Client Characteristic Configuration descriptor.

-

value is the currently cached descriptor value. This value gets +

+
NOTE: BluetoothRemoteGATTDescriptor attributes
+ characteristic is the GATT characteristic this descriptor belongs to. +

uuid is the UUID of the characteristic descriptor, e.g. '00002902-0000-1000-8000-00805f9b34fb' for the Client Characteristic Configuration descriptor.

+

value is the currently cached descriptor value. This value gets updated when the value of the descriptor is read.

-
-

Instances of BluetoothRemoteGATTDescriptor are created with the internal +

+

Instances of BluetoothRemoteGATTDescriptor are created with the internal slots described in the following table:

- - - - -
Internal Slot - Initial Value - Description (non-normative) -
[[representedDescriptor]] - <always set in prose> - The Descriptor this object represents, or null if the Descriptor + + + + +
Internal Slot + Initial Value + Description (non-normative) +
[[representedDescriptor]] + <always set in prose> + The Descriptor this object represents, or null if the Descriptor has been removed or otherwise invalidated. -
-
- To create a BluetoothRemoteGATTDescriptor representing a Descriptor descriptor, +
+
+ To create a BluetoothRemoteGATTDescriptor representing a Descriptor descriptor, the UA must return a new promise promise and run the following steps in parallel. -
    -
  1. -

    Let result be a new instance of BluetoothRemoteGATTDescriptor with its [[representedDescriptor]] slot initialized to descriptor.

    -
  2. -

    Initialize result.characteristic from +

      +
    1. +

      Let result be a new instance of BluetoothRemoteGATTDescriptor with its [[representedDescriptor]] slot initialized to descriptor.

      +
    2. +

      Initialize result.characteristic from the BluetoothRemoteGATTCharacteristic instance representing the Characteristic in which descriptor appears.

      -
    3. -

      Initialize result.uuid from the UUID of descriptor.

      -
    4. -

      Initialize result.value to null. +

    5. +

      Initialize result.uuid from the UUID of descriptor.

      +
    6. +

      Initialize result.value to null. The UA MAY initialize result.value to a new DataView wrapping a new ArrayBuffer containing the most recently read value from descriptor if this value is available.

      -
    7. -

      Resolve promise with result.

      -
    -
-
- The readValue() method, when invoked, MUST run the following steps: -
    -
  1. -

    If this.uuid is blocklisted for reads, return a promise rejected with a SecurityError and abort these steps.

    -
  2. -

    If this.characteristic.service.device.gatt.connected is false, return a promise rejected with a NetworkError and +

  3. +

    Resolve promise with result.

    +
+
+
+ The readValue() method, when invoked, MUST run the following steps: +
    +
  1. +

    If this.uuid is blocklisted for reads, return a promise rejected with a SecurityError and abort these steps.

    +
  2. +

    If this.characteristic.service.device.gatt.connected is false, return a promise rejected with a NetworkError and abort these steps.

    -
  3. -

    Let descriptor be this.[[representedDescriptor]].

    -
  4. -

    If descriptor is null, return a promise rejected with an InvalidStateError and abort these steps.

    -
  5. -

    Return a this.characteristic.service.device.gatt- connection-checking wrapper around a new promise promise and run the following steps in parallel:

    -
      -
    1. -

      If the UA is currently using the Bluetooth system, it MAY reject promise with a NetworkError and abort these steps.

      -

      Implementations may be able to avoid this NetworkError, +

    2. +

      Let descriptor be this.[[representedDescriptor]].

      +
    3. +

      If descriptor is null, return a promise rejected with an InvalidStateError and abort these steps.

      +
    4. +

      Return a this.characteristic.service.device.gatt- connection-checking wrapper around a new promise promise and run the following steps in parallel:

      +
        +
      1. +

        If the UA is currently using the Bluetooth system, it MAY reject promise with a NetworkError and abort these steps.

        +

        Implementations may be able to avoid this NetworkError, but for now sites need to serialize their use of this API and/or give the user a way to retry failed operations. <https://github.com/WebBluetoothCG/web-bluetooth/issues/188>

        -
      2. -

        Use either the Read Characteristic Descriptors or the Read Long Characteristic Descriptors sub-procedure to retrieve +

      3. +

        Use either the Read Characteristic Descriptors or the Read Long Characteristic Descriptors sub-procedure to retrieve the value of descriptor. Handle errors as described in § 5.7 Error handling.

        -
      4. -

        If the previous step returned an error, reject promise with that error and abort these steps.

        -
      5. -

        Queue a task to perform the following steps:

        -
          -
        1. -

          If promise is not in this.characteristic.service.device.gatt.[[activeAlgorithms]], reject promise with a NetworkError and abort +

        2. +

          If the previous step returned an error, reject promise with that error and abort these steps.

          +
        3. +

          Queue a task to perform the following steps:

          +
            +
          1. +

            If promise is not in this.characteristic.service.device.gatt.[[activeAlgorithms]], reject promise with a NetworkError and abort these steps.

            -
          2. -

            Let buffer be an ArrayBuffer holding the retrieved +

          3. +

            Let buffer be an ArrayBuffer holding the retrieved value, and assign new DataView(buffer) to this.value.

            -
          4. -

            Resolve promise with this.value.

            -
          -
        -
      -
-
- The writeValue(value) method, when invoked, MUST run the +
  • +

    Resolve promise with this.value.

    + + + +
    • +
    + The writeValue(value) method, when invoked, MUST run the following steps: -
      -
    1. -

      If this.uuid is blocklisted for writes, return a promise rejected with a SecurityError and abort these steps.

      -
    2. -

      Let bytes be a copy of the bytes held by value.

      -
    3. -

      If bytes is more than 512 bytes long (the maximum length of an +

        +
      1. +

        If this.uuid is blocklisted for writes, return a promise rejected with a SecurityError and abort these steps.

        +
      2. +

        Let bytes be a copy of the bytes held by value.

        +
      3. +

        If bytes is more than 512 bytes long (the maximum length of an attribute value, per Long Attribute Values) return a promise rejected with an InvalidModificationError and abort these steps.

        -
      4. -

        If this.characteristic.service.device.gatt.connected is false, return a promise rejected with a NetworkError and +

      5. +

        If this.characteristic.service.device.gatt.connected is false, return a promise rejected with a NetworkError and abort these steps.

        -
      6. -

        Let descriptor be this.[[representedDescriptor]].

        -
      7. -

        If descriptor is null, return a promise rejected with an InvalidStateError and abort these steps.

        -
      8. -

        Return a this.characteristic.service.device.gatt- connection-checking wrapper around a new promise promise and run the following steps in parallel.

        -
          -
        1. -

          If the UA is currently using the Bluetooth system, it MAY reject promise with a NetworkError and abort these steps.

          -

          Implementations may be able to avoid this NetworkError, +

        2. +

          Let descriptor be this.[[representedDescriptor]].

          +
        3. +

          If descriptor is null, return a promise rejected with an InvalidStateError and abort these steps.

          +
        4. +

          Return a this.characteristic.service.device.gatt- connection-checking wrapper around a new promise promise and run the following steps in parallel.

          +
            +
          1. +

            If the UA is currently using the Bluetooth system, it MAY reject promise with a NetworkError and abort these steps.

            +

            Implementations may be able to avoid this NetworkError, but for now sites need to serialize their use of this API and/or give the user a way to retry failed operations. <https://github.com/WebBluetoothCG/web-bluetooth/issues/188>

            -
          2. -

            Use either the Write Characteristic Descriptors or the Write +

          3. +

            Use either the Write Characteristic Descriptors or the Write Long Characteristic Descriptors sub-procedure to write bytes to descriptor. Handle errors as described in § 5.7 Error handling.

            -
          4. -

            If the previous step returned an error, reject promise with that error and abort these steps.

            -
          5. -

            Queue a task to perform the following steps:

            -
              -
            1. -

              If promise is not in this.characteristic.service.device.gatt.[[activeAlgorithms]], reject promise with a NetworkError and abort +

            2. +

              If the previous step returned an error, reject promise with that error and abort these steps.

              +
            3. +

              Queue a task to perform the following steps:

              +
                +
              1. +

                If promise is not in this.characteristic.service.device.gatt.[[activeAlgorithms]], reject promise with a NetworkError and abort these steps.

                -
              2. -

                Set this.value to a new DataView wrapping a new ArrayBuffer containing bytes.

                -
              3. -

                Resolve promise with undefined.

                -
              -
            -
          -
    +
  • +

    Set this.value to a new DataView wrapping a new ArrayBuffer containing bytes.

    +
  • +

    Resolve promise with undefined.

    + + +

    • 5.6. Events