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 v2 10/13] doc: Add API documentation for org.bluez.Service1
Date: Wed, 12 Jun 2013 09:06:52 +0200 [thread overview]
Message-ID: <1371020815-22330-11-git-send-email-mikel.astiz.oss@gmail.com> (raw)
In-Reply-To: <1371020815-22330-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 | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
2 files changed, 54 insertions(+), 1 deletion(-)
create mode 100644 doc/service-api.txt
diff --git a/Makefile.am b/Makefile.am
index 9d570fb..abab329 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..e07eb75
--- /dev/null
+++ b/doc/service-api.txt
@@ -0,0 +1,53 @@
+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 [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"
+ "connecting"
+ "connected"
+
+ string UUID [readonly]
+
+ 128-bit UUID that representing the remote service.
--
1.8.1.4
next prev parent reply other threads:[~2013-06-12 7:06 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-06-12 7:06 [RFC BlueZ v2 00/13] Add experimental org.bluez.Service1 Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 01/13] test: Remove obsolete test script Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 02/13] test: Add UUID alias table to bluezutils.py Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 03/13] test: Support human-friendly UUIDs in test-device Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 04/13] test: Show human-friendly UUIDs in list-devices Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 05/13] dbus: Add new org.bluez.Service1 Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 06/13] dbus: Add Device property to org.bluez.Service1 Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 07/13] dbus: Add UUID " Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 08/13] dbus: Add state " Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 09/13] dbus: Add Connect/Disconnect " Mikel Astiz
2013-06-12 7:06 ` Mikel Astiz [this message]
2013-06-12 7:06 ` [RFC BlueZ v2 11/13] dbus: Deprecate old profile-connecting API Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 12/13] test: Add test-service script Mikel Astiz
2013-06-12 7:06 ` [RFC BlueZ v2 13/13] test: Add --uuid to test-service Mikel Astiz
2013-06-16 11:50 ` [RFC BlueZ v2 00/13] Add experimental org.bluez.Service1 Marcel Holtmann
2013-06-16 13:58 ` Mikel Astiz
2013-06-19 8:02 ` Marcel Holtmann
2013-06-19 13:00 ` Mikel Astiz
2013-06-19 21:13 ` Marcel Holtmann
2013-07-04 8:27 ` 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=1371020815-22330-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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).