summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBruna Moreira <bruna.moreira@openbossa.org>2012-02-28 09:31:40 -0400
committerClaudio Takahasi <claudio.takahasi@openbossa.org>2012-02-28 13:38:20 -0300
commit6eddc881d1b0fff273902e245fb97e8e8a47bd0a (patch)
treed12a55b34a312d957ca162abb14400d5acf7b5eb
parent71756741fe8ee346e9dc1b3e560d2da62cc9ef65 (diff)
downloadbluez-le-docs-6eddc881d1b0fff273902e245fb97e8e8a47bd0a.tar.gz
bluez-le-docs-6eddc881d1b0fff273902e245fb97e8e8a47bd0a.tar.xz
bluez-le-docs-6eddc881d1b0fff273902e245fb97e8e8a47bd0a.zip
howto: Add test-proximity script documentation
-rw-r--r--howto.tex34
1 files changed, 34 insertions, 0 deletions
diff --git a/howto.tex b/howto.tex
index 8509a87..d3e8ea3 100644
--- a/howto.tex
+++ b/howto.tex
@@ -608,6 +608,40 @@ $ test-adapter discovering
\end{enumerate}
+\subsection{Proximity API}
+
+The Proximity API is available at {\em doc/proximity-api.txt}. The
+\verb|test-proximity| Python script uses the Proximity Monitor D-Bus API. It
+can be used to set values for LinkLossAlertLevel and ImmediateAlertLevel. The
+values permitted are "none", "mild" and "high".
+
+First, pair with remote device using \verb|simple-agent| or any other BlueZ
+pairing tool. After this, \verb|test-proximity| can be used.
+
+\begin{enumerate}
+
+\item The LinkLossAlertLevel operation only takes effect when link is lost, at which
+point the device will alert at the specified intensity level. For example, to
+set LinkLossAlertLevel to "mild":
+
+\begin{verbatim}
+$ ./test-proximity -b <device address> mild
+Proximity SetProperty('LinkLossAlertLevel', 'mild')
+PropertyChanged('LinkLossAlertLevel', 'mild')
+\end{verbatim}
+
+\item Using the ImmediateAlertLevel for any value other than "none" will make the
+remote device alert as soon as possible at the specified intensity level. For
+example, to set ImmediateAlertLevel to "high":
+
+\begin{verbatim}
+$ ./test-proximity -b <device address> ImmediateAlertLevel high
+Proximity SetProperty('ImmediateAlertLevel', 'high')
+PropertyChanged('ImmediateAlertLevel', 'high')
+\end{verbatim}
+
+\end{enumerate}
+
% \section{Supporting tools}
%
%