From d33b3e0ee618f1c6c1de72e9ff0c42beffc7eff1 Mon Sep 17 00:00:00 2001 From: James Prestwood Date: Tue, 3 Jul 2018 09:34:24 -0700 Subject: [PATCH] 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. --- doc/access-point-api.txt | 26 ++++++++++++++++++++++++++ doc/device-api.txt | 8 ++++++++ 2 files changed, 34 insertions(+) create mode 100644 doc/access-point-api.txt diff --git a/doc/access-point-api.txt b/doc/access-point-api.txt new file mode 100644 index 00000000..44335707 --- /dev/null +++ b/doc/access-point-api.txt @@ -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 diff --git a/doc/device-api.txt b/doc/device-api.txt index a95f7623..bd0d3475 100644 --- a/doc/device-api.txt +++ b/doc/device-api.txt @@ -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.