three.MF.V3.Tasks.ListSettings

View Source

 1from MF.V3.Descriptors.Settings.Scanner import Scanner as MF_V3_Descriptors_Settings_Scanner_Scanner
 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 3
 4
 5class ListSettings:
 6    """*
 7    Get scanner settings.
 8
 9    > Request example:
10
11    ```json
12    {
13    "Task":{
14    "Index":1,
15    "Type":"ListSettings"
16    }
17    }
18    ```
19
20    > Response example:
21
22    ```json
23    {
24    "Task":{
25    "Index":1,
26    "Type":"ListSettings",
27    "Output":{
28    "camera":{
29    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
30    "autoExposure":{"default":false,"value":false},
31    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
32    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
33    },
34    "projector":{
35    "brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
36    "on":{"default":false,"value":true}
37    },
38    "turntable":{
39    "scans":{"default":8,"max":24,"min":1,"value":3},
40    "sweep":{"default":360,"max":360,"min":5,"value":90},
41    "use":{"default":true,"value":true}
42    },
43    "capture":{
44    "quality":{"default":"Medium","value":"Medium"},
45    "texture":{"default":true,"value":true}
46    },
47    "i18n":{
48    "language":{"default":"en","value":"en"}
49    },
50    "style":{
51    "theme":{"default":"Dark","value":"Dark"}
52    },
53    "viewer":{
54    "textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
55    }
56    },
57    "State":"Completed"
58    }
59    }
60    ```
61    """
62    class Request:
63
64        """
65         Client request for the `ListSettings` task.
66        """
67        def __init__(self, Index: int, Type: str):
68            # A unique identifier generated by the client.
69            self.Index = Index
70            # "ListSettings"
71            self.Type = Type
72
73    class Response:
74
75        """
76         Server response for the `ListSettings` task.
77        """
78        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
79            # The unique identifier generated by the client.
80            self.Index = Index
81            # "ListSettings"
82            self.Type = Type
83            # The scanner settings descriptor.
84            self.Output = Output
85            # The current state of the task.
86            self.State = State
87            # A string describing the error if the task has failed.
88            self.Error = Error
89
90    def __init__(self):
91        pass

class ListSettings: View Source

 6class ListSettings:
 7    """*
 8    Get scanner settings.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"ListSettings"
17    }
18    }
19    ```
20
21    > Response example:
22
23    ```json
24    {
25    "Task":{
26    "Index":1,
27    "Type":"ListSettings",
28    "Output":{
29    "camera":{
30    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
31    "autoExposure":{"default":false,"value":false},
32    "digitalGain":{"default":256,"max":65536,"min":256,"value":320},
33    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
34    },
35    "projector":{
36    "brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
37    "on":{"default":false,"value":true}
38    },
39    "turntable":{
40    "scans":{"default":8,"max":24,"min":1,"value":3},
41    "sweep":{"default":360,"max":360,"min":5,"value":90},
42    "use":{"default":true,"value":true}
43    },
44    "capture":{
45    "quality":{"default":"Medium","value":"Medium"},
46    "texture":{"default":true,"value":true}
47    },
48    "i18n":{
49    "language":{"default":"en","value":"en"}
50    },
51    "style":{
52    "theme":{"default":"Dark","value":"Dark"}
53    },
54    "viewer":{
55    "textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
56    }
57    },
58    "State":"Completed"
59    }
60    }
61    ```
62    """
63    class Request:
64
65        """
66         Client request for the `ListSettings` task.
67        """
68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListSettings"
72            self.Type = Type
73
74    class Response:
75
76        """
77         Server response for the `ListSettings` task.
78        """
79        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListSettings"
83            self.Type = Type
84            # The scanner settings descriptor.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error
90
91    def __init__(self):
92        pass

* Get scanner settings.

Request example:

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

Response example:

{
"Task":{
"Index":1,
"Type":"ListSettings",
"Output":{
"camera":{
"analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
"autoExposure":{"default":false,"value":false},
"digitalGain":{"default":256,"max":65536,"min":256,"value":320},
"exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
},
"projector":{
"brightness":{"default":0.5,"max":1.0,"min":0.0,"value":0.800000011920929},
"on":{"default":false,"value":true}
},
"turntable":{
"scans":{"default":8,"max":24,"min":1,"value":3},
"sweep":{"default":360,"max":360,"min":5,"value":90},
"use":{"default":true,"value":true}
},
"capture":{
"quality":{"default":"Medium","value":"Medium"},
"texture":{"default":true,"value":true}
},
"i18n":{
"language":{"default":"en","value":"en"}
},
"style":{
"theme":{"default":"Dark","value":"Dark"}
},
"viewer":{
"textureOpacity":{"default":0.5,"max":1.0,"min":0.0,"value":1.0}
}
},
"State":"Completed"
}
}

class ListSettings.Request: View Source

63    class Request:
64
65        """
66         Client request for the `ListSettings` task.
67        """
68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListSettings"
72            self.Type = Type

Client request for the ListSettings task.

ListSettings.Request(Index: int, Type: str) View Source

68        def __init__(self, Index: int, Type: str):
69            # A unique identifier generated by the client.
70            self.Index = Index
71            # "ListSettings"
72            self.Type = Type

Index

Type

class ListSettings.Response: View Source

74    class Response:
75
76        """
77         Server response for the `ListSettings` task.
78        """
79        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListSettings"
83            self.Type = Type
84            # The scanner settings descriptor.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error

Server response for the ListSettings task.

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

79        def __init__(self, Index: int, Type: str, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
80            # The unique identifier generated by the client.
81            self.Index = Index
82            # "ListSettings"
83            self.Type = Type
84            # The scanner settings descriptor.
85            self.Output = Output
86            # The current state of the task.
87            self.State = State
88            # A string describing the error if the task has failed.
89            self.Error = Error

Index

Type

Output

State

Error