kinokero 0.0.5

data/lib/kinokero/version.rb

@@ -0,0 +1,3 @@
+module Kinokero
+  VERSION = "0.0.5"
+end

data/lib/proto/cloud_device_description.proto

@@ -0,0 +1,18 @@
+// Description of a cloud-enabled device's capabilities and properties. Also
+// known as CDD.
+
+import 'scanner_description_section.proto';
+import 'printer_description_section.proto';
+
+message CloudDeviceDescription {
+
+  // Version of the CDD in the form "X.Y" where changes to Y are backwards
+  // compatible, and changes to X are not (required).
+  optional string version = 1;
+
+  // Section of the CDD that specifically describes printers.
+  optional PrinterDescriptionSection printer = 101;
+
+  // Section of the CDD that specifically describes scanners.
+  optional ScannerDescriptionSection scanner = 102;
+}

data/lib/proto/cloud_device_state.proto

@@ -0,0 +1,30 @@
+// Represents the entire cloud-connected device state.
+
+import 'printer_state_section.proto';
+import 'scanner_state_section.proto';
+
+message CloudDeviceState {
+
+
+  // Device cloud connectivity state.
+  enum CloudConnectionStateType {
+    UNKNOWN = 0;
+    NOT_CONFIGURED = 1;
+    ONLINE = 2;
+    OFFLINE = 3;
+  }
+
+  // Version of the CDS in the form "X.Y" where changes to Y are backwards
+  // compatible, and changes to X are not (required).
+  optional string version = 1;
+
+  // Whether device is connected to the server. It is not intended to be
+  // reported by the device, it's set by the server.
+  optional CloudConnectionStateType cloud_connection_state = 2;
+
+  // Defined for devices with printing capabilities.
+  optional PrinterStateSection printer = 3;
+
+  // Defined for devices with scanning capabilities.
+  optional ScannerStateSection scanner = 4;
+}

data/lib/proto/cloud_device_state_type.proto

@@ -0,0 +1,20 @@
+// state type to resolve earlier circular definitions
+
+message CloudDeviceStateType {
+
+  // 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;
+  }
+}

data/lib/proto/cloud_device_ui_state.proto

@@ -0,0 +1,42 @@
+// Represents a cloud device's state in a form convenient for display in a UI.
+
+import 'cloud_device_ui_state_severity.proto';
+import 'printer_ui_state_section.proto';
+
+message CloudDeviceUiState {
+
+  enum Summary {
+    IDLE = 0;
+    PROCESSING = 1;
+    STOPPED = 2;
+    OFFLINE = 3;
+  }
+
+
+  // Device state summary (required).
+  optional Summary summary = 1 [default = IDLE];
+
+  // Overall severity (error level) of the device state (required).
+  // Must only be HIGH in the case that the device is STOPPED.
+  optional CloudDeviceUiStateSeverity.Severity severity = 2 [default = NONE];
+
+  // In the descriptions of the following three fields, "CDS is nontrivial"
+  // means that CDS is present and there is at least one state item in its
+  // PrinterStateSection or ScannerStateSection which is "interesting" enough
+  // to produce a UI state item for.
+
+  // Number of issues detected.
+  // Present if and only if CDS is nontrivial.
+  optional int32 num_issues = 3 [default = 0];
+
+  // Heuristically determined most relevant message from a state item.
+  // Present if and only if CDS is nontrivial, the device is not OFFLINE, and
+  // the maximum severity of a state item is at least MEDIUM if the device is
+  // IDLE or PROCESSING, or at least LOW if the device is STOPPED.
+  optional string caption = 4;
+
+  // State items specific to the printing capability of the device.
+  // Present if and only if CDS is nontrivial and this CloudDeviceUiState object
+  // is being returned in a single printer lookup or in a recent printer search.
+  optional PrinterUiStateSection printer = 5;
+}

data/lib/proto/cloud_device_ui_state_severity.proto

@@ -0,0 +1,12 @@
+// Represents a cloud device's state in a form convenient for display in a UI.
+
+message CloudDeviceUiStateSeverity {
+
+  enum Severity {
+    NONE = 0;
+    LOW = 1;
+    MEDIUM = 2;
+    HIGH = 3;
+  }
+
+}

data/lib/proto/cloud_job_ticket.proto

@@ -0,0 +1,18 @@
+// Description of how a cloud job (e.g. print job, scan job) should be handled
+// by the cloud device. Also known as CJT.
+
+import 'print_ticket_section.proto';
+import 'scan_ticket_section.proto';
+
+message CloudJobTicket {
+
+  // Version of the CJT in the form "X.Y" where changes to Y are backwards
+  // compatible, and changes to X are not (required).
+  optional string version = 1;
+
+  // Section of CJT pertaining to cloud printer ticket items.
+  optional PrintTicketSection print = 101;
+
+  // Section of CJT pertaining to cloud scanner ticket items.
+  optional ScanTicketSection scan = 102;
+}

data/lib/proto/collate.proto

@@ -0,0 +1,4 @@
+// Capability that defines the default collation setting on a device.
+message Collate {
+  optional bool default = 1 [default = true];
+}

data/lib/proto/collate_ticket_item.proto

@@ -0,0 +1,5 @@
+// Ticket item indicating whether to collate pages.
+message CollateTicketItem {
+  // Whether to print collated (required).
+  optional bool collate = 1;
+}

data/lib/proto/color.proto

@@ -0,0 +1,42 @@
+// Capability that defines the color options available on a device.
+
+import 'localized_string.proto';
+
+message Color {
+  enum Type {
+    STANDARD_COLOR = 0;
+    STANDARD_MONOCHROME = 1;
+    CUSTOM_COLOR = 2;
+    CUSTOM_MONOCHROME = 3;
+    AUTO = 4;
+  }
+
+  message Option {
+    // ID to help vendor identify the color option (required for options of type
+    // CUSTOM_COLOR and CUSTOM_MONOCHROME).
+    optional string vendor_id = 1;
+
+    // Type of color option used in UIs to differentiate color and non-color
+    // options (required). Note that there can be any number of options of type
+    // CUSTOM_COLOR and CUSTOM_MONOCHROME, but there should be at most one
+    // option of each of the other types.
+    optional Type type = 2;
+
+    // Non-localized user-friendly string that represents this option.
+    // New CDDs should use custom_display_name_localized instead. It is required
+    // that either custom_display_name or custom_display_name_localized is set
+    // for options of type CUSTOM_COLOR and CUSTOM_MONOCHROME. Options of each
+    // of the other types will have their display name localized by the server.
+    optional string custom_display_name = 3;
+
+    // Whether this option should be selected by default. Only one option
+    // should be set as default.
+    optional bool is_default = 4 [default = false];
+
+    // Translations of custom display name of the option.
+    // If not empty, must contain an entry with locale == EN.
+    repeated LocalizedString custom_display_name_localized = 5;
+  }
+
+  repeated Option option = 1;
+}

data/lib/proto/color_ticket_item.proto

@@ -0,0 +1,12 @@
+// Ticket item indicating which color option to use.
+
+import 'color.proto';
+
+message ColorTicketItem {
+  // Vendor ID of the color (required if the type is CUSTOM_COLOR or
+  // CUSTOM_MONOCHROME).
+  optional string vendor_id = 1;
+
+  // Type of the color (required).
+  optional Color.Type type = 2;
+}

data/lib/proto/copies.proto

@@ -0,0 +1,6 @@
+// Capability that defines a default and maximum value for multiple copies on a
+// device.
+message Copies {
+  optional int32 default = 1;
+  optional int32 max = 2;
+}

data/lib/proto/copies_ticket_item.proto

@@ -0,0 +1,5 @@
+// Ticket item indicating how many copies to produce.
+message CopiesTicketItem {
+  // Number of copies to print (required).
+  optional int32 copies = 1;
+}

data/lib/proto/cover.proto

@@ -0,0 +1,31 @@
+// Physical model of a printer cover.
+
+import 'localized_string.proto';
+
+message Cover {
+  // Enumeration of cover types.
+  enum Type {
+    CUSTOM = 0;
+    DOOR = 1;
+    COVER = 2;
+  }
+
+  // Vendor-provided ID of the cover (required).
+  optional string vendor_id = 1;
+
+  // Type of the cover (required).
+  optional Type type = 2;
+
+  // Index of the cover.
+  optional int64 index = 3;
+
+  // Non-localized custom display name of the cover.
+  // New CDDs should use custom_display_name_localized instead. It is required
+  // that either custom_display_name or custom_display_name_localized is set
+  // if the cover's type is CUSTOM.
+  optional string custom_display_name = 4;
+
+  // Translations of custom display name of the cover.
+  // If not empty, must contain an entry with locale == EN.
+  repeated LocalizedString custom_display_name_localized = 5;
+}

data/lib/proto/cover_state.proto

@@ -0,0 +1,25 @@
+// State of the device covers (door/cover/etc).
+message CoverState {
+
+  message Item {
+
+    enum StateType {
+      // Default cover state (closed, does not need any attention).
+      OK = 0;
+      // Cover is open. Treated as error.
+      OPEN = 1;
+      // Cover is not functioning properly. Treated as error.
+      FAILURE = 2;
+    }
+
+    // ID of the cover (refers to CDD model) (required).
+    optional string vendor_id = 1;
+
+    // Current cover state (required).
+    optional StateType state = 2;
+    // Vendor-specific message, ignored when state == OK.
+    optional string vendor_message = 101;
+  }
+
+  repeated Item item = 1;
+}

data/lib/proto/device_action_cause.proto

@@ -0,0 +1,19 @@
+message DeviceActionCause {
+
+    // Next number = 3.
+    enum ErrorCode {
+      // Error while downloading job.
+      DOWNLOAD_FAILURE = 0;
+      // Error due to invalid job ticket.
+      INVALID_TICKET = 1;
+      // A generic printing error occurred.
+      PRINT_FAILURE = 2;
+      // Error due to some other device action.
+      OTHER = 100;
+    }
+
+    // Error code for the device action which caused the current job state
+    // (required).
+    optional ErrorCode error_code = 1;
+}
+

data/lib/proto/dpi.proto

@@ -0,0 +1,27 @@
+// Capability that defines the 2D image quality levels available on a device.
+message Dpi {
+  message Option {
+    // Horizontal DPI (required).
+    optional int32 horizontal_dpi = 1;
+
+    // Vertical DPI (required).
+    optional int32 vertical_dpi = 2;
+
+    optional bool is_default = 3 [default = false];
+
+    // Custom display name to override the default display name which consists
+    // of "{$horizontal_dpi}x{$vertical_dpi} dpi".
+    optional string custom_display_name = 4;
+
+    // Vendor-provided ID for the dpi option. Used to disambiguate dpi options
+    // that may have the same horizontal and vertical dpi but a different effect
+    // on the printer.
+    optional string vendor_id = 5;
+  }
+
+  repeated Option option = 1;
+  optional int32 min_horizontal_dpi = 2;
+  optional int32 max_horizontal_dpi = 3;
+  optional int32 min_vertical_dpi = 4;
+  optional int32 max_vertical_dpi = 5;
+}

data/lib/proto/dpi_ticket_item.proto

@@ -0,0 +1,13 @@
+// Ticket item indicating what image resolution to use.
+message DpiTicketItem {
+  // Horizontal DPI to print at (required).
+  optional int32 horizontal_dpi = 1;
+
+  // Vertical DPI to print at (required).
+  optional int32 vertical_dpi = 2;
+
+  // Vendor-provided ID of the Dpi option. Needed to disambiguate Dpi options
+  // that have the same DPI values, but may have a different effect for the
+  // printer.
+  optional string vendor_id = 3;
+}

data/lib/proto/duplex.proto

@@ -0,0 +1,15 @@
+// Capability that defines the duplexing options available on a device.
+message Duplex {
+  enum Type {
+    NO_DUPLEX = 0;
+    LONG_EDGE = 1;
+    SHORT_EDGE = 2;
+  }
+
+  message Option {
+    optional Type type = 1 [default = NO_DUPLEX];
+    optional bool is_default = 2 [default = false];
+  }
+
+  repeated Option option = 1;
+}

data/lib/proto/duplex_ticket_item.proto

@@ -0,0 +1,8 @@
+// Ticket item indicating which duplexing option to use.
+
+import 'duplex.proto';
+
+message DuplexTicketItem {
+  // Type of duplexing (required).
+  optional Duplex.Type type = 1;
+}

data/lib/proto/fit_to_page.proto

@@ -0,0 +1,20 @@
+// Capability that defines the page fitting options available on a device.
+message FitToPage {
+  // Enumeration of page fitting algorithms. The "page" is defined as the media
+  // size minus any given margins.
+  enum Type {
+    NO_FITTING = 0;
+    FIT_TO_PAGE = 1;
+    GROW_TO_PAGE = 2;
+    SHRINK_TO_PAGE = 3;
+    FILL_PAGE = 4;
+  }
+
+  message Option {
+    // Type of fitting algorithm (required).
+    optional Type type = 1;
+    optional bool is_default = 2 [default = false];
+  }
+
+  repeated Option option = 1;
+}

data/lib/proto/fit_to_page_ticket_item.proto

@@ -0,0 +1,8 @@
+// Ticket item indicating what page-fitting algorithm to use.
+
+import 'fit_to_page.proto';
+
+message FitToPageTicketItem {
+  // Type of page fitting (required).
+  optional FitToPage.Type type = 1;
+}

data/lib/proto/input_tray_state.proto

@@ -0,0 +1,31 @@
+// State of the device's input trays.
+message InputTrayState {
+
+  message Item {
+
+    enum StateType {
+      // Tray is functional.
+      OK = 0;
+      // Tray is out of media. Treated as error.
+      EMPTY = 1;
+      // Tray is open. Treated as error.
+      OPEN = 2;
+      // Tray is installed, but turned off or disconnected. Treated as error.
+      OFF = 3;
+      // Tray is present, but not functioning properly. Treated as error.
+      FAILURE = 4;
+    }
+
+    // ID of the tray (refers to CDD model) (required).
+    optional string vendor_id = 1;
+
+    // Current tray state (required).
+    optional StateType state = 2;
+    // Loaded media level, percent. Ranges from 0 (empty) to 100 (fully loaded).
+    optional int32 level_percent = 3;
+    // Vendor-specific message, ignored when state == OK.
+    optional string vendor_message = 101;
+  }
+
+  repeated Item item = 1;
+}