Kernel/iwd
3
0
Fork 0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-25 09:39:25 +01:00
Code Releases Activity

doc: Generalize wsc-api method descriptions

Browse Source
This commit is contained in:
Andrew Zaborowski 2019-12-05 04:22:44 +01:00 committed by Denis Kenzior
parent cbbc247aa2
commit f909c6db26
1 changed files with 25 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
doc/wsc-api.txt
View File

@ -4,21 +4,24 @@ SimpleConfiguration hierarchy
Service net.connman.iwd Service net.connman.iwd
Interface net.connman.iwd.SimpleConfiguration Interface net.connman.iwd.SimpleConfiguration
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...} Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}
Object path /net/connman/iwd/{phy0,phy1,...}/p2p_peers/{aa_bb_cc_dd_ee_ff}
Methods void PushButton() Methods void PushButton()
Start WSC (formerly known as WPS, Wi-Fi Protected Start WSC (formerly known as WPS, Wi-Fi Protected
Setup) configuration in PushButton mode. Setup) configuration in PushButton mode or trigger a
connection to a specific P2P peer. The usage will
depend on which object this interface is found on.
Any connected networks on the device will be In the first use case any connected networks on the
disconnected and scanning will commence to find the device will be disconnected and scanning will commence
access point in PushButton mode. If multiple access to find the access point in PushButton mode. If
points are found, then a SessionOverlap error will be multiple access points are found, then a
returned. SessionOverlap error will be returned.
This method returns once the configuration has been This method returns once the configuration has been
completed and the network has been successfully completed and the network or the P2P peer has been
connected. successfully connected.
Possible errors: Possible errors:
net.connman.iwd.SimpleConfiguration.SessionOverlap net.connman.iwd.SimpleConfiguration.SessionOverlap
@ -28,6 +31,8 @@ Methods void PushButton()
net.connman.iwd.Aborted net.connman.iwd.Aborted
net.connman.iwd.Failed net.connman.iwd.Failed
net.connman.iwd.Busy net.connman.iwd.Busy
net.connman.iwd.InvalidArguments
net.connman.iwd.NotSupported
string GeneratePin() string GeneratePin()
@ -35,10 +40,12 @@ Methods void PushButton()
digit suitable for use by most user interfaces. digit suitable for use by most user interfaces.
void StartPin(string pin) void StartPin(string pin)
Start WSC in PIN mode. If iwd's WSC configuration
indicates that the device does not support a display, Start WSC or connect to a specific P2P peer in PIN
a static PIN from the main.conf configuration file is mode. If iwd's WSC configuration indicates that the
used. Contents of pin are ignored in this case. device does not support a display, a static PIN from
the main.conf configuration file is used. Contents
of pin are ignored in this case.
Otherwise, the pin provided will be utilized. This Otherwise, the pin provided will be utilized. This
can be an automatically generated PIN that contains a can be an automatically generated PIN that contains a
@ -47,8 +54,8 @@ Methods void PushButton()
8 digit PIN with an included check digit. 8 digit PIN with an included check digit.
This method returns once the configuration has been This method returns once the configuration has been
completed and the network has been successfully completed and the network or the P2P peer has been
connected. successfully connected.
Possible errors: Possible errors:
net.connman.iwd.SimpleConfiguration.NoCredentials net.connman.iwd.SimpleConfiguration.NoCredentials
@ -59,9 +66,10 @@ Methods void PushButton()
net.connman.iwd.Busy net.connman.iwd.Busy
net.connman.iwd.InvalidArguments net.connman.iwd.InvalidArguments
net.connman.iwd.InvalidFormat net.connman.iwd.InvalidFormat
net.connman.iwd.NotSupported
void Cancel() void Cancel()
Aborts any ongoing WSC operations. If no WSC Aborts any ongoing WSC operations or a P2P connection.
operation is ongoing, net.connman.iwd.NotAvailable is If no operation is ongoing, net.connman.iwd.NotAvailable
returned. is returned.