From: Rahul Chaturvedi <rkc@xxxxxxxxxx>
This defines the DBus API that we'll use with BlueZ to create, remove
and get service records.
---
doc/adapter-api.txt | 46 +++++++++++++++++++++++++++++++++++++++++++++
doc/device-api.txt | 37 ++++++++++++++++++++++++++++++++++++
2 files changed, 83 insertions(+)
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index acae032d9..6e4c37fc9 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -204,6 +204,52 @@ Methods void StartDiscovery()
org.bluez.Error.NotReady
org.bluez.Error.Failed
+ uint32 CreateServiceRecord(dict record)
+
+ This method creates an entry with the local SDP server
+ for this adapter for the specified record. This method
+ will only create the SDP record and not start listening
+ on any ports. It is up to the caller of the method to
+ ensure the validity of the service record. This record
+ will not be parsed for any validation but will instead
+ directly be inserted into the local SDP server’s
+ records.
+
+ The return value from this method will be the 32 bit
+ handle for the created service record.
+
+ The record dictionary will have dictionary entries of
+ the format: {id : (type, size, value)}, where,
+
+ uint16 id: The 16 bit attribute ID for an
+ attribute.
+ uint8 type: This will contain the type of the
+ attribute value. Attribute type values
+ are defined in the Bluetooth spec in
+ Volume 3, Part B, 3.2.
+ uint32 size: This is the size of the attribute
+ value.
+ variant value: This will contain the attribute value
+ for a given attribute_id. This variant
+ can either contain a primitive type, or
+ if type is SEQUENCE, an array of struct
+ of the signature (type, size, value).
+
+ Possible errors: org.bluez.Error.NotReady
+ org.bluez.Error.AlreadyExists
+ org.bluez.Error.Failed
+ org.bluez.Error.InvalidArguments
+
+ void RemoveServiceRecord(uint32 handle)
+
+ This method removes the SDP record with the given
+ handle from the local SDP server.
+
+ Possible errors: org.bluez.Error.NotReady
+ org.bluez.Error.DoesNotExist
+ org.bluez.Error.Failed
+ org.bluez.Error.InvalidArguments
+
Properties string Address [readonly]
The Bluetooth device address.
diff --git a/doc/device-api.txt b/doc/device-api.txt
index ceb68d2f6..e8f2c670d 100644
--- a/doc/device-api.txt
+++ b/doc/device-api.txt
@@ -120,6 +120,43 @@ Methods void Connect()
Possible errors: org.bluez.Error.DoesNotExist
org.bluez.Error.Failed
+ array{array{dict}} GetServiceRecords()
+
+ This method returns the complete service records of all
+ discovered BR/EDR services of the connected device till
+ now. The return value will be an array of an array of
+ dictionary entries. Each nested array of dictionary
+ entries will contain one service record. Each pair in
+ the returned dictionary entries will represent an
+ attribute in the service record.
+
+ The dictionary entries in the returned array of entries
+ will be of the format: {id : (type, size, value)} where,
+
+ uint16 id: The 16 bit attribute ID for an
+ attribute.
+ uint8 type: This will contain the type of the
+ attribute value. Attribute type values
+ are defined in the Bluetooth spec in
+ Volume 3, Part B, 3.2.
+ uint32 size: This is the size of the attribute
+ value.
+ variant value: This will contain the attribute value
+ for a given attribute_id. This variant
+ can either contain a primitive type, or
+ if type is SEQUENCE, an array of struct
+ of the signature (type, size, value).
+
+ Since the service record contains the service UUID and
+ name, these fields do not need to be given separately.
+ This method should be called after the ServiceResolved
+ property for this object has been set to true otherwise
+ it may return a partial or stale cached list.
+
+ Possible errors: org.bluez.Error.NotReady
+ org.bluez.Error.NotConnected
+ org.bluez.Error.Failed
+
Properties string Address [readonly]
The Bluetooth device address of the remote device.
--
2.24.1
