All of lore.kernel.org
 help / color / mirror / Atom feed
* [BlueZ PATCH v1] doc/advertisement-monitor-api: Rename methods and shorten the preset strings
@ 2020-05-06  0:54 Miao-chen Chou
  2020-05-18 21:21 ` Miao-chen Chou
  0 siblings, 1 reply; 3+ messages in thread
From: Miao-chen Chou @ 2020-05-06  0:54 UTC (permalink / raw)
  To: Bluetooth Kernel Mailing List
  Cc: Marcel Holtmann, Yoni Shavit, Alain Michaud,
	Luiz Augusto von Dentz, Michael Sun, Miao-chen Chou

This renames RegisterApplication/UnregisterApplication to
RegisterMonitor/UnregisterMonitor and shortens the strings used in some
properties.
---
Hi Maintainers,

This patch updates the experimental API for advertisement monitoring.

Thanks,
Miao

 doc/advertisement-monitor-api.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
index 604448f56..74adbfae9 100644
--- a/doc/advertisement-monitor-api.txt
+++ b/doc/advertisement-monitor-api.txt
@@ -89,7 +89,7 @@ Service		org.bluez
 Interface	org.bluez.AdvertisementMonitorManager1 [experimental]
 Object path	/org/bluez/{hci0,hci1,...}
 
-Methods		void RegisterApplication(object application)
+Methods		void RegisterMonitor(object application)
 
 			This registers a hierarchy of advertisement monitors.
 			The application object path together with the D-Bus
@@ -99,7 +99,7 @@ Methods		void RegisterApplication(object application)
 			Possible errors: org.bluez.Error.InvalidArguments
 					 org.bluez.Error.AlreadyExists
 
-		void UnregisterApplication(object application)
+		void UnregisterMonitor(object application)
 
 			This unregisters advertisement monitors that have been
 			previously registered. The object path parameter must
@@ -118,7 +118,7 @@ Properties	array{string} SupportedMonitorTypes [read-only]
 
 			Possible values for monitor types:
 
-			"patterns_with_logic_or"
+			"or_patterns"
 				Patterns with logic OR applied. With this type,
 				property "Patterns" must exist and has at least
 				one pattern.
@@ -130,7 +130,7 @@ Properties	array{string} SupportedMonitorTypes [read-only]
 
 			Possible values for features:
 
-			"controller-based-monitor-by-patterns"
+			"controller-patterns"
 				If the controller is capable of performing
 				advertisement monitoring by patterns, BlueZ
 				would offload the patterns to the controller to
-- 
2.24.1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Re: [BlueZ PATCH v1] doc/advertisement-monitor-api: Rename methods and shorten the preset strings
  2020-05-06  0:54 [BlueZ PATCH v1] doc/advertisement-monitor-api: Rename methods and shorten the preset strings Miao-chen Chou
@ 2020-05-18 21:21 ` Miao-chen Chou
       [not found]   ` <CACumGOJ37axfhtog6EO=23XeQxdb6ziuYMZK5ueX4etnf-ePog@mail.gmail.com>
  0 siblings, 1 reply; 3+ messages in thread
From: Miao-chen Chou @ 2020-05-18 21:21 UTC (permalink / raw)
  To: Bluetooth Kernel Mailing List
  Cc: Marcel Holtmann, Yoni Shavit, Alain Michaud,
	Luiz Augusto von Dentz, Michael Sun

Hi Marcel and Luiz,

Per Marcel's suggestion, I renamed the functions and refined the
string values of  features and monitor types. Can you help with
reviewing this?

Thanks,
Miao

On Tue, May 5, 2020 at 5:54 PM Miao-chen Chou <mcchou@chromium.org> wrote:
>
> This renames RegisterApplication/UnregisterApplication to
> RegisterMonitor/UnregisterMonitor and shortens the strings used in some
> properties.
> ---
> Hi Maintainers,
>
> This patch updates the experimental API for advertisement monitoring.
>
> Thanks,
> Miao
>
>  doc/advertisement-monitor-api.txt | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
> index 604448f56..74adbfae9 100644
> --- a/doc/advertisement-monitor-api.txt
> +++ b/doc/advertisement-monitor-api.txt
> @@ -89,7 +89,7 @@ Service               org.bluez
>  Interface      org.bluez.AdvertisementMonitorManager1 [experimental]
>  Object path    /org/bluez/{hci0,hci1,...}
>
> -Methods                void RegisterApplication(object application)
> +Methods                void RegisterMonitor(object application)
>
>                         This registers a hierarchy of advertisement monitors.
>                         The application object path together with the D-Bus
> @@ -99,7 +99,7 @@ Methods               void RegisterApplication(object application)
>                         Possible errors: org.bluez.Error.InvalidArguments
>                                          org.bluez.Error.AlreadyExists
>
> -               void UnregisterApplication(object application)
> +               void UnregisterMonitor(object application)
>
>                         This unregisters advertisement monitors that have been
>                         previously registered. The object path parameter must
> @@ -118,7 +118,7 @@ Properties  array{string} SupportedMonitorTypes [read-only]
>
>                         Possible values for monitor types:
>
> -                       "patterns_with_logic_or"
> +                       "or_patterns"
>                                 Patterns with logic OR applied. With this type,
>                                 property "Patterns" must exist and has at least
>                                 one pattern.
> @@ -130,7 +130,7 @@ Properties  array{string} SupportedMonitorTypes [read-only]
>
>                         Possible values for features:
>
> -                       "controller-based-monitor-by-patterns"
> +                       "controller-patterns"
>                                 If the controller is capable of performing
>                                 advertisement monitoring by patterns, BlueZ
>                                 would offload the patterns to the controller to
> --
> 2.24.1
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [BlueZ PATCH v1] doc/advertisement-monitor-api: Rename methods and shorten the preset strings
       [not found]   ` <CACumGOJ37axfhtog6EO=23XeQxdb6ziuYMZK5ueX4etnf-ePog@mail.gmail.com>
@ 2020-05-18 21:51     ` Miao-chen Chou
  0 siblings, 0 replies; 3+ messages in thread
From: Miao-chen Chou @ 2020-05-18 21:51 UTC (permalink / raw)
  To: Von Dentz, Luiz
  Cc: Bluetooth Kernel Mailing List, Marcel Holtmann, Yoni Shavit,
	Alain Michaud, Michael Sun

Hi Luiz,

Awesome! Thanks for reviewing.

On Mon, May 18, 2020 at 2:30 PM Von Dentz, Luiz
<luiz.von.dentz@intel.com> wrote:
>
> Hi Miao,
>
> On Mon, May 18, 2020 at 2:21 PM Miao-chen Chou <mcchou@chromium.org> wrote:
>>
>> Hi Marcel and Luiz,
>>
>> Per Marcel's suggestion, I renamed the functions and refined the
>> string values of  features and monitor types. Can you help with
>> reviewing this?
>>
>> Thanks,
>> Miao
>>
>> On Tue, May 5, 2020 at 5:54 PM Miao-chen Chou <mcchou@chromium.org> wrote:
>> >
>> > This renames RegisterApplication/UnregisterApplication to
>> > RegisterMonitor/UnregisterMonitor and shortens the strings used in some
>> > properties.
>> > ---
>> > Hi Maintainers,
>> >
>> > This patch updates the experimental API for advertisement monitoring.
>> >
>> > Thanks,
>> > Miao
>> >
>> >  doc/advertisement-monitor-api.txt | 8 ++++----
>> >  1 file changed, 4 insertions(+), 4 deletions(-)
>> >
>> > diff --git a/doc/advertisement-monitor-api.txt b/doc/advertisement-monitor-api.txt
>> > index 604448f56..74adbfae9 100644
>> > --- a/doc/advertisement-monitor-api.txt
>> > +++ b/doc/advertisement-monitor-api.txt
>> > @@ -89,7 +89,7 @@ Service               org.bluez
>> >  Interface      org.bluez.AdvertisementMonitorManager1 [experimental]
>> >  Object path    /org/bluez/{hci0,hci1,...}
>> >
>> > -Methods                void RegisterApplication(object application)
>> > +Methods                void RegisterMonitor(object application)
>> >
>> >                         This registers a hierarchy of advertisement monitors.
>> >                         The application object path together with the D-Bus
>> > @@ -99,7 +99,7 @@ Methods               void RegisterApplication(object application)
>> >                         Possible errors: org.bluez.Error.InvalidArguments
>> >                                          org.bluez.Error.AlreadyExists
>> >
>> > -               void UnregisterApplication(object application)
>> > +               void UnregisterMonitor(object application)
>> >
>> >                         This unregisters advertisement monitors that have been
>> >                         previously registered. The object path parameter must
>> > @@ -118,7 +118,7 @@ Properties  array{string} SupportedMonitorTypes [read-only]
>> >
>> >                         Possible values for monitor types:
>> >
>> > -                       "patterns_with_logic_or"
>> > +                       "or_patterns"
>> >                                 Patterns with logic OR applied. With this type,
>> >                                 property "Patterns" must exist and has at least
>> >                                 one pattern.
>> > @@ -130,7 +130,7 @@ Properties  array{string} SupportedMonitorTypes [read-only]
>> >
>> >                         Possible values for features:
>> >
>> > -                       "controller-based-monitor-by-patterns"
>> > +                       "controller-patterns"
>> >                                 If the controller is capable of performing
>> >                                 advertisement monitoring by patterns, BlueZ
>> >                                 would offload the patterns to the controller to
>> > --
>> > 2.24.1
>> >
>
>
> Sorry for the delay, it is now applied, thanks.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2020-05-18 21:52 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-05-06  0:54 [BlueZ PATCH v1] doc/advertisement-monitor-api: Rename methods and shorten the preset strings Miao-chen Chou
2020-05-18 21:21 ` Miao-chen Chou
     [not found]   ` <CACumGOJ37axfhtog6EO=23XeQxdb6ziuYMZK5ueX4etnf-ePog@mail.gmail.com>
2020-05-18 21:51     ` Miao-chen Chou

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.