All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mikel Astiz <mikel.astiz.oss@gmail.com>
To: linux-bluetooth@vger.kernel.org
Cc: Mikel Astiz <mikel.astiz@bmw-carit.de>
Subject: [RFC BlueZ v0 10/13] doc: Add API documentation for org.bluez.Service1
Date: Mon,  6 May 2013 10:43:27 +0200	[thread overview]
Message-ID: <1367829810-8262-11-git-send-email-mikel.astiz.oss@gmail.com> (raw)
In-Reply-To: <1367829810-8262-1-git-send-email-mikel.astiz.oss@gmail.com>

From: Mikel Astiz <mikel.astiz@bmw-carit.de>

Update the documentation to reflect the newly adopted D-Bus API.
---
 Makefile.am         |  2 +-
 doc/service-api.txt | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+), 1 deletion(-)
 create mode 100644 doc/service-api.txt

diff --git a/Makefile.am b/Makefile.am
index da87a21..9cd10b9 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -199,7 +199,7 @@ EXTRA_DIST += doc/assigned-numbers.txt doc/supported-features.txt
 
 EXTRA_DIST += doc/mgmt-api.txt \
 		doc/adapter-api.txt doc/device-api.txt \
-		doc/agent-api.txt doc/profile-api.txt \
+		doc/agent-api.txt doc/profile-api.txt doc/service-api.txt \
 		doc/network-api.txt doc/media-api.txt \
 		doc/health-api.txt doc/sap-api.txt
 
diff --git a/doc/service-api.txt b/doc/service-api.txt
new file mode 100644
index 0000000..ef611d6
--- /dev/null
+++ b/doc/service-api.txt
@@ -0,0 +1,54 @@
+BlueZ D-Bus Service API description
+***********************************
+
+Copyright (C) 2012-2013  BMW Car IT GmbH. All rights reserved.
+
+
+Service hierarchy
+=================
+
+Service		unique name
+Interface	org.bluez.Service1 [Experimental]
+Object path	freely definable
+
+Object path	[variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX/
+								serviceZZZ
+
+Methods		void Connect()
+
+			This method connects a specific service of this
+			device.
+
+			Possible errors: org.bluez.Error.AgentNotAvailable
+					 org.bluez.Error.AlreadyConnected
+					 org.bluez.Error.Canceled
+					 org.bluez.Error.Failed
+					 org.bluez.Error.InProgress
+
+		void Disconnect()
+
+			This method disconnects a specific service of this
+			device.
+
+			There is no connection tracking for a service, so
+			as long as the service is registered this will always
+			succeed.
+
+			Possible errors: org.bluez.Error.Failed
+					 org.bluez.Error.InProgress
+					 org.bluez.Error.NotConnected
+
+Properties	object Device [readonly]
+
+			The object path of the device the service belongs to.
+
+		string State [readonly]
+
+			Indicates the state of the connection.  Possible
+			values are:
+				"disconnected"
+				"connected"
+
+		string UUID [readonly]
+
+			128-bit UUID that representing the remote service.
-- 
1.8.1.4


  parent reply	other threads:[~2013-05-06  8:43 UTC|newest]

Thread overview: 23+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-05-06  8:43 [RFC BlueZ v0 00/13] Add experimental org.bluez.Service1 Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 01/13] test: Remove obsolete test script Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 02/13] test: Add UUID alias table to bluezutils.py Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 03/13] test: Support human-friendly UUIDs in test-device Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 04/13] test: Show human-friendly UUIDs in list-devices Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 05/13] dbus: Add new org.bluez.Service1 Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 06/13] dbus: Add Device property to org.bluez.Service1 Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 07/13] dbus: Add UUID " Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 08/13] dbus: Add state " Mikel Astiz
2013-05-06 10:00   ` Luiz Augusto von Dentz
2013-05-07  7:49     ` Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 09/13] dbus: Add Connect/Disconnect " Mikel Astiz
2013-05-06  8:43 ` Mikel Astiz [this message]
2013-05-15 16:38   ` [RFC BlueZ v0 10/13] doc: Add API documentation for org.bluez.Service1 Scott James Remnant
2013-05-16  6:22     ` Mikel Astiz
2013-05-16 17:10       ` Scott James Remnant
2013-05-17  9:20         ` Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 11/13] dbus: Deprecate old profile-connecting API Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 12/13] test: Add test-service script Mikel Astiz
2013-05-06  8:43 ` [RFC BlueZ v0 13/13] test: Add --uuid to test-service Mikel Astiz
2013-05-06  9:19 ` [RFC BlueZ v0 00/13] Add experimental org.bluez.Service1 Luiz Augusto von Dentz
2013-05-15  8:56   ` Mikel Astiz
2013-05-28  9:45     ` Mikel Astiz

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1367829810-8262-11-git-send-email-mikel.astiz.oss@gmail.com \
    --to=mikel.astiz.oss@gmail.com \
    --cc=linux-bluetooth@vger.kernel.org \
    --cc=mikel.astiz@bmw-carit.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.