[PATCH v2 07/13] doc: document BasicServiceSet API

James Prestwood
2024-08-08T17:42:45Z

---
doc/basic-service-set.txt | 10 ++++++++++
doc/network-api.txt | 5 +++++
doc/station-api.txt | 6 ++++++
3 files changed, 21 insertions(+)
create mode 100644 doc/basic-service-set.txt

v2:
* Renamed properties after review

diff --git a/doc/basic-service-set.txt b/doc/basic-service-set.txt
new file mode 100644
index 00000000..f827ca02
--- /dev/null
+++ b/doc/basic-service-set.txt
@@ -0,0 +1,10 @@
+Basic service set hierarchy
+=================
+
+Service net.connman.iwd
+Interface net.connman.iwd.BasicServiceSet
+Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}/Xxx
+
+Properties string Address [readonly]
+
+ MAC address of BSS
diff --git a/doc/network-api.txt b/doc/network-api.txt
index e4a34411..8bc6eea6 100644
--- a/doc/network-api.txt
+++ b/doc/network-api.txt
@@ -50,3 +50,8 @@ Properties string Name [readonly]
corresponding to this Network. If the network
is not provisioned or has not been connected to
before, the property is omitted.
+
+ array(object) ExtendedServiceSet [readonly]
+
+ Contains a list of paths of each individual
+ BasicServiceSet object.
diff --git a/doc/station-api.txt b/doc/station-api.txt
index 05dd137e..84f1b7bf 100644
--- a/doc/station-api.txt
+++ b/doc/station-api.txt
@@ -164,6 +164,12 @@ Properties string State [readonly]
for networks. net.connman.iwd.Network objects are
updated when this property goes from true to false.

+ object ConnectedAccessPoint [readonly, optional]
+
+ net.connman.iwd.BasicServiceSet object represeting the
+ BSS the device is currently connected to or to which
+ a connection is in progress.
+
SignalLevelAgent hierarchy
==========================

--
2.34.1