three.MF.V3.Tasks.ListWifi

 1from MF.V3.Descriptors.Wifi import Wifi as MF_V3_Descriptors_Wifi_Wifi
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3
 4
 5class ListWifi:
 6    """*
 7    List available wifi networks.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"ListWifi"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"ListWifi",
27    "Output":{
28    "networks":[
29    {"ssid":"Network1","isActive":true,"isPublic":false,"quality":90},
30    {"ssid":"Network2","isActive":true,"isPublic":true,"quality":50},
31    {"ssid":"Network3","isActive":true,"isPublic":true,"quality":75}
32    ],
33    "ssid":"Network1"
34    },
35    "State":"Completed"
36    }
37    }
38    ```
39    """
40    class Request:
41
42        """
43         Client request for the `ListWifi` task.
44        """
45        def __init__(self, Index: int, Type: str):
46            # A unique identifier generated by the client.
47            self.Index = Index
48            # "ListWifi"
49            self.Type = Type
50
51    class Response:
52
53        """
54         Server response for the `ListWifi` task.
55        """
56        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Wifi_Wifi = None, State: MF_V3_Task_TaskState = None, Error: str = None):
57            # The unique identifier generated by the client.
58            self.Index = Index
59            # "ListWifi"
60            self.Type = Type
61            # The wifi descriptor.
62            self.Output = Output
63            # The current state of the task.
64            self.State = State
65            # A string describing the error if the task has failed.
66            self.Error = Error
67
68    def __init__(self):
69        pass
class ListWifi:
 6class ListWifi:
 7    """*
 8    List available wifi networks.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListWifi"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListWifi",
28    "Output":{
29    "networks":[
30    {"ssid":"Network1","isActive":true,"isPublic":false,"quality":90},
31    {"ssid":"Network2","isActive":true,"isPublic":true,"quality":50},
32    {"ssid":"Network3","isActive":true,"isPublic":true,"quality":75}
33    ],
34    "ssid":"Network1"
35    },
36    "State":"Completed"
37    }
38    }
39    ```
40    """
41    class Request:
42
43        """
44         Client request for the `ListWifi` task.
45        """
46        def __init__(self, Index: int, Type: str):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "ListWifi"
50            self.Type = Type
51
52    class Response:
53
54        """
55         Server response for the `ListWifi` task.
56        """
57        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Wifi_Wifi = None, State: MF_V3_Task_TaskState = None, Error: str = None):
58            # The unique identifier generated by the client.
59            self.Index = Index
60            # "ListWifi"
61            self.Type = Type
62            # The wifi descriptor.
63            self.Output = Output
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error
68
69    def __init__(self):
70        pass

* List available wifi networks.

Request example:

{
"Task":{
"Index":1,
"Type":"ListWifi"
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"ListWifi",
"Output":{
"networks":[
{"ssid":"Network1","isActive":true,"isPublic":false,"quality":90},
{"ssid":"Network2","isActive":true,"isPublic":true,"quality":50},
{"ssid":"Network3","isActive":true,"isPublic":true,"quality":75}
],
"ssid":"Network1"
},
"State":"Completed"
}
}
class ListWifi.Request:
41    class Request:
42
43        """
44         Client request for the `ListWifi` task.
45        """
46        def __init__(self, Index: int, Type: str):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "ListWifi"
50            self.Type = Type

Client request for the ListWifi task.

ListWifi.Request(Index: int, Type: str)
46        def __init__(self, Index: int, Type: str):
47            # A unique identifier generated by the client.
48            self.Index = Index
49            # "ListWifi"
50            self.Type = Type
Index
Type
class ListWifi.Response:
52    class Response:
53
54        """
55         Server response for the `ListWifi` task.
56        """
57        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Wifi_Wifi = None, State: MF_V3_Task_TaskState = None, Error: str = None):
58            # The unique identifier generated by the client.
59            self.Index = Index
60            # "ListWifi"
61            self.Type = Type
62            # The wifi descriptor.
63            self.Output = Output
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error

Server response for the ListWifi task.

ListWifi.Response( Index: int, Type: str, Output: MF.V3.Descriptors.Wifi.Wifi = None, State: MF.V3.Task.TaskState = None, Error: str = None)
57        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Wifi_Wifi = None, State: MF_V3_Task_TaskState = None, Error: str = None):
58            # The unique identifier generated by the client.
59            self.Index = Index
60            # "ListWifi"
61            self.Type = Type
62            # The wifi descriptor.
63            self.Output = Output
64            # The current state of the task.
65            self.State = State
66            # A string describing the error if the task has failed.
67            self.Error = Error
Index
Type
Output
State
Error