3
0
mirror of https://git.kernel.org/pub/scm/network/wireless/iwd.git synced 2024-11-05 11:39:24 +01:00
iwd/doc/device-provisioning-api.txt
Jesse Lentz 03cc7a5f79 doc: Add new DeviceProvisioning API properties
Document the Started, Role, and URI properties of the DeviceProvisioning
API.
2022-06-27 11:06:49 -05:00

74 lines
2.0 KiB
Plaintext

Device Provisioning hierarchy
=============================
Service net.connman.iwd
Interface net.connman.iwd.DeviceProvisioning [Experimental]
Object path /net/connman/iwd/{phy0,phy1,...}/{1,2,...}
Methods string StartEnrollee()
Start a DPP enrollee. Currently only station devices are
supported.
Returns the enrollees URI
Possible errors: net.connman.iwd.InvalidArguments
net.connman.iwd.AlreadyExists
net.connman.iwd.NotAvailable
void Stop()
Stop an enrollee.
Possible errors: net.connman.iwd.Busy
net.connman.iwd.Failed
net.connman.iwd.InvalidArguments
string StartConfigurator()
Start a DPP configurator. Currently only connected
station devices are supported, and will only configure
the enrollee to the currently connected network.
Returns the configurator URI
Possible errors: net.connman.iwd.NotAvailable
net.connman.iwd.NotConnected
net.connman.iwd.NotConfigured
net.connman.iwd.NotSupported
net.connman.iwd.Busy
string ConfigureEnrollee(string uri)
Start a DPP configurator with an enrollees URI.
Only connected station devices are supported and will
only configure the enrollee to the currently connected
network.
This API is to handle the use case where the enrollee
has shared its URI to IWD (unlike StartConfigurator)
The URI for IWD is also returned which could be used
in the same way as it is with StartConfigurator().
Possible errors: net.connman.iwd.NotAvailable
net.connman.iwd.NotConnected
net.connman.iwd.NotConfigured
net.connman.iwd.NotSupported
net.connman.iwd.Busy
Properties boolean Started [readonly]
True if DPP is currently active.
string Role [readonly, optional]
Indicates the DPP role. Possible values are "enrollee"
or "configurator". This property is only available when
Started is true.
string URI [readonly, optional]
Indicates the DPP URI. This property is only available
when Started is true.