summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDenis Kenzior <denkenz@gmail.com>2012-09-04 22:03:14 -0500
committerDenis Kenzior <denkenz@gmail.com>2012-09-04 22:03:14 -0500
commitb7e92a714be1205657043d55b1f34016645525e4 (patch)
tree067272af483ae434fc8ab813ec079aeb14278c58 /doc
parentef7a4bc3a76af66009cd8ba622627ca641bfc4b8 (diff)
downloadofono-b7e92a714be1205657043d55b1f34016645525e4.tar.bz2
doc: Add a few BT-related clarifications
The 'Name' and 'Serial' property take on slightly different meanings in the case of Bluetooth devices (e.g. HFP). Update the documentation to reflect that.
Diffstat (limited to 'doc')
-rw-r--r--doc/modem-api.txt8
1 files changed, 7 insertions, 1 deletions
diff --git a/doc/modem-api.txt b/doc/modem-api.txt
index e242bd1d..1c4e440f 100644
--- a/doc/modem-api.txt
+++ b/doc/modem-api.txt
@@ -56,7 +56,9 @@ Properties boolean Powered [readwrite]
string Name [readonly, optional]
- Friendly name of the modem device.
+ Friendly name of the modem device. In the case of
+ Bluetooth devices (e.g. Type="sap" or "hfp") this
+ corresponds to the remote device name or it's alias.
string Manufacturer [readonly, optional]
@@ -84,6 +86,10 @@ Properties boolean Powered [readwrite]
This is usually obtained by using the +CGSN AT command.
+ In the case of Bluetooth devices (e.g. Type="sap" or
+ "hfp") this corresponds to the Bluetooth Device
+ Address of the remote device.
+
array{string} Features [readonly]
List of currently enabled features. It uses simple