diff options
| author | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2016-04-26 13:41:02 +0300 |
|---|---|---|
| committer | Luiz Augusto von Dentz <luiz.von.dentz@intel.com> | 2016-05-18 14:16:28 +0300 |
| commit | 93b64d9ca8a2bb663e37904d4b2c702c58a36e4f (patch) | |
| tree | 7bddbd438d7e720133f356d6fa9e01afe35be311 /doc/gatt-api.txt | |
| parent | 1055cee3269c1d13ab0cea46395fe789b94fb365 (diff) | |
| download | bluez-93b64d9ca8a2bb663e37904d4b2c702c58a36e4f.tar.gz | |
doc/gatt-api: Add options dictionary to ReadValue/WriteValue
This adds the possibility to pass an offset to these operations, and
also in the server case to give the device object.
Diffstat (limited to 'doc/gatt-api.txt')
| -rw-r--r-- | doc/gatt-api.txt | 20 |
1 files changed, 16 insertions, 4 deletions
diff --git a/doc/gatt-api.txt b/doc/gatt-api.txt index ad2ab1676..683b1b7df 100644 --- a/doc/gatt-api.txt +++ b/doc/gatt-api.txt @@ -61,23 +61,29 @@ Service org.bluez Interface org.bluez.GattCharacteristic1 [Experimental] Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/serviceXX/charYYYY -Methods array{byte} ReadValue() +Methods array{byte} ReadValue(dict options) Issues a request to read the value of the characteristic and returns the value if the operation was successful. + Possible options: "offset": uint16 offset + "device": Object Device (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.InProgress org.bluez.Error.NotPermitted org.bluez.Error.NotAuthorized org.bluez.Error.NotSupported - void WriteValue(array{byte} value) + void WriteValue(array{byte} value, dict options) Issues a request to write the value of the characteristic. + Possible options: "offset": Start offset + "device": Device path (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.InProgress org.bluez.Error.NotPermitted @@ -154,23 +160,29 @@ Service org.bluez Interface org.bluez.GattDescriptor1 [Experimental] Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/serviceXX/charYYYY/descriptorZZZ -Methods array{byte} ReadValue() +Methods array{byte} ReadValue(dict flags) Issues a request to read the value of the characteristic and returns the value if the operation was successful. + Possible options: "offset": Start offset + "device": Device path (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.InProgress org.bluez.Error.NotPermitted org.bluez.Error.NotAuthorized org.bluez.Error.NotSupported - void WriteValue(array{byte} value) + void WriteValue(array{byte} value, dict flags) Issues a request to write the value of the characteristic. + Possible options: "offset": Start offset + "device": Device path (Server only) + Possible Errors: org.bluez.Error.Failed org.bluez.Error.InProgress org.bluez.Error.NotPermitted |