From 2c2af4edd305ed63363a12cba3518d8a1db008ad Mon Sep 17 00:00:00 2001 From: Denis Kenzior Date: Fri, 11 Nov 2016 11:29:04 -0600 Subject: [PATCH] doc: Add WSC api --- doc/wsc-api.txt | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 doc/wsc-api.txt diff --git a/doc/wsc-api.txt b/doc/wsc-api.txt new file mode 100644 index 00000000..6d9fd7b8 --- /dev/null +++ b/doc/wsc-api.txt @@ -0,0 +1,36 @@ +WiFiSimpleConfiguration hierarchy +================================= + +Service net.connman.iwd +Interface net.connman.iwd.WiFiSimpleConfiguration [Experimental] +Object path /{phy0,phy1,...}/{1,2,...} + +Methods void PushButton + + Start WSC (formerly known as WPS, Wi-Fi Protected + Setup) configuration in PushButton mode. + + Any connected networks on the device will be + disconnected and scanning will commence to find the + access point in PushButton mode. If multiple access + points are found, then a SessionOverlap error will be + returned. + + This method returns once the configuration has been + completed and the network has been successfully + connected. + + Possible errors: + net.connman.iwd.WiFiSimpleConfiguration.SessionOverlap + net.connman.iwd.WiFiSimpleConfiguration.NoCredentials + net.connman.iwd.WiFiSimpleConfiguration.WalkTimerExpired + net.connman.iwd.WiFiSimpleConfiguration.NotReachable + net.connman.iwd.Aborted + net.connman.iwd.Failed + net.connman.iwd.Busy + + void Cancel() + + Aborts any ongoing WSC operations. If no WSC + operation is ongoing, net.connman.iwd.NotAvailable is + returned.