From: Miao-chen Chou <mcchou@chromium.org>
To: Bluetooth Kernel Mailing List <linux-bluetooth@vger.kernel.org>
Cc: Manish Mandlik <mmandlik@chromium.org>,
Howard Chung <howardchung@google.com>,
Luiz Augusto von Dentz <luiz.von.dentz@intel.com>,
Alain Michaud <alainm@chromium.org>,
Miao-chen Chou <mcchou@chromium.org>
Subject: [BlueZ PATCH v5 8/8] doc: Update Advertisement Monitor API description
Date: Fri, 11 Sep 2020 23:51:33 -0700 [thread overview]
Message-ID: <20200911235104.BlueZ.v5.8.Iee7e9d13c78dd02c5b283a203dea11a4a4ffa7cc@changeid> (raw)
In-Reply-To: <20200911235104.BlueZ.v5.1.Iaa9dc2a66de5fbfa97627e1dbeb800116d3aa91e@changeid>
This modifies the following description to Advertisement Monitor API.
- Add org.bluez.Error.Failed to RegisterMonitor() method.
- Add more description about the usage of RegisterMonitor() and
UnregisterMonitor() methods.
- Add description about the ranges for the fields in property
RSSIThresholdsAndTimers.
Reviewed-by: Yun-Hao Chung <howardchung@google.com>
Reviewed-by: Manish Mandlik <mmandlik@chromium.org>
---
(no changes since v1)
doc/advertisement-monitor-api.txt | 34 +++++++++++++++++++++++--------
1 file changed, 25 insertions(+), 9 deletions(-)
diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
index 74adbfae9..e09b6fd25 100644
--- a/doc/advertisement-monitor-api.txt
+++ b/doc/advertisement-monitor-api.txt
@@ -49,7 +49,7 @@ Properties string Type [read-only]
org.bluez.AdvertisementMonitorManager1 for the available
options.
- (Int16, Uint16, Int16, Uint16) RSSIThreshholdsAndTimers [read-only, optional]
+ (Int16, Uint16, Int16, Uint16) RSSIThresholdsAndTimers [read-only, optional]
This contains HighRSSIThreshold, HighRSSIThresholdTimer,
LowRSSIThreshold, LowRSSIThresholdTimer in order. The
@@ -66,7 +66,11 @@ Properties string Type [read-only]
RSSIs of the received advertisement(s) during
LowRSSIThresholdTimer do not reach LowRSSIThreshold.
- array{(uint8, uint8, string)} Patterns [read-only, optional]
+ The valid range of a RSSI is -127 to +20 dBm while 127
+ dBm indicates unset. The valid range of a timer is 1 to
+ 300 seconds while 0 indicates unset.
+
+ array{(uint8, uint8, array{byte})} Patterns [read-only, optional]
If Type is set to 0x01, this must exist and has at least
one entry in the array.
@@ -80,8 +84,9 @@ Properties string Type [read-only]
See https://www.bluetooth.com/specifications/
assigned-numbers/generic-access-profile/ for
the possible allowed value.
- string content_of_pattern
- This is the value of the pattern.
+ array{byte} content_of_pattern
+ This is the value of the pattern. The maximum
+ length of the bytes is 31.
Advertisement Monitor Manager hierarchy
=======================================
@@ -91,20 +96,31 @@ Object path /org/bluez/{hci0,hci1,...}
Methods void RegisterMonitor(object application)
- This registers a hierarchy of advertisement monitors.
+ This registers the root path of a hierarchy of
+ advertisement monitors.
The application object path together with the D-Bus
system bus connection ID define the identification of
the application registering advertisement monitors.
+ Once a root path is registered by a client via this
+ method, the client can freely expose/unexpose
+ advertisement monitors without re-registering the root
+ path again. After use, the client should call
+ UnregisterMonitor() method to invalidate the
+ advertisement monitors.
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.AlreadyExists
+ org.bluez.Error.Failed
void UnregisterMonitor(object application)
- This unregisters advertisement monitors that have been
- previously registered. The object path parameter must
- match the same value that has been used on
- registration.
+ This unregisters a hierarchy of advertisement monitors
+ that has been previously registered. The object path
+ parameter must match the same value that has been used
+ on registration. Upon unregistration, the advertisement
+ monitor(s) should expect to receive Release() method as
+ the signal that the advertisement monitor(s) has been
+ deactivated.
Possible errors: org.bluez.Error.InvalidArguments
org.bluez.Error.DoesNotExist
--
2.26.2
next prev parent reply other threads:[~2020-09-12 6:53 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-12 6:51 [BlueZ PATCH v5 1/8] adapter: Remove indirect dependency of headers Miao-chen Chou
2020-09-12 6:51 ` [BlueZ PATCH v5 2/8] adv_monitor: Introduce org.bluez.AdvertisementMonitorManager1 interface Miao-chen Chou
2020-09-12 7:29 ` [BlueZ,v5,2/8] " bluez.test.bot
2020-09-12 6:51 ` [BlueZ PATCH v5 3/8] adv_monitor: Implement Get functions of Adv monitor manager properties Miao-chen Chou
2020-09-12 6:51 ` [BlueZ PATCH v5 4/8] adv_monitor: Implement RegisterMonitor() Miao-chen Chou
2020-09-12 6:51 ` [BlueZ PATCH v5 5/8] adv_monitor: Implement UnregisterMonitor() Miao-chen Chou
2020-09-12 6:51 ` [BlueZ PATCH v5 6/8] adv_monitor: Handle D-Bus client ready events Miao-chen Chou
2020-09-12 6:51 ` [BlueZ PATCH v5 7/8] adv_monitor: Handle D-Bus proxy event of an ADV monitor Miao-chen Chou
2020-09-12 6:51 ` Miao-chen Chou [this message]
2020-09-12 7:32 ` [BlueZ,v5,1/8] adapter: Remove indirect dependency of headers bluez.test.bot
2020-09-14 19:47 ` [BlueZ PATCH v5 1/8] " Luiz Augusto von Dentz
2020-09-15 19:29 ` Miao-chen Chou
2020-09-15 19:53 ` Luiz Augusto von Dentz
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=20200911235104.BlueZ.v5.8.Iee7e9d13c78dd02c5b283a203dea11a4a4ffa7cc@changeid \
--to=mcchou@chromium.org \
--cc=alainm@chromium.org \
--cc=howardchung@google.com \
--cc=linux-bluetooth@vger.kernel.org \
--cc=luiz.von.dentz@intel.com \
--cc=mmandlik@chromium.org \
/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.