org.bluez.GattDescriptor - BlueZ D-Bus GattDescriptor API documentation

GATT local/server and remote/client descriptor attribute representation share the same high-level D-Bus API. Local/Server refers to GATT based descriptors exported by a plugin or an external application. Remote/Client refers to GATT descriptors exported by the peer.

ClientService org.bluez Interface org.bluez.GattDescriptor1 Objectpath [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/serviceXX/charYYYY/descriptorZZZ ServerService unique name Interface org.bluez.GattDescriptor1 Objectpath freely definable Methodsarray{byte}ReadValue(dictflags) Issues a request to read the value of the descriptor and returns the value if the operation was successful. Possible options: uint16offset Read start offset in bytes. objectdevice(serveronly) Device object. stringlink Link type (Server only). Possible values: "BR/EDR""LE" Possible Errors: org.bluez.Error.Failedorg.bluez.Error.InProgressorg.bluez.Error.NotPermittedorg.bluez.Error.NotAuthorizedorg.bluez.Error.NotSupportedvoidWriteValue(array{byte}value,dictflags) Issues a request to write the value of the descriptor. Possible flags: uint16offset Write start offset in bytes. uint16mtu Exchanged MTU (Server only). objectdevice Device path (Server only). stringlink Link type (Server only). Possible values: "BR/EDR""LE"booleanprepare-authorize True if prepare authorization request. Possible Errors: org.bluez.Error.Failedorg.bluez.Error.InProgressorg.bluez.Error.NotPermittedorg.bluez.Error.InvalidValueLengthorg.bluez.Error.NotAuthorizedorg.bluez.Error.NotSupportedorg.bluez.Error.ImproperlyConfiguredPropertiesstringUUID[read-only] 128-bit descriptor UUID. objectCharacteristic[read-only] Object path of the GATT characteristic the descriptor belongs to. array{byte}Value[read-only,optional] The cached value of the descriptor. This property gets updated only after a successful read request, upon which a PropertiesChanged signal will be emitted. array{string}Flags[read-only] Defines how the descriptor value can be used. Possible values: "read""write""encrypt-read""encrypt-write""encrypt-authenticated-read""encrypt-authenticated-write""secure-read"(ServerOnly)"secure-write"(ServerOnly)"authorize"uint16Handle[read-only](ClientOnly) Descriptor handle. uint16Handle[read-write,optional](ServerOnly) Descriptor handle. When available in the server it would attempt to use to allocate into the database which may fail, to auto allocate the value 0x0000 shall be used which will cause the allocated handle to be set once registered. BlueZ October 2023 ORG.BLUEZ.GATTDESCRIPTOR(5)

org.bluez.GattDescriptor - BlueZ D-Bus GattDescriptor API documentation