diff mbox series

[BlueZ,v5,4/6] adapter-api: Add PowerState property documentation

Message ID 20220831113647.85110-4-hadess@hadess.net (mailing list archive)
State Superseded
Headers show
Series [BlueZ,v5,1/6] adapter: Keep track of whether the adapter is rfkill'ed | expand

Checks

Context Check Description
tedd_an/pre-ci_am success Success
tedd_an/checkpatch success Checkpatch PASS
tedd_an/gitlint success Gitlint PASS

Commit Message

Bastien Nocera Aug. 31, 2022, 11:36 a.m. UTC
---
 doc/adapter-api.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

Comments

Luiz Augusto von Dentz Aug. 31, 2022, 8:43 p.m. UTC | #1
Hi Bastien,

On Wed, Aug 31, 2022 at 4:40 AM Bastien Nocera <hadess@hadess.net> 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
>
Bastien Nocera Sept. 1, 2022, 10:43 a.m. UTC | #2
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.
diff mbox series

Patch

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