STAR-322: Adding documentation and fixing model types

plugins/UM3NetworkPrinting/src/Cloud/Models/CloudClusterPrinterStatus.py

@@ -0,0 +1,60 @@
+# Copyright (c) 2018 Ultimaker B.V.
+# Cura is released under the terms of the LGPLv3 or higher.
+from typing import List, Union, Dict, Optional
+
+from cura.PrinterOutput.PrinterOutputController import PrinterOutputController
+from cura.PrinterOutput.PrinterOutputModel import PrinterOutputModel
+from .CloudClusterPrinterConfiguration import CloudClusterPrinterConfiguration
+from .BaseCloudModel import BaseCloudModel
+
+
+##  Class representing a cluster printer
+#  Spec: https://api-staging.ultimaker.com/connect/v1/spec
+class CloudClusterPrinterStatus(BaseCloudModel):
+    ## Creates a new cluster printer status
+    #  \param enabled: A printer can be disabled if it should not receive new jobs. By default every printer is enabled.
+    #  \param firmware_version: Firmware version installed on the printer. Can differ for each printer in a cluster.
+    #  \param friendly_name: Human readable name of the printer. Can be used for identification purposes.
+    #  \param ip_address: The IP address of the printer in the local network.
+    #  \param machine_variant: The type of printer. Can be 'Ultimaker 3' or 'Ultimaker 3ext'.
+    #  \param status: The status of the printer.
+    #  \param unique_name: The unique name of the printer in the network.
+    #  \param uuid: The unique ID of the printer, also known as GUID.
+    #  \param configuration: The active print core configurations of this printer.
+    #  \param reserved_by: A printer can be claimed by a specific print job.
+    def __init__(self, enabled: bool, firmware_version: str, friendly_name: str, ip_address: str, machine_variant: str,
+                 status: str, unique_name: str, uuid: str,
+                 configuration: List[Union[Dict[str, any], CloudClusterPrinterConfiguration]],
+                 reserved_by: Optional[str] = None, **kwargs) -> None:
+
+        self.configuration = self.parseModels(CloudClusterPrinterConfiguration, configuration)
+        self.enabled = enabled
+        self.firmware_version = firmware_version
+        self.friendly_name = friendly_name
+        self.ip_address = ip_address
+        self.machine_variant = machine_variant
+        self.status = status
+        self.unique_name = unique_name
+        self.uuid = uuid
+        self.reserved_by = reserved_by
+        super().__init__(**kwargs)
+
+    ## Creates a new output model.
+    #  \param controller - The controller of the model.
+    def createOutputModel(self, controller: PrinterOutputController) -> PrinterOutputModel:
+        model = PrinterOutputModel(controller, len(self.configuration), firmware_version = self.firmware_version)
+        self.updateOutputModel(model)
+        return model
+
+    ## Updates the given output model.
+    #  \param model - The output model to update.
+    def updateOutputModel(self, model: PrinterOutputModel) -> None:
+        model.updateKey(self.uuid)
+        model.updateName(self.friendly_name)
+        model.updateType(self.machine_variant)
+        model.updateState(self.status if self.enabled else "disabled")
+
+        for configuration, extruder_output, extruder_config in \
+                zip(self.configuration, model.extruders, model.printerConfiguration.extruderConfigurations):
+            configuration.updateOutputModel(extruder_output)
+            configuration.updateConfigurationModel(extruder_config)