diff options
author | Alexander Orlenko <zxteam@gmail.com> | 2010-07-13 11:00:04 +1100 |
---|---|---|
committer | Alexander Orlenko <zxteam@gmail.com> | 2010-07-13 11:00:04 +1100 |
commit | e01e7c9a76997de7cfcf5d5eda325cb1a9b8a2b2 (patch) | |
tree | 98cfa85761ca911472852bef101f10fe10a8fa00 /contrib | |
parent | 024e778b2cae61d9b72223d2363666a037eec92d (diff) | |
download | bluez-tools-e01e7c9a76997de7cfcf5d5eda325cb1a9b8a2b2.tar.gz |
Forked bluez-api 4.66 doc and fixed some typo
Removed on-fly patches in generator script
Added Network Hub/Peer/Router interfaces
Diffstat (limited to 'contrib')
-rw-r--r-- | contrib/bluez-api-4.66-fixed/adapter-api.txt (renamed from contrib/bluez-api-4.66/adapter-api.txt) | 4 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/agent-api.txt (renamed from contrib/bluez-api-4.66/agent-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/audio-api.txt (renamed from contrib/bluez-api-4.66/audio-api.txt) | 54 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/control-api.txt (renamed from contrib/bluez-api-4.66/control-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/device-api.txt (renamed from contrib/bluez-api-4.66/device-api.txt) | 2 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/input-api.txt (renamed from contrib/bluez-api-4.66/input-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/manager-api.txt (renamed from contrib/bluez-api-4.66/manager-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/network-api.txt (renamed from contrib/bluez-api-4.66/network-api.txt) | 79 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/serial-api.txt (renamed from contrib/bluez-api-4.66/serial-api.txt) | 0 | ||||
-rw-r--r-- | contrib/bluez-api-4.66-fixed/service-api.txt (renamed from contrib/bluez-api-4.66/service-api.txt) | 0 | ||||
-rwxr-xr-x | contrib/gen-dbus-gobject.pl | 26 | ||||
-rwxr-xr-x | contrib/generate-all.sh | 40 |
12 files changed, 143 insertions, 62 deletions
diff --git a/contrib/bluez-api-4.66/adapter-api.txt b/contrib/bluez-api-4.66-fixed/adapter-api.txt index 6098c76..c960d43 100644 --- a/contrib/bluez-api-4.66/adapter-api.txt +++ b/contrib/bluez-api-4.66-fixed/adapter-api.txt @@ -103,7 +103,7 @@ Methods dict GetProperties() org.bluez.Error.Failed object CreatePairedDevice(string address, object agent, - string capability) + string capability) [async] Creates a new object path for a remote device. This method will connect to the remote device and retrieve @@ -248,7 +248,7 @@ Properties string Address [readonly] Note that this property only affects incoming pairing requests. - uint32 PaireableTimeout [readwrite] + uint32 PairableTimeout [readwrite] The pairable timeout in seconds. A value of zero means that the timeout is disabled and it will stay in diff --git a/contrib/bluez-api-4.66/agent-api.txt b/contrib/bluez-api-4.66-fixed/agent-api.txt index d8d35c0..d8d35c0 100644 --- a/contrib/bluez-api-4.66/agent-api.txt +++ b/contrib/bluez-api-4.66-fixed/agent-api.txt diff --git a/contrib/bluez-api-4.66/audio-api.txt b/contrib/bluez-api-4.66-fixed/audio-api.txt index e7991f3..80c0b5d 100644 --- a/contrib/bluez-api-4.66/audio-api.txt +++ b/contrib/bluez-api-4.66-fixed/audio-api.txt @@ -27,12 +27,12 @@ Methods void Connect() Returns all properties for the interface. See the properties section for available properties. -Signals void PropertyChanged(string name, variant value) +Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. -Properties string State +Properties string State [readonly] Possible values: "disconnected", "connecting", "connected" @@ -128,31 +128,31 @@ Methods void Connect() Possible Errors: org.bluez.Error.DoesNotExist org.bluez.Error.InvalidArguments -Signals void AnswerRequested() +Signals AnswerRequested() Sent when the answer button is pressed on the headset - void Connected() {deprecated} + Connected() {deprecated} Sent when the device has been connected to. - void Disconnected() {deprecated} + Disconnected() {deprecated} Sent when the device has been disconnected from. - void Stopped() {deprecated} + Stopped() {deprecated} Sent when the audio connection is closed - void Playing() {deprecated} + Playing() {deprecated} Sent when the audio connection is opened - void SpeakerGainChanged(uint16 gain) {deprecated} + SpeakerGainChanged(uint16 gain) {deprecated} The speaker gain changed. - void MicrophoneGainChanged(uint16 gain) {deprecated} + MicrophoneGainChanged(uint16 gain) {deprecated} The microphone gain changed. @@ -161,7 +161,7 @@ Signals void AnswerRequested() This signal indicates a changed value of the given property. -properties string State [readonly] +Properties string State [readonly] Possible values: "disconnected", "connecting", "connected", "playing" @@ -191,16 +191,16 @@ properties string State [readonly] Indicates if there is a active connection to the HSP/HFP connection on the remote device. - boolean Playing [readonly] + boolean Playing [readonly] Indicates if an audio connection to the headset is active. - uint16 SpeakerGain [readwrite] + uint16 SpeakerGain [readwrite] The speaker gain when available. - uint16 MicrophoneGain [readwrite] + uint16 MicrophoneGain [readwrite] The speaker gain when available. @@ -233,20 +233,20 @@ Methods void Connect() Possible Errors: org.bluez.Error.InvalidArguments -Signals void Connected() {deprecated} +Signals Connected() {deprecated} Sent when a successful connection has been made to the remote A2DP Sink - void Disconnected() {deprecated} + Disconnected() {deprecated} Sent when the device has been disconnected from. - void Playing() {deprecated} + Playing() {deprecated} Sent when a stream with remote device is started. - void Stopped() {deprecated} + Stopped() {deprecated} Sent when a stream with remote device is suspended. @@ -255,7 +255,7 @@ Signals void Connected() {deprecated} This signal indicates a changed value of the given property. -properties string State [readonly] +Properties string State [readonly] Possible values: "disconnected", "connecting", "connected", "playing" @@ -285,7 +285,7 @@ properties string State [readonly] Indicates if a stream is setup to a A2DP sink on the remote device. - boolean Playing [readonly] + boolean Playing [readonly] Indicates if a stream is active to a A2DP sink on the remote device. @@ -318,7 +318,7 @@ Signals PropertyChanged(string name, variant value) This signal indicates a changed value of the given property. -properties string State [readonly] +Properties string State [readonly] Possible values: "disconnected", "connecting", "connected", "playing" @@ -396,22 +396,22 @@ Methods void Connect() Returns all properties for the interface. See the properties section for available properties. -Signals void Ring(string number) +Signals Ring(string number) Someone's calling from 'number'. Caller number is provided as received from AG. - void CallTerminated() + CallTerminated() Call failed to set up. It means that we tried to call someone or someone tried to call us but call was not accepted. - void CallStarted() + CallStarted() Call set up successfully. - void CallEnded() + CallEnded() Call was started and now ended. In contrast with CallTerminated where call didn't started @@ -421,7 +421,7 @@ Signals void Ring(string number) This signal indicates a changed value of the given property. -properties boolean Connected [readonly] +Properties boolean Connected [readonly] Indicates if there is an active connection to the AG service on the remote device. @@ -449,10 +449,10 @@ properties boolean Connected [readonly] Battery Charge indicator of AG, the value ranges from 0 to 5. - uint16 SpeakerGain [readonly] + uint16 SpeakerGain [readonly] The speaker gain when available. - uint16 MicrophoneGain [readonly] + uint16 MicrophoneGain [readonly] The speaker gain when available. diff --git a/contrib/bluez-api-4.66/control-api.txt b/contrib/bluez-api-4.66-fixed/control-api.txt index 1a42846..1a42846 100644 --- a/contrib/bluez-api-4.66/control-api.txt +++ b/contrib/bluez-api-4.66-fixed/control-api.txt diff --git a/contrib/bluez-api-4.66/device-api.txt b/contrib/bluez-api-4.66-fixed/device-api.txt index b818299..4dc05bb 100644 --- a/contrib/bluez-api-4.66/device-api.txt +++ b/contrib/bluez-api-4.66-fixed/device-api.txt @@ -31,7 +31,7 @@ Methods dict GetProperties() Possible Errors: org.bluez.Error.DoesNotExist org.bluez.Error.InvalidArguments - dict DiscoverServices(string pattern) + dict{u,s} DiscoverServices(string pattern) This method starts the service discovery to retrieve remote service records. The pattern parameter can diff --git a/contrib/bluez-api-4.66/input-api.txt b/contrib/bluez-api-4.66-fixed/input-api.txt index 7c3a4b2..7c3a4b2 100644 --- a/contrib/bluez-api-4.66/input-api.txt +++ b/contrib/bluez-api-4.66-fixed/input-api.txt diff --git a/contrib/bluez-api-4.66/manager-api.txt b/contrib/bluez-api-4.66-fixed/manager-api.txt index d2c1caf..d2c1caf 100644 --- a/contrib/bluez-api-4.66/manager-api.txt +++ b/contrib/bluez-api-4.66-fixed/manager-api.txt diff --git a/contrib/bluez-api-4.66/network-api.txt b/contrib/bluez-api-4.66-fixed/network-api.txt index eca60d4..58543e2 100644 --- a/contrib/bluez-api-4.66/network-api.txt +++ b/contrib/bluez-api-4.66-fixed/network-api.txt @@ -60,11 +60,11 @@ Properties boolean Connected [readonly] Indicates the connection role when available. -Network Hub/Peer/Router hierarchy +Network Hub hierarchy ================= Service org.bluez -Interface org.bluez.network.{Hub, Peer, Router} +Interface org.bluez.network.Hub Object path /org/bluez/{hci0,hci1,...} Methods dict GetProperties() @@ -81,14 +81,83 @@ Methods dict GetProperties() Possible Errors: org.bluez.Error.DoesNotExist org.bluez.Error.InvalidArguments -Properties string Name[readwrite] +Properties string Name [readwrite] The Bluetooth network server name. - boolean Enable[readwrite] + boolean Enable [readwrite] Indicates if the server is Enabled/Disabled. - string Uuid[readonly] + string UUID [readonly] + + The Bluetooth network server UUID 128 identification. + + +Network Peer hierarchy +================= + +Service org.bluez +Interface org.bluez.network.Peer +Object path /org/bluez/{hci0,hci1,...} + +Methods dict GetProperties() + + Returns all properties for the GN/PANU/NAP server. See the + properties section for available properties. + + void SetProperty(string name, variant value) + + Changes the value of the specified property. Only + 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 + +Properties string Name [readwrite] + + The Bluetooth network server name. + + boolean Enable [readwrite] + + Indicates if the server is Enabled/Disabled. + + string UUID [readonly] The Bluetooth network server UUID 128 identification. + + +Network Router hierarchy +================= + +Service org.bluez +Interface org.bluez.network.Router +Object path /org/bluez/{hci0,hci1,...} + +Methods dict GetProperties() + + Returns all properties for the GN/PANU/NAP server. See the + properties section for available properties. + + void SetProperty(string name, variant value) + + Changes the value of the specified property. Only + 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 + +Properties string Name [readwrite] + + The Bluetooth network server name. + + boolean Enable [readwrite] + + Indicates if the server is Enabled/Disabled. + + string UUID [readonly] + + The Bluetooth network server UUID 128 identification. + diff --git a/contrib/bluez-api-4.66/serial-api.txt b/contrib/bluez-api-4.66-fixed/serial-api.txt index 5f9bd5f..5f9bd5f 100644 --- a/contrib/bluez-api-4.66/serial-api.txt +++ b/contrib/bluez-api-4.66-fixed/serial-api.txt diff --git a/contrib/bluez-api-4.66/service-api.txt b/contrib/bluez-api-4.66-fixed/service-api.txt index 5c8c7f3..5c8c7f3 100644 --- a/contrib/bluez-api-4.66/service-api.txt +++ b/contrib/bluez-api-4.66-fixed/service-api.txt diff --git a/contrib/gen-dbus-gobject.pl b/contrib/gen-dbus-gobject.pl index f940df5..6b4a165 100755 --- a/contrib/gen-dbus-gobject.pl +++ b/contrib/gen-dbus-gobject.pl @@ -26,22 +26,22 @@ sub parse_doc_api { # On-fly patches: # audio-api.txt - s/void (PropertyChanged\(string name, variant value\))$/$1/; - s/(string State)$/$1 [readonly]/; - s/void (AnswerRequested\(\))/$1/; - s/^p(roperties\tstring State \[readonly\])$/P$1/; - s/ ( \[(readonly|readwrite)\])$/$1/; - s/void (Ring\(string number\))$/$1/; - s/void (CallTerminated\(\))$/$1/; - s/void (CallStarted\(\))$/$1/; - s/void (CallEnded\(\))$/$1/; - s/^p(roperties\tboolean Connected \[readonly\])$/P$1/; + #s/void (PropertyChanged\(string name, variant value\))$/$1/; + #s/(string State)$/$1 [readonly]/; + #s/void (AnswerRequested\(\))/$1/; + #s/^p(roperties\tstring State \[readonly\])$/P$1/; + #s/ ( \[(readonly|readwrite)\])$/$1/; + #s/void (Ring\(string number\))$/$1/; + #s/void (CallTerminated\(\))$/$1/; + #s/void (CallStarted\(\))$/$1/; + #s/void (CallEnded\(\))$/$1/; + #s/^p(roperties\tboolean Connected \[readonly\])$/P$1/; # adapter-api.txt - s/PaireableTimeout/PairableTimeout/; + #s/PaireableTimeout/PairableTimeout/; # device-api.txt - s/dict (DiscoverServices\(string pattern\))$/dict{u,s} $1/; + #s /dict (DiscoverServices\(string pattern\))$/dict{u,s} $1/; if (/^(.+) hierarchy$/) { my $hierarchy = $1; @@ -93,7 +93,7 @@ sub parse_doc_api { if ($decl =~ /,$/) { my $add_str = <INPUT>; # adapter-api.txt patch - $add_str =~ s/(string capability\))$/$1 [async]/; + #$add_str =~ s/(string capability\))$/$1 [async]/; if ($add_str =~ /\s+(.+)\)( \[(\w+)\])?$/) { $decl .= " $1)"; $args .= " $1"; diff --git a/contrib/generate-all.sh b/contrib/generate-all.sh index 1e7f8f9..2bbe37c 100755 --- a/contrib/generate-all.sh +++ b/contrib/generate-all.sh @@ -1,29 +1,41 @@ #!/bin/sh # adapter-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/adapter-api.txt > ../src/lib/adapter.h -./gen-dbus-gobject.pl -source bluez-api-4.66/adapter-api.txt > ../src/lib/adapter.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/adapter-api.txt > ../src/lib/adapter.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/adapter-api.txt > ../src/lib/adapter.c # audio-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/audio-api.txt > ../src/lib/audio.h -./gen-dbus-gobject.pl -source bluez-api-4.66/audio-api.txt > ../src/lib/audio.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/audio-api.txt > ../src/lib/audio.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/audio-api.txt > ../src/lib/audio.c # device-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/device-api.txt > ../src/lib/device.h -./gen-dbus-gobject.pl -source bluez-api-4.66/device-api.txt > ../src/lib/device.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/device-api.txt > ../src/lib/device.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/device-api.txt > ../src/lib/device.c # input-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/input-api.txt > ../src/lib/input.h -./gen-dbus-gobject.pl -source bluez-api-4.66/input-api.txt > ../src/lib/input.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/input-api.txt > ../src/lib/input.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/input-api.txt > ../src/lib/input.c # manager-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/manager-api.txt > ../src/lib/manager.h -./gen-dbus-gobject.pl -source bluez-api-4.66/manager-api.txt > ../src/lib/manager.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/manager-api.txt > ../src/lib/manager.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/manager-api.txt > ../src/lib/manager.c # network-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/network-api.txt > ../src/lib/network.h -./gen-dbus-gobject.pl -source bluez-api-4.66/network-api.txt > ../src/lib/network.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/network-api.txt > ../src/lib/network.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/network-api.txt > ../src/lib/network.c + +# network-api.txt +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/network-api.txt 2 > ../src/lib/hub.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/network-api.txt 2 > ../src/lib/hub.c + +# network-api.txt +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/network-api.txt 3 > ../src/lib/peer.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/network-api.txt 3 > ../src/lib/peer.c + +# network-api.txt +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/network-api.txt 4 > ../src/lib/router.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/network-api.txt 4 > ../src/lib/router.c # serial-api.txt -./gen-dbus-gobject.pl -header bluez-api-4.66/serial-api.txt > ../src/lib/serial.h -./gen-dbus-gobject.pl -source bluez-api-4.66/serial-api.txt > ../src/lib/serial.c +./gen-dbus-gobject.pl -header bluez-api-4.66-fixed/serial-api.txt > ../src/lib/serial.h +./gen-dbus-gobject.pl -source bluez-api-4.66-fixed/serial-api.txt > ../src/lib/serial.c |