summaryrefslogtreecommitdiff
path: root/doc/mesh-api.txt
diff options
context:
space:
mode:
authorInga Stotland <inga.stotland@intel.com>2019-07-25 19:03:10 -0700
committerBrian Gix <brian.gix@intel.com>2019-07-26 09:08:58 -0700
commit4b0bfe960df205d7930a804a16a1283f246e91b2 (patch)
treebb05f5223ea54c629907cc66476da192b8a41681 /doc/mesh-api.txt
parent79bf51dbb50ab9a10a42fcc51e23be92e2441508 (diff)
downloadbluez-4b0bfe960df205d7930a804a16a1283f246e91b2.tar.gz
doc/mesh-api: Restore properties in mesh node hierarchy
This restores Features, Beacon, BeaconFlags, IvIndex and SecondsSinceLAst heard properties under the org.bluez.mesh.Node1 interface.
Diffstat (limited to 'doc/mesh-api.txt')
-rw-r--r--doc/mesh-api.txt98
1 files changed, 49 insertions, 49 deletions
diff --git a/doc/mesh-api.txt b/doc/mesh-api.txt
index ff6b33346..7b62c0af4 100644
--- a/doc/mesh-api.txt
+++ b/doc/mesh-api.txt
@@ -343,6 +343,55 @@ Methods:
org.bluez.mesh.Error.DoesNotExist
org.bluez.mesh.Error.InvalidArguments
+Properties:
+ dict Features [read-only]
+
+ The dictionary that contains information about feature support.
+ The following keys are defined:
+
+ boolean Friend
+
+ Indicates the ability to establish a friendship with a
+ Low Power node
+
+ boolean LowPower
+
+ Indicates support for operating in Low Power node mode
+
+ boolean Proxy
+
+ Indicates support for GATT proxy
+
+ boolean Relay
+ Indicates support for relaying messages
+
+ If a key is absent from the dictionary, the feature is not supported.
+ Otherwise, true means that the feature is enabled and false means that
+ the feature is disabled.
+
+ boolean Beacon [read-only]
+
+ This property indicates whether the periodic beaconing is
+ enabled (true) or disabled (false).
+
+ uint8 BeaconFlags [read-only]
+
+ This property may be read at any time to determine the flag
+ field setting on sent and received beacons of the primary
+ network key.
+
+ uint32 IvIndex [read-only]
+
+ This property may be read at any time to determine the IV_Index
+ that the current network is on. This information is only useful
+ for provisioning.
+
+ uint32 SecondsSinceLastHeard [read-only]
+
+ This property may be read at any time to determine the number of
+ seconds since mesh network layer traffic was last detected on
+ this node's network.
+
Mesh Provisioning Hierarchy
============================
Service org.bluez.mesh
@@ -618,55 +667,6 @@ Methods:
PossibleErrors:
org.bluez.mesh.Error.InvalidArguments
-Properties:
- dict Features [read-only]
-
- The dictionary that contains information about feature support.
- The following keys are defined:
-
- boolean Friend
-
- Indicates the ability to establish a friendship with a
- Low Power node
-
- boolean LowPower
-
- Indicates support for operating in Low Power node mode
-
- boolean Proxy
-
- Indicates support for GATT proxy
-
- boolean Relay
- Indicates support for relaying messages
-
- If a key is absent from the dictionary, the feature is not supported.
- Otherwise, true means that the feature is enabled and false means that
- the feature is disabled.
-
- boolean Beacon [read-only]
-
- This property indicates whether the periodic beaconing is
- enabled (true) or disabled (false).
-
- uint8 BeaconFlags [read-only]
-
- This property may be read at any time to determine the flag
- field setting on sent and received beacons of the primary
- network key.
-
- uint32 IvIndex [read-only]
-
- This property may be read at any time to determine the IV_Index
- that the current network is on. This information is only useful
- for provisioning.
-
- uint32 SecondsSinceLastHeard [read-only]
-
- This property may be read at any time to determine the number of
- seconds since mesh network layer traffic was last detected on
- this node's network.
-
Mesh Application Hierarchy
==========================
Service unique name