Hi All,
Below is the updated proposal with all your valuable feedback. Could you please let me know your inputs for the same?
diff --git a/doc/attribute-api.txt b/doc/attribute-api.txt
index 98d7f30..a6b79c9 100644
--- a/doc/attribute-api.txt
+++ b/doc/attribute-api.txt
@@ -110,6 +110,20 @@ Methods dict GetProperties()
read-write properties can be changed. On success
this will emit a PropertyChanged signal.
+ void ReadCharacteristicValue(uint16 timeout)
+
+ Read the value of the characteristic with timeout value.
+ This will emit a ReadResponse signal with status code.
+
+ void WriteCharacteristicValue(variant value, string method, uint16 offset, uint16 timeout)
+
+ Changes the value of the specified characteristic as per the offset and method, with timeout value.
+ This will emit a WriteResponse signal with status code.
+
+ Write the value of the characreristic, with any of these specified method:
+ "WriteWithResponse", "SignedWriteWithoutResponse",
+ "WriteLongCharacteristicValue", "PrepareWrite", "ExecuteWrite".
+
Possible Errors: org.bluez.Error.InvalidArguments
Properties string UUID [readonly]
@@ -121,12 +135,46 @@ Properties string UUID [readonly]
Optional field containing a friendly name for the
Characteristic UUID.
+ boolean Broadcast [readwrite]
+
+ Indicates whether this characteristic is broadcasted or not.
+ If GATT Server Characteristic Configuration descriptor
+ is not available for this characteristic, or if the characteristic
+ properties do not allow this, writing to this property is not
+ allowed.
+
+ boolean Indicate [readwrite]
+
+ Indicates whether this characteristic is indicated or not.
+ If GATT Client Characteristic Configuration descriptor
+ is not available for this characteristic, or if the characteristic
+ properties do not allow this, writing to this property is not
+ allowed.
+
+ boolean Notify [readwrite]
+
+ Indicates whether this characteristic is notified or not.
+ If GATT Client Characteristic Configuration descriptor
+ is not available for this characteristic, or if the characteristic
+ properties do not allow this, writing to this property is not
+ allowed.
+
+ boolean Readable [readonly]
+
+ Indicates wether this characteristic value can be read.
+
+ array{string} WriteMethods [readonly]
+
+ Write methods supported by the characteristic, includes extended properties if defined, format defined by GATT spec.
+ Possible values:
+ { "WriteWithoutResponse", "Write", "AuthenticatedSignedWrite", "ReliableWrite", "WritableAuxiliaries"}
+
string Description [readonly]
Textual optional characteristic descriptor describing
the Characteristic Value.
- struct Format [readonly]
+ array{struct} Format [readonly]
Optional Characteristic descriptor which defines the
format of the Characteristic Value. For numeric
@@ -144,13 +192,17 @@ Properties string UUID [readonly]
array{byte} Value [readwrite]
- Raw value of the Characteristic Value attribute.
+ The last known raw value of the Characteristic Value attribute. ReadCharacteristicValue should be used to get the latest value from the server.
string Representation (of the binary Value) [readonly]
Friendly representation of the Characteristic Value
based on the format attribute.
+ array{object} CustomCharacteristicsDesc [readonly]
+
+ This list contains the user defined characteristics descriptors owned by this
+ specific characteristics, access the descriptor as attributes.
Characteristic Watcher hierarchy
===============================
@@ -161,4 +213,14 @@ Object path freely definable
Methods void ValueChanged(object characteristic, array{byte})
- New raw value of the Characteristic Value attribute.
+ New raw value of the Characteristic Value attribute. This will be sent in one of the following scenarios :
+ Value was notified/indicated by the server.
+ Value was read using the GetProperty, and the updated value received from the server was different than the one provided as the GetProperty result.
+
+ void ReadResponse(object characteristic, uint8 status, variant value)
+
+ Value read and status code for Read Characteristic Value attribute operation.
+
+ void WriteResponse(object characteristic, uint8 status)
+
+ Status code for Write Characteristic Value attribute opeartion. Should be used only when using Write operations which + have a response. Write command will not emit this signal, it is the responsibility of the client to make sure (by reading the value) that the value was actually set correctly.
Member of the CSR plc group of companies. CSR plc registered in England and Wales, registered number 4187346, registered office Churchill House, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, United Kingdom
More information can be found at www.csr.com. Follow CSR on Twitter at http://twitter.com/CSR_PLC and read our blog at www.csr.com/blog
--
To unsubscribe from this list: send the line "unsubscribe linux-bluetooth" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
