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

doc: updated device-api and added ap-api 

Added "Mode" documentation for device API, as well as added
a new ap-api.txt to document the AccessPoint interface.
This commit is contained in:
James Prestwood 2018-07-03 09:34:24 -07:00 committed by Denis Kenzior
parent 5f69aba32b
commit d33b3e0ee6
2 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
doc/access-point-api.txt Normal file
View File

@ -0,0 +1,26 @@
Access Point hiearchy
=====================
Service net.connman.iwd
Interface net.connman.AccessPoint [Experimental]
Object path /{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.InvalidArgs
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.InvalidArgs

8
doc/device-api.txt
View File

@ -146,3 +146,11 @@ Properties string Name [readonly]
object Adapter [readonly]
The object path of the adapter the device belongs to.
string Mode [readwrite]
Use to set the device mode. Valid modes are "station"
and "ap". Setting the mode to "ap" will cause the
AccessPoint interface to appear on the bus. If the device
mode is switch back to "station" it will cause any
mode specific interfaces to disappear from the bus.