Adding connman-test subpackage

[framework/connectivity/connman.git] / doc / agent-api.txt

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index b4b8a39..14b2e50 100644 (file)
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -61,15 +61,40 @@ Fields              string Name
                        Normally returning the "Name" field is the better
                        option here.
 
+               string Identity
+
+                       Identity (username) for EAP authentication methods.
+
                string Passphrase
 
-                       The passphrase for a network. For example a WEP
-                       key or a PSK passphrase.
+                       The passphrase for authentication. For example a WEP
+                       key, a PSK passphrase or a passphrase for EAP
+                       authentication methods.
+
+               string WPS
+
+                       This field requests the use of WPS to get associated.
+                       This is an alternate choice against Passphrase when
+                       requested service supports WPS. The reply can contain
+                       either empty pin, if user wants to use push-button
+                       method, or a pin code if user wants to use the pin
+                       method.
+
+               string Username
+
+                       Username for WISPr authentication. This field will be
+                       requested when connecting to a WISPr-enabled hotspot.
+
+               string Password
+
+                       Password for WISPr authentication. This field will be
+                       requested when connecting to a WISPr-enabled hotspot.
 
 Arguments      string Type
 
-                       Contains the type of a field. For example "psk",
-                       "wep", "ssid" or plain "string".
+                       Contains the type of a field. For example "psk", "wep"
+                       "passphrase", "response", "ssid", "wpspin" or plain
+                       "string".
 
                string Requirement
 
@@ -109,3 +134,56 @@ Examples   Requesting a passphrase for WPA2 network
                                           }
                                }
                        ==> { "Name" : "My hidden network" }
+
+               Requesting a passphrase for a WPA2 network with WPS alternative:
+
+                       RequestInput("/service3",
+                               { "Passphrase" : { "Type"        : "psk",
+                                                  "Requirement" : "mandatory",
+                                                  "Alternates"  : [ "WPS" ]
+                                                },
+                                 "WPS"        : { "Type"        : "wpspin",
+                                                  "Requirement" : "alternate"
+                                                }
+                               }
+
+                       ==> { "WPS" : "123456" }
+
+               Requesting passphrase for a WPA-Enterprise network:
+
+                       RequestInput("/service4",
+                               { "Identity"   : { "Type"        : "string",
+                                                  "Requirement" : "mandatory"
+                                                },
+                                 "Passphrase" : { "Type" : "passphrase",
+                                                  "Requirement" : "mandatory"
+                                                }
+                               }
+
+                       ==> { "Identity" : "alice", "Passphrase": "secret123" }
+
+               Requesting challenge response for a WPA-Enterprise network:
+
+                       RequestInput("/service4",
+                               { "Identity"   : { "Type"        : "string",
+                                                  "Requirement" : "mandatory"
+                                                },
+                                 "Passphrase" : { "Type" : "response",
+                                                  "Requirement" : "mandatory"
+                                                }
+                               }
+
+                       ==> { "Identity" : "bob", "Passphrase": "secret123" }
+
+               Requesting username and password for a WISPr-enabled hotspot:
+
+                       RequestInput("/service5",
+                                { "Username"   : { "Type"        : "string",
+                                                   "Requirement" : "mandatory"
+                                                 },
+                                  "Password"   : { "Type"        : "passphrase",
+                                                   "Requirement" : "mandatory"
+                                                 }
+                                }
+
+                        ==> { "Username" : "foo", "Password": "secret" }