1ORG.BLUEZ.GATTDESCRIPTOR(5)Linux System AdministratioOnRG.BLUEZ.GATTDESCRIPTOR(5)
2
3
4

NAME

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

DESCRIPTION

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

INTERFACE

18   Client
19       Service
20              org.bluez
21
22       Interface
23              org.bluez.GattDescriptor1
24
25       Object path
26              [variable     prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/ser‐
27              viceXX/charYYYY/descriptorZZZ
28
29   Server
30       Service
31              unique name
32
33       Interface
34              org.bluez.GattDescriptor1
35
36       Object path
37              freely definable
38
39   Methods
40   array{byte} ReadValue(dict flags)
41          Issues a request to read the value of the descriptor and returns the
42          value if the operation was successful.
43
44          Possible options:
45
46          uint16_t offset
47                 Read start offset in bytes.
48
49          object device (server only)
50                 Device object.
51
52          string link
53                 Link type (Server only).
54
55                 Possible values:
56
57                 "BR/EDR"
58
59                 "LE"
60
61          Possible Errors:
62
63          org.bluez.Error.Failed
64
65          org.bluez.Error.InProgress
66
67          org.bluez.Error.NotPermitted
68
69          org.bluez.Error.NotAuthorized
70
71          org.bluez.Error.NotSupported
72
73   void WriteValue(array{byte} value, dict flags)
74          Issues a request to write the value of the descriptor.
75
76          Possible flags:
77
78          uint16 offset
79                 Write start offset in bytes.
80
81          uint16 mtu
82                 Exchanged MTU (Server only).
83
84          object device
85                 Device path (Server only).
86
87          string link
88                 Link type (Server only).
89
90                 Possible values:
91
92                 "BR/EDR"
93
94                 "LE"
95
96          boolean prepare-authorize
97                 True if prepare authorization request.
98
99          Possible Errors:
100
101          org.bluez.Error.Failed
102
103          org.bluez.Error.InProgress
104
105          org.bluez.Error.NotPermitted
106
107          org.bluez.Error.InvalidValueLength
108
109          org.bluez.Error.NotAuthorized
110
111          org.bluez.Error.NotSupported
112
113   Properties
114   string UUID [read-only]
115          128-bit descriptor UUID.
116
117   object Characteristic [read-only]
118          Object path of the GATT characteristic the descriptor belongs to.
119
120   array{byte} Value [read-only, optional]
121          The  cached value of the descriptor. This property gets updated only
122          after a successful read request, upon which a PropertiesChanged sig‐
123          nal will be emitted.
124
125   array{string} Flags [read-only]
126          Defines how the descriptor value can be used.
127
128          Possible values:
129
130          "read"
131
132          "write"
133
134          "encrypt-read"
135
136          "encrypt-write"
137
138          "encrypt-authenticated-read"
139
140          "encrypt-authenticated-write"
141
142          "secure-read" (Server Only)
143
144          "secure-write" (Server Only)
145
146          "authorize"
147
148   uint16 Handle [read-only] (Client Only)
149          Descriptor handle.
150
151   uint16 Handle [read-write, optional] (Server Only)
152          Descriptor  handle. When available in the server it would attempt to
153          use to allocate into the database which may fail, to  auto  allocate
154          the value 0x0000 shall be used which will cause the allocated handle
155          to be set once registered.
156
157
158
159
160BlueZ                            October 2023      ORG.BLUEZ.GATTDESCRIPTOR(5)