summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBastien Nocera <hadess@hadess.net>2022-09-01 13:07:17 +0200
committerLuiz Augusto von Dentz <luiz.von.dentz@intel.com>2022-09-01 11:43:44 -0700
commit6e49216ad47dc8ffd9cbf2066d13fd7b59613c98 (patch)
treed97bf8e9f9110b2469b20724defd31e49c78c789 /doc
parent48992da64f52a4ca73221689e9e116ae93e0ba03 (diff)
downloadbluez-6e49216ad47dc8ffd9cbf2066d13fd7b59613c98.tar.gz
adapter-api: Add PowerState property documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/adapter-api.txt15
1 files changed, 15 insertions, 0 deletions
diff --git a/doc/adapter-api.txt b/doc/adapter-api.txt
index 48466ab75..9b2721c1b 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, experimental]
+
+ 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