kinokero 0.0.5

data/lib/proto/print_job_ui_state.proto

@@ -0,0 +1,24 @@
+// Represents a print job's state in a form convenient for display in a UI.
+message PrintJobUiState {
+
+  enum Summary {
+    DRAFT = 0;
+    QUEUED = 1;
+    IN_PROGRESS = 2;
+    PAUSED = 3;
+    DONE = 4;
+    CANCELLED = 5;
+    ERROR = 6;
+    EXPIRED = 7;
+  }
+
+  // Job state summary (required).
+  optional Summary summary = 1;
+
+  // Localized string describing the progress of the job, e.g. the number of
+  // attempts to deliver it or the number of pages which have been printed.
+  optional string progress = 2;
+
+  // Localized string describing the cause of an abnormal state of the job.
+  optional string cause = 3;
+}

data/lib/proto/print_ticket_section.proto

@@ -0,0 +1,30 @@
+// Section of a CJT which describes how a print job should be handled by a
+// cloud-connected printer.
+
+import 'vendor_ticket_item.proto';
+import 'color_ticket_item.proto';
+import 'duplex_ticket_item.proto';
+import 'page_orientation_ticket_item.proto';
+import 'copies_ticket_item.proto';
+import 'margins_ticket_item.proto';
+import 'dpi_ticket_item.proto';
+import 'fit_to_page_ticket_item.proto';
+import 'page_range_ticket_item.proto';
+import 'media_size_ticket_item.proto';
+import 'collate_ticket_item.proto';
+import 'reverse_order_ticket_item.proto';
+
+message PrintTicketSection {
+  repeated VendorTicketItem vendor_ticket_item = 1;
+  optional ColorTicketItem color = 2;
+  optional DuplexTicketItem duplex = 3;
+  optional PageOrientationTicketItem page_orientation = 4;
+  optional CopiesTicketItem copies = 5;
+  optional MarginsTicketItem margins = 6;
+  optional DpiTicketItem dpi = 7;
+  optional FitToPageTicketItem fit_to_page = 8;
+  optional PageRangeTicketItem page_range = 9;
+  optional MediaSizeTicketItem media_size = 10;
+  optional CollateTicketItem collate = 11;
+  optional ReverseOrderTicketItem reverse_order = 12;
+}

data/lib/proto/printer_description_section.proto

@@ -0,0 +1,107 @@
+// Section of a CDD that describes the capabilities and physical units of a
+// cloud-connected printer.
+
+import 'supported_content_type.proto';
+import 'printing_speed.proto';
+import 'pwg_raster_config.proto';
+import 'input_tray_unit.proto';
+import 'output_bin_unit.proto';
+import 'marker.proto';
+import 'cover.proto';
+import 'media_path.proto';
+import 'vendor_capability.proto';
+import 'color.proto';
+import 'duplex.proto';
+import 'page_orientation.proto';
+import 'copies.proto';
+import 'margins.proto';
+import 'dpi.proto';
+import 'fit_to_page.proto';
+import 'page_range.proto';
+import 'media_size.proto';
+import 'collate.proto';
+import 'reverse_order.proto';
+
+message PrinterDescriptionSection {
+
+  // Content types (sometimes referred to as MIME types) that are supported by
+  // the printer.
+  //
+  // The order of these types determines which content type the document should
+  // be converted to. For example, if the types are ordered as:
+  //
+  //   [
+  //     {"content_type": "application/pdf"},
+  //     {"content_type": "image/pwg-raster"}
+  //   ]
+  //
+  // Then the document's content type will first be matched to any content type
+  // in the list. If there is a match, then the document will be sent to the
+  // printer as is. If there is no match, then the document will be converted to
+  // a content type which the server supports starting from the first option. In
+  // this example, if the document is sent as "text/html" and the printer
+  // supports "application/pdf" and "image/pwg-raster", then the document will
+  // be converted to "application/pdf" and not "image/pwg-raster", because
+  // "application/pdf" is declared earlier in this list.
+  repeated SupportedContentType supported_content_type = 1;
+
+  // Printing speeds that the printer can operate at.
+  optional PrintingSpeed printing_speed = 2;
+
+  // PWG raster configuration of the printer. Required if the printer supports
+  // image/pwg-raster content type, and it should be omitted otherwise.
+  // This allows a cloud service to understand how to rasterize a document in
+  // PWG-raster for the printer.
+  optional PwgRasterConfig pwg_raster_config = 3;
+
+  // Physical model of the printer's input trays.
+  repeated InputTrayUnit input_tray_unit = 4;
+
+  // Physical model of the printer's output bins.
+  repeated OutputBinUnit output_bin_unit = 5;
+
+  // Physical model of the printer's markers.
+  repeated Marker marker = 6;
+
+  // Physical model of the printer's covers.
+  repeated Cover cover = 7;
+
+  // Physical model of the printer's media paths.
+  repeated MediaPath media_path = 8;
+
+  // Vendor-provided printer capabilities.
+  repeated VendorCapability vendor_capability = 101;
+
+  // Color printing capabilities of the printer.
+  optional Color color = 102;
+
+  // Duplexing capabilities of the printer.
+  optional Duplex duplex = 103;
+
+  // Page/paper orientation capabilities of the printer.
+  optional PageOrientation page_orientation = 104;
+
+  // Multiple copy capability of the printer.
+  optional Copies copies = 105;
+
+  // Page margins capability of the printer.
+  optional Margins margins = 106;
+
+  // Printing quality or dots-per-inch (DPI) capabilities of the printer.
+  optional Dpi dpi = 107;
+
+  // Page fitting capabilities of the printer.
+  optional FitToPage fit_to_page = 108;
+
+  // Page range selection capability of the printer.
+  optional PageRange page_range = 109;
+
+  // Page or media size capabilities of the printer.
+  optional MediaSize media_size = 110;
+
+  // Paper collation capability of the printer.
+  optional Collate collate = 111;
+
+  // Reverse order printing capability of the printer.
+  optional ReverseOrder reverse_order = 112;
+}

data/lib/proto/printer_state_section.proto

@@ -0,0 +1,49 @@
+// Represents the printer state.
+
+// import 'cloud_device_state.proto';
+import 'input_tray_state.proto';
+import 'output_bin_state.proto';
+import 'marker_state.proto';
+import 'cover_state.proto';
+import 'media_path_state.proto';
+import 'vendor_state.proto';
+
+message PrinterStateSection {
+
+  // Supported device states.
+  enum StateType {
+
+    // Device is ready to accept jobs. Self-testing, low power and all other
+    // states in which the device can start processing newly submitted jobs
+    // without user intervention should be mapped into this state.
+    IDLE = 0;
+
+    // Processing jobs (e.g. printing).
+    PROCESSING = 1;
+
+    // Device cannot process jobs. User should fix the problem to resume the
+    // processing (e.g. printer is out of paper).
+    STOPPED = 2;
+  }
+
+  // Current printer state (required).
+  optional StateType state = 1;
+
+  // State of the input trays.
+  optional InputTrayState input_tray_state = 2;
+
+  // State of the output bins.
+  optional OutputBinState output_bin_state = 3;
+
+  // State of the markers.
+  optional MarkerState marker_state = 4;
+
+  // State of the printer doors/covers/etc.
+  optional CoverState cover_state = 5;
+
+  // State of the printer media paths.
+  optional MediaPathState media_path_state = 6;
+
+  // Vendor-specific printer state.
+  optional VendorState vendor_state = 101;
+}

data/lib/proto/printer_ui_state_section.proto

@@ -0,0 +1,39 @@
+// Contains one UI state item for each CDS state item using the information
+// obtained from cross-referencing the CDD.
+
+import 'cloud_device_ui_state_severity.proto';
+import 'marker.proto';
+
+message PrinterUiStateSection {
+
+  // A UI state item with a severity level and either:
+  // (1) a localized message and UI-displayable data from the properties and
+  //     state of a particular unit of the device, or
+  // (2) a possibly non-localized vendor state message.
+  message Item {
+
+    // The severity of this individual state item (required).
+    optional CloudDeviceUiStateSeverity.Severity severity = 1;
+
+    // A message produced from a state item, e.g. Black ink level is 60%. This
+    // message may not be localized if it is from a VendorState.Item (required).
+    optional string message = 2;
+
+    // A non-localized vendor-specific message that provides additional
+    // information about the state of the device unit described by this item.
+    optional string vendor_message = 3;
+
+    // The fullness level of an input tray, output bin or marker.
+    optional int32 level_percent = 4;
+
+    // The color of a marker.
+    optional Marker.Color.Type color = 5;
+  }
+
+  repeated Item vendor_item = 1;
+  repeated Item input_tray_item = 2;
+  repeated Item output_bin_item = 3;
+  repeated Item marker_item = 4;
+  repeated Item cover_item = 5;
+  repeated Item media_path_item = 6;
+}

data/lib/proto/printing_speed.proto

@@ -0,0 +1,35 @@
+// Property that defines what speeds (in pages per minute) the printer can
+// operate at.
+
+import 'color.proto';
+import 'media_size.proto';
+
+message PrintingSpeed {
+  // Available speed of the printer.
+  //
+  // Specify settings that are associated with the given speed. If a setting
+  // is left unset, then it will be assumed that the speed is independent of
+  // that setting. For example, the following Option
+  //
+  //   {
+  //     "speed_ppm": 5.5,
+  //     "color_type": ["STANDARD_MONOCHROME"],
+  //     "media_size_name": ["NA_LETTER", "ISO_A4"]
+  //   }
+  //
+  // indicates that the printer prints at 5.5 pages per minute when printing in
+  // STANDARD_MONOCHROME in either NA_LETTER or ISO_A4 paper sizes.
+  message Option {
+    // Speed measured in pages per minute (required).
+    optional float speed_ppm = 1;
+
+    // Types of color settings that operate at this speed.
+    repeated Color.Type color_type = 2;
+
+    // Names of media sizes that operate at this speed.
+    repeated MediaSize.Name media_size_name = 3;
+  }
+
+  // Speeds that the printer can operate at.
+  repeated Option option = 1;
+}

data/lib/proto/pwg_raster_config.proto

@@ -0,0 +1,176 @@
+// Configuration of how printer should receive PWG raster images.
+
+import 'duplex.proto';
+
+message PwgRasterConfig {
+
+  message Resolution {
+    optional int32 cross_feed_dir = 1;  // Horizontal resolution in DPI.
+    optional int32 feed_dir = 2;  // Vertical resolution in DPI.
+  }
+
+  // Resolutions (in DPI) of the pages that the printer supports in PWG-raster
+  // format. The resolution MUST be supported for every page media supported by
+  // the printer. (Same as PwgRasterDocumentResolutionSupported PWG-raster
+  // semantic model element.) This field is strongly recommended, as it helps
+  // GCP to decide which resolutions are supported by the printer for PWG-raster
+  // documents if it has to downscale the document to a lower resolution.
+  //
+  // This list can be a subset of the full set of resolutions supported by the
+  // printer (in formats different from PWG-raster, e.g. PDF), but it MUST
+  // include an NxN DPI resolution where N <= 360 and N evenly divides all
+  // resolutions supported by the printer. A resolution NxN where N >= 600
+  // (possibly 600 or 720) is also strongly recommended.
+  //
+  // GCP will generate PWG-raster pages not necessarily at the resolution
+  // reported in the ticket, but the actual DPIs of the page (horizontal and
+  // vertical) will always perfectly divide the corresponding values reported in
+  // the ticket.
+  repeated Resolution document_resolution_supported = 2;
+
+  // List of PWG-raster document types (in terms of color space and bits per
+  // color) supported by the printer. Color printers MUST support SRGB_8 and
+  // possibly SGRAY_8. Monochrome printers must support either SRGB_8 or
+  // SGRAY_8. However, any printer that doesn't support SGRAY_8 must be able
+  // to perform conversion from RGB to grayscale if it receives a PWG-raster
+  // document in SRGB and the print job ticket specifies monochrome printing.
+  //
+  // This field is strongly recommended, and we recommend to include all types
+  // supported by the printer, as GCP may start serving more document types in
+  // the future.
+  repeated PwgDocumentTypeSupported document_type_supported = 3;
+
+  // Describes which transformation needs to be applied to back pages in
+  // duplexing in order to have them printed properly.
+  // The value mainly depends on how duplexing works on the printer, and the
+  // actual effect depends on which duplexing is specified in the ticket.
+  enum DocumentSheetBack {
+    // No special treatment for back pages (same as front page).
+    NORMAL = 0;
+    // Back pages are rotated 180 degrees if the document is portrait
+    // (TwoSidedLongEdge duplexing).
+    ROTATED = 1;
+    // Back pages are rotated 180 degrees if the document is landscape
+    // (TwoSidedShortEdge duplexing, opposite of ROTATED).
+    MANUAL_TUMBLE = 2;
+    // Page is flipped upside-down if portrait (TwoSidedLongEdge duplexing),
+    // left-right if landscape (TwoSidedShortEdge duplexing).
+    FLIPPED = 3;
+  }
+  // Same as PwgRasterDocumentSheetBack PWG-raster semantic model element.
+  // Default value is ROTATED.
+  optional DocumentSheetBack document_sheet_back = 4 [default = ROTATED];
+
+  // Instructs GCP that the printer wants to print pages from the last to the
+  // first. In that case GCP will stream PWG-raster pages in that order.
+  optional bool reverse_order_streaming = 5;
+
+  // Instructs GCP that the printer prefers receiving pages rotated 180 degrees.
+  // This rotation is in addition to possible additional rotations of even pages
+  // based on document_sheet_back in case of duplexing.
+  optional bool rotate_all_pages = 6;
+
+  // PWG-raster document types (in terms of color space and bits per color).
+  // This list is based on the PWG-raster specs of March 14, 2012, and it
+  // will be extended without notice if new types are added to newer versions
+  // of the specs. If a new type is not accepted by GCP capability parser please
+  // inform the GCP team. (This doesn't mean that GCP will start sending
+  // documents of the new kind.)
+  //
+  // The string names are identical to the keyword attribute values in
+  // PWG-raster documentation, except they are uppercase, and dashes are
+  // replaced by underscores.
+  enum PwgDocumentTypeSupported {
+    BLACK_1 = 1;
+    SGRAY_1 = 2;
+    ADOBE_RGB_8 = 3;
+    BLACK_8 = 4;
+    CMYK_8 = 5;
+    DEVICE1_8 = 6;
+    DEVICE2_8 = 7;
+    DEVICE3_8 = 8;
+    DEVICE4_8 = 9;
+    DEVICE5_8 = 10;
+    DEVICE6_8 = 11;
+    DEVICE7_8 = 12;
+    DEVICE8_8 = 13;
+    DEVICE9_8 = 14;
+    DEVICE10_8 = 15;
+    DEVICE11_8 = 16;
+    DEVICE12_8 = 17;
+    DEVICE13_8 = 18;
+    DEVICE14_8 = 19;
+    DEVICE15_8 = 20;
+    RGB_8 = 21;
+    SGRAY_8 = 22;
+    SRGB_8 = 23;
+    ADOBE_RGB_16 = 24;
+    BLACK_16 = 25;
+    CMYK_16 = 26;
+    DEVICE1_16 = 27;
+    DEVICE2_16 = 28;
+    DEVICE3_16 = 29;
+    DEVICE4_16 = 30;
+    DEVICE5_16 = 31;
+    DEVICE6_16 = 32;
+    DEVICE7_16 = 33;
+    DEVICE8_16 = 34;
+    DEVICE9_16 = 35;
+    DEVICE10_16 = 36;
+    DEVICE11_16 = 37;
+    DEVICE12_16 = 38;
+    DEVICE13_16 = 39;
+    DEVICE14_16 = 40;
+    DEVICE15_16 = 41;
+    RGB_16 = 42;
+    SGRAY_16 = 43;
+    SRGB_16 = 44;
+  }
+
+  // [Deprecated: Please use the other fields of PwgRasterConfig.]
+  // Transformation to apply to pages during PWG rasterization.
+  message Transformation {
+    // Types of transformation operations to apply.
+    enum Operation {
+      // Rotate pages 180 degrees.
+      ROTATE_180 = 0;
+
+      // Flip pages along the long edge of the paper.
+      FLIP_ON_LONG_EDGE = 1;
+
+      // Flip pages along the short edge of the paper.
+      FLIP_ON_SHORT_EDGE = 2;
+    }
+
+    // Selectors of which pages to apply the transformation to.
+    enum Operand {
+      // Apply transformation to all pages.
+      ALL_PAGES = 0;
+      // Apply transformation to even pages only when duplexing (deprecated,
+      // instead use EVEN_PAGES and specify appropriate duplex types).
+      ONLY_DUPLEXED_EVEN_PAGES = 1;
+      // Apply transformation to odd pages only when duplexing (deprecated,
+      // instead use ODD_PAGES and specify appropriate duplex types).
+      ONLY_DUPLEXED_ODD_PAGES = 2;
+      // Apply transformation to even pages.
+      EVEN_PAGES = 3;
+      // Apply transformation to odd pages.
+      ODD_PAGES = 4;
+    }
+    // Required.
+    optional Operation operation = 1;
+    // Required.
+    optional Operand operand = 2;
+    // Duplex types that the transformation applies to. Leave empty if the
+    // transformation is applicable to all duplex types.
+    repeated Duplex.Type duplex_type = 3;
+  }
+
+  // [Deprecated and only partially supported. Please use the other fields of
+  // PwgRasterConfig.
+  // Out of all possible transformations GCP will only support rotating all
+  // pages, but for that we strongly recommend using the rotate_all_pages
+  // boolean field instead.]
+  // What transformations to apply to pages in the print job.
+  repeated Transformation transformation = 1;
+}