doc: Add Adapter API documentation

2016-11-07 11:55:07 -06:00 · 2016-11-07 11:55:07 -06:00 · ee074153ed
parent 0b98f75dda
commit ee074153ed
1 changed files with 19 additions and 0 deletions
--- a/doc/adapter-api.txt
+++ b/doc/adapter-api.txt
@ -0,0 +1,19 @@
+Adapter hierarchy
+================
+
+Service		net.connman.iwd
+Interface	net.connman.iwd.Adapter [Experimental]
+Object path	/{phy0,phy1,...}
+
+Properties	boolean Powered [readwrite]
+
+			True if the adapter is powered.  If false, the
+			all of adapter's devices are powered down.
+
+		string Model [readonly, optional]
+
+			Contains the model name of the adapter, if available.
+
+		string Vendor [readonly, optional]
+
+			Contains the vendor name of the adapter, if available.