[PATCH -v2 1/3] Add Serial Proxy and Serial Proxy Manager doc

[PATCH -v2 1/3] Add Serial Proxy and Serial Proxy Manager doc

[Bruno Dilly]

---
 doc/serial-api.txt |  106 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 106 insertions(+), 0 deletions(-)

diff --git a/doc/serial-api.txt b/doc/serial-api.txt
index 5f9bd5f..a781292 100644
--- a/doc/serial-api.txt
+++ b/doc/serial-api.txt
@@ -39,3 +39,109 @@ Methods		string Connect(string pattern)
 
 			Possible errors: org.bluez.Error.InvalidArguments
 					 org.bluez.Error.DoesNotExist
+
+Serial Proxy Manager hierarchy
+=================
+
+Service		org.bluez
+Interface	org.bluez.SerialProxyManager
+Object path	[variable prefix]/{hci0,hci1,...}
+
+Methods		array{string} ListProxies()
+
+			Returns an array of the object path strings of
+			all the proxies created for the adapter.
+
+		string CreateProxy(string pattern, string address)
+
+			Possible patterns: UUID 128 bit as string
+					   Profile short names, e.g: spp, dun
+					   RFCOMM channel as string, 1-30
+
+			Address is the path to the TTY or Unix socket to be used.
+			Only one proxy per address (TTY or Unix socket)
+			is allowed.
+
+			The object path of created proxy is returned.
+			On success this will emit a ProxyCreated signal.
+
+			Possible Errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.AlreadyExists
+					 org.bluez.Error.Failed
+
+		void RemoveProxy(string path)
+
+			This removes the proxy object at the given path.
+			On success this will emit a ProxyRemoved signal.
+
+			Possible Errors: org.bluez.Error.DoesNotExist
+					 org.bluez.Error.NotAuthorized
+
+Signals		ProxyCreated(string path)
+
+			This signal indicates a proxy was created.
+			Parameter is object path of created proxy.
+
+		ProxyRemoved(string path)
+
+			This signal indicates a proxy was removed.
+			Parameter is object path of removed proxy.
+
+Serial Proxy hierarchy
+================
+
+Service		org.bluez
+Interface	org.bluez.SerialProxy
+Object path	[variable prefix]/{hci0,hci1,...}/{proxy0,proxy1,...}
+
+Methods		void Enable()
+
+			Starts to listen to the TTY or Unix socket, allocates
+			a RFCOMM channel and add record to the server.
+
+			Possible errors: org.bluez.Error.Failed
+
+		void Disable()
+
+			Stops to listen to the TTY or Unix socket, shutdown
+			the RFCOMM channel allocated for the proxy, and remove
+			record from the server.
+
+			Possible errors: org.bluez.Error.Failed
+
+		dict GetInfo()
+
+			Returns all properties for the proxy. See the
+			properties section for available properties.
+
+		void SetSerialParameters(string rate, uint8 data, uint8 stop,
+			string parity)
+
+			Configures serial communication setting baud rate,
+			data bits, stop bits and parity.
+
+			Doesn't allow change TTY settings if it is open.
+
+			Possible errors: org.bluez.Error.InvalidArguments
+					 org.bluez.Error.NotAuthorized
+
+Properties	string uuid [readonly]
+
+			128-bit UUID that represents the available remote service.
+
+		string address [readonly]
+
+			Address is the path to the TTY or Unix socket name used,
+			set when the proxy was created.
+
+		uint8 channel [readonly]
+
+			RFCOMM channel.
+
+		boolean enabled [readonly]
+
+			Indicates if the proxy is currently enabled.
+
+		boolean connected [readonly]
+
+			Indicates if the proxy is currently connected.
-- 
1.7.4.1

Re: [PATCH -v2 1/3] Add Serial Proxy and Serial Proxy Manager doc

[Johan Hedberg]

Hi Bruno,

On Mon, Aug 29, 2011, Bruno Dilly wrote:
> ---
>  doc/serial-api.txt |  106 ++++++++++++++++++++++++++++++++++++++++++++++++++++
>  1 files changed, 106 insertions(+), 0 deletions(-)

Applied. Thanks. I also added [experimental] flags for both interfaces.

Johan