3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-26 18:59:22 +01:00
iwd/doc/wsc-api.txt
2017-02-22 17:02:59 -06:00

68 lines
2.2 KiB
Plaintext

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
string GeneratePin()
Generates a random 8 digit PIN with an included check
digit suitable for use by most user interfaces.
void StartPin(string pin)
Start WSC in PIN mode. If iwd's WSC configuration
indicates that the device does not support a display,
a static PIN from the iwd.conf configuration file is
used. Contents of pin are ignored in this case.
Otherwise, the pin provided will be utilized. This
can be an automatically generated PIN that contains a
check digit, or a user-specified PIN. The
GeneratePin() method can be used a generate a random
8 digit PIN with an included check digit.
This method returns once the configuration has been
completed and the network has been successfully
connected.
Possible errors:
net.connman.iwd.WiFiSimpleConfiguration.NoCredentials
net.connman.iwd.WiFiSimpleConfiguration.NotReachable
net.connman.iwd.WiFiSimpleConfiguration.WalkTimerExpired
net.connman.iwd.Aborted
net.connman.iwd.Failed
net.connman.iwd.Busy
net.connman.iwd.InvalidArgs
net.connman.iwd.InvalidFormat
void Cancel()
Aborts any ongoing WSC operations. If no WSC
operation is ongoing, net.connman.iwd.NotAvailable is
returned.