doc: Add WSC api

This commit is contained in:
Denis Kenzior 2016-11-11 11:29:04 -06:00
parent 92ece898d1
commit 2c2af4edd3
1 changed files with 36 additions and 0 deletions

36
doc/wsc-api.txt Normal file
View File

@ -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.