From be2e1faa31c27703c9a443a807c5e1de2eff21a2 Mon Sep 17 00:00:00 2001
From: James Prestwood <prestwoj@gmail.com>
Date: Thu, 24 Feb 2022 09:05:00 -0800
Subject: [PATCH] doc: document access point scanning

---
 doc/access-point-api.txt | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt
index 68ba23c5..3512da82 100644
--- a/doc/access-point-api.txt
+++ b/doc/access-point-api.txt
@@ -37,6 +37,24 @@ Methods		void Start(string ssid, string psk)
 						net.connman.iwd.AlreadyExists
 						net.connman.iwd.NotFound
 
+		void Scan()
+
+			Schedule a network scan.
+
+			Possible errors:	net.connman.iwd.NotAvailable
+						net.connman.iwd.NotSupported
+						net.connman.iwd.Busy
+						net.connman.iwd.Failed
+
+		array(dict) GetOrderedNetworks()
+
+			Gets the list of networks found after scanning sorted
+			based on signal strength. Each item in the array is a
+			dictionary containing the network Name, SignalStrength,
+			and Security.
+
+			Possible errors:	net.connman.iwd.NotAvailable
+
 Properties	boolean Started [readonly]
 
 			Reflects whether an access point has been started.
@@ -45,3 +63,7 @@ Properties	boolean Started [readonly]
 
 			The SSID being broadcast for a started AP (omitted if
 			AP has not been started)
+
+		boolean Scanning [readonly]
+
+			Reflects whether the access point is scanning.