2022-08-31 11:40:56

by Bastien Nocera

[permalink] [raw]
Subject: [PATCH BlueZ v5 4/6] adapter-api: Add PowerState property documentation

---
doc/adapter-api.txt | 15 +++++++++++++++
1 file changed, 15 insertions(+)

diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 48466ab75..28e53a105 100644
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@@ -269,6 +269,21 @@ Properties string Address [readonly]
restart or unplugging of the adapter it will reset
back to false.

+ string PowerState [readonly]
+
+ The power state of an adapter.
+
+ The power state will show whether the adapter is
+ turning off, or turning on, as well as being on
+ or off.
+
+ Possible values:
+ "on" - powered on
+ "off" - powered off
+ "off-enabling" - transitioning from "off" to "on"
+ "on-disabling" - transitioning from "on" to "off"
+ "off-blocked" - blocked by rfkill
+
boolean Discoverable [readwrite]

Switch an adapter to discoverable or non-discoverable
--
2.37.2


2022-08-31 20:56:47

by Luiz Augusto von Dentz

[permalink] [raw]
Subject: Re: [PATCH BlueZ v5 4/6] adapter-api: Add PowerState property documentation

Hi Bastien,

On Wed, Aug 31, 2022 at 4:40 AM Bastien Nocera <[email protected]> wrote:
>
> ---
> doc/adapter-api.txt | 15 +++++++++++++++
> 1 file changed, 15 insertions(+)
>
> diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
> index 48466ab75..28e53a105 100644
> --- a/doc/adapter-api.txt
> +++ b/doc/adapter-api.txt
> @@ -269,6 +269,21 @@ Properties string Address [readonly]
> restart or unplugging of the adapter it will reset
> back to false.
>
> + string PowerState [readonly]

We should have it documented as experimental as well.

> +
> + The power state of an adapter.
> +
> + The power state will show whether the adapter is
> + turning off, or turning on, as well as being on
> + or off.
> +
> + Possible values:
> + "on" - powered on
> + "off" - powered off
> + "off-enabling" - transitioning from "off" to "on"
> + "on-disabling" - transitioning from "on" to "off"
> + "off-blocked" - blocked by rfkill
> +
> boolean Discoverable [readwrite]
>
> Switch an adapter to discoverable or non-discoverable
> --
> 2.37.2
>


--
Luiz Augusto von Dentz

2022-09-01 10:51:32

by Bastien Nocera

[permalink] [raw]
Subject: Re: [PATCH BlueZ v5 4/6] adapter-api: Add PowerState property documentation

On Wed, 2022-08-31 at 13:43 -0700, Luiz Augusto von Dentz wrote:
> > +               string PowerState [readonly]
>
> We should have it documented as experimental as well.

Fixed in v6.