diff options
author | Claudio Takahasi <claudio.takahasi@openbossa.org> | 2010-09-13 17:41:03 -0300 |
---|---|---|
committer | Johan Hedberg <johan.hedberg@nokia.com> | 2010-09-16 22:43:50 +0300 |
commit | 173e730a1e621a6e8386aed3d5712b9fbba769d3 (patch) | |
tree | d6a278fb7999e4aa85769bb38244cd831f67b7ad /doc | |
parent | ddf3c14cb5f5b59d7d31a9b14b083e08b33db95f (diff) | |
download | bluez-173e730a1e621a6e8386aed3d5712b9fbba769d3.tar.gz |
Add Characteristics methods/properties on attribute-api.txt
Diffstat (limited to 'doc')
-rw-r--r-- | doc/attribute-api.txt | 45 |
1 files changed, 43 insertions, 2 deletions
diff --git a/doc/attribute-api.txt b/doc/attribute-api.txt index 79d44ea7..ce5f4e65 100644 --- a/doc/attribute-api.txt +++ b/doc/attribute-api.txt @@ -115,6 +115,47 @@ Interface org.bluez.Characteristic Object path [prefix]/{hci0}/{device0}/{service0}/{characteristic0,...} [prefix]/{hci0}/{device0}/{service1}/{characteristic0,...} -Methods +Methods dict GetProperties() -Properties + Returns all properties for the characteristic. See the + properties section for available properties. + + +Properties string UUID [readonly] + + UUID128 of this characteristic. + + string Name [readonly] + + Optional field containing a friendly name for the + Characteristic UUID. + + string Description [readonly] + + Textual optional characteristic descriptor describing + the Characteristic Value. + + struct Format [readonly] + + Optional Characteristic descriptor which defines the + format of the Characteristic Value. For numeric + values, the actual value can be value * 10^Exponent. + NameSpace and Description are defined on the Assigned + Number Specification. + + uint8 | Format: format of the value + uint8 | Exponent: Field to determine how the value is + | further formatted. + uint16 | Unit: unit of the characteristic + uint8 | NameSpace: Name space of description. + uint16 | Description: Description of the characteristic defined + | in a high layer profile. + + array{byte} Value [readwrite] + + Raw value of the Characteristic Value attribute. + + string Representation (of the binary Value) [readonly] + + Friendly representation of the Characteristic Value + based on the format attribute. |