BluetoothGattCharacteristic (Firefox OS)
This API is available on Firefox OS for internal applications only.
The BluetoothGattCharacteristic
interface of the Web Bluetooth API represents a GATT service characteristic, which includes characteristic definition, value, properties and configuration info, and a list of descriptors that provide related information.
Interface overview
JavaScript
Copy Code
[CheckPermissions="bluetooth"] interface BluetoothGattCharacteristic { readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService#BluetoothGattService" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattService">BluetoothGattService</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#service" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">service</a>; [Cached, Pure] readonly attribute sequence<<a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#BluetoothGattDescriptor" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">BluetoothGattDescriptor</a>> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#descriptors" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">descriptors</a>; readonly attribute DOMString <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#uuid" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">uuid</a>; readonly attribute unsigned short <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#instanceId" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">instanceId</a>; readonly attribute ArrayBuffer? <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#value" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">value</a>; [Cached, Constant] readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#Permissions" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">Permissions</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#permissions_2" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">permissions</a>; [Cached, Constant] readonly attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#GattCharacteristicProperties" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">GattCharacteristicProperties</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#properties_2" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">properties</a>; [Cached, Pure] attribute <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#WriteType" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">WriteType</a> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#writeType" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">writeType</a>; [NewObject] Promise<ArrayBuffer> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#readValue.28.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">readValue()</a>; [NewObject] Promise<void> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#writeValue.28ArrayBuffer_value.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">writeValue(ArrayBuffer value)</a>; [NewObject] Promise<void> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#startNotifications.28.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">startNotifications()</a>; [NewObject] Promise<void> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#stopNotifications.28.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">stopNotifications()</a>; [NewObject] Promise<<a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor#BluetoothGattDescriptor" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattDescriptor">BluetoothGattDescriptor</a>> <a href="https://wiki.mozilla.org/B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic#addDescriptor.28DOMString_uuid.2C_Permissions_permissions.2C_ArrayBuffer_value.29" class="external" title="B2G/Bluetooth/WebBluetooth-v2/BluetoothGattCharacteristic">addDescriptor(DOMString uuid, Permissions permissions, ArrayBuffer value)</a>; };
Properties
BluetoothGattCharacteristic.service
Read only- Returns the
BluetoothGattService
that this characteristic belongs to. BluetoothGattCharacteristic.descriptors
Read only- Returns a cached array containing the
BluetoothGattDescriptor
objects that describe this characteristic. BluetoothGattCharacteristic.uuid
Read only- Returns a
DOMString
representing the UUID of this characteristic. BluetoothGattCharacteristic.instanceId
Read only- Returns a number representing the instance id of this characteristic.
BluetoothGattCharacteristic.value
Read only- Returns The cached value of this characteristic. This value can be updated via the
BluetoothGattCharacteristic.readValue()
method, characteristic notification, or indication from the remote device. BluetoothGattCharacteristic.permissions
Read only- Returns a bit mask that describes the operations permitted on this characteristic.
BluetoothGattCharacteristic.properties
Read only- Returns a bit mask that describes how to use the characteristic value.
BluetoothGattCharacteristic.writeType
Read only- Returns the type of write operation particular to this characteristic.
Methods
BluetoothGattCharacteristic.readValue()
- Reads the characteristic value from the remote device. The cached value property will also be updated after retrieving the value.
BluetoothGattCharacteristic.writeValue()
- Writes the characteristic value to the GATT server. If the local device is the GATT client, the value will be written to the remote GATT server. On the other hand, if the local device is the GATT server, the value will be written to
BluetoothGattCharacteristic.value
. BluetoothGattCharacteristic.startNotifications()
- Registers notifications/indications for this characteristic.
BluetoothGattCharacteristic.stopNotifications()
- Unregisters notifications/indications for this characteristic.
BluetoothGattCharacteristic.addDescriptor()
- Adds a descriptor to this characteristic.
Specifications
Specification | Status | Comment |
---|---|---|
Web Bluetooth The definition of 'BluetoothGattCharacteristic' in that specification. |
Draft | Rough draft; not part of any official specification yet. It should be discussed as part of the W3C's System Applications Working Group. |
Browser Compatibility
Feature | Chrome | Firefox (Gecko) | Internet Explorer | Opera | Safari (WebKit) |
---|---|---|---|---|---|
Basic support | No support | No support | No support | No support | No support |
Feature | Android | Android Webview | Firefox Mobile (Gecko) | Firefox OS | IE Mobile | Opera Mobile | Safari Mobile | Chrome for Android |
---|---|---|---|---|---|---|---|---|
Basic support | No support | No support | No support | 2.1 | No support | No support | No support | No support |
See also
License
© 2016 Mozilla Contributors
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-us/docs/web/api/bluetoothgattcharacteristic_(firefox_os)