3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-12-27 19:22:34 +01:00
iwd/doc/access-point-api.txt

86 lines
2.3 KiB
Plaintext

Access Point hierarchy
=====================
Service net.connman.iwd
Interface net.connman.iwd.AccessPoint [Experimental]
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}
Methods void Start(string ssid, string psk)
Start an access point called ssid with a passphrase
of psk.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArguments
net.connman.iwd.AlreadyExists
void Stop()
Stop a started access point. Note: Calling Stop() will
not bring down the AccessPoint interface. The device
mode must be switched to non-ap mode.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArguments
void StartProfile(string ssid)
Start a profile based access point. A profile must exist
in IWD's AP configuration directory (/var/lib/iwd/ap/
by default) of the name <ssid>.ap.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArguments
net.connman.iwd.AlreadyExists
net.connman.iwd.NotFound
void Scan()
Schedule a network scan.
Possible errors: net.connman.iwd.NotAvailable
net.connman.iwd.NotSupported
net.connman.iwd.Busy
net.connman.iwd.Failed
array(dict) GetOrderedNetworks()
Gets the list of networks found after scanning sorted
based on signal strength. Each item in the array is a
dictionary containing the network Name, SignalStrength,
and Security.
Possible errors: net.connman.iwd.NotAvailable
Properties boolean Started [readonly]
Reflects whether an access point has been started.
string Name [readonly, optional]
The SSID being broadcast for a started AP (omitted if
AP has not been started)
boolean Scanning [readonly]
Reflects whether the access point is scanning.
uint32 Frequency [readonly, optional]
The frequency that the Access Point is operating on.
array{string} PairwiseCiphers [readonly, optional]
List of pairwise ciphers the access point supports.
The same format as setting a list of ciphers for an AP
profile, i.e. TKIP, CCMP-128, GCMP-128, CCMP-256 etc.
string GroupCipher [readonly, optional]
The group cipher suite the access point is using.
Possible values are the same as what could be included
in the PairwiseCiphers list.