diff options
author | Alexander Orlenko <zxteam@gmail.com> | 2010-10-10 21:47:56 +1100 |
---|---|---|
committer | Alexander Orlenko <zxteam@gmail.com> | 2010-10-10 21:49:20 +1100 |
commit | 29ca468af5bb3110ea50c3b139d4ec0033631753 (patch) | |
tree | 2a6f8845d74d5476859c3c2ea4bc2029d054374c | |
parent | 93367e941a7aaa0b04695a36d17ede00a2e4e521 (diff) | |
download | bluez-tools-29ca468af5bb3110ea50c3b139d4ec0033631753.tar.gz |
bluez api updated to 4.75
-rw-r--r-- | contrib/bluez-api-4.69-fixed/attribute-api.txt | 97 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/adapter-api.txt (renamed from contrib/bluez-api-4.69-fixed/adapter-api.txt) | 6 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/agent-api.txt (renamed from contrib/bluez-api-4.69-fixed/agent-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/agent.xml (renamed from contrib/bluez-api-4.69-fixed/agent.xml) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/assigned-numbers.txt | 23 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/attribute-api.txt | 156 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/audio-api.txt (renamed from contrib/bluez-api-4.69-fixed/audio-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/control-api.txt (renamed from contrib/bluez-api-4.69-fixed/control-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/device-api.txt (renamed from contrib/bluez-api-4.69-fixed/device-api.txt) | 6 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/hfp-api.txt | 86 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/input-api.txt (renamed from contrib/bluez-api-4.69-fixed/input-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/manager-api.txt (renamed from contrib/bluez-api-4.69-fixed/manager-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/network-api.txt (renamed from contrib/bluez-api-4.69-fixed/network-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/serial-api.txt (renamed from contrib/bluez-api-4.69-fixed/serial-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.75-fixed/service-api.txt (renamed from contrib/bluez-api-4.69-fixed/service-api.txt) | 0 |
15 files changed, 272 insertions, 102 deletions
diff --git a/contrib/bluez-api-4.69-fixed/attribute-api.txt b/contrib/bluez-api-4.69-fixed/attribute-api.txt deleted file mode 100644 index ee91f93..0000000 --- a/contrib/bluez-api-4.69-fixed/attribute-api.txt +++ /dev/null @@ -1,97 +0,0 @@ -BlueZ D-Bus Attribute API description -************************************* - -Copyright (C) 2004-2010 Marcel Holtmann <marcel@holtmann.org> - - -Attribute hierarchy -=================== - -Service org.bluez -Interface org.bluez.Service - org.bluez.Characteristic -Object path [prefix]/{hci0}/{service0} - [prefix]/{hci0}/{device0}/{service0}/{characteristic0,...} - [prefix]/{hci0}/{device0}/{service1}/{characteristic0,...} - -Service details ---------------- - -One service object path for every remote SDP record or service in the -attribute database. One service object path for every local SDP record -or service from attribute database. - -Local services are children of the adapter object path. Remote services -are children of the remote device object path. This doesn't solve the -problem where local atttributes can have different instances based on -the remote device. - -In general the idea is to also represent SDP records as services so that -new style application can just use the service interfaces to retrieve the -needed information. That way the usage of SDP and GATT would be mostly -fully transparent and a differentiation becomes unimportant in the future. - -A service consists of some generic service information and a set of -characteristics. All characteristic are presented as object path as well. - -Properties ----------- - string Name (mandatory) - - General name of service - - string Description (optional) - - Description of service - - string UUID (mandatory) - - UUID of service. Service class value for SDP and GATT UUID - for attribute based services. - - array{object} Characteristics - - This list contains the characteristics owned by this specific - service and other characteristics from service includes. That - way no complicated service includes array is needed. - - string UUID - string Name - string Description - struct Format (type, name, exponet etc.) - - array{byte} Value - string Representation (of the binary Value) - - object Service (the original service in case of includes) - - At this point only GetProperties() method call should be - supported for simplicity. Changing characteristics is up - to future support. - - The object path of the characteristics might be split - over multiple service objects, because of includes. - - array[(object, dict)] GetCharacteristics() - - Array of tuples with object path as identifier. An alternativ - is doing dict of dict since the object path is unique and the - order of characteristics is irrelevant. However it might be - good to actually present an order here. - - See Characteristics properties for dictionary details. - - RegisterCharacteristicsWatcher(object path) - - Register a watcher for changes in specific characteristics - to monitor changes. - - A watcher will be registered for this service and will - notifier about any changed characteristics in the service. - This also notifies about any included characteristics. - - Method for the watch objects still need to be defined. - - UnregisterCharacteristicsWatcher(object path) - - Unregister a watcher. diff --git a/contrib/bluez-api-4.69-fixed/adapter-api.txt b/contrib/bluez-api-4.75-fixed/adapter-api.txt index 540bb0c..2e7308f 100644 --- a/contrib/bluez-api-4.69-fixed/adapter-api.txt +++ b/contrib/bluez-api-4.75-fixed/adapter-api.txt @@ -19,8 +19,7 @@ Methods dict GetProperties() Returns all properties for the adapter. See the properties section for available properties. - Possible Errors: org.bluez.Error.DoesNotExist - org.bluez.Error.InvalidArguments + Possible Errors: org.bluez.Error.NotReady void SetProperty(string name, variant value) @@ -28,8 +27,7 @@ Methods dict GetProperties() properties that are listed a read-write are changeable. On success this will emit a PropertyChanged signal. - Possible Errors: org.bluez.Error.DoesNotExist - org.bluez.Error.InvalidArguments + Possible Errors: org.bluez.Error.InvalidArguments void RequestSession() {unneeded_in_bluez_tools} diff --git a/contrib/bluez-api-4.69-fixed/agent-api.txt b/contrib/bluez-api-4.75-fixed/agent-api.txt index d8d35c0..d8d35c0 100644 --- a/contrib/bluez-api-4.69-fixed/agent-api.txt +++ b/contrib/bluez-api-4.75-fixed/agent-api.txt diff --git a/contrib/bluez-api-4.69-fixed/agent.xml b/contrib/bluez-api-4.75-fixed/agent.xml index 86e442b..86e442b 100644 --- a/contrib/bluez-api-4.69-fixed/agent.xml +++ b/contrib/bluez-api-4.75-fixed/agent.xml diff --git a/contrib/bluez-api-4.75-fixed/assigned-numbers.txt b/contrib/bluez-api-4.75-fixed/assigned-numbers.txt new file mode 100644 index 0000000..cda934c --- /dev/null +++ b/contrib/bluez-api-4.75-fixed/assigned-numbers.txt @@ -0,0 +1,23 @@ +RFCOMM Channels +=============== + +Since there are a limited amount of possible RFCOMM channels (1-31) +they've been pre-allocated for currently known profiles in order to +avoid conflicts. + +Profile Channel +----------------------- +DUN 1 +HFP HF 7 +OPP 9 +FTP 10 +BIP 11 +HSP AG 12 +HFP AG 13 +SYNCH (IrMC) 14 +PBAP 15 +MAP 16 +SyncEvolution 19 +PC/Ovi Suite 24 +SyncML Client 25 +SyncML Server 26 diff --git a/contrib/bluez-api-4.75-fixed/attribute-api.txt b/contrib/bluez-api-4.75-fixed/attribute-api.txt new file mode 100644 index 0000000..23808e6 --- /dev/null +++ b/contrib/bluez-api-4.75-fixed/attribute-api.txt @@ -0,0 +1,156 @@ +BlueZ D-Bus Attribute API description +************************************* + +Copyright (C) 2004-2010 Marcel Holtmann <marcel@holtmann.org> + +Service details +--------------- + +One service object path for every remote SDP record or service in the +attribute database. One service object path for every local SDP record +or service from attribute database. + +Local services are children of the adapter object path. Remote services +are children of the remote device object path. This doesn't solve the +problem where local atttributes can have different instances based on +the remote device. + +In general the idea is to also represent SDP records as services so that +new style application can just use the service interfaces to retrieve the +needed information. That way the usage of SDP and GATT would be mostly +fully transparent and a differentiation becomes unimportant in the future. + +A service consists of some generic service information and a set of +characteristics. All characteristic are presented as object path as well. + + +Local Service hierarchy +======================= + +Service org.bluez +Interface org.bluez.Service + org.bluez.Characteristic +Object path [prefix]/{hci0}/{service0, service1, ...} + +Methods + +Properties + + +Device Service hierarchy +======================== + +Service org.bluez +Interface org.bluez.Characteristic +Object path [prefix]/{hci0}/{device0}/{service0, service1, ...} + [prefix]/{hci0}/{device1}/{service0, service1, ...} + +Methods dict GetProperties() + + Returns all properties for the interface. See the + Properties section for the available properties. + + RegisterCharacteristicsWatcher(object agent) + + Register a watcher to monitor characteristic changes. + + A watcher will be registered for this service and will + notify about any changed characteristics in the service. + This also notifies about any included characteristics. + + UnregisterCharacteristicsWatcher(object agent) + + Unregister a watcher. + +Properties string Name (mandatory) [readonly] + + General name of service + + string Description (optional) [readonly] + + Description of service + + string UUID (mandatory) [readonly] + + UUID of service. Service class value for SDP and GATT + UUID for attribute based services. + + array{object} Characteristics [readonly] + + This list contains the characteristics owned by this + specific service and other characteristics from service + includes. That way no complicated service includes array + is needed. + + +Device Characteristic hierarchy +=============================== + +Service org.bluez +Interface org.bluez.Characteristic +Object path [prefix]/{hci0}/{device0}/{service0}/{characteristic0,...} + [prefix]/{hci0}/{device0}/{service1}/{characteristic0,...} + +Methods dict GetProperties() + + Returns all properties for the characteristic. See the + properties section for available properties. + + void SetProperty(string name, variant value) + + Changes the value of the specified property. Only + read-write properties can be changed. On success + this will emit a PropertyChanged signal. + + Possible Errors: org.bluez.Error.InvalidArguments + +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. + + +Characteristic Watcher hierarchy +=============================== + +Service unique name +Interface org.bluez.Watcher +Object path freely definable + +Methods void ValueChanged(object characteristic, array{byte}) + + New raw value of the Characteristic Value attribute. diff --git a/contrib/bluez-api-4.69-fixed/audio-api.txt b/contrib/bluez-api-4.75-fixed/audio-api.txt index 80c0b5d..80c0b5d 100644 --- a/contrib/bluez-api-4.69-fixed/audio-api.txt +++ b/contrib/bluez-api-4.75-fixed/audio-api.txt diff --git a/contrib/bluez-api-4.69-fixed/control-api.txt b/contrib/bluez-api-4.75-fixed/control-api.txt index ce9d2bd..ce9d2bd 100644 --- a/contrib/bluez-api-4.69-fixed/control-api.txt +++ b/contrib/bluez-api-4.75-fixed/control-api.txt diff --git a/contrib/bluez-api-4.69-fixed/device-api.txt b/contrib/bluez-api-4.75-fixed/device-api.txt index 8b7788c..5a73680 100644 --- a/contrib/bluez-api-4.69-fixed/device-api.txt +++ b/contrib/bluez-api-4.75-fixed/device-api.txt @@ -71,7 +71,7 @@ Methods dict GetProperties() Possible errors: org.bluez.Error.NotConnected - array{object} ListNodes() {deprecated} + array{object} ListNodes() {deprecated} {unsupported_in_bluez} Returns list of device node object paths. @@ -139,6 +139,10 @@ Properties string Address [readonly] List of 128-bit UUIDs that represents the available remote services. + array{object} Services [readonly] + + List of characteristics based services. + boolean Paired [readonly] Indicates if the remote device is paired. diff --git a/contrib/bluez-api-4.75-fixed/hfp-api.txt b/contrib/bluez-api-4.75-fixed/hfp-api.txt new file mode 100644 index 0000000..93251e8 --- /dev/null +++ b/contrib/bluez-api-4.75-fixed/hfp-api.txt @@ -0,0 +1,86 @@ +Gateway hierarchy +======================== + +Service org.bluez +Interface org.bluez.HandsfreeGateway +Object path [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX + +This interface is available for remote devices which can function in the Audio +Gateway role of the HFP profiles. It is intended to be used with external +telephony stacks / handlers of the HFP protocol. + +Methods void Connect() + + Connect to the AG service on the remote device. + + void Disconnect() + + Disconnect from the AG service on the remote device + + dict GetProperties() + + Returns all properties for the interface. See the + properties section for available properties. + + void RegisterAgent(object path) + + The object path defines the path the of the agent + that will be called when a new Handsfree connection + is established. + + If an application disconnects from the bus all of its + registered agents will be removed. + + void UnregisterAgent(object path) + + This unregisters the agent that has been previously + registered. The object path parameter must match the + same value that has been used on registration. + + Possible Errors: org.bluez.Error.Failed + org.bluez.Error.InvalidArguments + + +Signals PropertyChanged(string name, variant value) + + This signal indicates a changed value of the given + property. + +Properties string State [readonly] + + Indicates the state of the connection. Possible + values are: + "disconnected" + "connecting" + "connected" + "playing" + +HandsfreeAgent hierarchy +=============== + +Service unique name +Interface org.bluez.HandsfreeAgent +Object path freely definable + +Methods void NewConnection(filedescriptor fd) + + This method gets called whenever a new handsfree + connection has been established. The objectpath + contains the object path of the remote device. This + method assumes that DBus daemon with file descriptor + passing capability is being used. + + The agent should only return successfully once the + establishment of the service level connection (SLC) + has been completed. In the case of Handsfree this + means that BRSF exchange has been performed and + necessary initialization has been done. + + Possible Errors: org.bluez.Error.InvalidArguments + org.bluez.Error.Failed + + void Release() + + This method gets called whenever the service daemon + unregisters the agent or whenever the Adapter where + the HandsfreeAgent registers itself is removed. diff --git a/contrib/bluez-api-4.69-fixed/input-api.txt b/contrib/bluez-api-4.75-fixed/input-api.txt index 7c3a4b2..7c3a4b2 100644 --- a/contrib/bluez-api-4.69-fixed/input-api.txt +++ b/contrib/bluez-api-4.75-fixed/input-api.txt diff --git a/contrib/bluez-api-4.69-fixed/manager-api.txt b/contrib/bluez-api-4.75-fixed/manager-api.txt index d2c1caf..d2c1caf 100644 --- a/contrib/bluez-api-4.69-fixed/manager-api.txt +++ b/contrib/bluez-api-4.75-fixed/manager-api.txt diff --git a/contrib/bluez-api-4.69-fixed/network-api.txt b/contrib/bluez-api-4.75-fixed/network-api.txt index 4dd3e58..4dd3e58 100644 --- a/contrib/bluez-api-4.69-fixed/network-api.txt +++ b/contrib/bluez-api-4.75-fixed/network-api.txt diff --git a/contrib/bluez-api-4.69-fixed/serial-api.txt b/contrib/bluez-api-4.75-fixed/serial-api.txt index 5f9bd5f..5f9bd5f 100644 --- a/contrib/bluez-api-4.69-fixed/serial-api.txt +++ b/contrib/bluez-api-4.75-fixed/serial-api.txt diff --git a/contrib/bluez-api-4.69-fixed/service-api.txt b/contrib/bluez-api-4.75-fixed/service-api.txt index 5c8c7f3..5c8c7f3 100644 --- a/contrib/bluez-api-4.69-fixed/service-api.txt +++ b/contrib/bluez-api-4.75-fixed/service-api.txt |