doc/service-api: Add documentation for Service APIbaserock/v5.17-patched

2 files changed, 74 insertions, 1 deletions

diff --git a/Makefile.am b/Makefile.am
index f96c700d4..321ecba21 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -211,7 +211,8 @@ EXTRA_DIST += doc/mgmt-api.txt \
 		doc/adapter-api.txt doc/device-api.txt \
 		doc/agent-api.txt doc/profile-api.txt \
 		doc/network-api.txt doc/media-api.txt \
-		doc/health-api.txt doc/sap-api.txt
+		doc/health-api.txt doc/sap-api.txt \
+		doc/service-api.txt
 
 EXTRA_DIST += doc/alert-api.txt \
 		doc/proximity-api.txt doc/heartrate-api.txt \
diff --git a/doc/service-api.txt b/doc/service-api.txt
new file mode 100644
index 000000000..fba631e81
--- /dev/null
+++ b/doc/service-api.txt
@@ -0,0 +1,72 @@
+BlueZ D-Bus Service API description
+***********************************
+
+
+Service hierarchy
+=================
+
+Service		org.bluez
+Interface	org.bluez.Service1 [Plugin]
+Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/<UUID>
+
+		void Connect()
+
+			This method connects the service represented by
+			object.
+
+			Possible errors: org.bluez.Error.InProgress
+					 org.bluez.Error.Failed
+
+		void Disconnect()
+
+			This method disconnects the service represented by
+			object.
+
+			Possible errors: org.bluez.Error.InProgress
+					 org.bluez.Error.Failed
+
+Properties	string Device [readonly]
+
+			The object path of the device the service belongs to.
+
+		string State [readonly]
+
+			Service connection state.
+
+			Possible values: "disconnected", "connecting",
+			"connected", "disconnecting", "error".
+
+		string RemoteUUID [readonly]
+
+			UUID of the role the remote device will assume once
+			connected.
+
+			Note this UUID is the same given to
+			Device.ConnectProfile and Device.DisconnectProfile.
+
+		string LocalUUID [readonly]
+
+			UUID of the role the local adapter will assume once
+			connected.
+
+			Note this UUID is the same as used in
+			ProfileManager.RegisterProfile.
+
+		uint16 Version [readonly]
+
+			Combined version that shall be used once connected.
+
+		bool AutoConnect [readwrite]
+
+			Enable or disable service to auto connect once device
+			is connected.
+
+			Note this can be used for external connection policies
+			and currently is not persistent.
+
+		bool Blocked [readwrite]
+
+			Block or unblock incoming connections to service.
+
+			Note this can be used for external connection policies
+			and currently is not persistent.