three.MF.V3.Tasks.UpdateSettings 

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

* Update scanner settings.

Request example:

{
"Task":{
"Index":1,
"Type":"UpdateSettings",
"Input":{
"camera":{
"analogGain":256,
"digitalGain":320,
"exposure":18000
}
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"UpdateSettings",
"Input":{
"camera":{
"analogGain":256,
"digitalGain":320,
"exposure":18000
}
},
"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 UpdateSettings.Request: 
78    class Request:
79
80        """
81         Client request for the `UpdateSettings` task.
82        """
83        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scanner_Scanner):
84            # A unique identifier generated by the client.
85            self.Index = Index
86            # "UpdateSettings"
87            self.Type = Type
88            # Scanner settings.
89            self.Input = Input

Client request for the UpdateSettings task.

UpdateSettings.Request(Index: int, Type: str, Input: MF.V3.Settings.Scanner.Scanner) 
83        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scanner_Scanner):
84            # A unique identifier generated by the client.
85            self.Index = Index
86            # "UpdateSettings"
87            self.Type = Type
88            # Scanner settings.
89            self.Input = Input
Index
Type
Input
class UpdateSettings.Response: 
 91    class Response:
 92
 93        """
 94         Server response for the `UpdateSettings` task.
 95        """
 96        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scanner_Scanner, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 97            # The unique identifier generated by the client.
 98            self.Index = Index
 99            # "UpdateSettings"
100            self.Type = Type
101            # The requested scanner settings.
102            self.Input = Input
103            # The scanner settings descriptor.
104            self.Output = Output
105            # The current state of the task.
106            self.State = State
107            # A string describing the error if the task has failed.
108            self.Error = Error

Server response for the UpdateSettings task.

UpdateSettings.Response( Index: int, Type: str, Input: MF.V3.Settings.Scanner.Scanner, Output: MF.V3.Descriptors.Settings.Scanner.Scanner = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
 96        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Scanner_Scanner, Output: MF_V3_Descriptors_Settings_Scanner_Scanner = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 97            # The unique identifier generated by the client.
 98            self.Index = Index
 99            # "UpdateSettings"
100            self.Type = Type
101            # The requested scanner settings.
102            self.Input = Input
103            # The scanner settings descriptor.
104            self.Output = Output
105            # The current state of the task.
106            self.State = State
107            # A string describing the error if the task has failed.
108            self.Error = Error
Index
Type
Input
Output
State
Error