three.MF.V3.Tasks.AutoFocus

View Source

 1from MF.V3.Descriptors.Settings.Camera import Camera as MF_V3_Descriptors_Settings_Camera_Camera
 2from MF.V3.Settings.AutoFocus import AutoFocus as MF_V3_Settings_AutoFocus_AutoFocus
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class AutoFocus:
 7    """*
 8    Auto focus one or both cameras.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"AutoFocus",
17    "Input":{
18    "cameras":[{
19    "index":1,
20    "box":{"x":196,"y":130,"width":64,"height":64}
21    }],
22    "applyAll":false
23    }
24    }
25    }
26    ```
27
28    > Response example:
29
30    ```json
31    {
32    "Task":{
33    "Index":1,
34    "Type":"AutoFocus",
35    "Input":{
36    "cameras":[{
37    "index":1,
38    "box":{"x":196,"y":130,"width":64,"height":64}
39    }],
40    "applyAll":false
41    }
42    "Output":{
43    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
44    "autoExposure":{"default":false,"value":true},
45    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
46    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
47    "focus":{
48    "box":{
49    "default":[
50    {"height":64,"width":64,"x":224,"y":158},
51    {"height":64,"width":64,"x":224,"y":158}
52    ],
53    "value":[
54    {"height":64,"width":64,"x":271,"y":134},
55    {"height":64,"width":64,"x":196,"y":130}
56    ]
57    },
58    "value":{"default":[350,350],"max":1024,"min":0,"value":[396,392]}
59    }
60    },
61    "State":"Completed"
62    }
63    }
64    ```
65    """
66    class Request:
67
68        """
69         Client request for the `AutoFocus` task.
70        """
71        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None):
72            # A unique identifier generated by the client.
73            self.Index = Index
74            # "AutoFocus"
75            self.Type = Type
76            # AutoFocus settings.
77            self.Input = Input
78
79    class Response:
80
81        """
82         Server response for the `AutoFocus` task.
83        """
84        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
85            # The unique identifier generated by the client.
86            self.Index = Index
87            # "AutoFocus"
88            self.Type = Type
89            # Requested auto focus settings.
90            self.Input = Input
91            # Actual camera settings after auto focusing the camera(s).
92            self.Output = Output
93            # The current state of the task.
94            self.State = State
95            # A string describing the error if the task has failed.
96            self.Error = Error
97
98    def __init__(self):
99        pass

class AutoFocus: View Source

  7class AutoFocus:
  8    """*
  9    Auto focus one or both cameras.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"AutoFocus",
 18    "Input":{
 19    "cameras":[{
 20    "index":1,
 21    "box":{"x":196,"y":130,"width":64,"height":64}
 22    }],
 23    "applyAll":false
 24    }
 25    }
 26    }
 27    ```
 28
 29    > Response example:
 30
 31    ```json
 32    {
 33    "Task":{
 34    "Index":1,
 35    "Type":"AutoFocus",
 36    "Input":{
 37    "cameras":[{
 38    "index":1,
 39    "box":{"x":196,"y":130,"width":64,"height":64}
 40    }],
 41    "applyAll":false
 42    }
 43    "Output":{
 44    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
 45    "autoExposure":{"default":false,"value":true},
 46    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
 47    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
 48    "focus":{
 49    "box":{
 50    "default":[
 51    {"height":64,"width":64,"x":224,"y":158},
 52    {"height":64,"width":64,"x":224,"y":158}
 53    ],
 54    "value":[
 55    {"height":64,"width":64,"x":271,"y":134},
 56    {"height":64,"width":64,"x":196,"y":130}
 57    ]
 58    },
 59    "value":{"default":[350,350],"max":1024,"min":0,"value":[396,392]}
 60    }
 61    },
 62    "State":"Completed"
 63    }
 64    }
 65    ```
 66    """
 67    class Request:
 68
 69        """
 70         Client request for the `AutoFocus` task.
 71        """
 72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None):
 73            # A unique identifier generated by the client.
 74            self.Index = Index
 75            # "AutoFocus"
 76            self.Type = Type
 77            # AutoFocus settings.
 78            self.Input = Input
 79
 80    class Response:
 81
 82        """
 83         Server response for the `AutoFocus` task.
 84        """
 85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 86            # The unique identifier generated by the client.
 87            self.Index = Index
 88            # "AutoFocus"
 89            self.Type = Type
 90            # Requested auto focus settings.
 91            self.Input = Input
 92            # Actual camera settings after auto focusing the camera(s).
 93            self.Output = Output
 94            # The current state of the task.
 95            self.State = State
 96            # A string describing the error if the task has failed.
 97            self.Error = Error
 98
 99    def __init__(self):
100        pass

* Auto focus one or both cameras.

Request example:

{
"Task":{
"Index":1,
"Type":"AutoFocus",
"Input":{
"cameras":[{
"index":1,
"box":{"x":196,"y":130,"width":64,"height":64}
}],
"applyAll":false
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"AutoFocus",
"Input":{
"cameras":[{
"index":1,
"box":{"x":196,"y":130,"width":64,"height":64}
}],
"applyAll":false
}
"Output":{
"analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
"autoExposure":{"default":false,"value":true},
"digitalGain":{"default":256,"max":65536,"min":256,"value":320},
"exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
"focus":{
"box":{
"default":[
{"height":64,"width":64,"x":224,"y":158},
{"height":64,"width":64,"x":224,"y":158}
],
"value":[
{"height":64,"width":64,"x":271,"y":134},
{"height":64,"width":64,"x":196,"y":130}
]
},
"value":{"default":[350,350],"max":1024,"min":0,"value":[396,392]}
}
},
"State":"Completed"
}
}

class AutoFocus.Request: View Source

67    class Request:
68
69        """
70         Client request for the `AutoFocus` task.
71        """
72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None):
73            # A unique identifier generated by the client.
74            self.Index = Index
75            # "AutoFocus"
76            self.Type = Type
77            # AutoFocus settings.
78            self.Input = Input

Client request for the AutoFocus task.

AutoFocus.Request( Index: int, Type: str, Input: MF.V3.Settings.AutoFocus.AutoFocus = None) View Source

72        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None):
73            # A unique identifier generated by the client.
74            self.Index = Index
75            # "AutoFocus"
76            self.Type = Type
77            # AutoFocus settings.
78            self.Input = Input

Index

Type

Input

class AutoFocus.Response: View Source

80    class Response:
81
82        """
83         Server response for the `AutoFocus` task.
84        """
85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
86            # The unique identifier generated by the client.
87            self.Index = Index
88            # "AutoFocus"
89            self.Type = Type
90            # Requested auto focus settings.
91            self.Input = Input
92            # Actual camera settings after auto focusing the camera(s).
93            self.Output = Output
94            # The current state of the task.
95            self.State = State
96            # A string describing the error if the task has failed.
97            self.Error = Error

Server response for the AutoFocus task.

AutoFocus.Response( Index: int, Type: str, Input: MF.V3.Settings.AutoFocus.AutoFocus = None, Output: MF.V3.Descriptors.Settings.Camera.Camera = None, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_AutoFocus_AutoFocus = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
86            # The unique identifier generated by the client.
87            self.Index = Index
88            # "AutoFocus"
89            self.Type = Type
90            # Requested auto focus settings.
91            self.Input = Input
92            # Actual camera settings after auto focusing the camera(s).
93            self.Output = Output
94            # The current state of the task.
95            self.State = State
96            # A string describing the error if the task has failed.
97            self.Error = Error

Index

Type

Input

Output

State

Error