summaryrefslogtreecommitdiffstats
path: root/serial/serial-api.txt
diff options
context:
space:
mode:
authorClaudio Takahasi <claudio.takahasi@openbossa.org>2007-08-10 18:10:26 +0000
committerClaudio Takahasi <claudio.takahasi@openbossa.org>2007-08-10 18:10:26 +0000
commitd195a1ef061b12e04ae23cf644ea22d29178f590 (patch)
tree8c9ec5bffbbfb4bdf053e3e0be3710b231a01e03 /serial/serial-api.txt
parent55147912ac0d3b9090ce612c0543114255f488bf (diff)
serial-api: added serial port proxy
Diffstat (limited to 'serial/serial-api.txt')
-rw-r--r--serial/serial-api.txt41
1 files changed, 40 insertions, 1 deletions
diff --git a/serial/serial-api.txt b/serial/serial-api.txt
index 84512973..b02786e7 100644
--- a/serial/serial-api.txt
+++ b/serial/serial-api.txt
@@ -10,7 +10,21 @@ Manager hierarchy
Interface org.bluez.serial.Manager
Object path /org/bluez/serial
-Methods string CreatePort(string address, string pattern) [experimental]
+Methods string CreateProxy(string uuid, string tty)
+
+ Creates a serial port proxy object.
+
+ Possible errors:org.bluez.serial.Error.InvalidArguments
+ org.bluez.serial.NotAvailable
+ org.bluez.serial.Failed
+
+ void RemoveProxy(string path) [experimental]
+
+ Removes the serial port proxy object for given path.
+
+ Possible errors:org.bluez.serial.Error.DoesNotExist
+
+ string CreatePort(string address, string pattern) [experimental]
Creates a serial port object.
@@ -31,6 +45,10 @@ Methods string CreatePort(string address, string pattern) [experimental]
Returns an array of available serial port paths.
+ array{string} ListProxies() [experimental]
+
+ Returns an array of available serial port proxy paths.
+
string ConnectService(string address, string pattern)
Connects to a specific RFCOMM based service on a
@@ -63,6 +81,10 @@ Signals void PortCreated(string path) [experimental]
void PortRemoved(string path) [experimental]
+ void ProxyCreated(string path) [experimental]
+
+ void ProxyRemoved(string path) [experimental]
+
void ServiceConnected(string device)
void ServiceDisconnected(string device)
@@ -81,3 +103,20 @@ Methods string GetAddress() [experimental]
string GetInfo() [experimental]
Returns the port properties.
+
+Proxy hierarchy (experimental)
+=============================
+Interface org.bluez.serial.Proxy
+Object path /org/bluez/serial/rfcomm*
+
+Methods: string Enable() [experimental]
+
+ Register the serial proxy service record and start
+ listenning on the specified adapter/channel.
+
+ string Disable() [experimental]
+
+ Unregister the service record and stop listenning.
+
+ String GetInfo() [experimental]
+ Returns the proxy properties