kinokero 0.0.5

data/lib/proto/marker_state.proto

@@ -0,0 +1,31 @@
+// State of the device markers (toner/ink/staples/etc).
+message MarkerState {
+
+  message Item {
+
+    enum StateType {
+      // Marker is functional.
+      OK = 0;
+      // Marker resource is exhausted. Treated as error.
+      EXHAUSTED = 1;
+      // Marker is removed. Treated as error.
+      REMOVED = 2;
+      // Marker is present, but not functioning properly. Treated as error.
+      FAILURE = 3;
+    }
+
+    // ID of the marker (refers to CDD model) (required).
+    optional string vendor_id = 1;
+
+    // Current marker state (required).
+    optional StateType state = 2;
+    // Marker supply amount, percent. Ranges from 0 to 100.
+    optional int32 level_percent = 3;
+    // Estimated number of pages for which the marker supply amount will last.
+    optional int32 level_pages = 4;
+    // Vendor-specific message, ignored when state == OK.
+    optional string vendor_message = 101;
+  }
+
+  repeated Item item = 1;
+}

data/lib/proto/media_path.proto

@@ -0,0 +1,6 @@
+// Physical model of a media path of a printer. Media paths are the paths
+// through which print media flows.
+message MediaPath {
+  // Vendor-provided ID of a media path (required).
+  optional string vendor_id = 1;
+}

data/lib/proto/media_path_state.proto

@@ -0,0 +1,25 @@
+// State of the device media paths.
+message MediaPathState {
+
+  message Item {
+
+    enum StateType {
+      // Path is functioning.
+      OK = 0;
+      // Media is jammed. Treated as error.
+      MEDIA_JAM = 1;
+      // Path is present, but not functioning properly. Treated as error.
+      FAILURE = 2;
+    }
+
+    // ID of the media path (refers to CDD model) (required).
+    optional string vendor_id = 1;
+
+    // Current 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/media_size.proto

@@ -0,0 +1,216 @@
+// Capability that defines the media sizes available on a device.
+
+import 'localized_string.proto';
+
+message MediaSize {
+  // Enumeration of media size names. This is used for UI purposes.
+  enum Name {
+    CUSTOM = 0;
+
+    // North American standard sheet media names.
+    NA_INDEX_3X5 = 100;
+    NA_PERSONAL = 101;
+    NA_MONARCH = 102;
+    NA_NUMBER_9 = 103;
+    NA_INDEX_4X6 = 104;
+    NA_NUMBER_10 = 105;
+    NA_A2 = 106;
+    NA_NUMBER_11 = 107;
+    NA_NUMBER_12 = 108;
+    NA_5X7 = 109;
+    NA_INDEX_5X8 = 110;
+    NA_NUMBER_14 = 111;
+    NA_INVOICE = 112;
+    NA_INDEX_4X6_EXT = 113;
+    NA_6X9 = 114;
+    NA_C5 = 115;
+    NA_7X9 = 116;
+    NA_EXECUTIVE = 117;
+    NA_GOVT_LETTER = 118;
+    NA_GOVT_LEGAL = 119;
+    NA_QUARTO = 120;
+    NA_LETTER = 121;
+    NA_FANFOLD_EUR = 122;
+    NA_LETTER_PLUS = 123;
+    NA_FOOLSCAP = 124;
+    NA_LEGAL = 125;
+    NA_SUPER_A = 126;
+    NA_9X11 = 127;
+    NA_ARCH_A = 128;
+    NA_LETTER_EXTRA = 129;
+    NA_LEGAL_EXTRA = 130;
+    NA_10X11 = 131;
+    NA_10X13 = 132;
+    NA_10X14 = 133;
+    NA_10X15 = 134;
+    NA_11X12 = 135;
+    NA_EDP = 136;
+    NA_FANFOLD_US = 137;
+    NA_11X15 = 138;
+    NA_LEDGER = 139;
+    NA_EUR_EDP = 140;
+    NA_ARCH_B = 141;
+    NA_12X19 = 142;
+    NA_B_PLUS = 143;
+    NA_SUPER_B = 144;
+    NA_C = 145;
+    NA_ARCH_C = 146;
+    NA_D = 147;
+    NA_ARCH_D = 148;
+    NA_ASME_F = 149;
+    NA_WIDE_FORMAT = 150;
+    NA_E = 151;
+    NA_ARCH_E = 152;
+    NA_F = 153;
+
+    // Chinese standard sheet media size names.
+    ROC_16K = 200;
+    ROC_8K = 201;
+    PRC_32K = 202;
+    PRC_1 = 203;
+    PRC_2 = 204;
+    PRC_4 = 205;
+    PRC_5 = 206;
+    PRC_8 = 207;
+    PRC_6 = 208;
+    PRC_3 = 209;
+    PRC_16K = 210;
+    PRC_7 = 211;
+    OM_JUURO_KU_KAI = 212;
+    OM_PA_KAI = 213;
+    OM_DAI_PA_KAI = 214;
+    PRC_10 = 215;
+
+    // ISO standard sheet media size names.
+    ISO_A10 = 301;
+    ISO_A9 = 302;
+    ISO_A8 = 303;
+    ISO_A7 = 304;
+    ISO_A6 = 305;
+    ISO_A5 = 306;
+    ISO_A5_EXTRA = 307;
+    ISO_A4 = 308;
+    ISO_A4_TAB = 309;
+    ISO_A4_EXTRA = 310;
+    ISO_A3 = 311;
+    ISO_A4X3 = 312;
+    ISO_A4X4 = 313;
+    ISO_A4X5 = 314;
+    ISO_A4X6 = 315;
+    ISO_A4X7 = 316;
+    ISO_A4X8 = 317;
+    ISO_A4X9 = 318;
+    ISO_A3_EXTRA = 319;
+    ISO_A2 = 320;
+    ISO_A3X3 = 321;
+    ISO_A3X4 = 322;
+    ISO_A3X5 = 323;
+    ISO_A3X6 = 324;
+    ISO_A3X7 = 325;
+    ISO_A1 = 326;
+    ISO_A2X3 = 327;
+    ISO_A2X4 = 328;
+    ISO_A2X5 = 329;
+    ISO_A0 = 330;
+    ISO_A1X3 = 331;
+    ISO_A1X4 = 332;
+    ISO_2A0 = 333;
+    ISO_A0X3 = 334;
+    ISO_B10 = 335;
+    ISO_B9 = 336;
+    ISO_B8 = 337;
+    ISO_B7 = 338;
+    ISO_B6 = 339;
+    ISO_B6C4 = 340;
+    ISO_B5 = 341;
+    ISO_B5_EXTRA = 342;
+    ISO_B4 = 343;
+    ISO_B3 = 344;
+    ISO_B2 = 345;
+    ISO_B1 = 346;
+    ISO_B0 = 347;
+    ISO_C10 = 348;
+    ISO_C9 = 349;
+    ISO_C8 = 350;
+    ISO_C7 = 351;
+    ISO_C7C6 = 352;
+    ISO_C6 = 353;
+    ISO_C6C5 = 354;
+    ISO_C5 = 355;
+    ISO_C4 = 356;
+    ISO_C3 = 357;
+    ISO_C2 = 358;
+    ISO_C1 = 359;
+    ISO_C0 = 360;
+    ISO_DL = 361;
+    ISO_RA2 = 362;
+    ISO_SRA2 = 363;
+    ISO_RA1 = 364;
+    ISO_SRA1 = 365;
+    ISO_RA0 = 366;
+    ISO_SRA0 = 367;
+
+    // Japanese standard sheet media size names.
+    JIS_B10 = 400;
+    JIS_B9 = 401;
+    JIS_B8 = 402;
+    JIS_B7 = 403;
+    JIS_B6 = 404;
+    JIS_B5 = 405;
+    JIS_B4 = 406;
+    JIS_B3 = 407;
+    JIS_B2 = 408;
+    JIS_B1 = 409;
+    JIS_B0 = 410;
+    JIS_EXEC = 411;
+    JPN_CHOU4 = 412;
+    JPN_HAGAKI = 413;
+    JPN_YOU4 = 414;
+    JPN_CHOU2 = 415;
+    JPN_CHOU3 = 416;
+    JPN_OUFUKU = 417;
+    JPN_KAHU = 418;
+    JPN_KAKU2 = 419;
+
+    // Other metric standard sheet media size names.
+    OM_SMALL_PHOTO = 500;
+    OM_ITALIAN = 501;
+    OM_POSTFIX = 502;
+    OM_LARGE_PHOTO = 503;
+    OM_FOLIO = 504;
+    OM_FOLIO_SP = 505;
+    OM_INVITE = 506;
+  }
+
+  message Option {
+    optional Name name = 1 [default = CUSTOM];
+    // Both of the fields ("width_microns" and "height_microns") are required
+    // if "is_continuous_feed" is set to false. If "is_continuous_feed" is set
+    // to true only one of these fields is required.
+    optional int32 width_microns = 2;
+    optional int32 height_microns = 3;
+    optional bool is_continuous_feed = 4 [default = false];
+    optional bool is_default = 5 [default = false];
+
+    // 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 whose "name" field is CUSTOM.
+    optional string custom_display_name = 6;
+
+    // Vendor-provided ID for the media size option. Used to disambiguate media
+    // sizes that may have the same width and height but a different effect on
+    // the printer.
+    optional string vendor_id = 7;
+
+    // Translations of custom display name of the option.
+    // If not empty, must contain an entry with locale == EN.
+    repeated LocalizedString custom_display_name_localized = 8;
+  }
+
+  repeated Option option = 1;
+  optional int32 max_width_microns = 2;
+  optional int32 max_height_microns = 3;
+  optional int32 min_width_microns = 4;
+  optional int32 min_height_microns = 5;
+}

data/lib/proto/media_size_ticket_item.proto

@@ -0,0 +1,17 @@
+// Ticket item indicating what media size to use.
+message MediaSizeTicketItem {
+  // Width (in microns) of the media to print to.
+  optional int32 width_microns = 1;
+
+  // Height (in microns) of the media to print to.
+  optional int32 height_microns = 2;
+
+  // Whether the media size selection is continuously fed. If false, both width
+  // and height must be set. If true, only one need be set.
+  optional bool is_continuous_feed = 3 [default = false];
+
+  // Vendor-provided ID of the MediaSize option. Needed to disambiguate media
+  // sizes that may have the same width and height, but may have a different
+  // effect for the printer.
+  optional string vendor_id = 4;
+}

data/lib/proto/output_bin_state.proto

@@ -0,0 +1,31 @@
+// State of the device's output bins.
+message OutputBinState {
+
+  message Item {
+
+    enum StateType {
+      // Bin is functional.
+      OK = 0;
+      // Bin is full and cannot receive any more output. Treated as error.
+      FULL = 1;
+      // Bin is open. Treated as error.
+      OPEN = 2;
+      // Bin is installed, but turned off or disconnected. Treated as error.
+      OFF = 3;
+      // Bin is present, but not functioning properly. Treated as error.
+      FAILURE = 4;
+    }
+
+    // ID of the bin (refers to CDD model) (required).
+    optional string vendor_id = 1;
+
+    // Current bin state (required).
+    optional StateType state = 2;
+    // Used space, percent. Ranges from 0 (empty) to 100 (full).
+    optional int32 level_percent = 3;
+    // Vendor-specific message, ignored when state == OK.
+    optional string vendor_message = 101;
+  }
+
+  repeated Item item = 1;
+}

data/lib/proto/output_bin_unit.proto

@@ -0,0 +1,32 @@
+// Physical model of a printer output bin.
+
+import 'localized_string.proto';
+
+message OutputBinUnit {
+  // Enumeration of output bin types.
+  enum Type {
+    CUSTOM = 0;
+    OUTPUT_BIN = 1;
+    MAILBOX = 2;
+    STACKER = 3;
+  }
+
+  // Vendor-provided ID of the output bin (required).
+  optional string vendor_id = 1;
+
+  // Type of output bin (required).
+  optional Type type = 2;
+
+  // Index of the output bin.
+  optional int64 index = 3;
+
+  // Non-localized custom display name of the output bin.
+  // 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 bin's type is CUSTOM.
+  optional string custom_display_name = 4;
+
+  // Translations of custom display name of the output bin.
+  // If not empty, must contain an entry with locale == EN.
+  repeated LocalizedString custom_display_name_localized = 5;
+}

data/lib/proto/page_orientation.proto

@@ -0,0 +1,16 @@
+// Capability that defines the page orientation options available on a device.
+message PageOrientation {
+  enum Type {
+    PORTRAIT = 0;
+    LANDSCAPE = 1;
+    AUTO = 2;
+  }
+
+  message Option {
+    // Type of page orientation (required).
+    optional Type type = 1;
+    optional bool is_default = 2 [default = false];
+  }
+
+  repeated Option option = 1;
+}

data/lib/proto/page_orientation_ticket_item.proto

@@ -0,0 +1,9 @@
+// Ticket item indicating which page orientation option to use.
+
+import 'page_orientation.proto';
+
+
+message PageOrientationTicketItem {
+  // Page orientation type (required).
+  optional PageOrientation.Type type = 1;
+}

data/lib/proto/page_range.proto

@@ -0,0 +1,15 @@
+// Capability that defines a default page-range selection on a device.
+message PageRange {
+
+  // Interval of pages in the document to print.
+  message Interval {
+    // Beginning of the interval (inclusive) (required).
+    optional int32 start = 1;
+
+    // End of the interval (inclusive). If not set, then the interval will
+    // include all available pages after start.
+    optional int32 end = 2;
+  }
+
+  repeated Interval default = 1;
+}

data/lib/proto/page_range_ticket_item.proto

@@ -0,0 +1,7 @@
+// Ticket item indicating what pages to use.
+
+import 'page_range.proto';
+
+message PageRangeTicketItem {
+  repeated PageRange.Interval interval = 1;
+}

data/lib/proto/print_job_state.proto

@@ -0,0 +1,18 @@
+// Represents the current state of a print job on a cloud device.
+message PrintJobState {
+
+  // Version of the PJS in the form "X.Y" where changes to Y are backwards
+  // compatible, and changes to X are not (required).
+  optional string version = 1;
+
+  // Current state of the job (required).
+  optional JobState state = 2;
+
+  // Number of successfully printed pages. Printer should use this value to
+  // restart interrupted/suspended print jobs from the next page.
+  // Printer can only increase the number of pages printed.
+  optional int32 pages_printed = 3;
+
+  // Number of attempts to deliver the print job.
+  optional int32 delivery_attempts = 4;
+}

data/lib/proto/print_job_state_diff.proto

@@ -0,0 +1,13 @@
+// Diff that can be applied to a PrintJobState message. Any omitted field will
+// not be changed.
+
+import 'job_state.proto';
+
+message PrintJobStateDiff {
+
+  // New job state.
+  optional JobState state = 1;
+
+  // New number of pages printed.
+  optional int32 pages_printed = 2;
+}