Kernel
/
iwd
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git
3
0
Fork 0
Code Releases Activity

doc: Add StartPin method to wsc

This commit is contained in:
Denis Kenzior 2017-02-22 17:02:59 -06:00
parent 6c5ae87f1a
commit b959bb495b
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/wsc-api.txt
View File

@ -34,6 +34,32 @@ Methods void PushButton()
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